2
0
mirror of https://github.com/openssl/openssl.git synced 2025-03-01 19:28:10 +08:00
openssl/test
Richard Levitte 2d5a82570a Better use BIO_snprintf() than snprintf(), in case the later isn't available
Reviewed-by: Tim Hudson <tjh@openssl.org>
2016-04-07 13:35:24 +02:00
..
certs Move peer chain security checks into x509_vfy.c 2016-04-03 11:35:35 -04:00
ct
d2i-tests Fix memory leaks in ASN.1 2016-04-04 13:26:06 +02:00
ocsp-tests
recipes Fix no-ocsp 2016-04-06 14:57:45 +01:00
smime-certs
ssl-tests New SSL test framework 2016-04-05 13:44:46 +02:00
testlib/OpenSSL Enhance OpenSSL::Test::cmdstr to give cmd string variants 2016-04-02 23:13:42 +02:00
aborttest.c
afalgtest.c
asynctest.c
bftest.c
bntest.c Add missing mem leak test activation and checks 2016-04-06 06:17:21 -04:00
build.info Rename ssltest -> ssltest_old 2016-04-05 17:07:09 +02:00
CAss.cnf
CAssdh.cnf
CAssdsa.cnf
CAssrsa.cnf
casttest.c
CAtsa.cnf
clienthellotest.c
cms-examples.pl
constant_time_test.c
ct_test.c Add missing mem leak test activation and checks 2016-04-06 06:17:21 -04:00
d2i_test.c testutil: return 1 on success 2016-04-05 17:05:40 +02:00
danetest.c
danetest.in
danetest.pem
destest.c
dhtest.c Add missing mem leak test activation and checks 2016-04-06 06:17:21 -04:00
dsatest.c Make DSA_METHOD opaque 2016-04-03 00:23:56 +01:00
dtlsv1listentest.c
dummytest.c
ecdhtest_cavs.h
ecdhtest.c
ecdsatest.c
ectest.c
enginetest.c
evp_extra_test.c
evp_test.c
evptests.txt crypto/blake2: make lowest-level function handle multiple blocks.. 2016-03-31 21:34:00 +02:00
exdatatest.c
exptest.c
generate_ssl_tests.pl New SSL test framework 2016-04-05 13:44:46 +02:00
gmdifftest.c
handshake_helper.c New SSL test framework 2016-04-05 13:44:46 +02:00
handshake_helper.h New SSL test framework 2016-04-05 13:44:46 +02:00
heartbeat_test.c
hmactest.c
ideatest.c
igetest.c
Makefile.in Rename ssltest -> ssltest_old 2016-04-05 17:07:09 +02:00
md2test.c
md4test.c
md5test.c
mdc2test.c
memleaktest.c
methtest.c
nptest.c
p5_crpt2_test.c
P1ss.cnf
P2ss.cnf
packettest.c
pbelutest.c
pkcs7-1.pem
pkcs7.pem
pkits-test.pl
r160test.c
randtest.c
rc2test.c
rc4test.c
rc5test.c
README
README.ssltest.md New SSL test framework 2016-04-05 13:44:46 +02:00
rmdtest.c
rsa_test.c Make the RSA structure opaque 2016-04-06 16:19:17 +02:00
run_tests.pl
secmemtest.c
serverinfo.pem
sha1test.c
sha256t.c
sha512t.c
smcont.txt
srptest.c
ssl_test_ctx_test.c testutil: return 1 on success 2016-04-05 17:05:40 +02:00
ssl_test_ctx_test.conf New SSL test framework 2016-04-05 13:44:46 +02:00
ssl_test_ctx.c New SSL test framework 2016-04-05 13:44:46 +02:00
ssl_test_ctx.h New SSL test framework 2016-04-05 13:44:46 +02:00
ssl_test.c Better use BIO_snprintf() than snprintf(), in case the later isn't available 2016-04-07 13:35:24 +02:00
ssl_test.tmpl New SSL test framework 2016-04-05 13:44:46 +02:00
ssltest_old.c Rename ssltest -> ssltest_old 2016-04-05 17:07:09 +02:00
Sssdsa.cnf
Sssrsa.cnf
test_aesni
test_padlock
test_t4 Add support for SPARC T4 DES opcode. 2013-03-31 14:32:05 +02:00
test.cnf
testcrl.pem
testdsa.pem
testdsapub.pem
testec-p256.pem
testecpub-p256.pem
testp7.pem
testreq2.pem
testrsa.pem
testrsapub.pem
testsid.pem
testutil.c testutil: return 1 on success 2016-04-05 17:05:40 +02:00
testutil.h testutil: return 1 on success 2016-04-05 17:05:40 +02:00
testx509.pem
threadstest.c
times
Uss.cnf
v3-cert1.pem
v3-cert2.pem
v3nametest.c
verify_extra_test.c
wp_test.c

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)