diff options
authoranonym <>2020-10-15 16:34:55 +0200
committerintrigeri <>2020-10-16 06:36:38 +0000
commitb130d1b4b6a61f733332d87b587940e122ae0971 (patch)
parentd70e3bfb2e4c580ca233a457e429e821c1a25e2e (diff)
Document `rake test` and move ./run_test_suite to bin/run-test-suite.test/12503-rake-test-on-jenkins
The standard way of invoking the test suite should be through `rake test` from now on. While we're at it we do this move to reduce clutter in the source tree root, and to pick a more consistent name compared to our other scripts.
-rwxr-xr-xbin/run-test-suite (renamed from run_test_suite)0
8 files changed, 14 insertions, 14 deletions
diff --git a/Rakefile b/Rakefile
index fc53400..6ecddbd 100644
--- a/Rakefile
+++ b/Rakefile
@@ -662,7 +662,7 @@ task :test do
args += ['--tag', '@doc']
- run_command('./run_test_suite', *args)
+ run_command('./bin/run-test-suite', *args)
desc 'Clean up all build related files'
diff --git a/run_test_suite b/bin/run-test-suite
index 6cff802..6cff802 100755
--- a/run_test_suite
+++ b/bin/run-test-suite
diff --git a/features/support/config.rb b/features/support/config.rb
index bd16452..a5b6acd 100644
--- a/features/support/config.rb
+++ b/features/support/config.rb
@@ -3,7 +3,7 @@ require 'yaml'
require "#{Dir.pwd}/features/support/helpers/misc_helpers.rb"
# These files deal with options like some of the settings passed
-# to the `run_test_suite` script, and "secrets" like credentials
+# to the bin/run-test-suite script, and "secrets" like credentials
# (passwords, SSH keys) to be used in tests.
CONFIG_DIR = "#{Dir.pwd}/features/config".freeze
DEFAULTS_CONFIG_FILE = "#{CONFIG_DIR}/defaults.yml".freeze
@@ -22,7 +22,7 @@ config_files.each do |config_file|
-# Options passed to the `run_test_suite` script will always take
+# Options passed to the bin/run-test-suite script will always take
# precedence. The way we import these keys is only safe for values
# with types boolean or string. If we need more, we'll have to invoke
# YAML's type autodetection on ENV some how.
diff --git a/wiki/src/contribute/release_process/persistence-setup.mdwn b/wiki/src/contribute/release_process/persistence-setup.mdwn
index 52bffab..ef9608e 100644
--- a/wiki/src/contribute/release_process/persistence-setup.mdwn
+++ b/wiki/src/contribute/release_process/persistence-setup.mdwn
@@ -2,7 +2,7 @@
[[!toc levels=1]]
-Persistence-setup is not currently integrated with `run_test_suite`.
+Persistence-setup is not currently integrated with `rake test`.
To run it, follow these instructions, making sure that you are in the
`config/chroot_local-includes/usr/src/persistence-setup` directory.
diff --git a/wiki/src/contribute/release_process/test/automated_tests.mdwn b/wiki/src/contribute/release_process/test/automated_tests.mdwn
index 78ddf5b..e45ca40 100644
--- a/wiki/src/contribute/release_process/test/automated_tests.mdwn
+++ b/wiki/src/contribute/release_process/test/automated_tests.mdwn
@@ -67,7 +67,7 @@ tag.
## Running cucumber in the right environment
-The `run_test_suite` script is a wrapper on top of `cucumber`, that
+The `bin/run-test-suite` script is a wrapper on top of `cucumber`, that
sets the correct environment up:
* It uses `Xvfb` so that the `DISPLAY` environment variable points to
diff --git a/wiki/src/contribute/release_process/test/setup.mdwn b/wiki/src/contribute/release_process/test/setup.mdwn
index d2dd800..5416451 100644
--- a/wiki/src/contribute/release_process/test/setup.mdwn
+++ b/wiki/src/contribute/release_process/test/setup.mdwn
@@ -172,6 +172,6 @@ If you're running the test suite in a nested environnement, install
`tigervnc-viewer` on the bare metal level-0 host. Then you can use vncviewer's
`-via` option so that it automatically setup a ssh tunnel to your first level
test suite domain for you and display the Tails VM. E.g.
-where `$DISPLAY` is the display given to you by `run_test_suite` (often 0):
+where `$DISPLAY` is the display given to you by `bin/run-test-suite` (often 0):
vncviewer -viewonly -via user@level0 localhost:$DISPLAY
diff --git a/wiki/src/contribute/release_process/test/usage.mdwn b/wiki/src/contribute/release_process/test/usage.mdwn
index 8ed75e4..24917fb 100644
--- a/wiki/src/contribute/release_process/test/usage.mdwn
+++ b/wiki/src/contribute/release_process/test/usage.mdwn
@@ -16,7 +16,7 @@ Tails automated test suite.
-Use the `run_test_suite` script found in the [[Tails source root|contribute/git#main-repo]] to run
+Use `rake test` in the [[Tails source root|contribute/git#main-repo]] to run
all automated Cucumber test features. See the [[setup
documentation|test/setup]] in case you don't have a testing
environment yet. Note that the full Tails source tree must be readable
@@ -25,12 +25,12 @@ by the user running the test suite.
It's important to note that some features only depend on the Tails
sources, and some on the actual product of the sources, i.e. a Tails
ISO image. These features are tagged `@source` and `@product`,
-respectively. The arguments passed to `run_test_suite` may only affect
+respectively. The arguments passed to `rake test` may only affect
one of these types of features and not the other.
A typical example run of a few `@product` features could be:
- ./run_test_suite --view --capture \
+ rake test --view --capture \
--iso path/to/tails.iso \
features/apt.feature features/erase_memory.feature
@@ -41,13 +41,13 @@ session in a VNC viewer (`--view`) and also capturing it into a video
(`--capture`). Similarly, to test a `@source`
feature, we'd simply run something like:
- ./run_test_suite features/build.feature
+ rake test features/build.feature
-Actually, `run_test_suite` is just a wrapper around `cucumber`, so any
+Actually, `rake test` calls `bin/run-test-suite` which is just a wrapper around `cucumber`, so any
`cucumber` option can be passed too, although after an `--` so they
are not confused with the wrapper's options. For instance:
- ./run_test_suite ... -- --format debug features/apt.feature
+ rake test ... -- --format debug features/apt.feature
will enable the `debug` formatter, which in Tails' Cucumber setup will
enable debugging information to be printed (which is *very* useful
@@ -65,7 +65,7 @@ Configuration
The test suite can be configured in the following ways:
-1. `run_test_suite` parameters, which takes precedence over
+1. `rake test` parameters, which takes precedence over
2. the local configuration file `features/config/local.yml`, which
takes precedence over
diff --git a/wiki/src/contribute/working_together/roles/sysadmins/automated_tests_in_Jenkins.mdwn b/wiki/src/contribute/working_together/roles/sysadmins/automated_tests_in_Jenkins.mdwn
index 425b498..0e068f2 100644
--- a/wiki/src/contribute/working_together/roles/sysadmins/automated_tests_in_Jenkins.mdwn
+++ b/wiki/src/contribute/working_together/roles/sysadmins/automated_tests_in_Jenkins.mdwn
@@ -90,7 +90,7 @@ use the ISO being tested instead of the last released one:
Under the hood, once this change is applied Jenkins will pass the
ISO being tested (instead of the last released one) to
- `run_test_suite`'s `--old-iso` argument.
+ `rake test`'s `--old-iso` argument.
2. File an issue to ensure this temporarily change gets reverted
in due time.