#! /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
use strict;
use warnings;
-# Recognise VERBOSE and V which is common on other projects.
-# Additionally, also recognise VERBOSE_FAILURE and VF.
+# Recognise VERBOSE aka V which is common on other projects.
+# Additionally, recognise VERBOSE_FAILURE aka VF aka REPORT_FAILURES
+# and recognise VERBOSE_FAILURE_PROGRESS aka VFP aka REPORT_FAILURES_PROGRESS.
BEGIN {
$ENV{HARNESS_VERBOSE} = "yes" if $ENV{VERBOSE} || $ENV{V};
- $ENV{HARNESS_VERBOSE_FAILURE} = "yes" if $ENV{VERBOSE_FAILURE} || $ENV{VF};
- $ENV{HARNESS_VERBOSE_FAILURES_ONLY} = "yes"
- if $ENV{VERBOSE_FAILURES_ONLY} || $ENV{VFO};
- $ENV{HARNESS_VERBOSE_FAILURES_PROGRESS} = "yes"
- if $ENV{VERBOSE_FAILURES_PROGRESS} || $ENV{VFP};
+ $ENV{HARNESS_VERBOSE_FAILURE} = "yes"
+ if $ENV{VERBOSE_FAILURE} || $ENV{VF} || $ENV{REPORT_FAILURES};
+ $ENV{HARNESS_VERBOSE_FAILURE_PROGRESS} = "yes"
+ if ($ENV{VERBOSE_FAILURE_PROGRESS} || $ENV{VFP}
+ || $ENV{REPORT_FAILURES_PROGRESS});
}
use File::Spec::Functions qw/catdir catfile curdir abs2rel rel2abs/;
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
my %openssl_args = ();
$openssl_args{'failure_verbosity'} = $ENV{HARNESS_VERBOSE} ? 0 :
- $ENV{HARNESS_VERBOSE_FAILURE} ? 3 :
- $ENV{HARNESS_VERBOSE_FAILURES_PROGRESS} ? 2 :
- $ENV{HARNESS_VERBOSE_FAILURES_ONLY} ? 1 : 0;
+ $ENV{HARNESS_VERBOSE_FAILURE_PROGRESS} ? 2 :
+ 1; # $ENV{HARNESS_VERBOSE_FAILURE}
+print "Warning: HARNESS_VERBOSE overrides HARNESS_VERBOSE_FAILURE*\n"
+ if ($ENV{HARNESS_VERBOSE} && ($ENV{HARNESS_VERBOSE_FAILURE}
+ || $ENV{HARNESS_VERBOSE_FAILURE_PROGRESS}));
+print "Warning: HARNESS_VERBOSE_FAILURE_PROGRESS overrides HARNESS_VERBOSE_FAILURE\n"
+ if ($ENV{HARNESS_VERBOSE_FAILURE_PROGRESS} && $ENV{HARNESS_VERBOSE_FAILURE});
my $outfilename = $ENV{HARNESS_TAP_COPY};
open $openssl_args{'tap_copy'}, ">$outfilename"
my @alltests = find_matching_tests("*");
my %tests = ();
+sub reorder {
+ my $key = pop;
+
+ # for parallel test runs, do slow tests first
+ if ($jobs > 1 && $key =~ m/test_ssl_new|test_fuzz/) {
+ $key =~ s/(\d+)-/01-/;
+ }
+ return $key;
+}
+
my $initial_arg = 1;
foreach my $arg (@ARGV ? @ARGV : ('alltests')) {
if ($arg eq 'list') {
- foreach (@alltests) {
- (my $x = basename($_)) =~ s|^[0-9][0-9]-(.*)\.t$|$1|;
- print $x,"\n";
- }
- exit 0;
+ foreach (@alltests) {
+ (my $x = basename($_)) =~ s|^[0-9][0-9]-(.*)\.t$|$1|;
+ print $x,"\n";
+ }
+ exit 0;
}
if ($arg eq 'alltests') {
- warn "'alltests' encountered, ignoring everything before that...\n"
- unless $initial_arg;
- %tests = map { $_ => basename($_) } @alltests;
+ warn "'alltests' encountered, ignoring everything before that...\n"
+ unless $initial_arg;
+ %tests = map { $_ => 1 } @alltests;
} elsif ($arg =~ m/^(-?)(.*)/) {
- my $sign = $1;
- my $test = $2;
- my @matches = find_matching_tests($test);
-
- # If '-foo' is the first arg, it's short for 'alltests -foo'
- if ($sign eq '-' && $initial_arg) {
- %tests = map { $_ => basename($_) } @alltests;
- }
-
- if (scalar @matches == 0) {
- warn "Test $test found no match, skipping ",
- ($sign eq '-' ? "removal" : "addition"),
- "...\n";
- } else {
- foreach $test (@matches) {
- if ($sign eq '-') {
- delete $tests{$test};
- } else {
- $tests{$test} = basename($test);
- }
- }
- }
+ my $sign = $1;
+ my $test = $2;
+ my @matches = find_matching_tests($test);
+
+ # If '-foo' is the first arg, it's short for 'alltests -foo'
+ if ($sign eq '-' && $initial_arg) {
+ %tests = map { $_ => 1 } @alltests;
+ }
+
+ if (scalar @matches == 0) {
+ warn "Test $test found no match, skipping ",
+ ($sign eq '-' ? "removal" : "addition"),
+ "...\n";
+ } else {
+ foreach $test (@matches) {
+ if ($sign eq '-') {
+ delete $tests{$test};
+ } else {
+ $tests{$test} = 1;
+ }
+ }
+ }
} else {
- warn "I don't know what '$arg' is about, ignoring...\n";
+ warn "I don't know what '$arg' is about, ignoring...\n";
}
$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"));
}
$eres = eval {
package TAP::Parser::OpenSSL;
- use parent 'TAP::Parser';
+ use parent -norequire, 'TAP::Parser';
+ require TAP::Parser;
sub new {
my $class = shift;
if defined $fh;
my $failure_verbosity = $openssl_args{failure_verbosity};
- if ($failure_verbosity == 3) {
- push @failure_output, $self->as_string;
- } elsif ($failure_verbosity > 0) {
+ if ($failure_verbosity > 0) {
my $is_plan = $self->is_plan;
my $tests_planned = $is_plan && $self->tests_planned;
my $is_test = $self->is_test;
print $output_buffer if !$is_ok;
print "\n".$self->as_string
if !$is_ok || $failure_verbosity == 2;
+ print "\n# ------------------------------------------------------------------------------" if !$is_ok;
$output_buffer = "";
} elsif ($self->as_string ne "") {
# typically is_comment or is_unknown
print $_, "\n" foreach (("", @failure_output));
}
# Echo any trailing comments etc.
- print "$output_buffer" if $failure_verbosity != 3;
+ print "$output_buffer";
};
}
}
package TAP::Harness::OpenSSL;
- use parent 'TAP::Harness';
+ use parent -norequire, 'TAP::Harness';
+ require TAP::Harness;
package main;
my $harness = $package->new(\%tapargs);
my $ret =
- $harness->runtests(map { [ abs2rel($_, rel2abs(curdir())), $tests{$_} ] }
- sort 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");
+ $harness->runtests(map { [ abs2rel($_, rel2abs(curdir())), basename($_) ] }
+ @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