1 # Copyright 2016-2018 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
29 OpenSSL::Test - a private extension of Test::More
35 setup("my_test_name");
37 ok(run(app(["openssl", "version"])), "check for openssl presence");
39 indir "subdir" => sub {
40 ok(run(test(["sometest", "arg1"], stdout => "foo.txt")),
41 "run sometest with output to foo.txt");
46 This module is a private extension of L<Test::More> for testing OpenSSL.
47 In addition to the Test::More functions, it also provides functions that
48 easily find the diverse programs within a OpenSSL build tree, as well as
49 some other useful functions.
51 This module I<depends> on the environment variables C<$TOP> or C<$SRCTOP>
52 and C<$BLDTOP>. Without one of the combinations it refuses to work.
53 See L</ENVIRONMENT> below.
55 With each test recipe, a parallel data directory with (almost) the same name
56 as the recipe is possible in the source directory tree. For example, for a
57 recipe C<$SRCTOP/test/recipes/99-foo.t>, there could be a directory
58 C<$SRCTOP/test/recipes/99-foo_data/>.
63 use File
::Spec
::Functions qw
/file_name_is_absolute curdir canonpath splitdir
64 catdir catfile splitpath catpath devnull abs2rel
66 use File
::Path
2.00 qw
/rmtree mkpath/;
71 # The name of the test. This is set by setup() and is used in the other
72 # functions to verify that setup() has been used.
73 my $test_name = undef;
75 # Directories we want to keep track of TOP, APPS, TEST and RESULTS are the
76 # ones we're interested in, corresponding to the environment variables TOP
77 # (mandatory), BIN_D, TEST_D, UTIL_D and RESULT_D.
80 # The environment variables that gave us the contents in %directories. These
81 # get modified whenever we change directories, so that subprocesses can use
82 # the values of those environment variables as well
85 # A bool saying if we shall stop all testing if the current recipe has failing
86 # tests or not. This is set by setup() if the environment variable STOPTEST
87 # is defined with a non-empty value.
88 my $end_with_bailout = 0;
90 # A set of hooks that is affected by with() and may be used in diverse places.
91 # All hooks are expected to be CODE references.
94 # exit_checker is used by run() directly after completion of a command.
95 # it receives the exit code from that command and is expected to return
96 # 1 (for success) or 0 (for failure). This is the status value that run()
97 # will give back (through the |statusvar| reference and as returned value
98 # when capture => 1 doesn't apply).
99 exit_checker
=> sub { return shift == 0 ?
1 : 0 },
103 # Debug flag, to be set manually when needed
106 =head2 Main functions
108 The following functions are exported by default when using C<OpenSSL::Test>.
114 =item B<setup "NAME">
116 C<setup> is used for initial setup, and it is mandatory that it's used.
117 If it's not used in a OpenSSL test recipe, the rest of the recipe will
118 most likely refuse to run.
120 C<setup> checks for environment variables (see L</ENVIRONMENT> below),
121 checks that C<$TOP/Configure> or C<$SRCTOP/Configure> exists, C<chdir>
122 into the results directory (defined by the C<$RESULT_D> environment
123 variable if defined, otherwise C<$BLDTOP/test> or C<$TOP/test>, whichever
131 my $old_test_name = $test_name;
134 BAIL_OUT
("setup() must receive a name") unless $test_name;
135 warn "setup() detected test name change. Innocuous, so we continue...\n"
136 if $old_test_name && $old_test_name ne $test_name;
138 return if $old_test_name;
140 BAIL_OUT
("setup() needs \$TOP or \$SRCTOP and \$BLDTOP to be defined")
141 unless $ENV{TOP
} || ($ENV{SRCTOP
} && $ENV{BLDTOP
});
142 BAIL_OUT
("setup() found both \$TOP and \$SRCTOP or \$BLDTOP...")
143 if $ENV{TOP
} && ($ENV{SRCTOP
} || $ENV{BLDTOP
});
147 BAIL_OUT
("setup() expects the file Configure in the source top directory")
148 unless -f srctop_file
("Configure");
150 __cwd
($directories{RESULTS
});
155 =item B<indir "SUBDIR" =E<gt> sub BLOCK, OPTS>
157 C<indir> is used to run a part of the recipe in a different directory than
158 the one C<setup> moved into, usually a subdirectory, given by SUBDIR.
159 The part of the recipe that's run there is given by the codeblock BLOCK.
161 C<indir> takes some additional options OPTS that affect the subdirectory:
165 =item B<create =E<gt> 0|1>
167 When set to 1 (or any value that perl preceives as true), the subdirectory
168 will be created if it doesn't already exist. This happens before BLOCK
171 =item B<cleanup =E<gt> 0|1>
173 When set to 1 (or any value that perl preceives as true), the subdirectory
174 will be cleaned out and removed. This happens both before and after BLOCK
182 ok(run(app(["openssl", "version"]), stdout => "foo.txt"));
183 if (ok(open(RESULT, "foo.txt"), "reading foo.txt")) {
186 is($line, qr/^OpenSSL 1\./,
187 "check that we're using OpenSSL 1.x.x");
189 }, create => 1, cleanup => 1;
197 my $codeblock = shift;
200 my $reverse = __cwd
($subdir,%opts);
201 BAIL_OUT
("FAILURE: indir, \"$subdir\" wasn't possible to move into")
208 if ($opts{cleanup
}) {
209 rmtree
($subdir, { safe
=> 0 });
215 =item B<cmd ARRAYREF, OPTS>
217 This functions build up a platform dependent command based on the
218 input. It takes a reference to a list that is the executable or
219 script and its arguments, and some additional options (described
220 further on). Where necessary, the command will be wrapped in a
221 suitable environment to make sure the correct shared libraries are
222 used (currently only on Unix).
224 It returns a CODEREF to be used by C<run>, C<pipe> or C<cmdstr>.
226 The options that C<cmd> can take are in the form of hash values:
230 =item B<stdin =E<gt> PATH>
232 =item B<stdout =E<gt> PATH>
234 =item B<stderr =E<gt> PATH>
236 In all three cases, the corresponding standard input, output or error is
237 redirected from (for stdin) or to (for the others) a file given by the
238 string PATH, I<or>, if the value is C<undef>, C</dev/null> or similar.
242 =item B<app ARRAYREF, OPTS>
244 =item B<test ARRAYREF, OPTS>
246 Both of these are specific applications of C<cmd>, with just a couple
249 C<app> expects to find the given command (the first item in the given list
250 reference) as an executable in C<$BIN_D> (if defined, otherwise C<$TOP/apps>
253 C<test> expects to find the given command (the first item in the given list
254 reference) as an executable in C<$TEST_D> (if defined, otherwise C<$TOP/test>
257 Also, for both C<app> and C<test>, the command may be prefixed with
258 the content of the environment variable C<$EXE_SHELL>, which is useful
259 in case OpenSSL has been cross compiled.
261 =item B<perlapp ARRAYREF, OPTS>
263 =item B<perltest ARRAYREF, OPTS>
265 These are also specific applications of C<cmd>, where the interpreter
266 is predefined to be C<perl>, and they expect the script to be
267 interpreted to reside in the same location as C<app> and C<test>.
269 C<perlapp> and C<perltest> will also take the following option:
273 =item B<interpreter_args =E<gt> ARRAYref>
275 The array reference is a set of arguments for the interpreter rather
276 than the script. Take care so that none of them can be seen as a
277 script! Flags and their eventual arguments only!
283 ok(run(perlapp(["foo.pl", "arg1"],
284 interpreter_args => [ "-I", srctop_dir("test") ])));
290 One might wonder over the complexity of C<apps>, C<fuzz>, C<test>, ...
291 with all the lazy evaluations and all that. The reason for this is that
292 we want to make sure the directory in which those programs are found are
293 correct at the time these commands are used. Consider the following code
296 my $cmd = app(["openssl", ...]);
299 ok(run($cmd), "Testing foo")
302 If there wasn't this lazy evaluation, the directory where C<openssl> is
303 found would be incorrect at the time C<run> is called, because it was
304 calculated before we moved into the directory "foo".
315 # Make a copy to not destroy the caller's array
316 my @cmdargs = ( @
$cmd );
317 my @prog = __wrap_cmd
(shift @cmdargs, $opts{exe_shell
} // ());
319 return __decorate_cmd
($num, [ @prog, quotify
(@cmdargs) ],
328 my @cmdargs = ( @
{$cmd} );
329 my @prog = __fixup_prg
(__apps_file
(shift @cmdargs, __exeext
()));
330 return cmd
([ @prog, @cmdargs ],
331 exe_shell
=> $ENV{EXE_SHELL
}, %opts) -> (shift);
339 my @cmdargs = ( @
{$cmd} );
340 my @prog = __fixup_prg
(__fuzz_file
(shift @cmdargs, __exeext
()));
341 return cmd
([ @prog, @cmdargs ],
342 exe_shell
=> $ENV{EXE_SHELL
}, %opts) -> (shift);
350 my @cmdargs = ( @
{$cmd} );
351 my @prog = __fixup_prg
(__test_file
(shift @cmdargs, __exeext
()));
352 return cmd
([ @prog, @cmdargs ],
353 exe_shell
=> $ENV{EXE_SHELL
}, %opts) -> (shift);
361 my @interpreter_args = defined $opts{interpreter_args
} ?
362 @
{$opts{interpreter_args
}} : ();
363 my @interpreter = __fixup_prg
($^X
);
364 my @cmdargs = ( @
{$cmd} );
365 my @prog = __apps_file
(shift @cmdargs, undef);
366 return cmd
([ @interpreter, @interpreter_args,
367 @prog, @cmdargs ], %opts) -> (shift);
375 my @interpreter_args = defined $opts{interpreter_args
} ?
376 @
{$opts{interpreter_args
}} : ();
377 my @interpreter = __fixup_prg
($^X
);
378 my @cmdargs = ( @
{$cmd} );
379 my @prog = __test_file
(shift @cmdargs, undef);
380 return cmd
([ @interpreter, @interpreter_args,
381 @prog, @cmdargs ], %opts) -> (shift);
387 =item B<run CODEREF, OPTS>
389 CODEREF is expected to be the value return by C<cmd> or any of its
390 derivatives, anything else will most likely cause an error unless you
391 know what you're doing.
393 C<run> executes the command returned by CODEREF and return either the
394 resulting output (if the option C<capture> is set true) or a boolean
395 indicating if the command succeeded or not.
397 The options that C<run> can take are in the form of hash values:
401 =item B<capture =E<gt> 0|1>
403 If true, the command will be executed with a perl backtick, and C<run> will
404 return the resulting output as an array of lines. If false or not given,
405 the command will be executed with C<system()>, and C<run> will return 1 if
406 the command was successful or 0 if it wasn't.
408 =item B<prefix =E<gt> EXPR>
410 If specified, EXPR will be used as a string to prefix the output from the
411 command. This is useful if the output contains lines starting with C<ok >
412 or C<not ok > that can disturb Test::Harness.
414 =item B<statusvar =E<gt> VARREF>
416 If used, B<VARREF> must be a reference to a scalar variable. It will be
417 assigned a boolean indicating if the command succeeded or not. This is
418 particularly useful together with B<capture>.
422 For further discussion on what is considered a successful command or not, see
423 the function C<with> further down.
430 my ($cmd, $display_cmd) = shift->(0);
436 if ( $^O
eq "VMS" ) { # VMS
444 die "OpenSSL::Test::run(): statusvar value not a scalar reference"
445 if $opts{statusvar
} && ref($opts{statusvar
}) ne "SCALAR";
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
452 if ($ENV{HARNESS_ACTIVE
} && !$ENV{HARNESS_VERBOSE
}) {
453 open $save_STDOUT, '>&', \
*STDOUT
or die "Can't dup STDOUT: $!";
454 open $save_STDERR, '>&', \
*STDERR
or die "Can't dup STDERR: $!";
455 open STDOUT
, ">", devnull
();
456 open STDERR
, ">", devnull
();
459 $ENV{HARNESS_OSSL_LEVEL
} = $level + 1;
461 # The dance we do with $? is the same dance the Unix shells appear to
462 # do. For example, a program that gets aborted (and therefore signals
463 # SIGABRT = 6) will appear to exit with the code 134. We mimic this
464 # to make it easier to compare with a manual run of the command.
465 if ($opts{capture
} || defined($opts{prefix
})) {
469 open($pipe, '-|', "$prefix$cmd") or die "Can't start command: $!";
471 my $l = ($opts{prefix
} // "") . $_;
472 if ($opts{capture
}) {
480 $ENV{HARNESS_OSSL_PREFIX
} = "# ";
481 system("$prefix$cmd");
482 delete $ENV{HARNESS_OSSL_PREFIX
};
484 $e = ($?
& 0x7f) ?
($?
& 0x7f)|0x80 : ($?
>> 8);
485 $r = $hooks{exit_checker
}->($e);
486 if ($opts{statusvar
}) {
487 ${$opts{statusvar
}} = $r;
490 if ($ENV{HARNESS_ACTIVE
} && !$ENV{HARNESS_VERBOSE
}) {
493 open STDOUT
, '>&', $save_STDOUT or die "Can't restore STDOUT: $!";
494 open STDERR
, '>&', $save_STDERR or die "Can't restore STDERR: $!";
497 print STDERR
"$prefix$display_cmd => $e\n"
498 if !$ENV{HARNESS_ACTIVE
} || $ENV{HARNESS_VERBOSE
};
500 # At this point, $? stops being interesting, and unfortunately,
501 # there are Test::More versions that get picky if we leave it
505 if ($opts{capture
}) {
513 my $tb = Test
::More
->builder;
514 my $failure = scalar(grep { $_ == 0; } $tb->summary);
515 if ($failure && $end_with_bailout) {
516 BAIL_OUT
("Stoptest!");
520 =head2 Utility functions
522 The following functions are exported on request when using C<OpenSSL::Test>.
524 # To only get the bldtop_file and srctop_file functions.
525 use OpenSSL::Test qw/bldtop_file srctop_file/;
527 # To only get the bldtop_file function in addition to the default ones.
528 use OpenSSL::Test qw/:DEFAULT bldtop_file/;
532 # Utility functions, exported on request
536 =item B<bldtop_dir LIST>
538 LIST is a list of directories that make up a path from the top of the OpenSSL
539 build directory (as indicated by the environment variable C<$TOP> or
541 C<bldtop_dir> returns the resulting directory as a string, adapted to the local
549 return __bldtop_dir
(@_); # This caters for operating systems that have
550 # a very distinct syntax for directories.
555 =item B<bldtop_file LIST, FILENAME>
557 LIST is a list of directories that make up a path from the top of the OpenSSL
558 build directory (as indicated by the environment variable C<$TOP> or
559 C<$BLDTOP>) and FILENAME is the name of a file located in that directory path.
560 C<bldtop_file> returns the resulting file path as a string, adapted to the local
568 return __bldtop_file
(@_);
573 =item B<srctop_dir LIST>
575 LIST is a list of directories that make up a path from the top of the OpenSSL
576 source directory (as indicated by the environment variable C<$TOP> or
578 C<srctop_dir> returns the resulting directory as a string, adapted to the local
586 return __srctop_dir
(@_); # This caters for operating systems that have
587 # a very distinct syntax for directories.
592 =item B<srctop_file LIST, FILENAME>
594 LIST is a list of directories that make up a path from the top of the OpenSSL
595 source directory (as indicated by the environment variable C<$TOP> or
596 C<$SRCTOP>) and FILENAME is the name of a file located in that directory path.
597 C<srctop_file> returns the resulting file path as a string, adapted to the local
605 return __srctop_file
(@_);
610 =item B<data_dir LIST>
612 LIST is a list of directories that make up a path from the data directory
613 associated with the test (see L</DESCRIPTION> above).
614 C<data_dir> returns the resulting directory as a string, adapted to the local
622 return __data_dir
(@_);
627 =item B<data_file LIST, FILENAME>
629 LIST is a list of directories that make up a path from the data directory
630 associated with the test (see L</DESCRIPTION> above) and FILENAME is the name
631 of a file located in that directory path. C<data_file> returns the resulting
632 file path as a string, adapted to the local operating system.
639 return __data_file
(@_);
646 LIST is a list of CODEREFs returned by C<app> or C<test>, from which C<pipe>
647 creates a new command composed of all the given commands put together in a
648 pipe. C<pipe> returns a new CODEREF in the same manner as C<app> or C<test>,
649 to be passed to C<run> for execution.
664 my ($c, $dc, @el) = $_->(++$counter);
682 =item B<with HASHREF, CODEREF>
684 C<with> will temporarily install hooks given by the HASHREF and then execute
685 the given CODEREF. Hooks are usually expected to have a coderef as value.
687 The currently available hoosk are:
691 =item B<exit_checker =E<gt> CODEREF>
693 This hook is executed after C<run> has performed its given command. The
694 CODEREF receives the exit code as only argument and is expected to return
695 1 (if the exit code indicated success) or 0 (if the exit code indicated
707 my $codeblock = shift;
709 my %saved_hooks = ();
711 foreach (keys %opts) {
712 $saved_hooks{$_} = $hooks{$_} if exists($hooks{$_});
713 $hooks{$_} = $opts{$_};
718 foreach (keys %saved_hooks) {
719 $hooks{$_} = $saved_hooks{$_};
725 =item B<cmdstr CODEREF, OPTS>
727 C<cmdstr> takes a CODEREF from C<app> or C<test> and simply returns the
730 C<cmdstr> takes some additional options OPTS that affect the string returned:
734 =item B<display =E<gt> 0|1>
736 When set to 0, the returned string will be with all decorations, such as a
737 possible redirect of stderr to the null device. This is suitable if the
738 string is to be used directly in a recipe.
740 When set to 1, the returned string will be without extra decorations. This
741 is suitable for display if that is desired (doesn't confuse people with all
742 internal stuff), or if it's used to pass a command down to a subprocess.
753 my ($cmd, $display_cmd) = shift->(0);
756 if ($opts{display
}) {
765 =item B<quotify LIST>
767 LIST is a list of strings that are going to be used as arguments for a
768 command, and makes sure to inject quotes and escapes as necessary depending
769 on the content of each string.
771 This can also be used to put quotes around the executable of a command.
772 I<This must never ever be done on VMS.>
779 # Unix setup (default if nothing else is mentioned)
782 ($_ eq '' || /\s|[\{\}\\\$\[\]\*\?\|\&:;<>]/) ?
"'$_'" : $_ };
784 if ( $^O
eq "VMS") { # VMS setup
785 $arg_formatter = sub {
787 if ($_ eq '' || /\s|["[:upper:]]/) {
794 } elsif ( $^O
eq "MSWin32") { # MSWin setup
795 $arg_formatter = sub {
797 if ($_ eq '' || /\s|["\|\&\*\;<>]/) {
806 return map { $arg_formatter->($_) } @_;
811 =item B<openssl_versions>
813 Returns a list of two version numbers, the first representing the build
814 version, the second representing the library version. See opensslv.h for
815 more information on those numbers.
822 sub openssl_versions
{
828 run
(test
(['versions']), capture
=> 1);
829 @versions = ( $lines{'Build version'}, $lines{'Library version'} );
834 ######################################################################
835 # private functions. These are never exported.
839 OpenSSL::Test depends on some environment variables.
845 This environment variable is mandatory. C<setup> will check that it's
846 defined and that it's a directory that contains the file C<Configure>.
847 If this isn't so, C<setup> will C<BAIL_OUT>.
851 If defined, its value should be the directory where the openssl application
852 is located. Defaults to C<$TOP/apps> (adapted to the operating system).
856 If defined, its value should be the directory where the test applications
857 are located. Defaults to C<$TOP/test> (adapted to the operating system).
861 If defined, it puts testing in a different mode, where a recipe with
862 failures will result in a C<BAIL_OUT> at the end of its run.
869 (my $recipe_datadir = basename
($0)) =~ s/\.t$/_data/i;
871 $directories{SRCTOP
} = $ENV{SRCTOP
} || $ENV{TOP
};
872 $directories{BLDTOP
} = $ENV{BLDTOP
} || $ENV{TOP
};
873 $directories{BLDAPPS
} = $ENV{BIN_D
} || __bldtop_dir
("apps");
874 $directories{SRCAPPS
} = __srctop_dir
("apps");
875 $directories{BLDFUZZ
} = __bldtop_dir
("fuzz");
876 $directories{SRCFUZZ
} = __srctop_dir
("fuzz");
877 $directories{BLDTEST
} = $ENV{TEST_D
} || __bldtop_dir
("test");
878 $directories{SRCTEST
} = __srctop_dir
("test");
879 $directories{SRCDATA
} = __srctop_dir
("test", "recipes",
881 $directories{RESULTS
} = $ENV{RESULT_D
} || $directories{BLDTEST
};
883 push @direnv, "TOP" if $ENV{TOP
};
884 push @direnv, "SRCTOP" if $ENV{SRCTOP
};
885 push @direnv, "BLDTOP" if $ENV{BLDTOP
};
886 push @direnv, "BIN_D" if $ENV{BIN_D
};
887 push @direnv, "TEST_D" if $ENV{TEST_D
};
888 push @direnv, "RESULT_D" if $ENV{RESULT_D
};
890 $end_with_bailout = $ENV{STOPTEST
} ?
1 : 0;
893 # __srctop_file and __srctop_dir are helpers to build file and directory
894 # names on top of the source directory. They depend on $SRCTOP, and
895 # therefore on the proper use of setup() and when needed, indir().
896 # __bldtop_file and __bldtop_dir do the same thing but relative to $BLDTOP.
897 # __srctop_file and __bldtop_file take the same kind of argument as
898 # File::Spec::Functions::catfile.
899 # Similarly, __srctop_dir and __bldtop_dir take the same kind of argument
900 # as File::Spec::Functions::catdir
902 BAIL_OUT
("Must run setup() first") if (! $test_name);
905 return catfile
($directories{SRCTOP
},@_,$f);
909 BAIL_OUT
("Must run setup() first") if (! $test_name);
911 return catdir
($directories{SRCTOP
},@_);
915 BAIL_OUT
("Must run setup() first") if (! $test_name);
918 return catfile
($directories{BLDTOP
},@_,$f);
922 BAIL_OUT
("Must run setup() first") if (! $test_name);
924 return catdir
($directories{BLDTOP
},@_);
927 # __exeext is a function that returns the platform dependent file extension
928 # for executable binaries, or the value of the environment variable $EXE_EXT
929 # if that one is defined.
932 if ($^O
eq "VMS" ) { # VMS
934 } elsif ($^O
eq "MSWin32") { # Windows
937 return $ENV{"EXE_EXT"} || $ext;
940 # __test_file, __apps_file and __fuzz_file return the full path to a file
941 # relative to the test/, apps/ or fuzz/ directory in the build tree or the
942 # source tree, depending on where the file is found. Note that when looking
943 # in the build tree, the file name with an added extension is looked for, if
944 # an extension is given. The intent is to look for executable binaries (in
945 # the build tree) or possibly scripts (in the source tree).
946 # These functions all take the same arguments as File::Spec::Functions::catfile,
947 # *plus* a mandatory extension argument. This extension argument can be undef,
948 # and is ignored in such a case.
950 BAIL_OUT
("Must run setup() first") if (! $test_name);
954 my $out = catfile
($directories{BLDTEST
},@_,$f . $e);
955 $out = catfile
($directories{SRCTEST
},@_,$f) unless -f
$out;
960 BAIL_OUT
("Must run setup() first") if (! $test_name);
964 my $out = catfile
($directories{BLDAPPS
},@_,$f . $e);
965 $out = catfile
($directories{SRCAPPS
},@_,$f) unless -f
$out;
970 BAIL_OUT
("Must run setup() first") if (! $test_name);
974 my $out = catfile
($directories{BLDFUZZ
},@_,$f . $e);
975 $out = catfile
($directories{SRCFUZZ
},@_,$f) unless -f
$out;
980 BAIL_OUT
("Must run setup() first") if (! $test_name);
983 return catfile
($directories{SRCDATA
},@_,$f);
987 BAIL_OUT
("Must run setup() first") if (! $test_name);
989 return catdir
($directories{SRCDATA
},@_);
993 BAIL_OUT
("Must run setup() first") if (! $test_name);
996 return catfile
($directories{RESULTS
},@_,$f);
1002 # __cwd changes directory to DIR (string) and changes all the relative
1003 # entries in %directories accordingly. OPTS is an optional series of
1004 # hash style arguments to alter __cwd's behavior:
1006 # create = 0|1 The directory we move to is created if 1, not if 0.
1007 # cleanup = 0|1 The directory we move from is removed if 1, not if 0.
1010 my $dir = catdir
(shift);
1012 my $abscurdir = rel2abs
(curdir
());
1013 my $absdir = rel2abs
($dir);
1014 my $reverse = abs2rel
($abscurdir, $absdir);
1016 # PARANOIA: if we're not moving anywhere, we do nothing more
1017 if ($abscurdir eq $absdir) {
1021 # Do not support a move to a different volume for now. Maybe later.
1022 BAIL_OUT
("FAILURE: \"$dir\" moves to a different volume, not supported")
1023 if $reverse eq $abscurdir;
1025 # If someone happened to give a directory that leads back to the current,
1026 # it's extremely silly to do anything more, so just simulate that we did
1028 # In this case, we won't even clean it out, for safety's sake.
1029 return "." if $reverse eq "";
1031 $dir = canonpath
($dir);
1032 if ($opts{create
}) {
1036 # We are recalculating the directories we keep track of, but need to save
1037 # away the result for after having moved into the new directory.
1038 my %tmp_directories = ();
1041 # For each of these directory variables, figure out where they are relative
1042 # to the directory we want to move to if they aren't absolute (if they are,
1043 # they don't change!)
1044 my @dirtags = sort keys %directories;
1045 foreach (@dirtags) {
1046 if (!file_name_is_absolute
($directories{$_})) {
1047 my $newpath = abs2rel
(rel2abs
($directories{$_}), rel2abs
($dir));
1048 $tmp_directories{$_} = $newpath;
1052 # Treat each environment variable that was used to get us the values in
1053 # %directories the same was as the paths in %directories, so any sub
1054 # process can use their values properly as well
1056 if (!file_name_is_absolute
($ENV{$_})) {
1057 my $newpath = abs2rel
(rel2abs
($ENV{$_}), rel2abs
($dir));
1058 $tmp_ENV{$_} = $newpath;
1062 # Should we just bail out here as well? I'm unsure.
1063 return undef unless chdir($dir);
1065 if ($opts{cleanup
}) {
1066 rmtree
(".", { safe
=> 0, keep_root
=> 1 });
1069 # We put back new values carefully. Doing the obvious
1070 # %directories = ( %tmp_directories )
1071 # will clear out any value that happens to be an absolute path
1072 foreach (keys %tmp_directories) {
1073 $directories{$_} = $tmp_directories{$_};
1075 foreach (keys %tmp_ENV) {
1076 $ENV{$_} = $tmp_ENV{$_};
1080 print STDERR
"DEBUG: __cwd(), directories and files:\n";
1081 print STDERR
" \$directories{BLDTEST} = \"$directories{BLDTEST}\"\n";
1082 print STDERR
" \$directories{SRCTEST} = \"$directories{SRCTEST}\"\n";
1083 print STDERR
" \$directories{SRCDATA} = \"$directories{SRCDATA}\"\n";
1084 print STDERR
" \$directories{RESULTS} = \"$directories{RESULTS}\"\n";
1085 print STDERR
" \$directories{BLDAPPS} = \"$directories{BLDAPPS}\"\n";
1086 print STDERR
" \$directories{SRCAPPS} = \"$directories{SRCAPPS}\"\n";
1087 print STDERR
" \$directories{SRCTOP} = \"$directories{SRCTOP}\"\n";
1088 print STDERR
" \$directories{BLDTOP} = \"$directories{BLDTOP}\"\n";
1090 print STDERR
" current directory is \"",curdir
(),"\"\n";
1091 print STDERR
" the way back is \"$reverse\"\n";
1098 # __wrap_cmd CMD, EXE_SHELL
1100 # __wrap_cmd "wraps" CMD (string) with a beginning command that makes sure
1101 # the command gets executed with an appropriate environment. If EXE_SHELL
1102 # is given, it is used as the beginning command.
1104 # __wrap_cmd returns a list that should be used to build up a larger list
1105 # of command tokens, or be joined together like this:
1107 # join(" ", __wrap_cmd($cmd))
1110 my $exe_shell = shift;
1112 my @prefix = ( __bldtop_file
("util", "shlib_wrap.sh") );
1114 if(defined($exe_shell)) {
1115 @prefix = ( $exe_shell );
1116 } elsif ($^O
eq "VMS" || $^O
eq "MSWin32") {
1117 # VMS and Windows don't use any wrapper script for the moment
1121 return (@prefix, $cmd);
1126 # __fixup_prg does whatever fixup is needed to execute an executable binary
1127 # given by PROG (string).
1129 # __fixup_prg returns a string with the possibly prefixed program path spec.
1135 if ($^O
eq "VMS" ) {
1136 $prefix = ($prog =~ /^(?:[\$a-z0-9_]+:)?[<\[]/i ?
"mcr " : "mcr []");
1139 if (defined($prog)) {
1140 # Make sure to quotify the program file on platforms that may
1141 # have spaces or similar in their path name.
1142 # To our knowledge, VMS is the exception where quotifying should
1144 ($prog) = quotify
($prog) unless $^O
eq "VMS";
1145 return $prefix.$prog;
1148 print STDERR
"$prog not found\n";
1152 # __decorate_cmd NUM, CMDARRAYREF
1154 # __decorate_cmd takes a command number NUM and a command token array
1155 # CMDARRAYREF, builds up a command string from them and decorates it
1156 # with necessary redirections.
1157 # __decorate_cmd returns a list of two strings, one with the command
1158 # string to actually be used, the other to be displayed for the user.
1159 # The reason these strings might differ is that we redirect stderr to
1160 # the null device unless we're verbose and unless the user has
1161 # explicitly specified a stderr redirection.
1162 sub __decorate_cmd
{
1163 BAIL_OUT
("Must run setup() first") if (! $test_name);
1169 my $cmdstr = join(" ", @
$cmd);
1170 my $null = devnull
();
1171 my $fileornull = sub { $_[0] ?
$_[0] : $null; };
1175 my $saved_stderr = undef;
1176 $stdin = " < ".$fileornull->($opts{stdin
}) if exists($opts{stdin
});
1177 $stdout= " > ".$fileornull->($opts{stdout
}) if exists($opts{stdout
});
1178 $stderr=" 2> ".$fileornull->($opts{stderr
}) if exists($opts{stderr
});
1180 my $display_cmd = "$cmdstr$stdin$stdout$stderr";
1182 $stderr=" 2> ".$null
1183 unless $stderr || !$ENV{HARNESS_ACTIVE
} || $ENV{HARNESS_VERBOSE
};
1185 $cmdstr .= "$stdin$stdout$stderr";
1188 print STDERR
"DEBUG[__decorate_cmd]: \$cmdstr = \"$cmdstr\"\n";
1189 print STDERR
"DEBUG[__decorate_cmd]: \$display_cmd = \"$display_cmd\"\n";
1192 return ($cmdstr, $display_cmd);
1197 L<Test::More>, L<Test::Harness>
1201 Richard Levitte E<lt>levitte@openssl.orgE<gt> with assistance and
1202 inspiration from Andy Polyakov E<lt>appro@openssl.org<gt>.
1206 no warnings
'redefine';
1210 Test
::More
::subtest
@_;