#! /usr/bin/env perl
-# Copyright 2015-2016 The OpenSSL Project Authors. All Rights Reserved.
+# Copyright 2015-2020 The OpenSSL Project Authors. All Rights Reserved.
#
-# Licensed under the OpenSSL license (the "License"). You may not use
+# 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
# in the file LICENSE in the source distribution or at
# https://www.openssl.org/source/license.html
use warnings;
# Recognise VERBOSE and V which is common on other projects.
+# Additionally, also recognise VERBOSE_FAILURE and VF.
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};
}
use File::Spec::Functions qw/catdir catfile curdir abs2rel rel2abs/;
use File::Basename;
-use if $^O ne "VMS", 'File::Glob' => qw/glob/;
-use Module::Load::Conditional qw(can_load);
-
-my $TAP_Harness = can_load(modules => { 'TAP::Harness' => undef })
- ? 'TAP::Harness' : 'OpenSSL::TAP::Harness';
+use FindBin;
+use lib "$FindBin::Bin/../util/perl";
+use OpenSSL::Glob;
my $srctop = $ENV{SRCTOP} || $ENV{TOP};
my $bldtop = $ENV{BLDTOP} || $ENV{TOP};
my $recipesdir = catdir($srctop, "test", "recipes");
-my $testlib = catdir($srctop, "test", "testlib");
-my $utillib = catdir($srctop, "util");
+my $libdir = rel2abs(catdir($srctop, "util", "perl"));
+
+$ENV{OPENSSL_CONF} = rel2abs(catdir($srctop, "apps", "openssl.cnf"));
+$ENV{OPENSSL_CONF_INCLUDE} = rel2abs(catdir($bldtop, "providers"));
+$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"));
my %tapargs =
- ( verbosity => $ENV{VERBOSE} || $ENV{V} || $ENV{HARNESS_VERBOSE} ? 1 : 0,
- lib => [ $testlib, $utillib ],
- switches => '-w',
- merge => 1
+ ( verbosity => $ENV{HARNESS_VERBOSE} ? 1 : 0,
+ lib => [ $libdir ],
+ switches => '-w',
+ merge => 1,
);
+# Additional OpenSSL special TAP arguments. Because we can't pass them via
+# TAP::Harness->new(), they will be accessed directly, see the
+# TAP::Parser::OpenSSL implementation further down
+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;
+
+my $outfilename = $ENV{HARNESS_TAP_COPY};
+open $openssl_args{'tap_copy'}, ">$outfilename"
+ or die "Trying to create $outfilename: $!\n"
+ if defined $outfilename;
+
my @alltests = find_matching_tests("*");
my %tests = ();
if ($arg eq 'alltests') {
warn "'alltests' encountered, ignoring everything before that...\n"
unless $initial_arg;
- %tests = map { $_ => 1 } @alltests;
+ %tests = map { $_ => basename($_) } @alltests;
} elsif ($arg =~ m/^(-?)(.*)/) {
my $sign = $1;
my $test = $2;
# If '-foo' is the first arg, it's short for 'alltests -foo'
if ($sign eq '-' && $initial_arg) {
- %tests = map { $_ => 1 } @alltests;
+ %tests = map { $_ => basename($_) } @alltests;
}
if (scalar @matches == 0) {
if ($sign eq '-') {
delete $tests{$test};
} else {
- $tests{$test} = 1;
+ $tests{$test} = basename($test);
}
}
}
$initial_arg = 0;
}
-my $harness = $TAP_Harness->new(\%tapargs);
-my $ret = $harness->runtests(map { abs2rel($_, rel2abs(curdir())); }
- sort keys %tests);
-
-exit $ret->has_errors if (ref($ret) eq "TAP::Parser::Aggregator");
-
sub find_matching_tests {
my ($glob) = @_;
return glob(catfile($recipesdir,"*-$glob.t"));
}
+# The following is quite a bit of hackery to adapt to both TAP::Harness
+# and Test::Harness, depending on what's available.
+# The TAP::Harness hack allows support for HARNESS_VERBOSE_FAILURE* and
+# HARNESS_TAP_COPY, while the Test::Harness hack can't, because the pre
+# TAP::Harness Test::Harness simply doesn't have support for this sort of
+# thing.
+#
+# We use eval to avoid undue interruption if TAP::Harness isn't present.
+
+my $package;
+my $eres;
-# Fake TAP::Harness in case it's not loaded
-use Test::Harness;
-package OpenSSL::TAP::Harness;
+$eres = eval {
+ package TAP::Parser::OpenSSL;
+ use parent 'TAP::Parser';
-sub new {
- my $class = shift;
- my %args = %{ shift() };
+ sub new {
+ my $class = shift;
+ my %opts = %{ shift() };
+ my $failure_verbosity = $openssl_args{failure_verbosity};
+ print "\n" if $failure_verbosity == 1 || $failure_verbosity == 2;
+ my @plans = (); # initial level, no plan yet
+ my $output_buffer = "";
- return bless { %args }, $class;
-}
+ # We rely heavily on perl closures to make failure verbosity work
+ # We need to do so, because there's no way to safely pass extra
+ # objects down all the way to the TAP::Parser::Result object
+ my @failure_output = ();
+ my %callbacks = ();
+ if ($failure_verbosity > 0 || defined $openssl_args{tap_copy}) {
+ $callbacks{ALL} = sub { # on each line of test output
+ my $self = shift;
+ my $fh = $openssl_args{tap_copy};
+ print $fh $self->as_string, "\n"
+ if defined $fh;
-sub runtests {
- my $self = shift;
+ my $failure_verbosity = $openssl_args{failure_verbosity};
+ if ($failure_verbosity == 3) {
+ push @failure_output, $self->as_string;
+ } elsif ($failure_verbosity > 0) {
+ my $is_plan = $self->is_plan;
+ my $tests_planned = $is_plan && $self->tests_planned;
+ my $is_test = $self->is_test;
+ my $is_ok = $is_test && $self->is_ok;
+ # workaround in case parser not coping with indentation:
+ if ($self->is_unknown) {
+ ($is_plan, $tests_planned) = (1, $1)
+ if ($self->as_string =~ m/^\s+1\.\.(\d+)/);
+ ($is_test, $is_ok) = (1, !$1)
+ if ($self->as_string =~ m/^\s+(not )?ok /);
+ }
+ if ($is_plan) {
+ push @plans, $tests_planned;
+ $output_buffer = ""; # ignore comments etc. until plan
+ } elsif ($is_test) { # result of a test
+ pop @plans if @plans && --($plans[-1]) <= 0;
+ print $output_buffer if !$is_ok;
+ print $self->as_string."\n"
+ if !$is_ok || $failure_verbosity == 2;
+ $output_buffer = "";
+ } else { # typically comment or unknown
+ $output_buffer .= $self->as_string."\n";
+ }
+ }
+ }
+ }
- my @switches = ();
- if ($self->{switches}) {
- push @switches, $self->{switches};
- }
- if ($self->{lib}) {
- foreach (@{$self->{lib}}) {
- my $l = $_;
-
- # It seems that $switches is getting interpreted with 'eval' or
- # something like that, and that we need to take care of backslashes
- # or they will disappear along the way.
- $l =~ s|\\|\\\\|g if $^O eq "MSWin32";
- push @switches, "-I$l";
- }
+ if ($failure_verbosity > 0) {
+ $callbacks{EOF} = sub {
+ my $self = shift;
+
+ # We know we are a TAP::Parser::Aggregator object
+ if (scalar $self->failed > 0 && @failure_output) {
+ # We add an extra empty line, because in the case of a
+ # progress counter, we're still at the end of that progress
+ # line.
+ print $_, "\n" foreach (("", @failure_output));
+ }
+ # Echo any trailing comments etc.
+ print "$output_buffer" if $failure_verbosity != 3;
+ };
+ }
+
+ if (keys %callbacks) {
+ # If %opts already has a callbacks element, the order here
+ # ensures we do not override it
+ %opts = ( callbacks => { %callbacks }, %opts );
+ }
+
+ return $class->SUPER::new({ %opts });
}
- $Test::Harness::switches = join(' ', @switches);
- Test::Harness::runtests(@_);
+ package TAP::Harness::OpenSSL;
+ use parent 'TAP::Harness';
+
+ package main;
+
+ $tapargs{parser_class} = "TAP::Parser::OpenSSL";
+ $package = 'TAP::Harness::OpenSSL';
+};
+
+unless (defined $eres) {
+ $eres = eval {
+ # Fake TAP::Harness in case it's not loaded
+ package TAP::Harness::fake;
+ use parent 'Test::Harness';
+
+ sub new {
+ my $class = shift;
+ my %args = %{ shift() };
+
+ return bless { %args }, $class;
+ }
+
+ sub runtests {
+ my $self = shift;
+
+ # Pre TAP::Harness Test::Harness doesn't support [ filename, name ]
+ # elements, so convert such elements to just be the filename
+ my @args = map { ref($_) eq 'ARRAY' ? $_->[0] : $_ } @_;
+
+ my @switches = ();
+ if ($self->{switches}) {
+ push @switches, $self->{switches};
+ }
+ if ($self->{lib}) {
+ foreach (@{$self->{lib}}) {
+ my $l = $_;
+
+ # It seems that $switches is getting interpreted with 'eval'
+ # or something like that, and that we need to take care of
+ # backslashes or they will disappear along the way.
+ $l =~ s|\\|\\\\|g if $^O eq "MSWin32";
+ push @switches, "-I$l";
+ }
+ }
+
+ $Test::Harness::switches = join(' ', @switches);
+ Test::Harness::runtests(@args);
+ }
+
+ package main;
+ $package = 'TAP::Harness::fake';
+ };
+}
+
+unless (defined $eres) {
+ print $@,"\n" if $@;
+ print $!,"\n" if $!;
+ exit 127;
}
+
+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");
+
+# 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
+# with any exit code in that case.