1 # Copyright 2016 The OpenSSL Project Authors. All Rights Reserved.
3 # Licensed under the OpenSSL license (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));
28 OpenSSL::Test - a private extension of Test::More
34 setup("my_test_name");
36 ok(run(app(["openssl", "version"])), "check for openssl presence");
38 indir "subdir" => sub {
39 ok(run(test(["sometest", "arg1"], stdout => "foo.txt")),
40 "run sometest with output to foo.txt");
45 This module is a private extension of L<Test::More> for testing OpenSSL.
46 In addition to the Test::More functions, it also provides functions that
47 easily find the diverse programs within a OpenSSL build tree, as well as
48 some other useful functions.
50 This module I<depends> on the environment variables C<$TOP> or C<$SRCTOP>
51 and C<$BLDTOP>. Without one of the combinations it refuses to work.
52 See L</ENVIRONMENT> below.
54 With each test recipe, a parallel data directory with (almost) the same name
55 as the recipe is possible in the source directory tree. For example, for a
56 recipe C<$SRCTOP/test/recipes/99-foo.t>, there could be a directory
57 C<$SRCTOP/test/recipes/99-foo_data/>.
62 use File::Spec::Functions qw/file_name_is_absolute curdir canonpath splitdir
63 catdir catfile splitpath catpath devnull abs2rel
65 use File::Path 2.00 qw/rmtree mkpath/;
70 # The name of the test. This is set by setup() and is used in the other
71 # functions to verify that setup() has been used.
72 my $test_name = undef;
74 # Directories we want to keep track of TOP, APPS, TEST and RESULTS are the
75 # ones we're interested in, corresponding to the environment variables TOP
76 # (mandatory), BIN_D, TEST_D, UTIL_D and RESULT_D.
79 # The environment variables that gave us the contents in %directories. These
80 # get modified whenever we change directories, so that subprocesses can use
81 # the values of those environment variables as well
84 # A bool saying if we shall stop all testing if the current recipe has failing
85 # tests or not. This is set by setup() if the environment variable STOPTEST
86 # is defined with a non-empty value.
87 my $end_with_bailout = 0;
89 # A set of hooks that is affected by with() and may be used in diverse places.
90 # All hooks are expected to be CODE references.
93 # exit_checker is used by run() directly after completion of a command.
94 # it receives the exit code from that command and is expected to return
95 # 1 (for success) or 0 (for failure). This is the status value that run()
96 # will give back (through the |statusvar| reference and as returned value
97 # when capture => 1 doesn't apply).
98 exit_checker => sub { return shift == 0 ? 1 : 0 },
102 # Debug flag, to be set manually when needed
105 =head2 Main functions
107 The following functions are exported by default when using C<OpenSSL::Test>.
113 =item B<setup "NAME">
115 C<setup> is used for initial setup, and it is mandatory that it's used.
116 If it's not used in a OpenSSL test recipe, the rest of the recipe will
117 most likely refuse to run.
119 C<setup> checks for environment variables (see L</ENVIRONMENT> below),
120 checks that C<$TOP/Configure> or C<$SRCTOP/Configure> exists, C<chdir>
121 into the results directory (defined by the C<$RESULT_D> environment
122 variable if defined, otherwise C<$BLDTOP/test> or C<$TOP/test>, whichever
130 my $old_test_name = $test_name;
133 BAIL_OUT("setup() must receive a name") unless $test_name;
134 warn "setup() detected test name change. Innocuous, so we continue...\n"
135 if $old_test_name && $old_test_name ne $test_name;
137 return if $old_test_name;
139 BAIL_OUT("setup() needs \$TOP or \$SRCTOP and \$BLDTOP to be defined")
140 unless $ENV{TOP} || ($ENV{SRCTOP} && $ENV{BLDTOP});
141 BAIL_OUT("setup() found both \$TOP and \$SRCTOP or \$BLDTOP...")
142 if $ENV{TOP} && ($ENV{SRCTOP} || $ENV{BLDTOP});
146 BAIL_OUT("setup() expects the file Configure in the source top directory")
147 unless -f srctop_file("Configure");
149 __cwd($directories{RESULTS});
154 =item B<indir "SUBDIR" =E<gt> sub BLOCK, OPTS>
156 C<indir> is used to run a part of the recipe in a different directory than
157 the one C<setup> moved into, usually a subdirectory, given by SUBDIR.
158 The part of the recipe that's run there is given by the codeblock BLOCK.
160 C<indir> takes some additional options OPTS that affect the subdirectory:
164 =item B<create =E<gt> 0|1>
166 When set to 1 (or any value that perl preceives as true), the subdirectory
167 will be created if it doesn't already exist. This happens before BLOCK
170 =item B<cleanup =E<gt> 0|1>
172 When set to 1 (or any value that perl preceives as true), the subdirectory
173 will be cleaned out and removed. This happens both before and after BLOCK
181 ok(run(app(["openssl", "version"]), stdout => "foo.txt"));
182 if (ok(open(RESULT, "foo.txt"), "reading foo.txt")) {
185 is($line, qr/^OpenSSL 1\./,
186 "check that we're using OpenSSL 1.x.x");
188 }, create => 1, cleanup => 1;
196 my $codeblock = shift;
199 my $reverse = __cwd($subdir,%opts);
200 BAIL_OUT("FAILURE: indir, \"$subdir\" wasn't possible to move into")
207 if ($opts{cleanup}) {
208 rmtree($subdir, { safe => 0 });
214 =item B<cmd ARRAYREF, OPTS>
216 This functions build up a platform dependent command based on the
217 input. It takes a reference to a list that is the executable or
218 script and its arguments, and some additional options (described
219 further on). Where necessary, the command will be wrapped in a
220 suitable environment to make sure the correct shared libraries are
221 used (currently only on Unix).
223 It returns a CODEREF to be used by C<run>, C<pipe> or C<cmdstr>.
225 The options that C<cmd> can take are in the form of hash values:
229 =item B<stdin =E<gt> PATH>
231 =item B<stdout =E<gt> PATH>
233 =item B<stderr =E<gt> PATH>
235 In all three cases, the corresponding standard input, output or error is
236 redirected from (for stdin) or to (for the others) a file given by the
237 string PATH, I<or>, if the value is C<undef>, C</dev/null> or similar.
241 =item B<app ARRAYREF, OPTS>
243 =item B<test ARRAYREF, OPTS>
245 Both of these are specific applications of C<cmd>, with just a couple
248 C<app> expects to find the given command (the first item in the given list
249 reference) as an executable in C<$BIN_D> (if defined, otherwise C<$TOP/apps>
252 C<test> expects to find the given command (the first item in the given list
253 reference) as an executable in C<$TEST_D> (if defined, otherwise C<$TOP/test>
256 Also, for both C<app> and C<test>, the command may be prefixed with
257 the content of the environment variable C<$EXE_SHELL>, which is useful
258 in case OpenSSL has been cross compiled.
260 =item B<perlapp ARRAYREF, OPTS>
262 =item B<perltest ARRAYREF, OPTS>
264 These are also specific applications of C<cmd>, where the interpreter
265 is predefined to be C<perl>, and they expect the script to be
266 interpreted to reside in the same location as C<app> and C<test>.
268 C<perlapp> and C<perltest> will also take the following option:
272 =item B<interpreter_args =E<gt> ARRAYref>
274 The array reference is a set of arguments for the interpreter rather
275 than the script. Take care so that none of them can be seen as a
276 script! Flags and their eventual arguments only!
282 ok(run(perlapp(["foo.pl", "arg1"],
283 interpreter_args => [ "-I", srctop_dir("test") ])));
289 One might wonder over the complexity of C<apps>, C<fuzz>, C<test>, ...
290 with all the lazy evaluations and all that. The reason for this is that
291 we want to make sure the directory in which those programs are found are
292 correct at the time these commands are used. Consider the following code
295 my $cmd = app(["openssl", ...]);
298 ok(run($cmd), "Testing foo")
301 If there wasn't this lazy evaluation, the directory where C<openssl> is
302 found would be incorrect at the time C<run> is called, because it was
303 calculated before we moved into the directory "foo".
314 # Make a copy to not destroy the caller's array
315 my @cmdargs = ( @$cmd );
316 my @prog = __wrap_cmd(shift @cmdargs, $opts{exe_shell} // ());
318 return __decorate_cmd($num, [ @prog, quotify(@cmdargs) ],
327 my @cmdargs = ( @{$cmd} );
328 my @prog = __fixup_prg(__apps_file(shift @cmdargs, __exeext()));
329 return cmd([ @prog, @cmdargs ],
330 exe_shell => $ENV{EXE_SHELL}, %opts) -> (shift);
338 my @cmdargs = ( @{$cmd} );
339 my @prog = __fixup_prg(__fuzz_file(shift @cmdargs, __exeext()));
340 return cmd([ @prog, @cmdargs ],
341 exe_shell => $ENV{EXE_SHELL}, %opts) -> (shift);
349 my @cmdargs = ( @{$cmd} );
350 my @prog = __fixup_prg(__test_file(shift @cmdargs, __exeext()));
351 return cmd([ @prog, @cmdargs ],
352 exe_shell => $ENV{EXE_SHELL}, %opts) -> (shift);
360 my @interpreter_args = defined $opts{interpreter_args} ?
361 @{$opts{interpreter_args}} : ();
362 my @interpreter = __fixup_prg($^X);
363 my @cmdargs = ( @{$cmd} );
364 my @prog = __apps_file(shift @cmdargs, undef);
365 return cmd([ @interpreter, @interpreter_args,
366 @prog, @cmdargs ], %opts) -> (shift);
374 my @interpreter_args = defined $opts{interpreter_args} ?
375 @{$opts{interpreter_args}} : ();
376 my @interpreter = __fixup_prg($^X);
377 my @cmdargs = ( @{$cmd} );
378 my @prog = __test_file(shift @cmdargs, undef);
379 return cmd([ @interpreter, @interpreter_args,
380 @prog, @cmdargs ], %opts) -> (shift);
386 =item B<run CODEREF, OPTS>
388 CODEREF is expected to be the value return by C<cmd> or any of its
389 derivatives, anything else will most likely cause an error unless you
390 know what you're doing.
392 C<run> executes the command returned by CODEREF and return either the
393 resulting output (if the option C<capture> is set true) or a boolean
394 indicating if the command succeeded or not.
396 The options that C<run> can take are in the form of hash values:
400 =item B<capture =E<gt> 0|1>
402 If true, the command will be executed with a perl backtick, and C<run> will
403 return the resulting output as an array of lines. If false or not given,
404 the command will be executed with C<system()>, and C<run> will return 1 if
405 the command was successful or 0 if it wasn't.
407 =item B<prefix =E<gt> EXPR>
409 If specified, EXPR will be used as a string to prefix the output from the
410 command. This is useful if the output contains lines starting with C<ok >
411 or C<not ok > that can disturb Test::Harness.
413 =item B<statusvar =E<gt> VARREF>
415 If used, B<VARREF> must be a reference to a scalar variable. It will be
416 assigned a boolean indicating if the command succeeded or not. This is
417 particularly useful together with B<capture>.
421 For further discussion on what is considered a successful command or not, see
422 the function C<with> further down.
429 my ($cmd, $display_cmd) = shift->(0);
435 if ( $^O eq "VMS" ) { # VMS
443 die "OpenSSL::Test::run(): statusvar value not a scalar reference"
444 if $opts{statusvar} && ref($opts{statusvar}) ne "SCALAR";
446 # In non-verbose, we want to shut up the command interpreter, in case
447 # it has something to complain about. On VMS, it might complain both
448 # on stdout and stderr
451 if ($ENV{HARNESS_ACTIVE} && !$ENV{HARNESS_VERBOSE}) {
452 open $save_STDOUT, '>&', \*STDOUT or die "Can't dup STDOUT: $!";
453 open $save_STDERR, '>&', \*STDERR or die "Can't dup STDERR: $!";
454 open STDOUT, ">", devnull();
455 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 system("$prefix$cmd");
481 $e = ($? & 0x7f) ? ($? & 0x7f)|0x80 : ($? >> 8);
482 $r = $hooks{exit_checker}->($e);
483 if ($opts{statusvar}) {
484 ${$opts{statusvar}} = $r;
487 if ($ENV{HARNESS_ACTIVE} && !$ENV{HARNESS_VERBOSE}) {
490 open STDOUT, '>&', $save_STDOUT or die "Can't restore STDOUT: $!";
491 open STDERR, '>&', $save_STDERR or die "Can't restore STDERR: $!";
494 print STDERR "$prefix$display_cmd => $e\n"
495 if !$ENV{HARNESS_ACTIVE} || $ENV{HARNESS_VERBOSE};
497 # At this point, $? stops being interesting, and unfortunately,
498 # there are Test::More versions that get picky if we leave it
502 if ($opts{capture}) {
510 my $tb = Test::More->builder;
511 my $failure = scalar(grep { $_ == 0; } $tb->summary);
512 if ($failure && $end_with_bailout) {
513 BAIL_OUT("Stoptest!");
517 =head2 Utility functions
519 The following functions are exported on request when using C<OpenSSL::Test>.
521 # To only get the bldtop_file and srctop_file functions.
522 use OpenSSL::Test qw/bldtop_file srctop_file/;
524 # To only get the bldtop_file function in addition to the default ones.
525 use OpenSSL::Test qw/:DEFAULT bldtop_file/;
529 # Utility functions, exported on request
533 =item B<bldtop_dir LIST>
535 LIST is a list of directories that make up a path from the top of the OpenSSL
536 build directory (as indicated by the environment variable C<$TOP> or
538 C<bldtop_dir> returns the resulting directory as a string, adapted to the local
546 return __bldtop_dir(@_); # This caters for operating systems that have
547 # a very distinct syntax for directories.
552 =item B<bldtop_file LIST, FILENAME>
554 LIST is a list of directories that make up a path from the top of the OpenSSL
555 build directory (as indicated by the environment variable C<$TOP> or
556 C<$BLDTOP>) and FILENAME is the name of a file located in that directory path.
557 C<bldtop_file> returns the resulting file path as a string, adapted to the local
565 return __bldtop_file(@_);
570 =item B<srctop_dir LIST>
572 LIST is a list of directories that make up a path from the top of the OpenSSL
573 source directory (as indicated by the environment variable C<$TOP> or
575 C<srctop_dir> returns the resulting directory as a string, adapted to the local
583 return __srctop_dir(@_); # This caters for operating systems that have
584 # a very distinct syntax for directories.
589 =item B<srctop_file LIST, FILENAME>
591 LIST is a list of directories that make up a path from the top of the OpenSSL
592 source directory (as indicated by the environment variable C<$TOP> or
593 C<$SRCTOP>) and FILENAME is the name of a file located in that directory path.
594 C<srctop_file> returns the resulting file path as a string, adapted to the local
602 return __srctop_file(@_);
607 =item B<data_file LIST, FILENAME>
609 LIST is a list of directories that make up a path from the data directory
610 associated with the test (see L</DESCRIPTION> above) and FILENAME is the name
611 of a file located in that directory path. C<data_file> returns the resulting
612 file path as a string, adapted to the local operating system.
619 return __data_file(@_);
626 LIST is a list of CODEREFs returned by C<app> or C<test>, from which C<pipe>
627 creates a new command composed of all the given commands put together in a
628 pipe. C<pipe> returns a new CODEREF in the same manner as C<app> or C<test>,
629 to be passed to C<run> for execution.
644 my ($c, $dc, @el) = $_->(++$counter);
662 =item B<with HASHREF, CODEREF>
664 C<with> will temporarily install hooks given by the HASHREF and then execute
665 the given CODEREF. Hooks are usually expected to have a coderef as value.
667 The currently available hoosk are:
671 =item B<exit_checker =E<gt> CODEREF>
673 This hook is executed after C<run> has performed its given command. The
674 CODEREF receives the exit code as only argument and is expected to return
675 1 (if the exit code indicated success) or 0 (if the exit code indicated
687 my $codeblock = shift;
689 my %saved_hooks = ();
691 foreach (keys %opts) {
692 $saved_hooks{$_} = $hooks{$_} if exists($hooks{$_});
693 $hooks{$_} = $opts{$_};
698 foreach (keys %saved_hooks) {
699 $hooks{$_} = $saved_hooks{$_};
705 =item B<cmdstr CODEREF, OPTS>
707 C<cmdstr> takes a CODEREF from C<app> or C<test> and simply returns the
710 C<cmdstr> takes some additional options OPTS that affect the string returned:
714 =item B<display =E<gt> 0|1>
716 When set to 0, the returned string will be with all decorations, such as a
717 possible redirect of stderr to the null device. This is suitable if the
718 string is to be used directly in a recipe.
720 When set to 1, the returned string will be without extra decorations. This
721 is suitable for display if that is desired (doesn't confuse people with all
722 internal stuff), or if it's used to pass a command down to a subprocess.
733 my ($cmd, $display_cmd) = shift->(0);
736 if ($opts{display}) {
745 =item B<quotify LIST>
747 LIST is a list of strings that are going to be used as arguments for a
748 command, and makes sure to inject quotes and escapes as necessary depending
749 on the content of each string.
751 This can also be used to put quotes around the executable of a command.
752 I<This must never ever be done on VMS.>
759 # Unix setup (default if nothing else is mentioned)
761 sub { $_ = shift; /\s|[\{\}\\\$\[\]\*\?\|\&:;<>]/ ? "'$_'" : $_ };
763 if ( $^O eq "VMS") { # VMS setup
764 $arg_formatter = sub {
766 if (/\s|["[:upper:]]/) {
773 } elsif ( $^O eq "MSWin32") { # MSWin setup
774 $arg_formatter = sub {
776 if (/\s|["\|\&\*\;<>]/) {
785 return map { $arg_formatter->($_) } @_;
788 ######################################################################
789 # private functions. These are never exported.
793 OpenSSL::Test depends on some environment variables.
799 This environment variable is mandatory. C<setup> will check that it's
800 defined and that it's a directory that contains the file C<Configure>.
801 If this isn't so, C<setup> will C<BAIL_OUT>.
805 If defined, its value should be the directory where the openssl application
806 is located. Defaults to C<$TOP/apps> (adapted to the operating system).
810 If defined, its value should be the directory where the test applications
811 are located. Defaults to C<$TOP/test> (adapted to the operating system).
815 If defined, it puts testing in a different mode, where a recipe with
816 failures will result in a C<BAIL_OUT> at the end of its run.
823 (my $recipe_datadir = basename($0)) =~ s/\.t$/_data/i;
825 $directories{SRCTOP} = $ENV{SRCTOP} || $ENV{TOP};
826 $directories{BLDTOP} = $ENV{BLDTOP} || $ENV{TOP};
827 $directories{BLDAPPS} = $ENV{BIN_D} || __bldtop_dir("apps");
828 $directories{SRCAPPS} = __srctop_dir("apps");
829 $directories{BLDFUZZ} = __bldtop_dir("fuzz");
830 $directories{SRCFUZZ} = __srctop_dir("fuzz");
831 $directories{BLDTEST} = $ENV{TEST_D} || __bldtop_dir("test");
832 $directories{SRCTEST} = __srctop_dir("test");
833 $directories{SRCDATA} = __srctop_dir("test", "recipes",
835 $directories{RESULTS} = $ENV{RESULT_D} || $directories{BLDTEST};
837 push @direnv, "TOP" if $ENV{TOP};
838 push @direnv, "SRCTOP" if $ENV{SRCTOP};
839 push @direnv, "BLDTOP" if $ENV{BLDTOP};
840 push @direnv, "BIN_D" if $ENV{BIN_D};
841 push @direnv, "TEST_D" if $ENV{TEST_D};
842 push @direnv, "RESULT_D" if $ENV{RESULT_D};
844 $end_with_bailout = $ENV{STOPTEST} ? 1 : 0;
847 # __srctop_file and __srctop_dir are helpers to build file and directory
848 # names on top of the source directory. They depend on $SRCTOP, and
849 # therefore on the proper use of setup() and when needed, indir().
850 # __bldtop_file and __bldtop_dir do the same thing but relative to $BLDTOP.
851 # __srctop_file and __bldtop_file take the same kind of argument as
852 # File::Spec::Functions::catfile.
853 # Similarly, __srctop_dir and __bldtop_dir take the same kind of argument
854 # as File::Spec::Functions::catdir
856 BAIL_OUT("Must run setup() first") if (! $test_name);
859 return catfile($directories{SRCTOP},@_,$f);
863 BAIL_OUT("Must run setup() first") if (! $test_name);
865 return catdir($directories{SRCTOP},@_);
869 BAIL_OUT("Must run setup() first") if (! $test_name);
872 return catfile($directories{BLDTOP},@_,$f);
876 BAIL_OUT("Must run setup() first") if (! $test_name);
878 return catdir($directories{BLDTOP},@_);
881 # __exeext is a function that returns the platform dependent file extension
882 # for executable binaries, or the value of the environment variable $EXE_EXT
883 # if that one is defined.
886 if ($^O eq "VMS" ) { # VMS
888 } elsif ($^O eq "MSWin32") { # Windows
891 return $ENV{"EXE_EXT"} || $ext;
894 # __test_file, __apps_file and __fuzz_file return the full path to a file
895 # relative to the test/, apps/ or fuzz/ directory in the build tree or the
896 # source tree, depending on where the file is found. Note that when looking
897 # in the build tree, the file name with an added extension is looked for, if
898 # an extension is given. The intent is to look for executable binaries (in
899 # the build tree) or possibly scripts (in the source tree).
900 # These functions all take the same arguments as File::Spec::Functions::catfile,
901 # *plus* a mandatory extension argument. This extension argument can be undef,
902 # and is ignored in such a case.
904 BAIL_OUT("Must run setup() first") if (! $test_name);
908 my $out = catfile($directories{BLDTEST},@_,$f . $e);
909 $out = catfile($directories{SRCTEST},@_,$f) unless -f $out;
914 BAIL_OUT("Must run setup() first") if (! $test_name);
918 my $out = catfile($directories{BLDAPPS},@_,$f . $e);
919 $out = catfile($directories{SRCAPPS},@_,$f) unless -f $out;
924 BAIL_OUT("Must run setup() first") if (! $test_name);
928 my $out = catfile($directories{BLDFUZZ},@_,$f . $e);
929 $out = catfile($directories{SRCFUZZ},@_,$f) unless -f $out;
934 BAIL_OUT("Must run setup() first") if (! $test_name);
937 return catfile($directories{SRCDATA},@_,$f);
941 BAIL_OUT("Must run setup() first") if (! $test_name);
944 return catfile($directories{RESULTS},@_,$f);
950 # __cwd changes directory to DIR (string) and changes all the relative
951 # entries in %directories accordingly. OPTS is an optional series of
952 # hash style arguments to alter __cwd's behavior:
954 # create = 0|1 The directory we move to is created if 1, not if 0.
955 # cleanup = 0|1 The directory we move from is removed if 1, not if 0.
958 my $dir = catdir(shift);
960 my $abscurdir = rel2abs(curdir());
961 my $absdir = rel2abs($dir);
962 my $reverse = abs2rel($abscurdir, $absdir);
964 # PARANOIA: if we're not moving anywhere, we do nothing more
965 if ($abscurdir eq $absdir) {
969 # Do not support a move to a different volume for now. Maybe later.
970 BAIL_OUT("FAILURE: \"$dir\" moves to a different volume, not supported")
971 if $reverse eq $abscurdir;
973 # If someone happened to give a directory that leads back to the current,
974 # it's extremely silly to do anything more, so just simulate that we did
976 # In this case, we won't even clean it out, for safety's sake.
977 return "." if $reverse eq "";
979 $dir = canonpath($dir);
984 # We are recalculating the directories we keep track of, but need to save
985 # away the result for after having moved into the new directory.
986 my %tmp_directories = ();
989 # For each of these directory variables, figure out where they are relative
990 # to the directory we want to move to if they aren't absolute (if they are,
991 # they don't change!)
992 my @dirtags = sort keys %directories;
994 if (!file_name_is_absolute($directories{$_})) {
995 my $newpath = abs2rel(rel2abs($directories{$_}), rel2abs($dir));
996 $tmp_directories{$_} = $newpath;
1000 # Treat each environment variable that was used to get us the values in
1001 # %directories the same was as the paths in %directories, so any sub
1002 # process can use their values properly as well
1004 if (!file_name_is_absolute($ENV{$_})) {
1005 my $newpath = abs2rel(rel2abs($ENV{$_}), rel2abs($dir));
1006 $tmp_ENV{$_} = $newpath;
1010 # Should we just bail out here as well? I'm unsure.
1011 return undef unless chdir($dir);
1013 if ($opts{cleanup}) {
1014 rmtree(".", { safe => 0, keep_root => 1 });
1017 # We put back new values carefully. Doing the obvious
1018 # %directories = ( %tmp_directories )
1019 # will clear out any value that happens to be an absolute path
1020 foreach (keys %tmp_directories) {
1021 $directories{$_} = $tmp_directories{$_};
1023 foreach (keys %tmp_ENV) {
1024 $ENV{$_} = $tmp_ENV{$_};
1028 print STDERR "DEBUG: __cwd(), directories and files:\n";
1029 print STDERR " \$directories{BLDTEST} = \"$directories{BLDTEST}\"\n";
1030 print STDERR " \$directories{SRCTEST} = \"$directories{SRCTEST}\"\n";
1031 print STDERR " \$directories{SRCDATA} = \"$directories{SRCDATA}\"\n";
1032 print STDERR " \$directories{RESULTS} = \"$directories{RESULTS}\"\n";
1033 print STDERR " \$directories{BLDAPPS} = \"$directories{BLDAPPS}\"\n";
1034 print STDERR " \$directories{SRCAPPS} = \"$directories{SRCAPPS}\"\n";
1035 print STDERR " \$directories{SRCTOP} = \"$directories{SRCTOP}\"\n";
1036 print STDERR " \$directories{BLDTOP} = \"$directories{BLDTOP}\"\n";
1038 print STDERR " current directory is \"",curdir(),"\"\n";
1039 print STDERR " the way back is \"$reverse\"\n";
1046 # __wrap_cmd CMD, EXE_SHELL
1048 # __wrap_cmd "wraps" CMD (string) with a beginning command that makes sure
1049 # the command gets executed with an appropriate environment. If EXE_SHELL
1050 # is given, it is used as the beginning command.
1052 # __wrap_cmd returns a list that should be used to build up a larger list
1053 # of command tokens, or be joined together like this:
1055 # join(" ", __wrap_cmd($cmd))
1058 my $exe_shell = shift;
1060 my @prefix = ( __bldtop_file("util", "shlib_wrap.sh") );
1062 if(defined($exe_shell)) {
1063 @prefix = ( $exe_shell );
1064 } elsif ($^O eq "VMS" || $^O eq "MSWin32") {
1065 # VMS and Windows don't use any wrapper script for the moment
1069 return (@prefix, $cmd);
1074 # __fixup_prg does whatever fixup is needed to execute an executable binary
1075 # given by PROG (string).
1077 # __fixup_prg returns a string with the possibly prefixed program path spec.
1083 if ($^O eq "VMS" ) {
1084 $prefix = ($prog =~ /^(?:[\$a-z0-9_]+:)?[<\[]/i ? "mcr " : "mcr []");
1087 if (defined($prog)) {
1088 # Make sure to quotify the program file on platforms that may
1089 # have spaces or similar in their path name.
1090 # To our knowledge, VMS is the exception where quotifying should
1092 ($prog) = quotify($prog) unless $^O eq "VMS";
1093 return $prefix.$prog;
1096 print STDERR "$prog not found\n";
1100 # __decorate_cmd NUM, CMDARRAYREF
1102 # __decorate_cmd takes a command number NUM and a command token array
1103 # CMDARRAYREF, builds up a command string from them and decorates it
1104 # with necessary redirections.
1105 # __decorate_cmd returns a list of two strings, one with the command
1106 # string to actually be used, the other to be displayed for the user.
1107 # The reason these strings might differ is that we redirect stderr to
1108 # the null device unless we're verbose and unless the user has
1109 # explicitly specified a stderr redirection.
1110 sub __decorate_cmd {
1111 BAIL_OUT("Must run setup() first") if (! $test_name);
1117 my $cmdstr = join(" ", @$cmd);
1118 my $null = devnull();
1119 my $fileornull = sub { $_[0] ? $_[0] : $null; };
1123 my $saved_stderr = undef;
1124 $stdin = " < ".$fileornull->($opts{stdin}) if exists($opts{stdin});
1125 $stdout= " > ".$fileornull->($opts{stdout}) if exists($opts{stdout});
1126 $stderr=" 2> ".$fileornull->($opts{stderr}) if exists($opts{stderr});
1128 my $display_cmd = "$cmdstr$stdin$stdout$stderr";
1130 $stderr=" 2> ".$null
1131 unless $stderr || !$ENV{HARNESS_ACTIVE} || $ENV{HARNESS_VERBOSE};
1133 $cmdstr .= "$stdin$stdout$stderr";
1136 print STDERR "DEBUG[__decorate_cmd]: \$cmdstr = \"$cmdstr\"\n";
1137 print STDERR "DEBUG[__decorate_cmd]: \$display_cmd = \"$display_cmd\"\n";
1140 return ($cmdstr, $display_cmd);
1145 L<Test::More>, L<Test::Harness>
1149 Richard Levitte E<lt>levitte@openssl.orgE<gt> with assistance and
1150 inspiration from Andy Polyakov E<lt>appro@openssl.org<gt>.
1154 no warnings 'redefine';
1158 Test::More::subtest @_;