openssl/test
Dr. Stephen Henson 4a640fb6c3 Fix declarations and constification for inline stack.
Reviewed-by: Richard Levitte <levitte@openssl.org>
2016-01-07 18:00:51 +00: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
recipes Add support for minimum and maximum protocol version 2016-01-02 10:47:52 -05:00
smime-certs
testlib/OpenSSL testlib/OpenSSL/Test.pm: remove redundant 'cmd /c', MSWin32 Perl can take care of itself. 2015-10-13 19:48:28 +02:00
asynctest.c Convert __thread to pthreads for Thread Local Storage 2015-11-20 23:39:30 +00:00
bftest.c memset, memcpy, sizeof consistency fixes 2015-05-05 22:18:59 -04:00
bntest.c Don't export internal symbols 2015-12-15 16:46:48 +00:00
CAss.cnf Use 2K RSA and SHA256 in tests 2015-04-20 07:23:04 -04:00
CAssdh.cnf
CAssdsa.cnf
CAssrsa.cnf
casttest.c Stop symlinking, move files to intended directory 2015-03-31 20:16:01 +02:00
CAtsa.cnf Use better defaults for TSA. 2015-11-20 13:40:53 +00:00
clean_test.com
clienthellotest.c GH354: Memory leak fixes 2015-08-28 11:18:04 -04:00
cms-examples.pl
conftest.c No fprintf in the txt_db component 2015-06-09 12:39:08 -04:00
constant_time_test.c Add ossl_inline 2015-12-22 23:03:56 +00:00
destest.c Stop symlinking, move files to intended directory 2015-03-31 20:16:01 +02:00
dhtest.c add malloc fail check & fix memory leak 2015-12-14 17:38:56 +08:00
dsatest.c Have the test executables output in text mode 2015-09-06 01:35:54 +02:00
dummytest.c Rename some BUF_xxx to OPENSSL_xxx 2015-12-16 16:14:49 -05:00
ecdhtest.c remove ecdh.h header 2015-12-09 22:09:18 +00:00
ecdsatest.c remove ecdsa.h header 2015-12-09 22:09:19 +00:00
ectest.c Fix URLs mangled by reformat 2015-12-19 20:33:00 +00:00
enginetest.c Rename some BUF_xxx to OPENSSL_xxx 2015-12-16 16:14:49 -05:00
evp_extra_test.c Cleanup: fix all sources that used EVP_MD_CTX_(create|init|destroy) 2015-12-07 17:40:20 +01:00
evp_test.c Rename some BUF_xxx to OPENSSL_xxx 2015-12-16 16:14:49 -05:00
evptests.txt x86[_64] assembly pack: add optimized AES-NI OCB subroutines. 2015-12-10 13:11:26 +01:00
exdatatest.c ex_data part 2: doc fixes and CRYPTO_free_ex_index. 2015-12-01 11:48:37 -05:00
exptest.c Rename some BUF_xxx to OPENSSL_xxx 2015-12-16 16:14:49 -05:00
gmdifftest.c Check OPENSSL_gmtime_diff 2015-09-02 23:03:43 -04:00
gost2814789test.c Cleanup: fix all sources that used EVP_MD_CTX_(create|init|destroy) 2015-12-07 17:40:20 +01:00
heartbeat_test.c Rename some BUF_xxx to OPENSSL_xxx 2015-12-16 16:14:49 -05:00
hmactest.c Cleanup: fix all sources that used HMAC_CTX_init 2015-12-07 17:40:20 +01:00
ideatest.c Enable -Wmissing-variable-declarations and 2015-09-11 04:51:55 +01:00
igetest.c Remove the "eay" c-file-style indicators 2015-12-18 13:08:40 +01:00
jpaketest.c Have the test executables output in text mode 2015-09-06 01:35:54 +02:00
Makefile make a "missed make update" update 2015-12-28 14:53:28 -05:00
maketests.com
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 Cleanup: fix all sources that used EVP_MD_CTX_(create|init|destroy) 2015-12-07 17:40:20 +01:00
methtest.c
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 DTLS: remove unused cookie field 2015-10-09 15:32:35 +02:00
pbelutest.c PBE lookup test 2015-09-03 18:37:27 +01:00
pkcs7-1.pem
pkcs7.pem
pkits-test.pl
r160test.c
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
sha1test.c Cleanup the EVP_MD_CTX before exit rather than after 2015-12-08 01:01:13 +01:00
sha256t.c Cleanup: fix all sources that used EVP_MD_CTX_(create|init|destroy) 2015-12-07 17:40:20 +01:00
sha512t.c Cleanup: fix all sources that used EVP_MD_CTX_(create|init|destroy) 2015-12-07 17:40:20 +01:00
smcont.txt
srptest.c Have the test executables output in text mode 2015-09-06 01:35:54 +02:00
ssltest.c Fix declarations and constification for inline stack. 2016-01-07 18:00:51 +00:00
Sssdsa.cnf
Sssrsa.cnf
test_aesni
test_padlock
test_t4
test.cnf Use 2K RSA and SHA256 in tests 2015-04-20 07:23:04 -04:00
testcrl.pem
testdsa.pem
testdsapub.pem
testec-p256.pem
testecpub-p256.pem
testp7.pem
testreq2.pem
testrsa.pem
testrsapub.pem
tests.com
testsid.pem
testutil.c more OSSL_NELEM cases 2015-05-04 13:03:49 +01:00
testutil.h
testx509.pem
times
Uss.cnf Create DSA and ECDSA certificates. 2015-09-02 21:22:44 +01:00
v3-cert1.pem
v3-cert2.pem
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)