1 # Copyright 2016-2019 The OpenSSL Project Authors. All Rights Reserved.
3 # Licensed under the Apache License 2.0 (the "License"). You may not use
4 # this file except in compliance with the License. You can obtain a copy
5 # in the file LICENSE in the source distribution or at
6 # https://www.openssl.org/source/license.html
16 use vars
qw($VERSION @ISA @EXPORT @EXPORT_OK %EXPORT_TAGS);
19 @EXPORT = (@Test::More
::EXPORT
, qw(setup run indir cmd app fuzz test
20 perlapp perltest subtest));
21 @EXPORT_OK = (@Test::More
::EXPORT_OK
, qw(bldtop_dir bldtop_file
22 srctop_dir srctop_file
24 pipe with cmdstr quotify
26 ok_nofips is_nofips isnt_nofips));
30 OpenSSL::Test - a private extension of Test::More
36 setup("my_test_name");
38 ok(run(app(["openssl", "version"])), "check for openssl presence");
40 indir "subdir" => sub {
41 ok(run(test(["sometest", "arg1"], stdout => "foo.txt")),
42 "run sometest with output to foo.txt");
47 This module is a private extension of L<Test::More> for testing OpenSSL.
48 In addition to the Test::More functions, it also provides functions that
49 easily find the diverse programs within a OpenSSL build tree, as well as
50 some other useful functions.
52 This module I<depends> on the environment variables C<$TOP> or C<$SRCTOP>
53 and C<$BLDTOP>. Without one of the combinations it refuses to work.
54 See L</ENVIRONMENT> below.
56 With each test recipe, a parallel data directory with (almost) the same name
57 as the recipe is possible in the source directory tree. For example, for a
58 recipe C<$SRCTOP/test/recipes/99-foo.t>, there could be a directory
59 C<$SRCTOP/test/recipes/99-foo_data/>.
64 use File
::Spec
::Functions qw
/file_name_is_absolute curdir canonpath splitdir
65 catdir catfile splitpath catpath devnull abs2rel
67 use File
::Path
2.00 qw
/rmtree mkpath/;
69 use Cwd qw
/getcwd abs_path/;
73 # The name of the test. This is set by setup() and is used in the other
74 # functions to verify that setup() has been used.
75 my $test_name = undef;
77 # Directories we want to keep track of TOP, APPS, TEST and RESULTS are the
78 # ones we're interested in, corresponding to the environment variables TOP
79 # (mandatory), BIN_D, TEST_D, UTIL_D and RESULT_D.
82 # The environment variables that gave us the contents in %directories. These
83 # get modified whenever we change directories, so that subprocesses can use
84 # the values of those environment variables as well
87 # A bool saying if we shall stop all testing if the current recipe has failing
88 # tests or not. This is set by setup() if the environment variable STOPTEST
89 # is defined with a non-empty value.
90 my $end_with_bailout = 0;
92 # A set of hooks that is affected by with() and may be used in diverse places.
93 # All hooks are expected to be CODE references.
96 # exit_checker is used by run() directly after completion of a command.
97 # it receives the exit code from that command and is expected to return
98 # 1 (for success) or 0 (for failure). This is the status value that run()
99 # will give back (through the |statusvar| reference and as returned value
100 # when capture => 1 doesn't apply).
101 exit_checker
=> sub { return shift == 0 ?
1 : 0 },
105 # Debug flag, to be set manually when needed
108 =head2 Main functions
110 The following functions are exported by default when using C<OpenSSL::Test>.
116 =item B<setup "NAME">
118 C<setup> is used for initial setup, and it is mandatory that it's used.
119 If it's not used in a OpenSSL test recipe, the rest of the recipe will
120 most likely refuse to run.
122 C<setup> checks for environment variables (see L</ENVIRONMENT> below),
123 checks that C<$TOP/Configure> or C<$SRCTOP/Configure> exists, C<chdir>
124 into the results directory (defined by the C<$RESULT_D> environment
125 variable if defined, otherwise C<$BLDTOP/test> or C<$TOP/test>, whichever
133 my $old_test_name = $test_name;
136 BAIL_OUT
("setup() must receive a name") unless $test_name;
137 warn "setup() detected test name change. Innocuous, so we continue...\n"
138 if $old_test_name && $old_test_name ne $test_name;
140 return if $old_test_name;
142 BAIL_OUT
("setup() needs \$TOP or \$SRCTOP and \$BLDTOP to be defined")
143 unless $ENV{TOP
} || ($ENV{SRCTOP
} && $ENV{BLDTOP
});
144 BAIL_OUT
("setup() found both \$TOP and \$SRCTOP or \$BLDTOP...")
145 if $ENV{TOP
} && ($ENV{SRCTOP
} || $ENV{BLDTOP
});
149 BAIL_OUT
("setup() expects the file Configure in the source top directory")
150 unless -f srctop_file
("Configure");
152 note
"The results of this test will end up in $directories{RESULTS}";
154 __cwd
($directories{RESULTS
});
159 =item B<indir "SUBDIR" =E<gt> sub BLOCK, OPTS>
161 C<indir> is used to run a part of the recipe in a different directory than
162 the one C<setup> moved into, usually a subdirectory, given by SUBDIR.
163 The part of the recipe that's run there is given by the codeblock BLOCK.
165 C<indir> takes some additional options OPTS that affect the subdirectory:
169 =item B<create =E<gt> 0|1>
171 When set to 1 (or any value that perl perceives as true), the subdirectory
172 will be created if it doesn't already exist. This happens before BLOCK
180 ok(run(app(["openssl", "version"]), stdout => "foo.txt"));
181 if (ok(open(RESULT, "foo.txt"), "reading foo.txt")) {
184 is($line, qr/^OpenSSL 1\./,
185 "check that we're using OpenSSL 1.x.x");
195 my $codeblock = shift;
198 my $reverse = __cwd
($subdir,%opts);
199 BAIL_OUT
("FAILURE: indir, \"$subdir\" wasn't possible to move into")
209 =item B<cmd ARRAYREF, OPTS>
211 This functions build up a platform dependent command based on the
212 input. It takes a reference to a list that is the executable or
213 script and its arguments, and some additional options (described
214 further on). Where necessary, the command will be wrapped in a
215 suitable environment to make sure the correct shared libraries are
216 used (currently only on Unix).
218 It returns a CODEREF to be used by C<run>, C<pipe> or C<cmdstr>.
220 The options that C<cmd> can take are in the form of hash values:
224 =item B<stdin =E<gt> PATH>
226 =item B<stdout =E<gt> PATH>
228 =item B<stderr =E<gt> PATH>
230 In all three cases, the corresponding standard input, output or error is
231 redirected from (for stdin) or to (for the others) a file given by the
232 string PATH, I<or>, if the value is C<undef>, C</dev/null> or similar.
236 =item B<app ARRAYREF, OPTS>
238 =item B<test ARRAYREF, OPTS>
240 Both of these are specific applications of C<cmd>, with just a couple
243 C<app> expects to find the given command (the first item in the given list
244 reference) as an executable in C<$BIN_D> (if defined, otherwise C<$TOP/apps>
247 C<test> expects to find the given command (the first item in the given list
248 reference) as an executable in C<$TEST_D> (if defined, otherwise C<$TOP/test>
251 Also, for both C<app> and C<test>, the command may be prefixed with
252 the content of the environment variable C<$EXE_SHELL>, which is useful
253 in case OpenSSL has been cross compiled.
255 =item B<perlapp ARRAYREF, OPTS>
257 =item B<perltest ARRAYREF, OPTS>
259 These are also specific applications of C<cmd>, where the interpreter
260 is predefined to be C<perl>, and they expect the script to be
261 interpreted to reside in the same location as C<app> and C<test>.
263 C<perlapp> and C<perltest> will also take the following option:
267 =item B<interpreter_args =E<gt> ARRAYref>
269 The array reference is a set of arguments for the interpreter rather
270 than the script. Take care so that none of them can be seen as a
271 script! Flags and their eventual arguments only!
277 ok(run(perlapp(["foo.pl", "arg1"],
278 interpreter_args => [ "-I", srctop_dir("test") ])));
284 One might wonder over the complexity of C<apps>, C<fuzz>, C<test>, ...
285 with all the lazy evaluations and all that. The reason for this is that
286 we want to make sure the directory in which those programs are found are
287 correct at the time these commands are used. Consider the following code
290 my $cmd = app(["openssl", ...]);
293 ok(run($cmd), "Testing foo")
296 If there wasn't this lazy evaluation, the directory where C<openssl> is
297 found would be incorrect at the time C<run> is called, because it was
298 calculated before we moved into the directory "foo".
309 # Make a copy to not destroy the caller's array
310 my @cmdargs = ( @
$cmd );
311 my @prog = __wrap_cmd
(shift @cmdargs, $opts{exe_shell
} // ());
313 return __decorate_cmd
($num, [ @prog, quotify
(@cmdargs) ],
322 my @cmdargs = ( @
{$cmd} );
323 my @prog = __fixup_prg
(__apps_file
(shift @cmdargs, __exeext
()));
324 return cmd
([ @prog, @cmdargs ],
325 exe_shell
=> $ENV{EXE_SHELL
}, %opts) -> (shift);
333 my @cmdargs = ( @
{$cmd} );
334 my @prog = __fixup_prg
(__fuzz_file
(shift @cmdargs, __exeext
()));
335 return cmd
([ @prog, @cmdargs ],
336 exe_shell
=> $ENV{EXE_SHELL
}, %opts) -> (shift);
344 my @cmdargs = ( @
{$cmd} );
345 my @prog = __fixup_prg
(__test_file
(shift @cmdargs, __exeext
()));
346 return cmd
([ @prog, @cmdargs ],
347 exe_shell
=> $ENV{EXE_SHELL
}, %opts) -> (shift);
355 my @interpreter_args = defined $opts{interpreter_args
} ?
356 @
{$opts{interpreter_args
}} : ();
357 my @interpreter = __fixup_prg
($^X
);
358 my @cmdargs = ( @
{$cmd} );
359 my @prog = __apps_file
(shift @cmdargs, undef);
360 return cmd
([ @interpreter, @interpreter_args,
361 @prog, @cmdargs ], %opts) -> (shift);
369 my @interpreter_args = defined $opts{interpreter_args
} ?
370 @
{$opts{interpreter_args
}} : ();
371 my @interpreter = __fixup_prg
($^X
);
372 my @cmdargs = ( @
{$cmd} );
373 my @prog = __test_file
(shift @cmdargs, undef);
374 return cmd
([ @interpreter, @interpreter_args,
375 @prog, @cmdargs ], %opts) -> (shift);
381 =item B<run CODEREF, OPTS>
383 CODEREF is expected to be the value return by C<cmd> or any of its
384 derivatives, anything else will most likely cause an error unless you
385 know what you're doing.
387 C<run> executes the command returned by CODEREF and return either the
388 resulting output (if the option C<capture> is set true) or a boolean
389 indicating if the command succeeded or not.
391 The options that C<run> can take are in the form of hash values:
395 =item B<capture =E<gt> 0|1>
397 If true, the command will be executed with a perl backtick, and C<run> will
398 return the resulting output as an array of lines. If false or not given,
399 the command will be executed with C<system()>, and C<run> will return 1 if
400 the command was successful or 0 if it wasn't.
402 =item B<prefix =E<gt> EXPR>
404 If specified, EXPR will be used as a string to prefix the output from the
405 command. This is useful if the output contains lines starting with C<ok >
406 or C<not ok > that can disturb Test::Harness.
408 =item B<statusvar =E<gt> VARREF>
410 If used, B<VARREF> must be a reference to a scalar variable. It will be
411 assigned a boolean indicating if the command succeeded or not. This is
412 particularly useful together with B<capture>.
416 For further discussion on what is considered a successful command or not, see
417 the function C<with> further down.
424 my ($cmd, $display_cmd) = shift->(0);
430 if ( $^O
eq "VMS" ) { # VMS
438 die "OpenSSL::Test::run(): statusvar value not a scalar reference"
439 if $opts{statusvar
} && ref($opts{statusvar
}) ne "SCALAR";
441 # For some reason, program output, or even output from this function
442 # somehow isn't caught by TAP::Harness (TAP::Parser?) on VMS, so we're
443 # silencing it specifically there until further notice.
447 # In non-verbose, we want to shut up the command interpreter, in case
448 # it has something to complain about. On VMS, it might complain both
449 # on stdout and stderr
450 if ($ENV{HARNESS_ACTIVE
} && !$ENV{HARNESS_VERBOSE
}) {
451 open $save_STDOUT, '>&', \
*STDOUT
or die "Can't dup STDOUT: $!";
452 open $save_STDERR, '>&', \
*STDERR
or die "Can't dup STDERR: $!";
453 open STDOUT
, ">", devnull
();
454 open STDERR
, ">", devnull
();
458 $ENV{HARNESS_OSSL_LEVEL
} = $level + 1;
460 # The dance we do with $? is the same dance the Unix shells appear to
461 # do. For example, a program that gets aborted (and therefore signals
462 # SIGABRT = 6) will appear to exit with the code 134. We mimic this
463 # to make it easier to compare with a manual run of the command.
464 if ($opts{capture
} || defined($opts{prefix
})) {
468 open($pipe, '-|', "$prefix$cmd") or die "Can't start command: $!";
470 my $l = ($opts{prefix
} // "") . $_;
471 if ($opts{capture
}) {
479 $ENV{HARNESS_OSSL_PREFIX
} = "# ";
480 system("$prefix$cmd");
481 delete $ENV{HARNESS_OSSL_PREFIX
};
483 $e = ($?
& 0x7f) ?
($?
& 0x7f)|0x80 : ($?
>> 8);
484 $r = $hooks{exit_checker
}->($e);
485 if ($opts{statusvar
}) {
486 ${$opts{statusvar
}} = $r;
489 # Restore STDOUT / STDERR on VMS
491 if ($ENV{HARNESS_ACTIVE
} && !$ENV{HARNESS_VERBOSE
}) {
494 open STDOUT
, '>&', $save_STDOUT or die "Can't restore STDOUT: $!";
495 open STDERR
, '>&', $save_STDERR or die "Can't restore STDERR: $!";
498 print STDERR
"$prefix$display_cmd => $e\n"
499 if !$ENV{HARNESS_ACTIVE
} || $ENV{HARNESS_VERBOSE
};
501 print STDERR
"$prefix$display_cmd => $e\n";
504 # At this point, $? stops being interesting, and unfortunately,
505 # there are Test::More versions that get picky if we leave it
509 if ($opts{capture
}) {
517 my $tb = Test
::More
->builder;
518 my $failure = scalar(grep { $_ == 0; } $tb->summary);
519 if ($failure && $end_with_bailout) {
520 BAIL_OUT
("Stoptest!");
524 =head2 Utility functions
526 The following functions are exported on request when using C<OpenSSL::Test>.
528 # To only get the bldtop_file and srctop_file functions.
529 use OpenSSL::Test qw/bldtop_file srctop_file/;
531 # To only get the bldtop_file function in addition to the default ones.
532 use OpenSSL::Test qw/:DEFAULT bldtop_file/;
536 # Utility functions, exported on request
540 =item B<bldtop_dir LIST>
542 LIST is a list of directories that make up a path from the top of the OpenSSL
543 build directory (as indicated by the environment variable C<$TOP> or
545 C<bldtop_dir> returns the resulting directory as a string, adapted to the local
553 return __bldtop_dir
(@_); # This caters for operating systems that have
554 # a very distinct syntax for directories.
559 =item B<bldtop_file LIST, FILENAME>
561 LIST is a list of directories that make up a path from the top of the OpenSSL
562 build directory (as indicated by the environment variable C<$TOP> or
563 C<$BLDTOP>) and FILENAME is the name of a file located in that directory path.
564 C<bldtop_file> returns the resulting file path as a string, adapted to the local
572 return __bldtop_file
(@_);
577 =item B<srctop_dir LIST>
579 LIST is a list of directories that make up a path from the top of the OpenSSL
580 source directory (as indicated by the environment variable C<$TOP> or
582 C<srctop_dir> returns the resulting directory as a string, adapted to the local
590 return __srctop_dir
(@_); # This caters for operating systems that have
591 # a very distinct syntax for directories.
596 =item B<srctop_file LIST, FILENAME>
598 LIST is a list of directories that make up a path from the top of the OpenSSL
599 source directory (as indicated by the environment variable C<$TOP> or
600 C<$SRCTOP>) and FILENAME is the name of a file located in that directory path.
601 C<srctop_file> returns the resulting file path as a string, adapted to the local
609 return __srctop_file
(@_);
614 =item B<data_dir LIST>
616 LIST is a list of directories that make up a path from the data directory
617 associated with the test (see L</DESCRIPTION> above).
618 C<data_dir> returns the resulting directory as a string, adapted to the local
626 return __data_dir
(@_);
631 =item B<data_file LIST, FILENAME>
633 LIST is a list of directories that make up a path from the data directory
634 associated with the test (see L</DESCRIPTION> above) and FILENAME is the name
635 of a file located in that directory path. C<data_file> returns the resulting
636 file path as a string, adapted to the local operating system.
643 return __data_file
(@_);
650 LIST is a list of CODEREFs returned by C<app> or C<test>, from which C<pipe>
651 creates a new command composed of all the given commands put together in a
652 pipe. C<pipe> returns a new CODEREF in the same manner as C<app> or C<test>,
653 to be passed to C<run> for execution.
668 my ($c, $dc, @el) = $_->(++$counter);
686 =item B<with HASHREF, CODEREF>
688 C<with> will temporarily install hooks given by the HASHREF and then execute
689 the given CODEREF. Hooks are usually expected to have a coderef as value.
691 The currently available hoosk are:
695 =item B<exit_checker =E<gt> CODEREF>
697 This hook is executed after C<run> has performed its given command. The
698 CODEREF receives the exit code as only argument and is expected to return
699 1 (if the exit code indicated success) or 0 (if the exit code indicated
711 my $codeblock = shift;
713 my %saved_hooks = ();
715 foreach (keys %opts) {
716 $saved_hooks{$_} = $hooks{$_} if exists($hooks{$_});
717 $hooks{$_} = $opts{$_};
722 foreach (keys %saved_hooks) {
723 $hooks{$_} = $saved_hooks{$_};
729 =item B<cmdstr CODEREF, OPTS>
731 C<cmdstr> takes a CODEREF from C<app> or C<test> and simply returns the
734 C<cmdstr> takes some additional options OPTS that affect the string returned:
738 =item B<display =E<gt> 0|1>
740 When set to 0, the returned string will be with all decorations, such as a
741 possible redirect of stderr to the null device. This is suitable if the
742 string is to be used directly in a recipe.
744 When set to 1, the returned string will be without extra decorations. This
745 is suitable for display if that is desired (doesn't confuse people with all
746 internal stuff), or if it's used to pass a command down to a subprocess.
757 my ($cmd, $display_cmd) = shift->(0);
760 if ($opts{display
}) {
769 =item B<quotify LIST>
771 LIST is a list of strings that are going to be used as arguments for a
772 command, and makes sure to inject quotes and escapes as necessary depending
773 on the content of each string.
775 This can also be used to put quotes around the executable of a command.
776 I<This must never ever be done on VMS.>
783 # Unix setup (default if nothing else is mentioned)
786 ($_ eq '' || /\s|[\{\}\\\$\[\]\*\?\|\&:;<>]/) ?
"'$_'" : $_ };
788 if ( $^O
eq "VMS") { # VMS setup
789 $arg_formatter = sub {
791 if ($_ eq '' || /\s|["[:upper:]]/) {
798 } elsif ( $^O
eq "MSWin32") { # MSWin setup
799 $arg_formatter = sub {
801 if ($_ eq '' || /\s|["\|\&\*\;<>]/) {
810 return map { $arg_formatter->($_) } @_;
815 =item B<openssl_versions>
817 Returns a list of two version numbers, the first representing the build
818 version, the second representing the library version. See opensslv.h for
819 more information on those numbers.
826 sub openssl_versions
{
832 run
(test
(['versions']), capture
=> 1);
833 @versions = ( $lines{'Build version'}, $lines{'Library version'} );
840 =item B<ok_nofips EXPR, TEST_NAME>
842 C<ok_nofips> is equivalent to using C<ok> when the environment variable
843 C<FIPS_MODE> is undefined, otherwise it is equivalent to C<not ok>. This can be
844 used for C<ok> tests that must fail when testing a FIPS provider. The parameters
845 are the same as used by C<ok> which is an expression EXPR followed by the test
846 description TEST_NAME.
850 ok_nofips(run(app(["md5.pl"])), "md5 should fail in fips mode");
852 =item B<is_nofips EXPR1, EXPR2, TEST_NAME>
854 C<is_nofips> is equivalent to using C<is> when the environment variable
855 C<FIPS_MODE> is undefined, otherwise it is equivalent to C<isnt>. This can be
856 used for C<is> tests that must fail when testing a FIPS provider. The parameters
857 are the same as used by C<is> which has 2 arguments EXPR1 and EXPR2 that can be
858 compared using eq or ne, followed by a test description TEST_NAME.
862 is_nofips(ultimate_answer(), 42, "Meaning of Life");
864 =item B<isnt_nofips EXPR1, EXPR2, TEST_NAME>
866 C<isnt_nofips> is equivalent to using C<isnt> when the environment variable
867 C<FIPS_MODE> is undefined, otherwise it is equivalent to C<is>. This can be
868 used for C<isnt> tests that must fail when testing a FIPS provider. The
869 parameters are the same as used by C<isnt> which has 2 arguments EXPR1 and EXPR2
870 that can be compared using ne or eq, followed by a test description TEST_NAME.
874 isnt_nofips($foo, '', "Got some foo");
881 return ok
(!$_[0], @_[1..$#_]) if defined $ENV{FIPS_MODE
};
882 return ok
($_[0], @_[1..$#_]);
886 return isnt
($_[0], $_[1], @_[2..$#_]) if defined $ENV{FIPS_MODE
};
887 return is
($_[0], $_[1], @_[2..$#_]);
891 return is
($_[0], $_[1], @_[2..$#_]) if defined $ENV{FIPS_MODE
};
892 return isnt
($_[0], $_[1], @_[2..$#_]);
895 ######################################################################
896 # private functions. These are never exported.
900 OpenSSL::Test depends on some environment variables.
906 This environment variable is mandatory. C<setup> will check that it's
907 defined and that it's a directory that contains the file C<Configure>.
908 If this isn't so, C<setup> will C<BAIL_OUT>.
912 If defined, its value should be the directory where the openssl application
913 is located. Defaults to C<$TOP/apps> (adapted to the operating system).
917 If defined, its value should be the directory where the test applications
918 are located. Defaults to C<$TOP/test> (adapted to the operating system).
922 If defined, it puts testing in a different mode, where a recipe with
923 failures will result in a C<BAIL_OUT> at the end of its run.
927 If defined it indicates that the FIPS provider is being tested. Tests may use
928 B<ok_nofips>, B<is_nofips> and B<isnt_nofips> to invert test results
929 i.e. Some tests may only work in non FIPS mode.
936 (my $recipe_datadir = basename
($0)) =~ s/\.t$/_data/i;
938 $directories{SRCTOP
} = abs_path
($ENV{SRCTOP
} || $ENV{TOP
});
939 $directories{BLDTOP
} = abs_path
($ENV{BLDTOP
} || $ENV{TOP
});
940 $directories{BLDAPPS
} = $ENV{BIN_D
} || __bldtop_dir
("apps");
941 $directories{SRCAPPS
} = __srctop_dir
("apps");
942 $directories{BLDFUZZ
} = __bldtop_dir
("fuzz");
943 $directories{SRCFUZZ
} = __srctop_dir
("fuzz");
944 $directories{BLDTEST
} = $ENV{TEST_D
} || __bldtop_dir
("test");
945 $directories{SRCTEST
} = __srctop_dir
("test");
946 $directories{SRCDATA
} = __srctop_dir
("test", "recipes",
948 $directories{RESULTTOP
} = $ENV{RESULT_D
} || __bldtop_dir
("test-runs");
949 $directories{RESULTS
} = catdir
($directories{RESULTTOP
}, $test_name);
951 # Create result directory dynamically
952 rmtree
($directories{RESULTS
}, { safe
=> 0, keep_root
=> 1 });
953 mkpath
($directories{RESULTS
});
955 push @direnv, "TOP" if $ENV{TOP
};
956 push @direnv, "SRCTOP" if $ENV{SRCTOP
};
957 push @direnv, "BLDTOP" if $ENV{BLDTOP
};
958 push @direnv, "BIN_D" if $ENV{BIN_D
};
959 push @direnv, "TEST_D" if $ENV{TEST_D
};
960 push @direnv, "RESULT_D" if $ENV{RESULT_D
};
962 $end_with_bailout = $ENV{STOPTEST
} ?
1 : 0;
965 # __srctop_file and __srctop_dir are helpers to build file and directory
966 # names on top of the source directory. They depend on $SRCTOP, and
967 # therefore on the proper use of setup() and when needed, indir().
968 # __bldtop_file and __bldtop_dir do the same thing but relative to $BLDTOP.
969 # __srctop_file and __bldtop_file take the same kind of argument as
970 # File::Spec::Functions::catfile.
971 # Similarly, __srctop_dir and __bldtop_dir take the same kind of argument
972 # as File::Spec::Functions::catdir
974 BAIL_OUT
("Must run setup() first") if (! $test_name);
977 return abs2rel
(catfile
($directories{SRCTOP
},@_,$f),getcwd
);
981 BAIL_OUT
("Must run setup() first") if (! $test_name);
983 return abs2rel
(catdir
($directories{SRCTOP
},@_), getcwd
);
987 BAIL_OUT
("Must run setup() first") if (! $test_name);
990 return abs2rel
(catfile
($directories{BLDTOP
},@_,$f), getcwd
);
994 BAIL_OUT
("Must run setup() first") if (! $test_name);
996 return abs2rel
(catdir
($directories{BLDTOP
},@_), getcwd
);
999 # __exeext is a function that returns the platform dependent file extension
1000 # for executable binaries, or the value of the environment variable $EXE_EXT
1001 # if that one is defined.
1004 if ($^O
eq "VMS" ) { # VMS
1006 } elsif ($^O
eq "MSWin32") { # Windows
1009 return $ENV{"EXE_EXT"} || $ext;
1012 # __test_file, __apps_file and __fuzz_file return the full path to a file
1013 # relative to the test/, apps/ or fuzz/ directory in the build tree or the
1014 # source tree, depending on where the file is found. Note that when looking
1015 # in the build tree, the file name with an added extension is looked for, if
1016 # an extension is given. The intent is to look for executable binaries (in
1017 # the build tree) or possibly scripts (in the source tree).
1018 # These functions all take the same arguments as File::Spec::Functions::catfile,
1019 # *plus* a mandatory extension argument. This extension argument can be undef,
1020 # and is ignored in such a case.
1022 BAIL_OUT
("Must run setup() first") if (! $test_name);
1026 my $out = catfile
($directories{BLDTEST
},@_,$f . $e);
1027 $out = catfile
($directories{SRCTEST
},@_,$f) unless -f
$out;
1032 BAIL_OUT
("Must run setup() first") if (! $test_name);
1036 my $out = catfile
($directories{BLDAPPS
},@_,$f . $e);
1037 $out = catfile
($directories{SRCAPPS
},@_,$f) unless -f
$out;
1042 BAIL_OUT
("Must run setup() first") if (! $test_name);
1046 my $out = catfile
($directories{BLDFUZZ
},@_,$f . $e);
1047 $out = catfile
($directories{SRCFUZZ
},@_,$f) unless -f
$out;
1052 BAIL_OUT
("Must run setup() first") if (! $test_name);
1055 return catfile
($directories{SRCDATA
},@_,$f);
1059 BAIL_OUT
("Must run setup() first") if (! $test_name);
1061 return catdir
($directories{SRCDATA
},@_);
1064 sub __results_file
{
1065 BAIL_OUT
("Must run setup() first") if (! $test_name);
1068 return catfile
($directories{RESULTS
},@_,$f);
1074 # __cwd changes directory to DIR (string) and changes all the relative
1075 # entries in %directories accordingly. OPTS is an optional series of
1076 # hash style arguments to alter __cwd's behavior:
1078 # create = 0|1 The directory we move to is created if 1, not if 0.
1081 my $dir = catdir
(shift);
1083 my $abscurdir = rel2abs
(curdir
());
1084 my $absdir = rel2abs
($dir);
1085 my $reverse = abs2rel
($abscurdir, $absdir);
1087 # PARANOIA: if we're not moving anywhere, we do nothing more
1088 if ($abscurdir eq $absdir) {
1092 # Do not support a move to a different volume for now. Maybe later.
1093 BAIL_OUT
("FAILURE: \"$dir\" moves to a different volume, not supported")
1094 if $reverse eq $abscurdir;
1096 # If someone happened to give a directory that leads back to the current,
1097 # it's extremely silly to do anything more, so just simulate that we did
1099 # In this case, we won't even clean it out, for safety's sake.
1100 return "." if $reverse eq "";
1102 $dir = canonpath
($dir);
1103 if ($opts{create
}) {
1107 # We are recalculating the directories we keep track of, but need to save
1108 # away the result for after having moved into the new directory.
1109 my %tmp_directories = ();
1112 # For each of these directory variables, figure out where they are relative
1113 # to the directory we want to move to if they aren't absolute (if they are,
1114 # they don't change!)
1115 my @dirtags = sort keys %directories;
1116 foreach (@dirtags) {
1117 if (!file_name_is_absolute
($directories{$_})) {
1118 my $newpath = abs2rel
(rel2abs
($directories{$_}), rel2abs
($dir));
1119 $tmp_directories{$_} = $newpath;
1123 # Treat each environment variable that was used to get us the values in
1124 # %directories the same was as the paths in %directories, so any sub
1125 # process can use their values properly as well
1127 if (!file_name_is_absolute
($ENV{$_})) {
1128 my $newpath = abs2rel
(rel2abs
($ENV{$_}), rel2abs
($dir));
1129 $tmp_ENV{$_} = $newpath;
1133 # Should we just bail out here as well? I'm unsure.
1134 return undef unless chdir($dir);
1136 # We put back new values carefully. Doing the obvious
1137 # %directories = ( %tmp_directories )
1138 # will clear out any value that happens to be an absolute path
1139 foreach (keys %tmp_directories) {
1140 $directories{$_} = $tmp_directories{$_};
1142 foreach (keys %tmp_ENV) {
1143 $ENV{$_} = $tmp_ENV{$_};
1147 print STDERR
"DEBUG: __cwd(), directories and files:\n";
1148 print STDERR
" \$directories{BLDTEST} = \"$directories{BLDTEST}\"\n";
1149 print STDERR
" \$directories{SRCTEST} = \"$directories{SRCTEST}\"\n";
1150 print STDERR
" \$directories{SRCDATA} = \"$directories{SRCDATA}\"\n";
1151 print STDERR
" \$directories{RESULTS} = \"$directories{RESULTS}\"\n";
1152 print STDERR
" \$directories{BLDAPPS} = \"$directories{BLDAPPS}\"\n";
1153 print STDERR
" \$directories{SRCAPPS} = \"$directories{SRCAPPS}\"\n";
1154 print STDERR
" \$directories{SRCTOP} = \"$directories{SRCTOP}\"\n";
1155 print STDERR
" \$directories{BLDTOP} = \"$directories{BLDTOP}\"\n";
1157 print STDERR
" current directory is \"",curdir
(),"\"\n";
1158 print STDERR
" the way back is \"$reverse\"\n";
1165 # __wrap_cmd CMD, EXE_SHELL
1167 # __wrap_cmd "wraps" CMD (string) with a beginning command that makes sure
1168 # the command gets executed with an appropriate environment. If EXE_SHELL
1169 # is given, it is used as the beginning command.
1171 # __wrap_cmd returns a list that should be used to build up a larger list
1172 # of command tokens, or be joined together like this:
1174 # join(" ", __wrap_cmd($cmd))
1177 my $exe_shell = shift;
1179 my @prefix = ( __bldtop_file
("util", "shlib_wrap.sh") );
1181 if(defined($exe_shell)) {
1182 @prefix = ( $exe_shell );
1183 } elsif ($^O
eq "VMS" || $^O
eq "MSWin32") {
1184 # VMS and Windows don't use any wrapper script for the moment
1188 return (@prefix, $cmd);
1193 # __fixup_prg does whatever fixup is needed to execute an executable binary
1194 # given by PROG (string).
1196 # __fixup_prg returns a string with the possibly prefixed program path spec.
1202 if ($^O
eq "VMS" ) {
1203 $prefix = ($prog =~ /^(?:[\$a-z0-9_]+:)?[<\[]/i ?
"mcr " : "mcr []");
1206 if (defined($prog)) {
1207 # Make sure to quotify the program file on platforms that may
1208 # have spaces or similar in their path name.
1209 # To our knowledge, VMS is the exception where quotifying should
1211 ($prog) = quotify
($prog) unless $^O
eq "VMS";
1212 return $prefix.$prog;
1215 print STDERR
"$prog not found\n";
1219 # __decorate_cmd NUM, CMDARRAYREF
1221 # __decorate_cmd takes a command number NUM and a command token array
1222 # CMDARRAYREF, builds up a command string from them and decorates it
1223 # with necessary redirections.
1224 # __decorate_cmd returns a list of two strings, one with the command
1225 # string to actually be used, the other to be displayed for the user.
1226 # The reason these strings might differ is that we redirect stderr to
1227 # the null device unless we're verbose and unless the user has
1228 # explicitly specified a stderr redirection.
1229 sub __decorate_cmd
{
1230 BAIL_OUT
("Must run setup() first") if (! $test_name);
1236 my $cmdstr = join(" ", @
$cmd);
1237 my $null = devnull
();
1238 my $fileornull = sub { $_[0] ?
$_[0] : $null; };
1242 my $saved_stderr = undef;
1243 $stdin = " < ".$fileornull->($opts{stdin
}) if exists($opts{stdin
});
1244 $stdout= " > ".$fileornull->($opts{stdout
}) if exists($opts{stdout
});
1245 $stderr=" 2> ".$fileornull->($opts{stderr
}) if exists($opts{stderr
});
1247 my $display_cmd = "$cmdstr$stdin$stdout$stderr";
1249 # VMS program output escapes TAP::Parser
1251 $stderr=" 2> ".$null
1252 unless $stderr || !$ENV{HARNESS_ACTIVE
} || $ENV{HARNESS_VERBOSE
};
1255 $cmdstr .= "$stdin$stdout$stderr";
1258 print STDERR
"DEBUG[__decorate_cmd]: \$cmdstr = \"$cmdstr\"\n";
1259 print STDERR
"DEBUG[__decorate_cmd]: \$display_cmd = \"$display_cmd\"\n";
1262 return ($cmdstr, $display_cmd);
1267 L<Test::More>, L<Test::Harness>
1271 Richard Levitte E<lt>levitte@openssl.orgE<gt> with assistance and
1272 inspiration from Andy Polyakov E<lt>appro@openssl.org<gt>.
1276 no warnings
'redefine';
1280 Test
::More
::subtest
@_;