3rd-party/catch2
1
0
Fork 0
mirror of https://github.com/catchorg/Catch2.git synced 2024-11-22 13:26:10 +01:00
Code Issues Packages Projects Releases Wiki Activity

Document the stability guarantees of '--order rand' option

Browse Source
This commit is contained in:
Martin Hořeňovský 2022-04-25 21:43:10 +02:00
parent db57a4956f
commit 9dc229693d
No known key found for this signature in database
GPG Key ID: DE48307B8B0D381A
1 changed files with 7 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
docs/command-line.md
View File

@ -334,13 +334,19 @@ Lexicographic order. Tests are sorted by their name, their tags are ignored.
### rand ### rand
Randomly sorted. The order is dependent on Catch2's random seed (see Randomly ordered. The order is dependent on Catch2's random seed (see
[`--rng-seed`](#rng-seed)), and is subset invariant. What this means [`--rng-seed`](#rng-seed)), and is subset invariant. What this means
is that as long as the random seed is fixed, running only some tests is that as long as the random seed is fixed, running only some tests
(e.g. via tag) does not change their relative order. (e.g. via tag) does not change their relative order.
> The subset stability was introduced in Catch2 v2.12.0 > The subset stability was introduced in Catch2 v2.12.0
Since the random order was made subset stable, we promise that given
the same random seed, the order of test cases will be the same across
different platforms, as long as the tests were compiled against identical
version of Catch2. We reserve the right to change the relative order
of tests cases between Catch2 versions, but it is unlikely to happen often.
<a id="rng-seed"></a> <a id="rng-seed"></a>
## Specify a seed for the Random Number Generator ## Specify a seed for the Random Number Generator