Update copyright year
[openssl.git] / test / run_tests.pl
index 73d4d91931c08a89f7b75d8fc38e65720f5625f0..90fba194b11bec4e82dcff9420fe54701b39cc66 100644 (file)
@@ -1,5 +1,5 @@
 #! /usr/bin/env perl
-# Copyright 2015-2020 The OpenSSL Project Authors. All Rights Reserved.
+# Copyright 2015-2022 The OpenSSL Project Authors. All Rights Reserved.
 #
 # Licensed under the Apache License 2.0 (the "License").  You may not use
 # this file except in compliance with the License.  You can obtain a copy
@@ -31,22 +31,35 @@ my $srctop = $ENV{SRCTOP} || $ENV{TOP};
 my $bldtop = $ENV{BLDTOP} || $ENV{TOP};
 my $recipesdir = catdir($srctop, "test", "recipes");
 my $libdir = rel2abs(catdir($srctop, "util", "perl"));
-my $jobs = $ENV{HARNESS_JOBS};
+my $jobs = $ENV{HARNESS_JOBS} // 1;
 
-$ENV{OPENSSL_CONF} = rel2abs(catdir($srctop, "apps", "openssl.cnf"));
-$ENV{OPENSSL_CONF_INCLUDE} = rel2abs(catdir($bldtop, "providers"));
+$ENV{OPENSSL_CONF} = rel2abs(catfile($srctop, "apps", "openssl.cnf"));
+$ENV{OPENSSL_CONF_INCLUDE} = rel2abs(catdir($bldtop, "test"));
 $ENV{OPENSSL_MODULES} = rel2abs(catdir($bldtop, "providers"));
 $ENV{OPENSSL_ENGINES} = rel2abs(catdir($bldtop, "engines"));
-$ENV{CTLOG_FILE} = rel2abs(catdir($srctop, "test", "ct", "log_list.cnf"));
+$ENV{CTLOG_FILE} = rel2abs(catfile($srctop, "test", "ct", "log_list.cnf"));
+
+# On platforms that support this, this will ensure malloc returns data that is
+# set to a non-zero value. Can be helpful for detecting uninitialized reads in
+# some situations.
+$ENV{'MALLOC_PERTURB_'} = '128' if !defined $ENV{'MALLOC_PERTURB_'};
 
 my %tapargs =
     ( verbosity         => $ENV{HARNESS_VERBOSE} ? 1 : 0,
       lib               => [ $libdir ],
       switches          => '-w',
       merge             => 1,
+      timer             => $ENV{HARNESS_TIMER} ? 1 : 0,
     );
 
-$tapargs{jobs} = $jobs if defined $jobs;
+if ($jobs > 1) {
+    if ($ENV{HARNESS_VERBOSE}) {
+        print "Warning: HARNESS_JOBS > 1 ignored with HARNESS_VERBOSE\n";
+    } else {
+        $tapargs{jobs} = $jobs;
+        print "Using HARNESS_JOBS=$jobs\n";
+    }
+}
 
 # Additional OpenSSL special TAP arguments.  Because we can't pass them via
 # TAP::Harness->new(), they will be accessed directly, see the
@@ -74,8 +87,8 @@ sub reorder {
     my $key = pop;
 
     # for parallel test runs, do slow tests first
-    if (defined $jobs && $jobs > 1 && $key =~ m/test_ssl_new|test_fuzz/) {
-        $key =~ s/(\d+)-/00-/;
+    if ($jobs > 1 && $key =~ m/test_ssl_new|test_fuzz/) {
+        $key =~ s/(\d+)-/01-/;
     }
     return $key;
 }
@@ -123,12 +136,19 @@ foreach my $arg (@ARGV ? @ARGV : ('alltests')) {
     $initial_arg = 0;
 }
 
+# prep recipes are mandatory and need to be always run first
+my @preps = glob(catfile($recipesdir,"00-prep_*.t"));
+foreach my $test (@preps) {
+    delete $tests{$test};
+}
+
 sub find_matching_tests {
     my ($glob) = @_;
 
     if ($glob =~ m|^[\d\[\]\?\-]+$|) {
         return glob(catfile($recipesdir,"$glob-*.t"));
     }
+
     return glob(catfile($recipesdir,"*-$glob.t"));
 }
 
@@ -146,7 +166,8 @@ my $eres;
 
 $eres = eval {
     package TAP::Parser::OpenSSL;
-    use parent 'TAP::Parser';
+    use parent -norequire, 'TAP::Parser';
+    require TAP::Parser;
 
     sub new {
         my $class = shift;
@@ -229,7 +250,8 @@ $eres = eval {
     }
 
     package TAP::Harness::OpenSSL;
-    use parent 'TAP::Harness';
+    use parent -norequire, 'TAP::Harness';
+    require TAP::Harness;
 
     package main;
 
@@ -291,14 +313,31 @@ unless (defined $eres) {
 my $harness = $package->new(\%tapargs);
 my $ret =
     $harness->runtests(map { [ abs2rel($_, rel2abs(curdir())), basename($_) ] }
-                       sort { reorder($a) cmp reorder($b) } keys %tests);
-
-# $ret->has_errors may be any number, not just 0 or 1.  On VMS, numbers
-# from 2 and on are used as is as VMS statuses, which has severity encoded
-# in the lower 3 bits.  0 and 1, on the other hand, generate SUCCESS and
-# FAILURE, so for currect reporting on all platforms, we make sure the only
-# exit codes are 0 and 1.  Double-bang is the trick to do so.
-exit !!$ret->has_errors if (ref($ret) eq "TAP::Parser::Aggregator");
+                       @preps);
+
+if (ref($ret) ne "TAP::Parser::Aggregator" || !$ret->has_errors) {
+    $ret =
+        $harness->runtests(map { [ abs2rel($_, rel2abs(curdir())), basename($_) ] }
+                           sort { reorder($a) cmp reorder($b) } keys %tests);
+}
+
+# If this is a TAP::Parser::Aggregator, $ret->has_errors is the count of
+# tests that failed.  We don't bother with that exact number, just exit
+# with an appropriate exit code when it isn't zero.
+if (ref($ret) eq "TAP::Parser::Aggregator") {
+    exit 0 unless $ret->has_errors;
+    exit 1 unless $^O eq 'VMS';
+    # On VMS, perl converts an exit 1 to SS$_ABORT (%SYSTEM-F-ABORT), which
+    # is a bit harsh.  As per perl recommendations, we explicitly use the
+    # same VMS status code as typical C programs would for exit(1), except
+    # we set the error severity rather than success.
+    # Ref: https://perldoc.perl.org/perlport#exit
+    #      https://perldoc.perl.org/perlvms#$?
+    exit  0x35a000              # C facility code
+        + 8                     # 1 << 3 (to make space for the 3 severity bits)
+        + 2                     # severity: E(rror)
+        + 0x10000000;           # bit 28 set => the shell stays silent
+}
 
 # If this isn't a TAP::Parser::Aggregator, it's the pre-TAP test harness,
 # which simply dies at the end if any test failed, so we don't need to bother