$ ./tbb-testsuite [options] <tbb-file>...

The <tbb-file> can be:

  • the path to a tbb tarball file.

  • the path to a sha256sum file. In which case all tarballs listed in the sha256sum and compatible with the current platform will be tested.

  • the URL of a tbb tarball, which will be downloaded before being tested.

  • the URL of a sha256sum file, which will be downloaded. The gpg signature from file sha256sum.asc will also be downloaded and checked with the keyring selected with the --keyring option, unless the --no-gpgcheck option is used. All the tarballs listed in the sha256sum and compatible with the current platform will be downloaded, have their checksum checked and will be tested.

Available options


Select the action to be done. The default is to run the tests. See the section about actions for details.


Select a configuration file. See the section about Configuration Files below.


Select a testsuite type to use, when a tarball is specified on the command line. If unspecified, the default Tor Browser testsuite is used.


Disable gpg check when downloading a sha256sum.txt file.


Name of the keyring file used to check the gpg signature of a downloaded sha256sum.txt file. If the file is not an absolute path, then it is relative to the keyring directory.


The directory where to store the files downloaded when a URL is given rather than a local path. If the file already exists in this directory, it is not downloaded again. If this option is not given, the files are downloaded in a temporary directory which is removed at the end of the tests.


Don’t start a tor daemon. If you use this option, you should already have a tor daemon running.


Select the tor control port number. Default is 9551.


Select the tor socks port. Default is 9550.


Directory where the tests reports are saved.


URL where the tests reports can be accessed. This is used when sending a report by email, to add a reference to the full report.


The name of the tests run. This is used as directory name to save the results inside the reports-dir. If not set, a random name is used.


Run the tests using a virtual frame buffer X server. You should also disable the X server with --no-xdummy.


Don’t start an X server with the dummy driver to run the tests.


When using xvfb or X dummy, this sets the default resolution. The default is 1024x768.


Only run the list of tests selected. When this option is not used, all tests are run. This option is useful when you are working on a new test and don’t want to run all the test suite to try your new test.


Don’t run the list of tests selected.


Upload the tests reports to select host, with ssh.


Select the OS for which you want to run tests, when using a sha256sums-unsigned-build.txt file. By default, it is the OS you are currently running. This option can be useful to run some tests from a different OS than what you are running, for instance testing the Windows bundles from Linux.


Select the architecture for which you want to run tests, when using a sha256sums-unsigned-build.txt file. By default, it is the architecture you are currently running.


Enable upload of files for analysis on instead of the regular testsuite.


Set the From header that will be used when sending reports by email.


Enable sending of reports by email to the selected email address. This option can be used multiple time to send to multiple people.


Set the template used to create the subject of the reports emails.


Select the port used to start an http proxy, for tor_bootstrap tests that require an http proxy.


Disable cleanup of tmp directory after running the testsuite. This can be useful for debugging.

Configuration Files

In addition to setting options using command line arguments, it is possible to set options using a configuration file and the --config option. If the path given to the --config option is relative, it is expected to be in the config directory.

The configuration file is a perl script which when evaluated should return a hash containing the configuration. The options set by the default configuration and command line arguments are available to this script in the $option hash reference.

Selecting action

The --action option can be used to select the action to be done. The following actions are available:


Run the tests, make a report, and update the reports index page. This is the default action.


Create an index page listing the tests reports.


Regenerate the html report of a test run. You should use the --name option to select the test run.


List available tests and their descriptions.


Upload a report to a remote host. The report name is selected with the --name option, and the remote host with the --upload-to. This action is also done as part of run_tests if the --upload-to option is defined.


Receive a report on stdin. Usually this action is run from an ssh authorized_keys file.


Update the ssh authorized_keys file with users defined in the uploaders option. You need to run this on a user account that will be receiving tests reports. See config/receive-reports for an example of config file which defines ssh keys.


Send a text version of the report by email. The report name is selected with the --name option, the recipient with the --email-to, the sender with the --email-from and the subject template with the --email-subject options.


Show a text version of the report, as it would be sent by email. The report name is selected with the --name option.


Dump on stdout all the options and their values. This can be useful to check what options are actually used when you have a config file, command line options and default options.