openssl/test
Matt Caswell 7251b2eb14 Document the OPENSSL_TEST_RAND_SEED environment variable
Reviewed-by: Dmitry Belyavskiy <beldmit@gmail.com>
Reviewed-by: Paul Dale <pauli@openssl.org>
(Merged from https://github.com/openssl/openssl/pull/22118)
2023-09-20 18:02:54 +10:00
..
certs Copyright year updates 2023-09-07 09:59:15 +01:00
ct
d2i-tests
helpers SSL: Test SSL_get_[rw]poll_descriptor, SSL_net_(read|write)_desired 2023-09-20 11:20:34 +10:00
ocsp-tests
recipes Fix a possible memleak in rsa_pub_encode 2023-09-11 10:48:54 +02:00
smime-certs Copyright year updates 2023-09-07 09:59:15 +01:00
smime-eml
ssl-tests Copyright year updates 2023-09-07 09:59:15 +01:00
testutil Enable the ability to seed the test RNG without randomising test ordering 2023-09-20 18:02:54 +10:00
aborttest.c
acvp_test.c
acvp_test.inc
aesgcmtest.c
afalgtest.c "foo * bar" should be "foo *bar" 2023-09-11 10:15:30 +02:00
algorithmid_test.c
asn1_decode_test.c
asn1_dsa_internal_test.c
asn1_encode_test.c
asn1_internal_test.c Copyright year updates 2023-09-07 09:59:15 +01:00
asn1_string_table_test.c
asn1_time_test.c
asynciotest.c
asynctest.c
bad_dtls_test.c
bftest.c
bio_callback_test.c
bio_comp_test.c
bio_core_test.c Copyright year updates 2023-09-07 09:59:15 +01:00
bio_dgram_test.c Further fix in bio_dgram_test for BIO_s_dgram_mem() 2023-09-13 11:53:13 +01:00
bio_enc_test.c
bio_memleak_test.c
bio_prefix_text.c
bio_readbuffer_test.c
bio_tfo_test.c
bioprinttest.c
bn_internal_test.c
bn_rand_range.h
bntest.c Copyright year updates 2023-09-07 09:59:15 +01:00
bntests.pl
build_wincrypt_test.c Copyright year updates 2023-09-07 09:59:15 +01:00
build.info Fix decoders so that they use the passed in propq. 2023-08-16 18:02:51 +02:00
ca_internals_test.c
ca-and-certs.cnf
casttest.c
CAtsa.cnf Changed the default value of the "ess_cert_id_alg" option 2023-08-25 15:05:51 +02:00
cc_dummy.c Copyright year updates 2023-09-07 09:59:15 +01:00
cert_comp_test.c
chacha_internal_test.c test/chacha: replace CPUID_OBJ with OPENSSL_CPUID_OBJ 2023-09-07 14:57:40 +02:00
cipher_overhead_test.c
cipherbytes_test.c
cipherlist_test.c
ciphername_test.c
clienthellotest.c
cmactest.c Fix new typos found by codespell 2023-06-18 16:53:09 +10:00
cmp_asn_test.c Copyright year updates 2023-09-07 09:59:15 +01:00
cmp_client_test.c Copyright year updates 2023-09-07 09:59:15 +01:00
cmp_ctx_test.c Copyright year updates 2023-09-07 09:59:15 +01:00
cmp_hdr_test.c Copyright year updates 2023-09-07 09:59:15 +01:00
cmp_msg_test.c Copyright year updates 2023-09-07 09:59:15 +01:00
cmp_protect_test.c Copyright year updates 2023-09-07 09:59:15 +01:00
cmp_server_test.c
cmp_status_test.c
cmp_vfy_test.c Copyright year updates 2023-09-07 09:59:15 +01:00
cms-examples.pl
cmsapitest.c Copyright year updates 2023-09-07 09:59:15 +01:00
conf_include_test.c
confdump.c
constant_time_test.c
context_internal_test.c
crltest.c
ct_test.c
ctype_internal_test.c
curve448_internal_test.c Copyright year updates 2023-09-07 09:59:15 +01:00
d2i_test.c
dane-cross.in
danetest.c
danetest.in
danetest.pem
data2.bin
data.bin
decoder_propq_test.c Fix decoders so that they use the passed in propq. 2023-08-16 18:02:51 +02:00
default-and-fips.cnf
default-and-legacy.cnf
default.cnf
defltfips_test.c
destest.c Copyright year updates 2023-09-07 09:59:15 +01:00
dhkem_test.inc Copyright year updates 2023-09-07 09:59:15 +01:00
dhtest.c Copyright year updates 2023-09-07 09:59:15 +01:00
drbgtest.c "foo * bar" should be "foo *bar" 2023-09-11 10:15:30 +02:00
dsa_no_digest_size_test.c
dsatest.c Copyright year updates 2023-09-07 09:59:15 +01:00
dtls_mtu_test.c
dtlstest.c Copyright year updates 2023-09-07 09:59:15 +01:00
dtlsv1listentest.c
ec_internal_test.c
ecdsatest.c Copyright year updates 2023-09-07 09:59:15 +01:00
ecdsatest.h
ecstresstest.c
ectest.c "foo * bar" should be "foo *bar" 2023-09-11 10:15:30 +02:00
endecode_test.c Copyright year updates 2023-09-07 09:59:15 +01:00
endecoder_legacy_test.c
enginetest.c
errtest.c Copyright year updates 2023-09-07 09:59:15 +01:00
event_queue_test.c
evp_extra_test2.c Copyright year updates 2023-09-07 09:59:15 +01:00
evp_extra_test.c Copyright year updates 2023-09-07 09:59:15 +01:00
evp_fetch_prov_test.c
evp_kdf_test.c Copyright year updates 2023-09-07 09:59:15 +01:00
evp_libctx_test.c
evp_pkey_ctx_new_from_name.c
evp_pkey_dhkem_test.c Copyright year updates 2023-09-07 09:59:15 +01:00
evp_pkey_dparams_test.c
evp_pkey_provided_test.c Copyright year updates 2023-09-07 09:59:15 +01:00
evp_test.c Postponed further context duplication support for ciphers 2023-09-19 14:37:17 +10:00
exdatatest.c
exptest.c Copyright year updates 2023-09-07 09:59:15 +01:00
ext_internal_test.c Copyright year updates 2023-09-07 09:59:15 +01:00
fake_rsaprov.c Add Test to verify open_ex password checking works 2023-09-19 12:24:07 +02:00
fake_rsaprov.h Add Test to verify open_ex password checking works 2023-09-19 12:24:07 +02:00
fatalerrtest.c
ffc_internal_test.c Copyright year updates 2023-09-07 09:59:15 +01:00
filterprov.c Copyright year updates 2023-09-07 09:59:15 +01:00
filterprov.h
fips_version_test.c
fips-alt.cnf
fips-and-base.cnf
fips.cnf
generate_buildtest.pl
generate_ssl_tests.pl
gmdifftest.c
hexstr_test.c
hmactest.c
hpke_test.c Copyright year updates 2023-09-07 09:59:15 +01:00
http_test.c
ideatest.c
igetest.c
insta_ca.cert.pem
insta.priv.pem
keymgmt_internal_test.c
legacy.cnf
lhash_test.c
list_test.c
localetest.c
mdc2_internal_test.c
mdc2test.c
membio_test.c Copyright year updates 2023-09-07 09:59:15 +01:00
memleaktest.c
modes_internal_test.c
moduleloadtest.c
namemap_internal_test.c
nodefltctxtest.c
null.cnf
ocspapitest.c "foo * bar" should be "foo *bar" 2023-09-11 10:15:30 +02:00
ossl_store_test.c
p_test.c Copyright year updates 2023-09-07 09:59:15 +01:00
packettest.c Copyright year updates 2023-09-07 09:59:15 +01:00
pairwise_fail_test.c
param_build_test.c Copyright year updates 2023-09-07 09:59:15 +01:00
params_api_test.c
params_conversion_test.c
params_test.c
pbelutest.c
pbetest.c Copyright year updates 2023-09-07 09:59:15 +01:00
pem_read_depr_test.c
pemtest.c Copyright year updates 2023-09-07 09:59:15 +01:00
pkcs7_test.c
pkcs7-1.pem
pkcs7.pem
pkcs12_api_test.c Copyright year updates 2023-09-07 09:59:15 +01:00
pkcs12_format_test.c Fix PKCS#12 creation error when certificate contains auxiliary data 2023-09-15 16:06:25 +02:00
pkey_meth_kdf_test.c
pkey_meth_test.c
pkits-test.pl
poly1305_internal_test.c
priority_queue_test.c
property_test.c Copyright year updates 2023-09-07 09:59:15 +01:00
prov_config_test.c
provfetchtest.c Copyright year updates 2023-09-07 09:59:15 +01:00
provider_default_search_path_test.c
provider_fallback_test.c
provider_internal_test.c Copyright year updates 2023-09-07 09:59:15 +01:00
provider_internal_test.cnf.in
provider_pkey_test.c Add Test to verify open_ex password checking works 2023-09-19 12:24:07 +02:00
provider_status_test.c
provider_test.c Copyright year updates 2023-09-07 09:59:15 +01:00
proxy.cnf
punycode_test.c Copyright year updates 2023-09-07 09:59:15 +01:00
quic_ackm_test.c Copyright year updates 2023-09-07 09:59:15 +01:00
quic_cc_test.c Copyright year updates 2023-09-07 09:59:15 +01:00
quic_cfq_test.c Copyright year updates 2023-09-07 09:59:15 +01:00
quic_client_test.c Raise the timeout in quic_client_test.c 2023-08-28 10:02:23 +02:00
quic_fc_test.c Copyright year updates 2023-09-07 09:59:15 +01:00
quic_fifd_test.c Copyright year updates 2023-09-07 09:59:15 +01:00
quic_multistream_test.c QUIC MULTISTREAM TEST: Correct trivial bug 2023-09-13 22:16:34 +02:00
quic_newcid_test.c Extend the test_quic_write_read() test to include resumption 2023-08-02 20:27:07 +01:00
quic_record_test_util.h Copyright year updates 2023-09-07 09:59:15 +01:00
quic_record_test.c Copyright year updates 2023-09-07 09:59:15 +01:00
quic_stream_test.c Copyright year updates 2023-09-07 09:59:15 +01:00
quic_tserver_test.c Fix test/quic_tserver_test.c for slow machines 2023-09-13 22:07:58 +02:00
quic_txp_test.c Copyright year updates 2023-09-07 09:59:15 +01:00
quic_txpim_test.c
quic_wire_test.c Copyright year updates 2023-09-07 09:59:15 +01:00
quicapitest.c Test that a client that does not supply ALPN fails as expected 2023-09-13 09:45:17 +01:00
quicfaultstest.c Test we correctly handle missing ALPN from the server 2023-09-13 09:41:05 +01:00
rand_status_test.c
rand_test.c
rc2test.c
rc4test.c
rc5test.c
rdcpu_sanitytest.c
README-dev.md testutil: allow a failure return from setup_tests that doesn't print help 2023-08-04 11:57:27 +10:00
README-external.md updated (lib+)oqsprovider to latest releases 2023-06-15 08:39:10 +10:00
README.md Document the OPENSSL_TEST_RAND_SEED environment variable 2023-09-20 18:02:54 +10:00
README.ssltest.md
recordlentest.c Copyright year updates 2023-09-07 09:59:15 +01:00
rpktest.c configure: introduce no-ecx to remove ECX related feature 2023-06-14 13:06:22 +10:00
rsa_complex.c
rsa_mp_test.c Copyright year updates 2023-09-07 09:59:15 +01:00
rsa_sp800_56b_test.c Copyright year updates 2023-09-07 09:59:15 +01:00
rsa_test.c Copyright year updates 2023-09-07 09:59:15 +01:00
rsa_x931_test.c Copyright year updates 2023-09-07 09:59:15 +01:00
run_tests.pl
safe_math_test.c
sanitytest.c Copyright year updates 2023-09-07 09:59:15 +01:00
secmemtest.c
serverinfo2.pem
serverinfo.pem
servername_test.c
session.pem
sha_test.c
shibboleth.pfx
shlibloadtest.c
simpledynamic.c
simpledynamic.h
siphash_internal_test.c
sm2_internal_test.c
sm3_internal_test.c
sm4_internal_test.c
smcont_zero.txt
smcont.bin
smcont.txt
sparse_array_test.c
srptest.c
ssl_cert_table_internal_test.c
ssl_ctx_test.c Copyright year updates 2023-09-07 09:59:15 +01:00
ssl_handshake_rtt_test.c [feat] SSL RTT in both client and server statem. SSL_get_handshake_rtt makes it available 2023-06-02 05:46:46 +02:00
ssl_old_test.c Fix memory leaks in ssl_old_test.c 2023-09-13 14:30:34 +02:00
ssl_test_ctx_test.c
ssl_test_ctx_test.cnf
ssl_test.c Copyright year updates 2023-09-07 09:59:15 +01:00
ssl_test.tmpl
sslapitest.c SSL: Test SSL_get_[rw]poll_descriptor, SSL_net_(read|write)_desired 2023-09-20 11:20:34 +10:00
sslbuffertest.c Copyright year updates 2023-09-07 09:59:15 +01:00
sslcorrupttest.c
stack_test.c
sysdefault.cnf
sysdefaulttest.c
test_test.c
test.cnf
testcrl.pem
testdsa.pem
testdsapub.pem
testec-p112r1.pem
testec-p256.pem
testecpub-p256.pem
tested448.pem
tested448pub.pem
tested25519.pem
tested25519pub.pem
testp7.pem
testreq2.pem
testrsa2048.pem
testrsa2048pub.pem
testrsa_withattrs.der
testrsa_withattrs.pem
testrsa.pem
testrsapss.pem
testrsapssmandatory.pem
testrsapub.pem
testsid.pem
testutil.h Copyright year updates 2023-09-07 09:59:15 +01:00
testx509.pem
threadpool_test.c
threadstest_fips.c
threadstest.c Copyright year updates 2023-09-07 09:59:15 +01:00
threadstest.h
time_offset_test.c
timing_load_creds.c
tls13ccstest.c Copyright year updates 2023-09-07 09:59:15 +01:00
tls13encryptiontest.c Copyright year updates 2023-09-07 09:59:15 +01:00
tls13secretstest.c Copyright year updates 2023-09-07 09:59:15 +01:00
tls-provider.c Remove repeated words 2023-09-11 10:15:30 +02:00
trace_api_test.c Copyright year updates 2023-09-07 09:59:15 +01:00
uitest.c
upcallstest.c Copyright year updates 2023-09-07 09:59:15 +01:00
user_property_test.c Copyright year updates 2023-09-07 09:59:15 +01:00
v3_ca_exts.cnf
v3-cert1.pem
v3-cert2.pem
v3ext.c
v3nametest.c Copyright year updates 2023-09-07 09:59:15 +01:00
verify_extra_test.c
versions.c
wpackettest.c Copyright year updates 2023-09-07 09:59:15 +01:00
x509_check_cert_pkey_test.c Copyright year updates 2023-09-07 09:59:15 +01:00
x509_dup_cert_test.c
x509_internal_test.c
x509_test.c
x509_time_test.c
x509aux.c

Using OpenSSL Tests

After a successful build, and before installing, the libraries should be tested. Run:

$ make test                                      # Unix
$ mms test                                       ! OpenVMS
$ nmake test                                     # Windows

Warning: you MUST run the tests from an unprivileged account (or disable your privileges temporarily if your platform allows it).

If some tests fail, take a look at the section Test Failures below.

Test Failures

If some tests fail, look at the output. There may be reasons for the failure that isn't a problem in OpenSSL itself (like an OS malfunction or a Perl issue). You may want increased verbosity, that can be accomplished like this:

Full verbosity, showing full output of all successful and failed test cases (make macro VERBOSE or V):

$ make V=1 test                                  # Unix
$ mms /macro=(V=1) test                          ! OpenVMS
$ nmake V=1 test                                 # Windows

Verbosity on failed (sub-)tests only (VERBOSE_FAILURE or VF or REPORT_FAILURES):

$ make test VF=1

Verbosity on failed (sub-)tests, in addition progress on succeeded (sub-)tests (VERBOSE_FAILURE_PROGRESS or VFP or REPORT_FAILURES_PROGRESS):

$ make test VFP=1

If you want to run just one or a few specific tests, you can use the make variable TESTS to specify them, like this:

$ make TESTS='test_rsa test_dsa' test            # Unix
$ mms/macro="TESTS=test_rsa test_dsa" test       ! OpenVMS
$ nmake TESTS='test_rsa test_dsa' test           # Windows

And of course, you can combine (Unix examples shown):

$ make test TESTS='test_rsa test_dsa' VF=1
$ make test TESTS="test_cmp_*" VFP=1

You can find the list of available tests like this:

$ make list-tests                                # Unix
$ mms list-tests                                 ! OpenVMS
$ nmake list-tests                               # Windows

Have a look at the manual for the perl module Test::Harness to see what other HARNESS_* variables there are.

To report a bug please open an issue on GitHub, at https://github.com/openssl/openssl/issues.

For more details on how the make variables TESTS can be used, see section Running Selected Tests below.

Running Selected Tests

The make variable TESTS supports a versatile set of space separated tokens with which you can specify a set of tests to be performed. With a "current set of tests" in mind, initially being empty, here are the possible tokens:

 alltests      The current set of tests becomes the whole set of available
               tests (as listed when you do 'make list-tests' or similar).

 xxx           Adds the test 'xxx' to the current set of tests.

-xxx           Removes 'xxx' from the current set of tests.  If this is the
               first token in the list, the current set of tests is first
               assigned the whole set of available tests, effectively making
               this token equivalent to TESTS="alltests -xxx".

 nn            Adds the test group 'nn' (which is a number) to the current
               set of tests.

-nn            Removes the test group 'nn' from the current set of tests.
               If this is the first token in the list, the current set of
               tests is first assigned the whole set of available tests,
               effectively making this token equivalent to
               TESTS="alltests -xxx".

Also, all tokens except for "alltests" may have wildcards, such as *. (on Unix and Windows, BSD style wildcards are supported, while on VMS, it's VMS style wildcards)

Examples

Run all tests except for the fuzz tests:

$ make TESTS='-test_fuzz*' test

or, if you want to be explicit:

$ make TESTS='alltests -test_fuzz*' test

Run all tests that have a name starting with "test_ssl" but not those starting with "test_ssl_":

$ make TESTS='test_ssl* -test_ssl_*' test

Run only test group 10:

$ make TESTS='10' test

Run all tests except the slow group (group 99):

$ make TESTS='-99' test

Run all tests in test groups 80 to 99 except for tests in group 90:

$ make TESTS='[89]? -90' test

To run specific fuzz tests you can use for instance:

$ make test TESTS='test_fuzz_cmp test_fuzz_cms'

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

Random numbers in tests

Some tests use random numbers as part of the test. In some cases a test failure may occur for some random numbers, but not for others. The seed used for the rand number generator can be set via the OPENSSL_TEST_RAND_SEED environment variable. It can also be set via the OPENSSL_TEST_RAND_ORDER environment variable which additionally randomises the order tests are run in (see below).

When a test fails the test harness will display the seed used during the test (displaying either the OPENSSL_TEST_RAND_SEED or OPENSSL_TEST_RAND_ORDER environment variable value that must be used to recreate the results), e.g.

$ make OPENSSL_TEST_RAND_SEED=42 test

Randomisation of Test Ordering

By default, the test harness will execute tests in the order they were added. By setting the OPENSSL_TEST_RAND_ORDER environment variable to zero, the test ordering will be randomised. This additionally seeds the random number generator used within the tests as described in the section above. If a randomly ordered test fails, the seed value used will be reported. Setting the OPENSSL_TEST_RAND_ORDER environment variable to this value will rerun the tests in the same order and will also seed the test random number generator. This assures repeatability of randomly ordered test runs. This repeatability is independent of the operating system, processor or platform used.

To randomise the test ordering:

$ make OPENSSL_TEST_RAND_ORDER=0 test

To run the tests using the order defined by the random seed 42:

$ make OPENSSL_TEST_RAND_ORDER=42 test