openssl/test
Dr. Stephen Henson 340166a9da Change test recipes to use disabled()
Reviewed-by: Richard Levitte <levitte@openssl.org>
2015-09-20 00:04:16 +01:00
..
Attic Remove old testing scripts out of the way. 2015-09-07 16:10:58 +02:00
certs Add test for CVE-2015-1793 2015-07-07 21:57:11 +01:00
ocsp-tests Fix OCSP checking. 2012-12-07 18:47:47 +00:00
recipes Change test recipes to use disabled() 2015-09-20 00:04:16 +01:00
smime-certs Add X9.42 DH certificate to S/MIME test 2013-08-05 16:23:22 +01:00
testlib/OpenSSL Add Utils.pm 2015-09-20 00:04:15 +01:00
bftest.c memset, memcpy, sizeof consistency fixes 2015-05-05 22:18:59 -04:00
bntest.c Enable -Wmissing-variable-declarations and 2015-09-11 04:51:55 +01:00
CAss.cnf Use 2K RSA and SHA256 in tests 2015-04-20 07:23:04 -04:00
CAssdh.cnf Import of old SSLeay release: SSLeay 0.9.0b 1998-12-21 10:56:39 +00:00
CAssdsa.cnf Import of old SSLeay release: SSLeay 0.9.0b 1998-12-21 10:56:39 +00:00
CAssrsa.cnf Import of old SSLeay release: SSLeay 0.9.0b 1998-12-21 10:56:39 +00:00
casttest.c Stop symlinking, move files to intended directory 2015-03-31 20:16:01 +02:00
CAtsa.cnf Use 2K RSA and SHA256 in tests 2015-04-20 07:23:04 -04:00
clean_test.com * apps/makeapps.com: Forgot to end the check for /POINTER_SIZE=64=ARGV 2011-03-20 14:02:20 +00:00
clienthellotest.c GH354: Memory leak fixes 2015-08-28 11:18:04 -04:00
cms-examples.pl Use "cont" consistently in cms-examples.pl 2008-05-01 23:30:06 +00:00
conftest.c No fprintf in the txt_db component 2015-06-09 12:39:08 -04:00
constant_time_test.c Add recipes for misc other things we want to test 2015-09-07 16:10:57 +02:00
destest.c Stop symlinking, move files to intended directory 2015-03-31 20:16:01 +02:00
dhtest.c Have the test executables output in text mode 2015-09-06 01:35:54 +02:00
dsatest.c Have the test executables output in text mode 2015-09-06 01:35:54 +02:00
dummytest.c Run util/openssl-format-source -v -c . 2015-01-22 09:20:09 +00:00
ecdhtest.c Have the test executables output in text mode 2015-09-06 01:35:54 +02:00
ecdsatest.c Enable -Wmissing-variable-declarations and 2015-09-11 04:51:55 +01:00
ectest.c EC_POINT_is_on_curve does not return a boolean 2015-06-10 10:43:53 +01:00
enginetest.c memset, memcpy, sizeof consistency fixes 2015-05-05 22:18:59 -04:00
evp_extra_test.c free null cleanup finale 2015-05-01 10:02:07 -04:00
evp_test.c RT3757: base64 encoding bugs 2015-09-17 19:48:14 +02:00
evptests.txt base64 decode: check for high bit 2015-09-17 21:42:38 +02:00
exptest.c Have the test executables output in text mode 2015-09-06 01:35:54 +02:00
gmdifftest.c Check OPENSSL_gmtime_diff 2015-09-02 23:03:43 -04:00
gost2814789test.c Enable -Wmissing-variable-declarations and 2015-09-11 04:51:55 +01:00
heartbeat_test.c memset, memcpy, sizeof consistency fixes 2015-05-05 22:18:59 -04:00
hmactest.c RT3856: Fix memory leaks in test code 2015-06-23 07:59:15 -04:00
ideatest.c Enable -Wmissing-variable-declarations and 2015-09-11 04:51:55 +01:00
igetest.c more OSSL_NELEM cases 2015-05-04 13:03:49 +01:00
jpaketest.c Have the test executables output in text mode 2015-09-06 01:35:54 +02:00
Makefile make update 2015-09-16 12:40:55 +01:00
maketests.com Catch up the VMS build. 2015-03-05 18:20:06 +01:00
md2test.c Stop symlinking, move files to intended directory 2015-03-31 20:16:01 +02:00
md4test.c Stop symlinking, move files to intended directory 2015-03-31 20:16:01 +02:00
md5test.c Stop symlinking, move files to intended directory 2015-03-31 20:16:01 +02:00
mdc2test.c Stop symlinking, move files to intended directory 2015-03-31 20:16:01 +02:00
methtest.c More comment realignment 2015-01-22 09:20:10 +00:00
nptest.c Test for NULL ptr == 0 2015-09-04 14:30:38 -04:00
p5_crpt2_test.c Stop symlinking, move files to intended directory 2015-03-31 20:16:01 +02:00
P1ss.cnf Use 2K RSA and SHA256 in tests 2015-04-20 07:23:04 -04:00
P2ss.cnf Use 2K RSA and SHA256 in tests 2015-04-20 07:23:04 -04:00
packettest.c Remove PACKET_back 2015-09-18 13:04:07 +02:00
pbelutest.c PBE lookup test 2015-09-03 18:37:27 +01:00
pkcs7-1.pem Import of old SSLeay release: SSLeay 0.8.1b 1998-12-21 10:52:47 +00:00
pkcs7.pem Import of old SSLeay release: SSLeay 0.8.1b 1998-12-21 10:52:47 +00:00
pkits-test.pl detect and use older PKITS data 2011-12-11 16:39:25 +00:00
r160test.c Run util/openssl-format-source -v -c . 2015-01-22 09:20:09 +00:00
randtest.c Stop symlinking, move files to intended directory 2015-03-31 20:16:01 +02:00
rc2test.c Stop symlinking, move files to intended directory 2015-03-31 20:16:01 +02:00
rc4test.c memset, memcpy, sizeof consistency fixes 2015-05-05 22:18:59 -04:00
rc5test.c Stop symlinking, move files to intended directory 2015-03-31 20:16:01 +02:00
README Add documentation for the new testing framework 2015-09-07 16:10:58 +02:00
rmdtest.c Stop symlinking, move files to intended directory 2015-03-31 20:16:01 +02:00
rsa_test.c RT 3493: fix RSA test 2015-09-01 20:01:24 +02:00
run_tests.pl Add a method to list available tests 2015-09-15 14:07:10 +02:00
secmemtest.c More secure storage of key material. 2015-06-23 17:09:35 -04:00
serverinfo.pem Require ServerInfo PEMs to be named "BEGIN SERVERINFO FOR"... 2013-09-13 19:32:55 -07:00
sha1test.c Stop symlinking, move files to intended directory 2015-03-31 20:16:01 +02:00
sha256t.c Enable -Wmissing-variable-declarations and 2015-09-11 04:51:55 +01:00
sha512t.c Enable -Wmissing-variable-declarations and 2015-09-11 04:51:55 +01:00
smcont.txt Add extensive PCKS7 and CMS consistency test script. 2008-03-18 14:37:59 +00:00
srptest.c Have the test executables output in text mode 2015-09-06 01:35:54 +02:00
ssltest.c Enable -Wmissing-variable-declarations and 2015-09-11 04:51:55 +01:00
Sssdsa.cnf Import of old SSLeay release: SSLeay 0.9.0b 1998-12-21 10:56:39 +00:00
Sssrsa.cnf Import of old SSLeay release: SSLeay 0.9.0b 1998-12-21 10:56:39 +00:00
test_aesni test_aesni: harmonize with AES-NI support at EVP layer. 2012-07-15 13:38:51 +00:00
test_padlock Update test/test_padlock script. 2009-04-27 19:04:23 +00:00
test_t4 Add support for SPARC T4 DES opcode. 2013-03-31 14:32:05 +02:00
test.cnf Use 2K RSA and SHA256 in tests 2015-04-20 07:23:04 -04:00
testcrl.pem Import of old SSLeay release: SSLeay 0.8.1b 1998-12-21 10:52:47 +00:00
testdsa.pem Add private/public key conversion tests 2015-03-29 03:26:12 +01:00
testdsapub.pem Add private/public key conversion tests 2015-03-29 03:26:12 +01:00
testec-p256.pem Add private/public key conversion tests 2015-03-29 03:26:12 +01:00
testecpub-p256.pem Add private/public key conversion tests 2015-03-29 03:26:12 +01:00
testp7.pem Change PKCS#7 test data to take account of removal of 2000-08-25 01:29:41 +00:00
testreq2.pem Import of old SSLeay release: SSLeay 0.8.1b 1998-12-21 10:52:47 +00:00
testrsa.pem Import of old SSLeay release: SSLeay 0.8.1b 1998-12-21 10:52:47 +00:00
testrsapub.pem Add private/public key conversion tests 2015-03-29 03:26:12 +01:00
tests.com Catch up the VMS build. 2015-03-05 18:20:06 +01:00
testsid.pem Remove SSLv2 support 2014-12-04 11:55:03 +01:00
testutil.c more OSSL_NELEM cases 2015-05-04 13:03:49 +01:00
testutil.h Run util/openssl-format-source -v -c . 2015-01-22 09:20:09 +00:00
testx509.pem Import of old SSLeay release: SSLeay 0.8.1b 1998-12-21 10:52:47 +00:00
times Updates from 1.0.0-stable branch. 2009-04-20 11:33:12 +00:00
Uss.cnf Create DSA and ECDSA certificates. 2015-09-02 21:22:44 +01:00
v3-cert1.pem Import of old SSLeay release: SSLeay 0.8.1b 1998-12-21 10:52:47 +00:00
v3-cert2.pem Import of old SSLeay release: SSLeay 0.8.1b 1998-12-21 10:52:47 +00:00
v3nametest.c Stop symlinking, move files to intended directory 2015-03-31 20:16:01 +02:00
verify_extra_test.c Make the verify_extra test location agnostic 2015-09-06 01:28:40 +02:00
wp_test.c Enable -Wmissing-variable-declarations and 2015-09-11 04:51:55 +01:00

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/Makefile.  More on this later.


Naming convetions
=================

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:

05  individual symmetric cipher algorithms
10  math (bignum)
15  individual asymmetric cipher algorithms
20  openssl enc
25  certificate forms, generation and verification
30  engine and evp
70  PACKET layer
80  "larger" protocols (CA, CMS, OCSP, SSL, TSA)
90  misc


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.

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'.


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'.

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
========================

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:

    {NAME}TEST= {name}test

* add `$({NAME}TEST)$(EXE_EXT)' to the assignment of EXE:

* add `$({NAME}TEST).o' to the assignment of OBJ:

* add `$({NAME}TEST).c' to the assignment of SRC:

* add the following lines for building the executable:

    $({NAME}TEST)$(EXE_EXT): $({NAME}TEST).o $(DLIBCRYPTO)
           @target=$({NAME}TEST); $(BUILD_CMD)