Tree @scrub-obsolete/main (Download .tar.gz)
- ..
- certs
- ct
- d2i-tests
- helpers
- ocsp-tests
- recipes
- smime-certs
- ssl-tests
- testutil
- aborttest.c
- acvp_test.c
- acvp_test.inc
- aesgcmtest.c
- afalgtest.c
- algorithmid_test.c
- asn1_decode_test.c
- asn1_dsa_internal_test.c
- asn1_encode_test.c
- asn1_internal_test.c
- asn1_string_table_test.c
- asn1_time_test.c
- asynciotest.c
- asynctest.c
- bad_dtls_test.c
- bftest.c
- bio_callback_test.c
- bio_core_test.c
- bio_enc_test.c
- bio_memleak_test.c
- bio_prefix_text.c
- bio_readbuffer_test.c
- bioprinttest.c
- bn_internal_test.c
- bn_rand_range.h
- bntest.c
- bntests.pl
- build.info
- ca-and-certs.cnf
- casttest.c
- CAtsa.cnf
- chacha_internal_test.c
- cipher_overhead_test.c
- cipherbytes_test.c
- cipherlist_test.c
- ciphername_test.c
- clienthellotest.c
- cmactest.c
- cmp_asn_test.c
- cmp_client_test.c
- cmp_ctx_test.c
- cmp_hdr_test.c
- cmp_msg_test.c
- cmp_protect_test.c
- cmp_server_test.c
- cmp_status_test.c
- cmp_vfy_test.c
- cms-examples.pl
- cmsapitest.c
- 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
- d2i_test.c
- dane-cross.in
- danetest.c
- danetest.in
- danetest.pem
- data.bin
- data2.bin
- default-and-fips.cnf
- default-and-legacy.cnf
- default.cnf
- defltfips_test.c
- destest.c
- dhtest.c
- drbgtest.c
- dsa_no_digest_size_test.c
- dsatest.c
- dtls_mtu_test.c
- dtlstest.c
- dtlsv1listentest.c
- ec_internal_test.c
- ecdsatest.c
- ecdsatest.h
- ecstresstest.c
- ectest.c
- endecode_test.c
- endecoder_legacy_test.c
- enginetest.c
- errtest.c
- evp_extra_test.c
- evp_extra_test2.c
- evp_fetch_prov_test.c
- evp_kdf_test.c
- evp_libctx_test.c
- evp_pkey_ctx_new_from_name.c
- evp_pkey_dparams_test.c
- evp_pkey_provided_test.c
- evp_test.c
- exdatatest.c
- exptest.c
- fake_rsaprov.c
- fake_rsaprov.h
- fatalerrtest.c
- ffc_internal_test.c
- filterprov.c
- filterprov.h
- fips-alt.cnf
- fips-and-base.cnf
- fips.cnf
- generate_buildtest.pl
- generate_ssl_tests.pl
- gmdifftest.c
- hexstr_test.c
- hmactest.c
- http_test.c
- ideatest.c
- igetest.c
- insta.priv.pem
- insta_ca.cert.pem
- keymgmt_internal_test.c
- legacy.cnf
- lhash_test.c
- localetest.c
- mdc2_internal_test.c
- mdc2test.c
- memleaktest.c
- modes_internal_test.c
- moduleloadtest.c
- namemap_internal_test.c
- ocspapitest.c
- ossl_store_test.c
- p_test.c
- packettest.c
- param_build_test.c
- params_api_test.c
- params_conversion_test.c
- params_test.c
- pbelutest.c
- pbetest.c
- pem_read_depr_test.c
- pemtest.c
- pkcs12_format_test.c
- pkcs7-1.pem
- pkcs7.pem
- pkcs7_test.c
- pkey_meth_kdf_test.c
- pkey_meth_test.c
- pkits-test.pl
- poly1305_internal_test.c
- property_test.c
- prov_config_test.c
- provfetchtest.c
- provider_fallback_test.c
- provider_internal_test.c
- provider_internal_test.cnf.in
- provider_pkey_test.c
- provider_status_test.c
- provider_test.c
- proxy.cnf
- rand_status_test.c
- rand_test.c
- rc2test.c
- rc4test.c
- rc5test.c
- rdrand_sanitytest.c
- README-dev.md
- README-external.md
- README.md
- README.ssltest.md
- recordlentest.c
- rsa_complex.c
- rsa_mp_test.c
- rsa_sp800_56b_test.c
- rsa_test.c
- run_tests.pl
- sanitytest.c
- secmemtest.c
- serverinfo.pem
- serverinfo2.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.bin
- smcont.txt
- smcont_zero.txt
- sparse_array_test.c
- srptest.c
- ssl_cert_table_internal_test.c
- ssl_ctx_test.c
- ssl_old_test.c
- ssl_test.c
- ssl_test.tmpl
- ssl_test_ctx_test.c
- ssl_test_ctx_test.cnf
- sslapitest.c
- sslbuffertest.c
- sslcorrupttest.c
- stack_test.c
- sysdefault.cnf
- sysdefaulttest.c
- test.cnf
- test_test.c
- testcrl.pem
- testdsa.pem
- testdsapub.pem
- testec-p256.pem
- testecpub-p256.pem
- tested25519.pem
- tested25519pub.pem
- tested448.pem
- tested448pub.pem
- testp7.pem
- testreq2.pem
- testrsa.pem
- testrsa2048.pem
- testrsa_withattrs.der
- testrsa_withattrs.pem
- testrsapss.pem
- testrsapssmandatory.pem
- testrsapub.pem
- testsid.pem
- testutil.h
- testx509.pem
- threadstest.c
- threadstest.h
- threadstest_fips.c
- time_offset_test.c
- tls-provider.c
- tls13ccstest.c
- tls13encryptiontest.c
- tls13secretstest.c
- uitest.c
- upcallstest.c
- user_property_test.c
- v3-cert1.pem
- v3-cert2.pem
- v3_ca_exts.cnf
- v3ext.c
- v3nametest.c
- verify_extra_test.c
- versions.c
- wpackettest.c
- x509_check_cert_pkey_test.c
- x509_dup_cert_test.c
- x509_internal_test.c
- x509_time_test.c
- x509aux.c
README-dev.md @scrub-obsolete/main — raw · history · blame
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 | Guidelines for test developers ============================== How to add recipes ------------------ For any test that you want to perform, you write a script located in `test/recipes/`, named `{nn}-test_{name}.t`, where `{nn}` is a two digit number and `{name}` is a unique name of your choice. Please note that if a test involves a new testing executable, you will need to do some additions in test/build.info. Please refer to the section ["Changes to test/build.info"](README.md#changes-to-testbuildinfo) below. Naming conventions ------------------ A test executable is named `test/{name}test.c` A test recipe is named `test/recipes/{nn}-test_{name}.t`, where `{nn}` is a two digit number and `{name}` is a unique name of your choice. The number `{nn}` is (somewhat loosely) grouped as follows: 00-04 sanity, internal and essential API tests 05-09 individual symmetric cipher algorithms 10-14 math (bignum) 15-19 individual asymmetric cipher algorithms 20-24 openssl commands (some otherwise not tested) 25-29 certificate forms, generation and verification 30-35 engine and evp 60-79 APIs: 60 X509 subsystem 61 BIO subsystem 65 CMP subsystem 70 PACKET layer 80-89 "larger" protocols (CA, CMS, OCSP, SSL, TSA) 90-98 misc 99 most time consuming tests [such as test_fuzz] A recipe that just runs a test executable ----------------------------------------- A script that just runs a program looks like this: #! /usr/bin/env perl use OpenSSL::Test::Simple; simple_test("test_{name}", "{name}test", "{name}"); `{name}` is the unique name you have chosen for your test. The second argument to `simple_test` is the test executable, and `simple_test` expects it to be located in `test/` For documentation on `OpenSSL::Test::Simple`, do `perldoc util/perl/OpenSSL/Test/Simple.pm`. A recipe that runs a more complex test -------------------------------------- For more complex tests, you will need to read up on Test::More and OpenSSL::Test. Test::More is normally preinstalled, do `man Test::More` for documentation. For OpenSSL::Test, do `perldoc util/perl/OpenSSL/Test.pm`. A script to start from could be this: #! /usr/bin/env perl use strict; use warnings; use OpenSSL::Test; setup("test_{name}"); plan tests => 2; # The number of tests being performed ok(test1, "test1"); ok(test2, "test1"); sub test1 { # test feature 1 } sub test2 { # test feature 2 } Changes to test/build.info -------------------------- Whenever a new test involves a new test executable you need to do the following (at all times, replace {NAME} and {name} with the name of your test): * add `{name}` to the list of programs under `PROGRAMS_NO_INST` * create a three line description of how to build the test, you will have to modify the include paths and source files if you don't want to use the basic test framework: SOURCE[{name}]={name}.c INCLUDE[{name}]=.. ../include ../apps/include DEPEND[{name}]=../libcrypto libtestutil.a Generic form of C test executables ---------------------------------- #include "testutil.h" static int my_test(void) { int testresult = 0; /* Assume the test will fail */ int observed; observed = function(); /* Call the code under test */ if (!TEST_int_eq(observed, 2)) /* Check the result is correct */ goto end; /* Exit on failure - optional */ testresult = 1; /* Mark the test case a success */ end: cleanup(); /* Any cleanup you require */ return testresult; } int setup_tests(void) { ADD_TEST(my_test); /* Add each test separately */ return 1; /* Indicate success */ } You should use the `TEST_xxx` macros provided by `testutil.h` to test all failure conditions. These macros produce an error message in a standard format if the condition is not met (and nothing if the condition is met). Additional information can be presented with the `TEST_info` macro that takes a `printf` format string and arguments. `TEST_error` is useful for complicated conditions, it also takes a `printf` format string and argument. In all cases the `TEST_xxx` macros are guaranteed to evaluate their arguments exactly once. This means that expressions with side effects are allowed as parameters. Thus, if (!TEST_ptr(ptr = OPENSSL_malloc(..))) works fine and can be used in place of: ptr = OPENSSL_malloc(..); if (!TEST_ptr(ptr)) The former produces a more meaningful message on failure than the latter. Note that the test infrastructure automatically sets up all required environment variables (such as `OPENSSL_MODULES`, `OPENSSL_CONF`, etc.) for the tests. Individual tests may choose to override the default settings as required. |