Commit 15269e56 authored by Emilia Kasper's avatar Emilia Kasper
Browse files

Add more details on how to add a new SSL test 



Reviewed-by: default avatarStephen Henson <steve@openssl.org>
parent 45dcb5cf

test/README.ssltest.md

+39 −18
Original line number Diff line number Diff line
@@ -10,23 +10,7 @@ harness generates the output files on the fly. 


However, for verification, we also include checked-in configuration outputs

corresponding to the default configuration. These testcases live in

`test/ssl-tests/*.conf` files. Therefore, whenever you're adding or updating a

generated test, you should run



```

$ ./config

$ cd test

$ TOP=.. perl -I testlib/ generate_ssl_tests.pl ssl-tests/my.conf.in \

  > ssl-tests/my.conf

```



where `my.conf.in` is your test input file.



For example, to generate the test cases in `ssl-tests/01-simple.conf.in`, do



```

$ TOP=.. perl generate_ssl_tests.pl ssl-tests/01-simple.conf.in > ssl-tests/01-simple.conf

```

`test/ssl-tests/*.conf` files.



For more details, see `ssl-tests/01-simple.conf.in` for an example.
@@ -206,7 +190,44 @@ client => { 


## Adding a test to the test harness



Add your configuration file to `test/recipes/80-test_ssl_new.t`.

1. Add a new test configuration to `test/ssl-tests`, following the examples of

   existing `*.conf.in` files (for example, `01-simple.conf.in`).



2. Generate the generated `*.conf` test input file. You can do so by running

   `generate_ssl_tests.pl`:



```

$ ./config

$ cd test

$ TOP=.. perl -I testlib/ generate_ssl_tests.pl ssl-tests/my.conf.in \

  > ssl-tests/my.conf

```



where `my.conf.in` is your test input file.



For example, to generate the test cases in `ssl-tests/01-simple.conf.in`, do



```

$ TOP=.. perl -I testlib/ generate_ssl_tests.pl ssl-tests/01-simple.conf.in > ssl-tests/01-simple.conf

```



Alternatively (hackish but simple), you can comment out



```

unlink glob $tmp_file;

```



in `test/recipes/80-test_ssl_new.t` and run



```

$ make TESTS=test_ssl_new test

```



This will save the generated output in a `*.tmp` file in the build directory.



3. Update the number of tests planned in `test/recipes/80-test_ssl_new.t`. If

   the test suite has any skip conditions, update those too (see

   `test/recipes/80-test_ssl_new.t` for details).



## Running the tests with the test harness

test/recipes/80-test_ssl_new.t

+5 −1
Original line number Diff line number Diff line
@@ -44,6 +44,8 @@ my $no_npn = disabled("nextprotoneg"); 
my $no_ct = disabled("ct");

my $no_ec = disabled("ec");



# Add your test here if the test conf.in generates test cases and/or

# expectations dynamically based on the OpenSSL compile-time config.

my %conf_dependent_tests = (

  "02-protocol-version.conf" => !$is_default_tls,

  "04-client_auth.conf" => !$is_default_tls,
@@ -52,7 +54,9 @@ my %conf_dependent_tests = ( 
  "11-dtls_resumption.conf" => !$is_default_dtls,

);



# Default is $no_tls but some tests have different skip conditions.

# Add your test here if it should be skipped for some compile-time

# configurations. Default is $no_tls but some tests have different skip

# conditions.

my %skip = (

  "07-dtls-protocol-version.conf" => $no_dtls,

  "08-npn.conf" => $no_tls || $no_npn,