openssl/test
Matt Caswell a193388811 Fix some clang warnings
The af_alg engine and associated test were creating warnings when compiled
with clang. This fixes it.

Reviewed-by: Richard Levitte <levitte@openssl.org>
2016-03-07 13:36:17 +00:00
..
certs CT policy validation 2016-03-01 20:03:25 +00:00
ct Verify SCT signatures 2016-03-01 11:59:28 -05:00
ocsp-tests
recipes Fix minor errors in the afalg test 2016-03-07 13:36:17 +00:00
smime-certs
testlib/OpenSSL Rethink logging of test recipes 2016-02-12 20:56:46 +01:00
afalgtest.c Fix some clang warnings 2016-03-07 13:36:17 +00:00
asynctest.c Fix use before init warnings in asynctest 2016-02-29 13:07:28 +00:00
bftest.c
bntest.c Clean up the tests for auto-init/de-init 2016-02-09 15:11:38 +00:00
build.info Adding afalg test 2016-03-07 13:36:17 +00:00
CAss.cnf GH645: Fix typo: ctificates -> certificates 2016-02-09 11:05:22 -05:00
CAssdh.cnf
CAssdsa.cnf
CAssrsa.cnf
casttest.c
CAtsa.cnf
clienthellotest.c Clean up the tests for auto-init/de-init 2016-02-09 15:11:38 +00:00
cms-examples.pl
constant_time_test.c
ct_test.c CT policy validation 2016-03-01 20:03:25 +00:00
danetest.c Make sure to use unsigned char for is*() functions 2016-02-14 19:31:55 +01:00
danetest.in Suppress DANE TLSA reflection when verification fails 2016-02-08 14:46:09 -05:00
danetest.pem
destest.c
dhtest.c
dsatest.c Clean up the tests for auto-init/de-init 2016-02-09 15:11:38 +00:00
dtlsv1listentest.c fix "no-engine" build of test fixture 2016-02-25 15:23:40 -05:00
dummytest.c
ecdhtest.c skip inappropriate X25519 tests 2016-02-28 22:54:54 +00:00
ecdsatest.c skip inappropriate X25519 tests 2016-02-28 22:54:54 +00:00
ectest.c skip inappropriate X25519 tests 2016-02-28 22:54:54 +00:00
enginetest.c Clean up the tests for auto-init/de-init 2016-02-09 15:11:38 +00:00
evp_extra_test.c Clean up the tests for auto-init/de-init 2016-02-09 15:11:38 +00:00
evp_test.c Generalise KDF test in evp_test.c 2016-03-02 20:57:32 +00:00
evptests.txt GH355: Implement HKDF 2016-03-03 18:21:20 -05:00
exdatatest.c
exptest.c Clean up the tests for auto-init/de-init 2016-02-09 15:11:38 +00:00
gmdifftest.c
heartbeat_test.c Remove TLS heartbeat, disable DTLS heartbeat 2016-02-11 12:57:26 -05:00
hmactest.c
ideatest.c
igetest.c
Makefile.in Adding afalg test 2016-03-07 13:36:17 +00:00
md2test.c
md4test.c
md5test.c
mdc2test.c
memleaktest.c
methtest.c Clean up the tests for auto-init/de-init 2016-02-09 15:11:38 +00:00
nptest.c
p5_crpt2_test.c Rename INIT funtions, deprecate old ones. 2016-02-10 09:37:03 -05:00
P1ss.cnf
P2ss.cnf
packettest.c Refactor ClientHello extension parsing 2016-03-03 13:53:26 +01:00
pbelutest.c
pkcs7-1.pem
pkcs7.pem
pkits-test.pl
r160test.c
randtest.c
rc2test.c
rc4test.c Don't call cpuid in test; done as init. 2016-02-14 16:36:41 -05:00
rc5test.c
README
rmdtest.c
rsa_test.c Clean up the tests for auto-init/de-init 2016-02-09 15:11:38 +00:00
run_tests.pl unified build scheme: adjust test framework for out of source build tree 2016-02-09 11:43:20 +01:00
secmemtest.c Fixup secmemtest for the change of CRYPTO_free() and friends 2016-02-17 12:27:53 +01:00
serverinfo.pem
sha1test.c
sha256t.c
sha512t.c
smcont.txt
srptest.c Clean up the tests for auto-init/de-init 2016-02-09 15:11:38 +00:00
ssltest.c Extends s_client to allow a basic CT policy to be enabled 2016-03-04 10:50:10 -05:00
Sssdsa.cnf
Sssrsa.cnf
test_aesni
test_padlock
test_t4
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.h
testx509.pem
threadstest.c Implement new multi-threading API 2016-02-26 10:00:36 +00:00
times
Uss.cnf
v3-cert1.pem
v3-cert2.pem
v3nametest.c
verify_extra_test.c Clean up the tests for auto-init/de-init 2016-02-09 15:11:38 +00:00
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)