diff options
Diffstat (limited to 'deps/openssl/openssl/test/README')
| -rw-r--r-- | deps/openssl/openssl/test/README | 86 |
1 files changed, 63 insertions, 23 deletions
diff --git a/deps/openssl/openssl/test/README b/deps/openssl/openssl/test/README index ef39d38ac9..37722e79f3 100644 --- a/deps/openssl/openssl/test/README +++ b/deps/openssl/openssl/test/README @@ -29,7 +29,8 @@ The number {nn} is (somewhat loosely) grouped as follows: 60-79 APIs 70 PACKET layer 80-89 "larger" protocols (CA, CMS, OCSP, SSL, TSA) -90-99 misc +90-98 misc +99 most time consuming tests [such as test_fuzz] A recipe that just runs a test executable @@ -38,9 +39,9 @@ A recipe that just runs a test executable A script that just runs a program looks like this: #! /usr/bin/perl - + use OpenSSL::Test::Simple; - + simple_test("test_{name}", "{name}test", "{name}"); {name} is the unique name you have chosen for your test. @@ -49,7 +50,7 @@ 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 test/testlib/OpenSSL/Test/Simple.pm'. +`perldoc util/perl/OpenSSL/Test/Simple.pm'. A recipe that runs a more complex test @@ -57,53 +58,92 @@ 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 test/testlib/OpenSSL/Test.pm'. +documentation. For OpenSSL::Test, do `perldoc util/perl/OpenSSL/Test.pm'. A script to start from could be this: #! /usr/bin/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/Makefile -======================== + +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): -* among the variables for test executables at the beginning, add a line like - this: +* 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 + 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_equal(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 */ + } - {NAME}TEST= {name}test +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, -* add `$({NAME}TEST)$(EXE_EXT)' to the assignment of EXE: + if (!TEST_ptr(ptr = OPENSSL_malloc(..))) -* add `$({NAME}TEST).o' to the assignment of OBJ: +works fine and can be used in place of: -* add `$({NAME}TEST).c' to the assignment of SRC: + ptr = OPENSSL_malloc(..); + if (!TEST_ptr(ptr)) -* add the following lines for building the executable: +The former produces a more meaningful message on failure than the latter. - $({NAME}TEST)$(EXE_EXT): $({NAME}TEST).o $(DLIBCRYPTO) - @target=$({NAME}TEST); $(BUILD_CMD) |