test/run_tests.pl: Make sure to exit with a code that's understood universally
[openssl.git] / test / run_tests.pl
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 use strict;
10 use warnings;
11
12 # Recognise VERBOSE and V which is common on other projects.
13 BEGIN {
14     $ENV{HARNESS_VERBOSE} = "yes" if $ENV{VERBOSE} || $ENV{V};
15 }
16
17 use File::Spec::Functions qw/catdir catfile curdir abs2rel rel2abs/;
18 use File::Basename;
19 use if $^O ne "VMS", 'File::Glob' => qw/glob/;
20 use Module::Load::Conditional qw(can_load);
21
22 my $TAP_Harness = can_load(modules => { 'TAP::Harness' => undef }) 
23     ? 'TAP::Harness' : 'OpenSSL::TAP::Harness';
24
25 my $srctop = $ENV{SRCTOP} || $ENV{TOP};
26 my $bldtop = $ENV{BLDTOP} || $ENV{TOP};
27 my $recipesdir = catdir($srctop, "test", "recipes");
28 my $testlib = catdir($srctop, "test", "testlib");
29 my $utillib = catdir($srctop, "util");
30
31 my %tapargs =
32     ( verbosity => $ENV{VERBOSE} || $ENV{V} || $ENV{HARNESS_VERBOSE} ? 1 : 0,
33       lib       => [ $testlib, $utillib ],
34       switches  => '-w',
35       merge     => 1
36     );
37
38 my @alltests = find_matching_tests("*");
39 my %tests = ();
40
41 my $initial_arg = 1;
42 foreach my $arg (@ARGV ? @ARGV : ('alltests')) {
43     if ($arg eq 'list') {
44         foreach (@alltests) {
45             (my $x = basename($_)) =~ s|^[0-9][0-9]-(.*)\.t$|$1|;
46             print $x,"\n";
47         }
48         exit 0;
49     }
50     if ($arg eq 'alltests') {
51         warn "'alltests' encountered, ignoring everything before that...\n"
52             unless $initial_arg;
53         %tests = map { $_ => 1 } @alltests;
54     } elsif ($arg =~ m/^(-?)(.*)/) {
55         my $sign = $1;
56         my $test = $2;
57         my @matches = find_matching_tests($test);
58
59         # If '-foo' is the first arg, it's short for 'alltests -foo'
60         if ($sign eq '-' && $initial_arg) {
61             %tests = map { $_ => 1 } @alltests;
62         }
63
64         if (scalar @matches == 0) {
65             warn "Test $test found no match, skipping ",
66                 ($sign eq '-' ? "removal" : "addition"),
67                 "...\n";
68         } else {
69             foreach $test (@matches) {
70                 if ($sign eq '-') {
71                     delete $tests{$test};
72                 } else {
73                     $tests{$test} = 1;
74                 }
75             }
76         }
77     } else {
78         warn "I don't know what '$arg' is about, ignoring...\n";
79     }
80
81     $initial_arg = 0;
82 }
83
84 my $harness = $TAP_Harness->new(\%tapargs);
85 my $ret = $harness->runtests(map { abs2rel($_, rel2abs(curdir())); }
86                                  sort keys %tests);
87
88 # $ret->has_errors may be any number, not just 0 or 1.  On VMS, numbers
89 # from 2 and on are used as is as VMS statuses, which has severity encoded
90 # in the lower 3 bits.  0 and 1, on the other hand, generate SUCCESS and
91 # FAILURE, so for currect reporting on all platforms, we make sure the only
92 # exit codes are 0 and 1.  Double-bang is the trick to do so.
93 exit !!$ret->has_errors if (ref($ret) eq "TAP::Parser::Aggregator");
94
95 # If this isn't a TAP::Parser::Aggregator, it's the pre-TAP test harness,
96 # which simply dies at the end if any test failed, so we don't need to bother
97 # with any exit code in that case.
98
99 sub find_matching_tests {
100     my ($glob) = @_;
101
102     if ($glob =~ m|^[\d\[\]\?\-]+$|) {
103         return glob(catfile($recipesdir,"$glob-*.t"));
104     }
105     return glob(catfile($recipesdir,"*-$glob.t"));
106 }
107
108
109 # Fake TAP::Harness in case it's not loaded
110 use Test::Harness;
111 package OpenSSL::TAP::Harness;
112
113 sub new {
114     my $class = shift;
115     my %args = %{ shift() };
116
117     return bless { %args }, $class;
118 }
119
120 sub runtests {
121     my $self = shift;
122
123     my @switches = ();
124     if ($self->{switches}) {
125         push @switches, $self->{switches};
126     }
127     if ($self->{lib}) {
128         foreach (@{$self->{lib}}) {
129             my $l = $_;
130
131             # It seems that $switches is getting interpreted with 'eval' or
132             # something like that, and that we need to take care of backslashes
133             # or they will disappear along the way.
134             $l =~ s|\\|\\\\|g if $^O eq "MSWin32";
135             push @switches, "-I$l";
136         }
137     }
138
139     $Test::Harness::switches = join(' ', @switches);
140     Test::Harness::runtests(@_);
141 }