Add more details on how to add a new SSL test
[openssl.git] / test / recipes / 80-test_ssl_new.t
1 #! /usr/bin/env perl
2 # Copyright 2015-2016 The OpenSSL Project Authors. All Rights Reserved.
3 #
4 # Licensed under the OpenSSL license (the "License").  You may not use
5 # this file except in compliance with the License.  You can obtain a copy
6 # in the file LICENSE in the source distribution or at
7 # https://www.openssl.org/source/license.html
8
9
10 use strict;
11 use warnings;
12
13 use File::Basename;
14 use File::Compare qw/compare_text/;
15 use if $^O ne "VMS", 'File::Glob' => qw/glob/;
16
17 use OpenSSL::Test qw/:DEFAULT srctop_dir srctop_file/;
18 use OpenSSL::Test::Utils qw/disabled alldisabled available_protocols/;
19
20 setup("test_ssl_new");
21
22 $ENV{TEST_CERTS_DIR} = srctop_dir("test", "certs");
23 $ENV{CTLOG_FILE} = srctop_file("test", "ct", "log_list.conf");
24
25 my @conf_srcs =  glob(srctop_file("test", "ssl-tests", "*.conf.in"));
26 map { s/;.*// } @conf_srcs if $^O eq "VMS";
27 my @conf_files = map { basename($_) } @conf_srcs;
28 map { s/\.in// } @conf_files;
29
30 # We hard-code the number of tests to double-check that the globbing above
31 # finds all files as expected.
32 plan tests => 13;  # = scalar @conf_srcs
33
34 # Some test results depend on the configuration of enabled protocols. We only
35 # verify generated sources in the default configuration.
36 my $is_default_tls = (disabled("ssl3") && !disabled("tls1") &&
37                       !disabled("tls1_1") && !disabled("tls1_2"));
38
39 my $is_default_dtls = (!disabled("dtls1") && !disabled("dtls1_2"));
40
41 my $no_tls = alldisabled(available_protocols("tls"));
42 my $no_dtls = alldisabled(available_protocols("dtls"));
43 my $no_npn = disabled("nextprotoneg");
44 my $no_ct = disabled("ct");
45 my $no_ec = disabled("ec");
46
47 # Add your test here if the test conf.in generates test cases and/or
48 # expectations dynamically based on the OpenSSL compile-time config.
49 my %conf_dependent_tests = (
50   "02-protocol-version.conf" => !$is_default_tls,
51   "04-client_auth.conf" => !$is_default_tls,
52   "07-dtls-protocol-version.conf" => !$is_default_dtls,
53   "10-resumption.conf" => !$is_default_tls,
54   "11-dtls_resumption.conf" => !$is_default_dtls,
55 );
56
57 # Add your test here if it should be skipped for some compile-time
58 # configurations. Default is $no_tls but some tests have different skip
59 # conditions.
60 my %skip = (
61   "07-dtls-protocol-version.conf" => $no_dtls,
62   "08-npn.conf" => $no_tls || $no_npn,
63   "10-resumption.conf" => disabled("tls1_1") || disabled("tls1_2"),
64   "11-dtls_resumption.conf" => disabled("dtls1") || disabled("dtls1_2"),
65   "12-ct.conf" => $no_tls || $no_ct || $no_ec,
66   # We could run some of these tests without TLS 1.2 if we had a per-test
67   # disable instruction but that's a bizarre configuration not worth
68   # special-casing for.
69   # We should review this once we have TLS 1.3.
70   "13-fragmentation.conf" => disabled("tls1_2")
71 );
72
73 foreach my $conf (@conf_files) {
74     subtest "Test configuration $conf" => sub {
75         test_conf($conf,
76                   $conf_dependent_tests{$conf} || $^O eq "VMS" ?  0 : 1,
77                   defined($skip{$conf}) ? $skip{$conf} : $no_tls);
78     }
79 }
80
81 sub test_conf {
82     plan tests => 3;
83
84     my ($conf, $check_source, $skip) = @_;
85
86     my $conf_file = srctop_file("test", "ssl-tests", $conf);
87     my $tmp_file = "${conf}.$$.tmp";
88     my $run_test = 1;
89
90   SKIP: {
91       # "Test" 1. Generate the source.
92       my $input_file = $conf_file . ".in";
93
94       skip 'failure', 2 unless
95         ok(run(perltest(["generate_ssl_tests.pl", $input_file],
96                         interpreter_args => [ "-I", srctop_dir("test", "testlib")],
97                         stdout => $tmp_file)),
98            "Getting output from generate_ssl_tests.pl.");
99
100     SKIP: {
101         # Test 2. Compare against existing output in test/ssl_tests.conf.
102         skip "Skipping generated source test for $conf", 1
103           if !$check_source;
104
105         $run_test = is(cmp_text($tmp_file, $conf_file), 0,
106                        "Comparing generated sources.");
107       }
108
109       # Test 3. Run the test.
110       skip "No tests available; skipping tests", 1 if $skip;
111       skip "Stale sources; skipping tests", 1 if !$run_test;
112
113       ok(run(test(["ssl_test", $tmp_file])), "running ssl_test $conf");
114     }
115
116     unlink glob $tmp_file;
117 }
118
119 sub cmp_text {
120     return compare_text(@_, sub {
121         $_[0] =~ s/\R//g;
122         $_[1] =~ s/\R//g;
123         return $_[0] ne $_[1];
124     });
125 }