summaryrefslogtreecommitdiffstats
path: root/test/README.md
diff options
context:
space:
mode:
authorNicola Tuveri <nic.tuv@gmail.com>2020-06-30 10:23:56 +0300
committerNicola Tuveri <nic.tuv@gmail.com>2020-07-02 16:47:17 +0300
commita20c9075d6a72f484d1f27d99a54483a7e96fc51 (patch)
treed7723493bd65a0276cd0c6711ec25b3c56e17f06 /test/README.md
parent587e4e53f886cd4d7a8b0eb063b823409e2ed4b9 (diff)
Run tests in parallel
The environment variable `HARNESS_JOBS` can be used to control how many jobs to run in parallel. The default is still to run jobs sequentially. This commit does not define custom `rules`, and different versions of `TAP::Harness` come with different strategies regarding the default `rules` that define which test recipes can be run in parallel. In recent versions of Perl, unless specified otherwise any task can be run in parallel. Reviewed-by: David von Oheimb <david.von.oheimb@siemens.com> (Merged from https://github.com/openssl/openssl/pull/12326)
Diffstat (limited to 'test/README.md')
-rw-r--r--test/README.md19
1 files changed, 19 insertions, 0 deletions
diff --git a/test/README.md b/test/README.md
index 4db26bd047..5c80d64762 100644
--- a/test/README.md
+++ b/test/README.md
@@ -128,3 +128,22 @@ To stochastically verify that the algorithm that produces uniformly distributed
random numbers is operating correctly (with a false positive rate of 0.01%):
$ ./util/wrap.sh test/bntest -stochastic
+
+Running Tests in Parallel
+-------------------------
+
+By default the test harness will execute the selected tests sequentially.
+Depending on the platform characteristics, running more than one test job in
+parallel may speed up test execution.
+This can be requested by setting the `HARNESS_JOBS` environment variable to a
+positive integer value. This specifies the maximum number of test jobs to run in
+parallel.
+
+Depending on the Perl version different strategies could be adopted to select
+which test recipes can be run in parallel. In recent versions of Perl, unless
+specified otherwise, any task can be run in parallel. Consult the documentation
+for `TAP::Harness` to know more.
+
+To run up to four tests in parallel at any given time:
+
+ $ make HARNESS_JOBS=4 test