TestSwarm - Distributed Continuous Integration for JavaScript
TestSwarm provides distributed continuous integration testing for
JavaScript.
The main instance monitoring jQuery core and related projects runs at
swarm.jquery.org.
Project Status
TestSwarm is still in use in projects of the jQuery Foundation, but it isn't under active development anymore. Although critical issues may be patched in the future, most open issues will remain unaddressed.
Within the jQuery Foundation, we're experimenting with alternative projects, to eventually shut down our own instance of TestSwarm:
We recommend reviewing those and other alternatives.
Quick start
Clone the repo, git clone --recursive git://github.com/jquery/testswarm.git.
Versioning
TestSwarm uses the Semantic Versioning guidelines as much as possible.
Releases will be numbered in the following format:
<major>.<minor>.<patch>
The -alpha suffix is used to indicate unreleased versions in development.
For more information on SemVer, please visit https://semver.org/.
Bug tracker
Found a bug? Please report it using our issue
tracker!
Installation
Environmental compatibility
To run TestSwarm you will need a web server, a database server and PHP.
At the moment TestSwarm supports the following, but other configurations
may work as well.
- Apache 2.0+, NGINX 1.2+
- PHP 5.4+ (or PHP-FPM for NGINX)
- MySQL 4.0+
- cURL (for the cleanup action; see step 8)
Steps
-
Create an empty MySQL database and create a user with read and write access to it.
-
Copy
config/sample-localSettings.phptoconfig/localSettings.php
Copyconfig/sample-localSettings.jsontoconfig/localSettings.json.
EditlocalSettings.jsonand replace the sample settings with your own.
Refer to the Settings page for more information. -
For Apache:
Copyconfig/sample-.htaccessto.htaccess.
To run TestSwarm from a non-root directory, setweb.contextpathinlocalSettings.jsonto the
correct path from the web root and update RewriteBase in.htaccess.
Verify that.htaccessis working properly by opening a page other than the HomePage (e.g.
/testswarm/projects) in your browser.Required Apache configuration:AllowOverrideis set toAll(or ensureFileInfois included).mod_rewriteinstalled and loaded.
For NGINX:
Copyconfig/sample-nginx.confto/etc/nginx/sites-available.
The file name should match your domain e.g. for swarm.example.org:
cp config/sample-nginx.conf /etc/nginx/sites-available/swarm.example.org.conf
Open this conf file in your editor and replace the "example" values with the correct values.
Make sure your install is located at/var/www/testswarm
(otherwise update the file to match the correct location).
Now you need to link thesites-availableconfig to thesites-enabledconfig:
(replace the "swarm.example.org" with your own file name):
ln -s /etc/nginx/sites-available/swarm.example.org.conf /etc/nginx/sites-enabled/swarm.example.org.conf
Now make sure that php-fpm is running:/etc/init.d/php-fpm status
if is not running start it:/etc/init.d/php-fpm start -
Copy
config/sample-robots.txttorobots.txt
Or, if TestSwarm is not in the root directory, add similar rules to your rootrobots.txt. -
Set
storage.cacheDirto a writable directory that is not readable from the
web. Either set it to a custom path outside the document root, or use the
defaultcachedirectory (protected with .htaccess).Chmod it:
chmod 777 cache. -
Install dependencies
composer install --no-dev -
Install the TestSwarm database by running:
php scripts/install.php -
Create an entry in your crontab for action=cleanup. This performs various
cleaning duties such as making timed-out runs available again.
* * * * * curl -s http://swarm.example.org/api.php?action=cleanup > /dev/null
Get involved
You're welcome to use the GitHub issue tracker
to start discussions.
Some of us are also on Gitter at jquery/dev.
Documentation
Copyright and license
See LICENSE.txt.
History
TestSwarm was originally created by John Resig as a
basic tool to support unit testing of the jQuery JavaScript
library. It later become a Mozilla Labs project,
and has since moved again to become a jQuery Foundation project.