4 # This script is the beginnings of a script to run a sequence of test
5 # programs. See the MPICH document for a description of the test
6 # strategy and requirements.
9 # Tests are controlled by a file listing test programs; if the file is
10 # a directory, then all of the programs in the directory and subdirectories
13 # To run a test, the following steps are executed
14 # Build the executable:
17 # mpiexec -n <np> ./programname >out 2>err
18 # Check the return code (non zero is failure)
19 # Check the stderr output (non empty is failure)
20 # Check the stdout output (No Errors or Test passed are the only valid
22 # Remove executable, out, err files
24 # The format of a list file is
25 # programname number-of-processes
26 # If number-of-processes is missing, $np_default is used (this is 2 but can
27 # be overridden with -np=new-value)
30 # Because these tests can take a long time to run, there is an
31 # option to cause the tests to stop is a "stopfile" is found.
32 # The stopfile can be created by a separate, watchdog process, to ensure that
33 # tests end at a certain time.
34 # The name of this file is (by default) .stoptest
35 # in the top-level run directory. The environment variable
37 # can specify a different file name.
39 # Import the mkpath command
43 $MPIMajorVersion = "1";
44 $MPIMinorVersion = "1";
45 $mpiexec = "smpirun"; # Name of mpiexec program (including path, if necessary)
46 $testIsStrict = "true";
48 $np_arg = "-np"; # Name of argument to specify the number of processes
49 $err_count = 0; # Number of programs that failed.
50 $total_run = 0; # Number of programs tested
51 $total_seen = 0; # Number of programs considered for testing
52 $np_default = 2; # Default number of processes to use
53 $np_max = -1; # Maximum number of processes to use (overrides any
54 # value in the test list files. -1 is Infinity
55 $defaultTimeLimit = 180; # default timeout
57 $srcdir = "."; # Used to set the source dir for testlist files
59 $curdir = "."; # used to track the relative current directory
62 $xmloutput = 0; # Set to true to get xml output (also specify file)
63 $closeXMLOutput = 1; # Set to false to leave XML output file open to
64 # accept additional data
65 $verbose = 1; # Set to true to get more output
66 $showProgress = 0; # Set to true to get a "." with each run program.
67 $newline = "\r\n"; # Set to \r\n for Windows-friendly, \n for Unix only
68 $batchRun = 0; # Set to true to batch the execution of the tests
69 # (i.e., run them together, then test output,
70 # rather than build/run/check for each test)
71 $testCount = 0; # Used with batchRun to count tests.
72 $batrundir = "."; # Set to the directory into which to run the examples
76 # TAP (Test Anything Protocol) output
83 $depth = 0; # This is used to manage multiple open list files
89 my $program_wrapper = '';
91 #---------------------------------------------------------------------------
92 # Get some arguments from the environment
93 # Currently, only the following are understood:
95 # RUNTESTS_VERBOSE (an alias for VERBOSE in case you want to
97 # RUNTESTS_SHOWPROGRESS
100 # MPITEST_PROGRAM_WRAPPER (Value is added after -np but before test
101 # executable. Tools like valgrind may be inserted
103 #---------------------------------------------------------------------------
104 if ( defined($ENV{"VERBOSE"}) || defined($ENV{"V"}) || defined($ENV{"RUNTESTS_VERBOSE"}) ) {
107 if ( defined($ENV{"RUNTESTS_SHOWPROGRESS"} ) ) {
110 if (defined($ENV{"MPITEST_STOPTEST"})) {
111 $stopfile = $ENV{"MPITEST_STOPTEST"};
114 $stopfile = `pwd` . "/.stoptest";
115 $stopfile =~ s/\r*\n*//g; # Remove any newlines (from pwd)
118 if (defined($ENV{"MPITEST_TIMEOUT"})) {
119 $defaultTimeLimit = $ENV{"MPITEST_TIMEOUT"};
122 # Define this to leave the XML output file open to receive additional data
123 if (defined($ENV{'NOXMLCLOSE'}) && $ENV{'NOXMLCLOSE'} eq 'YES') {
127 if (defined($ENV{'MPITEST_PROGRAM_WRAPPER'})) {
128 $program_wrapper = $ENV{'MPITEST_PROGRAM_WRAPPER'};
131 if (defined($ENV{'MPITEST_BATCH'})) {
132 if ($ENV{'MPITEST_BATCH'} eq 'YES' || $ENV{'MPITEST_BATCH'} eq 'yes') {
134 } elsif ($ENV{'MPITEST_BATCH'} eq 'NO' || $ENV{'MPITEST_BATCH'} eq 'no') {
138 print STDERR "Unrecognized value for MPITEST_BATCH = $ENV{'MPITEST_BATCH'}\n";
141 if (defined($ENV{'MPITEST_BATCHDIR'})) {
142 $batrundir = $ENV{'MPITEST_BATCHDIR'};
145 #---------------------------------------------------------------------------
146 # Process arguments and override any defaults
147 #---------------------------------------------------------------------------
149 if (/--?mpiexec=(.*)/) {
150 # Use mpiexec as given - it may be in the path, and
151 # we don't want to bother to try and find it.
154 elsif (/--?np=(.*)/) { $np_default = $1; }
155 elsif (/--?maxnp=(.*)/) { $np_max = $1; }
156 elsif (/--?tests=(.*)/) { $listfiles = $1; }
157 elsif (/--?srcdir=(.*)/) { $srcdir = $1;
158 $mpiexec="$mpiexec -platform ${srcdir}/../../../../examples/platforms/small_platform_with_routers.xml -hostfile ${srcdir}/../../hostfile_coll --log=root.thr:critical --cfg=smpi/running-power:1e9 --cfg=smpi/async-small-thresh:65536"; }
159 elsif (/--?verbose/) { $verbose = 1; }
160 elsif (/--?showprogress/) { $showProgress = 1; }
161 elsif (/--?debug/) { $debug = 1; }
162 elsif (/--?batch/) { $batchRun = 1; }
163 elsif (/--?batchdir=(.*)/) { $batrundir = $1; }
164 elsif (/--?timeoutarg=(.*)/) { $timeoutArgPattern = $1; }
165 elsif (/--?execarg=(.*)/) { $execarg = "$execarg $1"; }
166 elsif (/VALGRIND_COMMAND=(.*)/) {
168 elsif (/VALGRIND_OPTIONS=(.*)/) {
169 $wrapparg = "-wrapper \"$valgrind $1\""; }
170 elsif (/--?xmlfile=(.*)/) {
172 if (! ($xmlfile =~ /^\//)) {
175 $xmlfullfile = $thisdir . "/" . $xmlfile ;
178 $xmlfullfile = $xmlfile;
181 open( XMLOUT, ">$xmlfile" ) || die "Cannot open $xmlfile\n";
182 my $date = `date "+%Y-%m-%d-%H-%M"`;
184 # MPISOURCE can be used to describe the source of MPI for this
186 print XMLOUT "<?xml version='1.0' ?>$newline";
187 print XMLOUT "<?xml-stylesheet href=\"TestResults.xsl\" type=\"text/xsl\" ?>$newline";
188 print XMLOUT "<MPITESTRESULTS>$newline";
189 print XMLOUT "<DATE>$date</DATE>$newline";
190 print XMLOUT "<MPISOURCE></MPISOURCE>$newline";
192 elsif (/--?noxmlclose/) {
195 elsif (/--?tapfile=(.*)/) {
197 if ($tapfile !~ m|^/|) {
200 $tapfullfile = $thisdir . "/" . $tapfile ;
203 $tapfullfile = $tapfile;
206 open( TAPOUT, ">$tapfile" ) || die "Cannot open $tapfile\n";
207 my $date = `date "+%Y-%m-%d-%H-%M"`;
209 print TAPOUT "TAP version 13\n";
210 print TAPOUT "# MPICH test suite results (TAP format)\n";
211 print TAPOUT "# date ${date}\n";
212 # we do not know at this point how many tests will be run, so do
213 # not print a test plan line like "1..450" until the very end
217 # Perform any post argument processing
219 if (! -d $batrundir) {
220 mkpath $batrundir || die "Could not create $batrundir\n";
222 open( BATOUT, ">$batrundir/runtests.batch" ) || die "Could not open $batrundir/runtests.batch\n";
225 # We must have mpiexec
226 if ("$mpiexec" eq "") {
227 print STDERR "No mpiexec found!\n";
234 if ($listfiles eq "") {
236 print STDERR "An implicit list of tests is not permitted in batch mode\n";
240 &ProcessImplicitList;
243 elsif (-d $listfiles) {
244 print STDERR "Testing by directories not yet supported\n";
247 &RunList( $listfiles );
250 if ($xmloutput && $closeXMLOutput) {
251 print XMLOUT "</MPITESTRESULTS>$newline";
256 print TAPOUT "1..$total_seen\n";
262 print "Programs created along with a runtest.batch file in $batrundir\n";
263 print "Run that script and then use checktests to summarize the results\n";
267 print "$err_count tests failed out of $total_run\n";
269 print "Details in $xmlfullfile\n";
273 print " All $total_run tests passed!\n";
276 print "TAP formatted results in $tapfullfile\n";
280 # ---------------------------------------------------------------------------
283 # Enter a new directory and process a list file.
284 # ProcessDir( directory-name, list-file-name )
286 my $dir = $_[0]; $dir =~ s/\/$//;
287 my $listfile = $_[1];
289 my $savecurdir = $curdir;
290 my $savesrcdir = $srcdir;
293 if (substr($srcdir,0,3) eq "../") {
294 $srcdir = "../$srcdir";
297 print "Processing directory $dir\n" if ($verbose || $debug);
300 print STDERR "only direct subdirectories allowed in list files";
304 &RunList( $listfile );
305 print "\n" if $showProgress; # Terminate line from progress output
307 $curdir = $savecurdir;
308 $srcdir = $savesrcdir;
310 # ---------------------------------------------------------------------------
311 # Run the programs listed in the file given as the argument.
312 # This file describes the tests in the format
313 # programname number-of-processes [ key=value ... ]
314 # If the second value is not given, the default value is used.
317 my $LIST = "LIST$depth"; $depth++;
318 my $listfile = $_[0];
321 my $listfileSource = $listfile;
323 print "Looking in $curdir/$listfile\n" if $debug;
324 if (! -s "$listfile" && -s "$srcdir/$curdir/$listfile" ) {
325 $listfileSource = "$srcdir/$curdir/$listfile";
327 open( $LIST, "<$listfileSource" ) ||
328 die "Could not open $listfileSource\n";
330 # Check for stop file
332 # Exit because we found a stopfile
333 print STDERR "Terminating test because stopfile $stopfile found\n";
338 # Remove any trailing newlines/returns
340 # Remove any leading whitespace
342 # Some tests require that support routines are built first
343 # This is specified with !<dir>:<target>
344 if (/^\s*\!([^:]*):(.*)/) {
345 # Hack: just execute in a subshell. This discards any
350 # List file entries have the form:
351 # program [ np [ name=value ... ] ]
352 # See files errhan/testlist, init/testlist, and spawn/testlist
353 # for examples of using the key=value form
354 my @args = split(/\s+/,$_);
355 my $programname = $args[0];
361 my $mpiexecArgs = "$execarg";
362 my $requiresStrict = "";
363 my $requiresMPIX = "";
367 if ($#args >= 1) { $np = $args[1]; }
368 # Process the key=value arguments
369 for (my $i=2; $i <= $#args; $i++) {
370 if ($args[$i] =~ /([^=]+)=(.*)/) {
373 if ($key eq "resultTest") {
374 $ResultTest = $value;
376 elsif ($key eq "init") {
377 $InitForRun = $value;
379 elsif ($key eq "timeLimit") {
382 elsif ($key eq "arg") {
383 $progArgs = "$progArgs $value";
385 elsif ($key eq "mpiexecarg") {
386 $mpiexecArgs = "$mpiexecArgs $value";
388 elsif ($key eq "env") {
389 $progEnv = "$progEnv $value";
391 elsif ($key eq "mpiversion") {
392 $mpiVersion = $value;
394 elsif ($key eq "strict") {
395 $requiresStrict = $value
397 elsif ($key eq "mpix") {
398 $requiresMPIX = $value
400 elsif ($key eq "xfail") {
402 print STDERR "\"xfail=\" requires an argument\n";
407 print STDERR "Unrecognized key $key in $listfileSource\n";
413 if ($programname eq "") { next; }
415 if ($np eq "") { $np = $np_default; }
416 if ($np_max > 0 && $np > $np_max) { $np = $np_max; }
418 # allows us to accurately output TAP test numbers without disturbing the
419 # original totals that have traditionally been reported
421 # These "unless" blocks are ugly, but permit us to honor skipping
422 # criteria for directories as well without counting directories as tests
423 # in our XML/TAP output.
424 unless (-d $programname) {
428 # If a minimum MPI version is specified, check against the
429 # available MPI. If the version is unknown, we ignore this
430 # test (thus, all tests will be run).
431 if ($mpiVersion ne "" && $MPIMajorVersion ne "unknown" &&
432 $MPIMinorVersion ne "unknown") {
433 my ($majorReq,$minorReq) = split(/\./,$mpiVersion);
434 if ($majorReq > $MPIMajorVersion or
435 ($majorReq == $MPIMajorVersion && $minorReq > $MPIMinorVersion))
437 unless (-d $programname) {
438 SkippedTest($programname, $np, $workdir, "requires MPI version $mpiVersion");
443 # Check whether strict is required by MPI but not by the
444 # test (use strict=false for tests that use non-standard extensions)
445 if (lc($requiresStrict) eq "false" && lc($testIsStrict) eq "true") {
446 unless (-d $programname) {
447 SkippedTest($programname, $np, $workdir, "non-strict test, strict MPI mode requested");
452 if (lc($testIsStrict) eq "true") {
453 # Strict MPI testing was requested, so assume that a non-MPICH MPI
454 # implementation is being tested and the "xfail" implementation
455 # assumptions do not hold.
459 if (lc($requiresMPIX) eq "true" && lc($MPIHasMPIX) eq "no") {
460 unless (-d $programname) {
461 SkippedTest($programname, $np, $workdir, "tests MPIX extensions, MPIX testing disabled");
466 if (-d $programname) {
467 # If a directory, go into the that directory and
468 # look for a new list file
469 &ProcessDir( $programname, $listfile );
473 if (&BuildMPIProgram( $programname, $xfail ) == 0) {
474 if ($batchRun == 1) {
475 &AddMPIProgram( $programname, $np, $ResultTest,
476 $InitForRun, $timeLimit, $progArgs,
477 $progEnv, $mpiexecArgs, $xfail );
480 &RunMPIProgram( $programname, $np, $ResultTest,
481 $InitForRun, $timeLimit, $progArgs,
482 $progEnv, $mpiexecArgs, $xfail );
485 elsif ($xfail ne '') {
486 # We expected to run this program, so failure to build
491 if ($batchRun == 0) {
492 &CleanUpAfterRun( $programname );
499 # This routine tries to run all of the files in the current
501 sub ProcessImplicitList {
502 # The default is to run every file in the current directory.
503 # If there are no built programs, build and run every file
504 # WARNING: This assumes that anything executable should be run as
508 open (PGMS, "ls -1 |" ) || die "Cannot list directory\n";
512 if (-d $programname) { next; } # Ignore directories
513 if ($programname eq "runtests") { next; } # Ignore self
514 if ($programname eq "checktests") { next; } # Ignore helper
515 if ($programname eq "configure") { next; } # Ignore configure script
516 if ($programname eq "config.status") { next; } # Ignore configure helper
517 if (-x $programname) { $found_exec++; }
518 if ($programname =~ /\.[cf]$/) { $found_src++; }
523 print "Found executables\n" if $debug;
524 open (PGMS, "ls -1 |" ) || die "Cannot list programs\n";
526 # Check for stop file
528 # Exit because we found a stopfile
529 print STDERR "Terminating test because stopfile $stopfile found\n";
534 if (-d $programname) { next; } # Ignore directories
535 if ($programname eq "runtests") { next; } # Ignore self
536 if (-x $programname) {
538 &RunMPIProgram( $programname, $np_default, "", "", "", "", "", "", "" );
544 print "Found source files\n" if $debug;
545 open (PGMS, "ls -1 *.c |" ) || die "Cannot list programs\n";
548 # Exit because we found a stopfile
549 print STDERR "Terminating test because stopfile $stopfile found\n";
554 # Skip messages from ls about no files
555 if (! -s $programname) { next; }
556 $programname =~ s/\.c//;
558 if (&BuildMPIProgram( $programname, "") == 0) {
559 &RunMPIProgram( $programname, $np_default, "", "", "", "", "", "", "" );
562 # We expected to run this program, so failure to build
567 &CleanUpAfterRun( $programname );
573 # ToDo: Add a way to limit the time that any particular program may run.
575 # name of program, number of processes, name of routine to check results
576 # init for testing, timelimit, and any additional program arguments
577 # If the 3rd arg is not present, the a default that simply checks that the
578 # return status is 0 and that the output is " No Errors" is used.
580 my ($programname,$np,$ResultTest,$InitForTest,$timeLimit,$progArgs,$progEnv,$mpiexecArgs,$xfail) = @_;
582 my $found_noerror = 0;
585 &RunPreMsg( $programname, $np, $curdir );
589 # Set a default timeout on tests (3 minutes for now)
590 my $timeout = $defaultTimeLimit;
591 if (defined($timeLimit) && $timeLimit =~ /^\d+$/) {
592 $timeout = $timeLimit;
594 $ENV{"MPIEXEC_TIMEOUT"} = $timeout;
596 # Run the optional setup routine. For example, the timeout tests could
597 # be set to a shorter timeout.
598 if ($InitForTest ne "") {
601 print STDOUT "Env includes $progEnv\n" if $verbose;
602 print STDOUT "$mpiexec $wrapparg $mpiexecArgs $np_arg $np $program_wrapper ./$programname $progArgs\n" if $verbose;
603 print STDOUT "." if $showProgress;
604 # Save and restore the environment if necessary before running mpiexec.
605 if ($progEnv ne "") {
607 foreach $val (split(/\s+/, $progEnv)) {
608 if ($val =~ /([^=]+)=(.*)/) {
612 print STDERR "Environment variable/value $val not in a=b form\n";
616 open ( MPIOUT, "$mpiexec $wrapparg $np_arg $np $mpiexecArgs $program_wrapper ./$programname $progArgs 2>&1 |" ) ||
617 die "Could not run ./$programname\n";
618 if ($progEnv ne "") {
621 if ($ResultTest ne "") {
622 # Read and process the output
623 ($found_error, $inline) = &$ResultTest( MPIOUT, $programname );
627 $inline = "$mpiexec $wrapparg $np_arg $np $program_wrapper ./$programname\n";
633 print STDOUT $_ if $verbose;
635 if (/FORTRAN STOP/) { next; }
637 if (/^\s*No [Ee]rrors\s*$/ && $found_noerror == 0) {
640 if (! /^\s*No [Ee]rrors\s*$/ && !/^\s*Test Passed\s*$/) {
641 print STDERR "Unexpected output in $programname: $_";
648 if ($found_noerror == 0) {
649 print STDERR "Program $programname exited without No Errors\n";
655 $rc = close ( MPIOUT );
657 # Only generate a message if we think that the program
661 $signal_num = $run_status & 127;
662 if ($run_status > 255) { $run_status >>= 8; }
663 print STDERR "Program $programname exited with non-zero status $run_status\n";
664 if ($signal_num != 0) {
665 print STDERR "Program $programname exited with signal $signal_num\n";
673 &RunTestFailed( $programname, $np, $curdir, $inline, $xfail );
676 &RunTestPassed( $programname, $np, $curdir, $xfail );
678 &RunPostMsg( $programname, $np, $curdir );
681 # This version simply writes the mpiexec command out, with the output going
682 # into a file, and recording the output status of the run.
684 my ($programname,$np,$ResultTest,$InitForTest,$timeLimit,$progArgs,$progEnv,$mpiexecArgs, $xfail) = @_;
686 if (! -x $programname) {
687 print STDERR "Could not find $programname!";
691 if ($ResultTest ne "") {
692 # This test really needs to be run manually, with this test
693 # Eventually, we can update this to include handleing in checktests.
694 print STDERR "Run $curdir/$programname with $np processes and use $ResultTest to check the results\n";
698 # Set a default timeout on tests (3 minutes for now)
699 my $timeout = $defaultTimeLimit;
700 if (defined($timeLimit) && $timeLimit =~ /^\d+$/) {
701 # On some systems, there is no effective time limit on
702 # individual mpi program runs. In that case, we may
703 # want to treat these also as "run manually".
704 $timeout = $timeLimit;
706 print BATOUT "export MPIEXEC_TIMEOUT=$timeout\n";
708 # Run the optional setup routine. For example, the timeout tests could
709 # be set to a shorter timeout.
710 if ($InitForTest ne "") {
714 # For non-MPICH versions of mpiexec, a timeout may require a different
715 # environment variable or command line option (e.g., for Cray aprun,
716 # the option -t <sec> must be given, there is no environment variable
717 # to set the timeout.
719 if (defined($timeoutArgPattern) && $timeoutArgPattern ne "") {
720 my $timeArg = $timeoutArgPattern;
721 $timeoutArg =~ s/<SEC>/$timeout/;
722 $extraArgs .= $timeoutArg
725 print STDOUT "Env includes $progEnv\n" if $verbose;
726 print STDOUT "$mpiexec $np_arg $np $extraArgs $program_wrapper ./$programname $progArgs\n" if $verbose;
727 print STDOUT "." if $showProgress;
728 # Save and restore the environment if necessary before running mpiexec.
729 if ($progEnv ne "") {
731 # save_NAME_is_set=is old name set
733 # export NAME=newvalue
735 # export NAME=oldValue (if set!)
736 print STDERR "Batch output does not permit changes to environment\n";
738 # The approach here is to move the test codes to a single directory from
739 # which they can be run; this avoids complex code to change directories
740 # and ensure that the output goes "into the right place".
742 rename $programname, "$batrundir/$programname";
743 print BATOUT "echo \"# $mpiexec $np_arg $np $extraArgs $mpiexecArgs $program_wrapper $curdir/$programname $progArgs\" > runtests.$testCount.out\n";
744 # Some programs expect to run in the same directory as the executable
745 print BATOUT "$mpiexec $np_arg $np $extraArgs $mpiexecArgs $program_wrapper ./$programname $progArgs >> runtests.$testCount.out 2>&1\n";
746 print BATOUT "echo \$? > runtests.$testCount.status\n";
750 # Return value is 0 on success, non zero on failure
751 sub BuildMPIProgram {
752 my $programname = shift;
753 if (! -x $programname) {
754 die "Could not find $programname. Aborting.\n";
757 # THE FOLLOWING IS DISABLED.
760 if ($verbose) { print STDERR "making $programname\n"; }
761 if (! -x $programname) { $remove_this_pgm = 1; }
762 else { $remove_this_pgm = 0; }
763 my $output = `make $programname 2>&1`;
765 if ($rc > 255) { $rc >>= 8; }
766 if (! -x $programname) {
767 print STDERR "Failed to build $programname; $output\n";
771 # Add a line to the summary file describing the failure
772 # This will ensure that failures to build will end up
773 # in the summary file (which is otherwise written by the
774 # RunMPIProgram step)
775 &RunPreMsg( $programname, $np, $curdir );
776 &RunTestFailed( $programname, $np, $curdir, "Failed to build $programname; $output", $xfail );
777 &RunPostMsg( $programname, $np, $curdir );
782 sub CleanUpAfterRun {
783 my $programname = $_[0];
785 # Check for that this program has exited. If it is still running,
786 # issue a warning and leave the application. Of course, this
787 # check is complicated by the lack of a standard access to the
788 # running processes for this user in Unix.
789 @stillRunning = &FindRunning( $programname );
791 if ($#stillRunning > -1) {
792 print STDERR "Some programs ($programname) may still be running:\npids = ";
793 for (my $i=0; $i <= $#stillRunning; $i++ ) {
794 print STDERR $stillRunning[$i] . " ";
797 # Remind the user that the executable remains; we leave it around
798 # to allow the programmer to debug the running program, for which
799 # the executable is needed.
800 print STDERR "The executable ($programname) will not be removed.\n";
803 if ($remove_this_pgm && $clean_pgms) {
804 unlink $programname, "$programname.o";
806 $remove_this_pgm = 0;
809 # ----------------------------------------------------------------------------
811 my $programname = $_[0];
814 my $logname = $ENV{'USER'};
816 my $rc = open PSFD, "ps auxw -U $logname 2>&1 |";
819 $rc = open PSFD, "ps -fu $logname 2>&1 |";
822 print STDERR "Could not execute ps command\n";
827 if (/$programname/) {
828 @fields = split(/\s+/);
829 my $pid = $fields[$pidloc];
830 # Check that we've found a numeric pid
831 if ($pid =~ /^\d+$/) {
832 $pids[$#pids + 1] = $pid;
840 # ----------------------------------------------------------------------------
842 # TestStatus is a special test that reports success *only* when the
843 # status return is NONZERO
846 my $programname = $_[1];
851 #print STDOUT $_ if $verbose;
853 if (/FORTRAN STOP/) { next; }
855 # ANY output is an error. We have the following output
856 # exception for the Hydra process manager.
859 print STDERR "Unexpected output in $programname: $_";
866 $rc = close ( MPIOUT );
869 $signal_num = $run_status & 127;
870 if ($run_status > 255) { $run_status >>= 8; }
873 # This test *requires* non-zero return codes
878 $inline .= "$mpiexec returned a zero status but the program returned a nonzero status\n";
880 return ($found_error,$inline);
883 # TestTimeout is a special test that reports success *only* when the
884 # status return is NONZERO and there are no processes left over.
885 # This test currently checks only for the return status.
888 my $programname = $_[1];
893 #print STDOUT $_ if $verbose;
895 if (/FORTRAN STOP/) { next; }
897 if (/[Tt]imeout/) { next; }
898 # Allow 'signaled with Interrupt' (see gforker mpiexec)
899 if (/signaled with Interrupt/) { next; }
900 # Allow 'job ending due to env var MPIEXEC_TIMEOUT' (mpd)
901 if (/job ending due to env var MPIEXEC_TIMEOUT/) { next; }
902 # Allow 'APPLICATION TIMED OUT' (hydra)
903 if (/\[mpiexec@.*\] APPLICATION TIMED OUT/) { last; }
904 # ANY output is an error (other than timeout)
906 print STDERR "Unexpected output in $programname: $_";
913 $rc = close ( MPIOUT );
916 $signal_num = $run_status & 127;
917 if ($run_status > 255) { $run_status >>= 8; }
920 # This test *requires* non-zero return codes
925 $inline .= "$mpiexec returned a zero status but the program returned a nonzero status\n";
928 # Here should go a check of the processes
929 # open( PFD, "ps -fu $LOGNAME | grep -v grep | grep $programname |" );
934 return ($found_error,$inline);
937 # TestErrFatal is a special test that reports success *only* when the
938 # status return is NONZERO; it ignores error messages
941 my $programname = $_[1];
946 #print STDOUT $_ if $verbose;
948 if (/FORTRAN STOP/) { next; }
950 # ALL output is allowed.
952 $rc = close ( MPIOUT );
955 $signal_num = $run_status & 127;
956 if ($run_status > 255) { $run_status >>= 8; }
959 # This test *requires* non-zero return codes
964 $inline .= "$mpiexec returned a zero status but the program returned a nonzero status\n";
966 return ($found_error,$inline);
969 # ----------------------------------------------------------------------------
971 # RunPreMsg( programname, np, workdir ) - Call before running a program
972 # RunTestFailed, RunTestPassed - Call after test
973 # RunPostMsg - Call at end of each test
976 my ($programname,$np,$workdir) = @_;
978 print XMLOUT "<MPITEST>$newline<NAME>$programname</NAME>$newline";
979 print XMLOUT "<NP>$np</NP>$newline";
980 print XMLOUT "<WORKDIR>$workdir</WORKDIR>$newline";
984 my ($programname, $np, $workdir) = @_;
986 print XMLOUT "</MPITEST>$newline";
990 my ($programname, $np, $workdir, $xfail) = @_;
992 print XMLOUT "<STATUS>pass</STATUS>$newline";
997 $xfailstr = " # TODO $xfail";
999 print TAPOUT "ok ${total_run} - $workdir/$programname ${np}${xfailstr}\n";
1003 my $programname = shift;
1005 my $workdir = shift;
1011 # basic escapes that wreck the XML output
1012 $xout =~ s/</\*AMP\*lt;/g;
1013 $xout =~ s/>/\*AMP\*gt;/g;
1014 $xout =~ s/&/\*AMP\*amp;/g;
1015 $xout =~ s/\*AMP\*/&/g;
1016 # TODO: Also capture any non-printing characters (XML doesn't like them
1018 print XMLOUT "<STATUS>fail</STATUS>$newline";
1019 print XMLOUT "<TESTDIFF>$newline$xout</TESTDIFF>$newline";
1025 $xfailstr = " # TODO $xfail";
1027 print TAPOUT "not ok ${total_run} - $workdir/$programname ${np}${xfailstr}\n";
1028 print TAPOUT " ---\n";
1029 print TAPOUT " Directory: $workdir\n";
1030 print TAPOUT " File: $programname\n";
1031 print TAPOUT " Num-procs: $np\n";
1032 print TAPOUT " Date: \"" . localtime . "\"\n";
1034 # The following would be nice, but it leads to unfortunate formatting in
1035 # the Jenkins web output for now. Using comment lines instead, since
1036 # they are easier to read/find in a browser.
1037 ## print TAPOUT " Output: |\n";
1038 ## # using block literal format, requires that all chars are printable
1039 ## # UTF-8 (or UTF-16, but we won't encounter that)
1040 ## foreach my $line (split m/\r?\n/, $output) {
1042 ## # 4 spaces, 2 for TAP indent, 2 more for YAML block indent
1043 ## print TAPOUT " $line\n";
1046 print TAPOUT " ...\n";
1048 # Alternative to the "Output:" YAML block literal above. Do not put any
1049 # spaces before the '#', this causes some TAP parsers (including Perl's
1050 # TAP::Parser) to treat the line as "unknown" instead of a proper
1052 print TAPOUT "## Test output (expected 'No Errors'):\n";
1053 foreach my $line (split m/\r?\n/, $output) {
1055 print TAPOUT "## $line\n";
1061 my $programname = shift;
1063 my $workdir = shift;
1066 # simply omit from the XML output
1069 print TAPOUT "ok ${total_seen} - $workdir/$programname $np # SKIP $reason\n";
1073 # ----------------------------------------------------------------------------
1074 # Alternate init routines
1075 sub InitQuickTimeout {
1076 $ENV{"MPIEXEC_TIMEOUT"} = 10;