9 use vars qw($VERSION @ISA @EXPORT @EXPORT_OK %EXPORT_TAGS);
12 @EXPORT = (@Test::More::EXPORT, qw(setup indir app perlapp test perltest run));
13 @EXPORT_OK = (@Test::More::EXPORT_OK, qw(bldtop_dir bldtop_file
14 srctop_dir srctop_file
15 pipe with cmdstr quotify));
19 OpenSSL::Test - a private extension of Test::More
25 setup("my_test_name");
27 ok(run(app(["openssl", "version"])), "check for openssl presence");
29 indir "subdir" => sub {
30 ok(run(test(["sometest", "arg1"], stdout => "foo.txt")),
31 "run sometest with output to foo.txt");
36 This module is a private extension of L<Test::More> for testing OpenSSL.
37 In addition to the Test::More functions, it also provides functions that
38 easily find the diverse programs within a OpenSSL build tree, as well as
39 some other useful functions.
41 This module I<depends> on the environment variables C<$TOP> or C<$SRCTOP>
42 and C<$BLDTOP>. Without one of the combinations it refuses to work.
43 See L</ENVIRONMENT> below.
48 use File::Spec::Functions qw/file_name_is_absolute curdir canonpath splitdir
49 catdir catfile splitpath catpath devnull abs2rel
51 use File::Path 2.00 qw/rmtree mkpath/;
54 # The name of the test. This is set by setup() and is used in the other
55 # functions to verify that setup() has been used.
56 my $test_name = undef;
58 # Directories we want to keep track of TOP, APPS, TEST and RESULTS are the
59 # ones we're interested in, corresponding to the environment variables TOP
60 # (mandatory), BIN_D, TEST_D, UTIL_D and RESULT_D.
63 # A bool saying if we shall stop all testing if the current recipe has failing
64 # tests or not. This is set by setup() if the environment variable STOPTEST
65 # is defined with a non-empty value.
66 my $end_with_bailout = 0;
68 # A set of hooks that is affected by with() and may be used in diverse places.
69 # All hooks are expected to be CODE references.
72 # exit_checker is used by run() directly after completion of a command.
73 # it receives the exit code from that command and is expected to return
74 # 1 (for success) or 0 (for failure). This is the value that will be
76 # NOTE: When run() gets the option 'capture => 1', this hook is ignored.
77 exit_checker => sub { return shift == 0 ? 1 : 0 },
81 # Debug flag, to be set manually when needed
84 # Declare some utility functions that are defined at the end
91 # Declare some private functions that are defined at the end
101 The following functions are exported by default when using C<OpenSSL::Test>.
107 =item B<setup "NAME">
109 C<setup> is used for initial setup, and it is mandatory that it's used.
110 If it's not used in a OpenSSL test recipe, the rest of the recipe will
111 most likely refuse to run.
113 C<setup> checks for environment variables (see L</ENVIRONMENT> below),
114 checks that C<$TOP/Configure> or C<$SRCTOP/Configure> exists, C<chdir>
115 into the results directory (defined by the C<$RESULT_D> environment
116 variable if defined, otherwise C<$BLDTOP/test> or C<$TOP/test>, whichever
126 BAIL_OUT("setup() must receive a name") unless $test_name;
127 BAIL_OUT("setup() needs \$TOP or \$SRCTOP and \$BLDTOP to be defined")
128 unless $ENV{TOP} || ($ENV{SRCTOP} && $ENV{BLDTOP});
129 BAIL_OUT("setup() found both \$TOP and \$SRCTOP or \$BLDTOP...")
130 if $ENV{TOP} && ($ENV{SRCTOP} || $ENV{BLDTOP});
134 BAIL_OUT("setup() expects the file Configure in the \$TOP directory")
135 unless -f srctop_file("Configure");
137 __cwd($directories{RESULTS});
142 =item B<indir "SUBDIR" =E<gt> sub BLOCK, OPTS>
144 C<indir> is used to run a part of the recipe in a different directory than
145 the one C<setup> moved into, usually a subdirectory, given by SUBDIR.
146 The part of the recipe that's run there is given by the codeblock BLOCK.
148 C<indir> takes some additional options OPTS that affect the subdirectory:
152 =item B<create =E<gt> 0|1>
154 When set to 1 (or any value that perl preceives as true), the subdirectory
155 will be created if it doesn't already exist. This happens before BLOCK
158 =item B<cleanup =E<gt> 0|1>
160 When set to 1 (or any value that perl preceives as true), the subdirectory
161 will be cleaned out and removed. This happens both before and after BLOCK
169 ok(run(app(["openssl", "version"]), stdout => "foo.txt"));
170 if (ok(open(RESULT, "foo.txt"), "reading foo.txt")) {
173 is($line, qr/^OpenSSL 1\./,
174 "check that we're using OpenSSL 1.x.x");
176 }, create => 1, cleanup => 1;
184 my $codeblock = shift;
187 my $reverse = __cwd($subdir,%opts);
188 BAIL_OUT("FAILURE: indir, \"$subdir\" wasn't possible to move into")
195 if ($opts{cleanup}) {
196 rmtree($subdir, { safe => 0 });
202 =item B<app ARRAYREF, OPTS>
204 =item B<test ARRAYREF, OPTS>
206 Both of these functions take a reference to a list that is a command and
207 its arguments, and some additional options (described further on).
209 C<app> expects to find the given command (the first item in the given list
210 reference) as an executable in C<$BIN_D> (if defined, otherwise C<$TOP/apps>
213 C<test> expects to find the given command (the first item in the given list
214 reference) as an executable in C<$TEST_D> (if defined, otherwise C<$TOP/test>
217 Both return a CODEREF to be used by C<run>, C<pipe> or C<cmdstr>.
219 The options that both C<app> and C<test> can take are in the form of hash
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<perlapp ARRAYREF, OPTS>
238 =item B<perltest ARRAYREF, OPTS>
240 Both these functions function the same way as B<app> and B<test>, except
241 that they expect the command to be a perl script.
250 return sub { my $num = shift;
251 return __build_cmd($num, \&__apps_file, $cmd, %opts); }
257 return sub { my $num = shift;
258 return __build_cmd($num, \&__test_file, $cmd, %opts); }
264 return sub { my $num = shift;
265 return __build_cmd($num, \&__perlapps_file, $cmd, %opts); }
271 return sub { my $num = shift;
272 return __build_cmd($num, \&__perltest_file, $cmd, %opts); }
277 =item B<run CODEREF, OPTS>
279 This CODEREF is expected to be the value return by C<app> or C<test>,
280 anything else will most likely cause an error unless you know what you're
283 C<run> executes the command returned by CODEREF and return either the
284 resulting output (if the option C<capture> is set true) or a boolean indicating
285 if the command succeeded or not.
287 The options that C<run> can take are in the form of hash values:
291 =item B<capture =E<gt> 0|1>
293 If true, the command will be executed with a perl backtick, and C<run> will
294 return the resulting output as an array of lines. If false or not given,
295 the command will be executed with C<system()>, and C<run> will return 1 if
296 the command was successful or 0 if it wasn't.
300 For further discussion on what is considered a successful command or not, see
301 the function C<with> further down.
308 my ($cmd, $display_cmd) = shift->(0);
314 if ( $^O eq "VMS" ) { # VMS
321 if ($opts{capture}) {
325 system("$prefix$cmd");
327 $r = $hooks{exit_checker}->($e);
330 # At this point, $? stops being interesting, and unfortunately,
331 # there are Test::More versions that get picky if we leave it
335 if ($opts{capture}) {
343 my $tb = Test::More->builder;
344 my $failure = scalar(grep { $_ == 0; } $tb->summary);
345 if ($failure && $end_with_bailout) {
346 BAIL_OUT("Stoptest!");
350 =head2 Utility functions
352 The following functions are exported on request when using C<OpenSSL::Test>.
354 # To only get the bldtop_file and srctop_file functions.
355 use OpenSSL::Test qw/bldtop_file srctop_file/;
357 # To only get the bldtop_file function in addition to the default ones.
358 use OpenSSL::Test qw/:DEFAULT bldtop_file/;
362 # Utility functions, exported on request
366 =item B<bldtop_dir LIST>
368 LIST is a list of directories that make up a path from the top of the OpenSSL
369 build directory (as indicated by the environment variable C<$TOP> or
371 C<bldtop_dir> returns the resulting directory as a string, adapted to the local
379 return __bldtop_dir(@_); # This caters for operating systems that have
380 # a very distinct syntax for directories.
385 =item B<bldtop_file LIST, FILENAME>
387 LIST is a list of directories that make up a path from the top of the OpenSSL
388 build directory (as indicated by the environment variable C<$TOP> or
389 C<$BLDTOP>) and FILENAME is the name of a file located in that directory path.
390 C<bldtop_file> returns the resulting file path as a string, adapted to the local
398 return __bldtop_file(@_);
403 =item B<srctop_dir LIST>
405 LIST is a list of directories that make up a path from the top of the OpenSSL
406 source directory (as indicated by the environment variable C<$TOP> or
408 C<srctop_dir> returns the resulting directory as a string, adapted to the local
416 return __srctop_dir(@_); # This caters for operating systems that have
417 # a very distinct syntax for directories.
422 =item B<srctop_file LIST, FILENAME>
424 LIST is a list of directories that make up a path from the top of the OpenSSL
425 source directory (as indicated by the environment variable C<$TOP> or
426 C<$SRCTOP>) and FILENAME is the name of a file located in that directory path.
427 C<srctop_file> returns the resulting file path as a string, adapted to the local
435 return __srctop_file(@_);
442 LIST is a list of CODEREFs returned by C<app> or C<test>, from which C<pipe>
443 creates a new command composed of all the given commands put together in a
444 pipe. C<pipe> returns a new CODEREF in the same manner as C<app> or C<test>,
445 to be passed to C<run> for execution.
460 my ($c, $dc, @el) = $_->(++$counter);
478 =item B<with HASHREF, CODEREF>
480 C<with> will temporarly install hooks given by the HASHREF and then execute
481 the given CODEREF. Hooks are usually expected to have a coderef as value.
483 The currently available hoosk are:
487 =item B<exit_checker =E<gt> CODEREF>
489 This hook is executed after C<run> has performed its given command. The
490 CODEREF receives the exit code as only argument and is expected to return
491 1 (if the exit code indicated success) or 0 (if the exit code indicated
503 my $codeblock = shift;
505 my %saved_hooks = ();
507 foreach (keys %opts) {
508 $saved_hooks{$_} = $hooks{$_} if exists($hooks{$_});
509 $hooks{$_} = $opts{$_};
514 foreach (keys %saved_hooks) {
515 $hooks{$_} = $saved_hooks{$_};
521 =item B<cmdstr CODEREF>
523 C<cmdstr> takes a CODEREF from C<app> or C<test> and simply returns the
531 my ($cmd, $display_cmd) = shift->(0);
538 =item B<quotify LIST>
540 LIST is a list of strings that are going to be used as arguments for a
541 command, and makes sure to inject quotes and escapes as necessary depending
542 on the content of each string.
544 This can also be used to put quotes around the executable of a command.
545 I<This must never ever be done on VMS.>
552 # Unix setup (default if nothing else is mentioned)
554 sub { $_ = shift; /\s|[\{\}\\\$\[\]\*\?\|\&:;<>]/ ? "'$_'" : $_ };
556 if ( $^O eq "VMS") { # VMS setup
557 $arg_formatter = sub {
559 if (/\s|["[:upper:]]/) {
566 } elsif ( $^O eq "MSWin32") { # MSWin setup
567 $arg_formatter = sub {
569 if (/\s|["\|\&\*\;<>]/) {
578 return map { $arg_formatter->($_) } @_;
581 ######################################################################
582 # private functions. These are never exported.
586 OpenSSL::Test depends on some environment variables.
592 This environment variable is mandatory. C<setup> will check that it's
593 defined and that it's a directory that contains the file C<Configure>.
594 If this isn't so, C<setup> will C<BAIL_OUT>.
598 If defined, its value should be the directory where the openssl application
599 is located. Defaults to C<$TOP/apps> (adapted to the operating system).
603 If defined, its value should be the directory where the test applications
604 are located. Defaults to C<$TOP/test> (adapted to the operating system).
608 If defined, it puts testing in a different mode, where a recipe with
609 failures will result in a C<BAIL_OUT> at the end of its run.
616 $directories{SRCTOP} = $ENV{SRCTOP} || $ENV{TOP};
617 $directories{BLDTOP} = $ENV{BLDTOP} || $ENV{TOP};
618 $directories{APPS} = $ENV{BIN_D} || __bldtop_dir("apps");
619 $directories{TEST} = $ENV{TEST_D} || __bldtop_dir("test");
620 $directories{RESULTS} = $ENV{RESULT_D} || $directories{TEST};
622 $end_with_bailout = $ENV{STOPTEST} ? 1 : 0;
626 BAIL_OUT("Must run setup() first") if (! $test_name);
629 return catfile($directories{SRCTOP},@_,$f);
633 BAIL_OUT("Must run setup() first") if (! $test_name);
635 return catdir($directories{SRCTOP},@_);
639 BAIL_OUT("Must run setup() first") if (! $test_name);
642 return catfile($directories{BLDTOP},@_,$f);
646 BAIL_OUT("Must run setup() first") if (! $test_name);
648 return catdir($directories{BLDTOP},@_);
652 BAIL_OUT("Must run setup() first") if (! $test_name);
655 return catfile($directories{TEST},@_,$f);
658 sub __perltest_file {
659 BAIL_OUT("Must run setup() first") if (! $test_name);
662 return ($^X, catfile($directories{TEST},@_,$f));
666 BAIL_OUT("Must run setup() first") if (! $test_name);
669 return catfile($directories{APPS},@_,$f);
672 sub __perlapps_file {
673 BAIL_OUT("Must run setup() first") if (! $test_name);
676 return ($^X, catfile($directories{APPS},@_,$f));
680 BAIL_OUT("Must run setup() first") if (! $test_name);
683 return catfile($directories{RESULTS},@_,$f);
687 my $dir = catdir(shift);
689 my $abscurdir = rel2abs(curdir());
690 my $absdir = rel2abs($dir);
691 my $reverse = abs2rel($abscurdir, $absdir);
693 # PARANOIA: if we're not moving anywhere, we do nothing more
694 if ($abscurdir eq $absdir) {
698 # Do not support a move to a different volume for now. Maybe later.
699 BAIL_OUT("FAILURE: \"$dir\" moves to a different volume, not supported")
700 if $reverse eq $abscurdir;
702 # If someone happened to give a directory that leads back to the current,
703 # it's extremely silly to do anything more, so just simulate that we did
705 # In this case, we won't even clean it out, for safety's sake.
706 return "." if $reverse eq "";
708 $dir = canonpath($dir);
713 # Should we just bail out here as well? I'm unsure.
714 return undef unless chdir($dir);
716 if ($opts{cleanup}) {
717 rmtree(".", { safe => 0, keep_root => 1 });
720 # For each of these directory variables, figure out where they are relative
721 # to the directory we want to move to if they aren't absolute (if they are,
722 # they don't change!)
723 my @dirtags = sort keys %directories;
725 if (!file_name_is_absolute($directories{$_})) {
726 my $newpath = abs2rel(rel2abs($directories{$_}), rel2abs($dir));
727 $directories{$_} = $newpath;
732 print STDERR "DEBUG: __cwd(), directories and files:\n";
733 print STDERR " \$directories{TEST} = \"$directories{TEST}\"\n";
734 print STDERR " \$directories{RESULTS} = \"$directories{RESULTS}\"\n";
735 print STDERR " \$directories{APPS} = \"$directories{APPS}\"\n";
736 print STDERR " \$directories{SRCTOP} = \"$directories{SRCTOP}\"\n";
737 print STDERR " \$directories{BLDTOP} = \"$directories{BLDTOP}\"\n";
739 print STDERR " current directory is \"",curdir(),"\"\n";
740 print STDERR " the way back is \"$reverse\"\n";
748 my $exe_shell = shift;
750 my $prefix = __bldtop_file("util", "shlib_wrap.sh")." ";
751 my $ext = $ENV{"EXE_EXT"} || "";
753 if (defined($exe_shell)) {
754 $prefix = "$exe_shell ";
755 } elsif ($^O eq "VMS" ) { # VMS
756 $prefix = ($prog =~ /^(?:[\$a-z0-9_]+:)?[<\[]/i ? "mcr " : "mcr []");
758 } elsif ($^O eq "MSWin32") { # Windows
763 # We test both with and without extension. The reason
764 # is that we might be passed a complete file spec, with
767 my $prog = "$prog$ext";
773 if (defined($prog)) {
774 # Make sure to quotify the program file on platforms that may
775 # have spaces or similar in their path name.
776 # To our knowledge, VMS is the exception where quotifying should
778 ($prog) = quotify($prog) unless $^O eq "VMS";
779 return $prefix.$prog;
782 print STDERR "$prog not found\n";
787 BAIL_OUT("Must run setup() first") if (! $test_name);
790 my $path_builder = shift;
791 # Make a copy to not destroy the caller's array
792 my @cmdarray = ( @{$_[0]} ); shift;
794 # We do a little dance, as $path_builder might return a list of
795 # more than one. If so, only the first is to be considered a
796 # program to fix up, the rest is part of the arguments. This
797 # happens for perl scripts, where $path_builder will return
798 # a list of two, $^X and the script name.
799 # Also, if $path_builder returned more than one, we don't apply
800 # the EXE_SHELL environment variable.
801 my @prog = ($path_builder->(shift @cmdarray));
802 my $first = shift @prog;
803 my $exe_shell = @prog ? undef : $ENV{EXE_SHELL};
804 my $cmd = __fixup_cmd($first, $exe_shell);
806 if ( ! -f $prog[0] ) {
807 print STDERR "$prog[0] not found\n";
811 my @args = (@prog, @cmdarray);
818 my $null = devnull();
821 $arg_str = " ".join(" ", quotify @args) if @args;
823 my $fileornull = sub { $_[0] ? $_[0] : $null; };
827 my $saved_stderr = undef;
828 $stdin = " < ".$fileornull->($opts{stdin}) if exists($opts{stdin});
829 $stdout= " > ".$fileornull->($opts{stdout}) if exists($opts{stdout});
830 $stderr=" 2> ".$fileornull->($opts{stderr}) if exists($opts{stderr});
832 my $display_cmd = "$cmd$arg_str$stdin$stdout$stderr";
835 unless $stderr || !$ENV{HARNESS_ACTIVE} || $ENV{HARNESS_VERBOSE};
837 $cmd .= "$arg_str$stdin$stdout$stderr";
840 print STDERR "DEBUG[__build_cmd]: \$cmd = \"$cmd\"\n";
841 print STDERR "DEBUG[__build_cmd]: \$display_cmd = \"$display_cmd\"\n";
844 return ($cmd, $display_cmd);
849 L<Test::More>, L<Test::Harness>
853 Richard Levitte E<lt>levitte@openssl.orgE<gt> with assitance and
854 inspiration from Andy Polyakov E<lt>appro@openssl.org<gt>.