njn | 9fb16f5 | 2003-04-23 17:47:13 +0000 | [diff] [blame] | 1 | #! @PERL@ |
njn | a217f3d | 2002-09-27 08:26:27 +0000 | [diff] [blame] | 2 | ##--------------------------------------------------------------------## |
| 3 | ##--- Valgrind regression testing script vg_regtest ---## |
| 4 | ##--------------------------------------------------------------------## |
njn | c2e7f48 | 2002-09-27 08:44:17 +0000 | [diff] [blame] | 5 | |
njn | b9c427c | 2004-12-01 14:14:42 +0000 | [diff] [blame] | 6 | # This file is part of Valgrind, a dynamic binary instrumentation |
| 7 | # framework. |
njn | c2e7f48 | 2002-09-27 08:44:17 +0000 | [diff] [blame] | 8 | # |
njn | 0e1b514 | 2003-04-15 14:58:06 +0000 | [diff] [blame] | 9 | # Copyright (C) 2003 Nicholas Nethercote |
njn | 2bc1012 | 2005-05-08 02:10:27 +0000 | [diff] [blame] | 10 | # njn@valgrind.org |
njn | c2e7f48 | 2002-09-27 08:44:17 +0000 | [diff] [blame] | 11 | # |
| 12 | # This program is free software; you can redistribute it and/or |
| 13 | # modify it under the terms of the GNU General Public License as |
| 14 | # published by the Free Software Foundation; either version 2 of the |
| 15 | # License, or (at your option) any later version. |
| 16 | # |
| 17 | # This program is distributed in the hope that it will be useful, but |
| 18 | # WITHOUT ANY WARRANTY; without even the implied warranty of |
| 19 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU |
| 20 | # General Public License for more details. |
| 21 | # |
| 22 | # You should have received a copy of the GNU General Public License |
| 23 | # along with this program; if not, write to the Free Software |
| 24 | # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA |
| 25 | # 02111-1307, USA. |
| 26 | # |
| 27 | # The GNU General Public License is contained in the file COPYING. |
| 28 | |
| 29 | #---------------------------------------------------------------------------- |
njn | a217f3d | 2002-09-27 08:26:27 +0000 | [diff] [blame] | 30 | # usage: vg_regtest [options] <dirs | files> |
njn25 | e49d8e7 | 2002-09-23 09:36:25 +0000 | [diff] [blame] | 31 | # |
njn | a217f3d | 2002-09-27 08:26:27 +0000 | [diff] [blame] | 32 | # Options: |
njn | a217f3d | 2002-09-27 08:26:27 +0000 | [diff] [blame] | 33 | # --all: run tests in all subdirs |
njn | 3ed8960 | 2006-10-23 18:38:35 +0000 | [diff] [blame] | 34 | # --valgrind: valgrind launcher to use. Default is ./coregrind/valgrind. |
| 35 | # (This option should probably only be used in conjunction with |
| 36 | # --valgrind-lib.) |
| 37 | # --valgrind-lib: valgrind libraries to use. Default is $tests_dir/.in_place. |
| 38 | # (This option should probably only be used in conjunction with |
| 39 | # --valgrind.) |
njn | a217f3d | 2002-09-27 08:26:27 +0000 | [diff] [blame] | 40 | # |
njn | 4ba5a79 | 2002-09-30 10:23:54 +0000 | [diff] [blame] | 41 | # The easiest way is to run all tests in valgrind/ with (assuming you installed |
| 42 | # in $PREFIX): |
| 43 | # |
| 44 | # $PREFIX/bin/vg_regtest --all |
| 45 | # |
njn | a217f3d | 2002-09-27 08:26:27 +0000 | [diff] [blame] | 46 | # You can specify individual files to test, or whole directories, or both. |
jsgf | 855d93d | 2003-10-13 22:26:55 +0000 | [diff] [blame] | 47 | # Directories are traversed recursively, except for ones named, for example, |
| 48 | # CVS/ or docs/. |
njn25 | e49d8e7 | 2002-09-23 09:36:25 +0000 | [diff] [blame] | 49 | # |
| 50 | # Each test is defined in a file <test>.vgtest, containing one or more of the |
njn | a217f3d | 2002-09-27 08:26:27 +0000 | [diff] [blame] | 51 | # following lines, in any order: |
njn25 | e49d8e7 | 2002-09-23 09:36:25 +0000 | [diff] [blame] | 52 | # - prog: <prog to run> (compulsory) |
| 53 | # - args: <args for prog> (default: none) |
| 54 | # - vgopts: <Valgrind options> (default: none) |
| 55 | # - stdout_filter: <filter to run stdout through> (default: none) |
njn | a217f3d | 2002-09-27 08:26:27 +0000 | [diff] [blame] | 56 | # - stderr_filter: <filter to run stderr through> (default: ./filter_stderr) |
nethercote | c5e1d80 | 2004-11-18 12:48:17 +0000 | [diff] [blame] | 57 | # - prereq: <prerequisite command> (default: none) |
njn | 734b805 | 2007-11-01 04:40:37 +0000 | [diff] [blame] | 58 | # - post: <post-test check command> (default: none) |
| 59 | # - cleanup: <post-test cleanup cmd> (default: none) |
njn25 | e49d8e7 | 2002-09-23 09:36:25 +0000 | [diff] [blame] | 60 | # |
njn | a217f3d | 2002-09-27 08:26:27 +0000 | [diff] [blame] | 61 | # Note that filters are necessary for stderr results to filter out things that |
| 62 | # always change, eg. process id numbers. |
njn25 | e49d8e7 | 2002-09-23 09:36:25 +0000 | [diff] [blame] | 63 | # |
njn | 7866031 | 2005-06-29 04:02:24 +0000 | [diff] [blame] | 64 | # Expected stdout (filtered) is kept in <test>.stdout.exp[0-9]* (can be more |
nethercote | 4592db6 | 2004-02-29 01:31:09 +0000 | [diff] [blame] | 65 | # than one expected output). It can be missing if it would be empty. Expected |
sewardj | 79e88da | 2007-11-09 23:29:46 +0000 | [diff] [blame] | 66 | # stderr (filtered) is kept in <test>.stderr.exp*. There must be at least |
| 67 | # one stderr.exp* file. |
njn25 | e49d8e7 | 2002-09-23 09:36:25 +0000 | [diff] [blame] | 68 | # |
nethercote | c5e1d80 | 2004-11-18 12:48:17 +0000 | [diff] [blame] | 69 | # The prerequisite command, if present, must return 0 otherwise the test is |
njn | 0001fc3 | 2006-04-03 14:25:23 +0000 | [diff] [blame] | 70 | # skipped. The post-test command, if present, must return 0 and its stdout |
njn | 734b805 | 2007-11-01 04:40:37 +0000 | [diff] [blame] | 71 | # must match the expected stdout which is kept in <test>.post.exp[0-9]*. |
nethercote | c5e1d80 | 2004-11-18 12:48:17 +0000 | [diff] [blame] | 72 | # |
njn25 | e49d8e7 | 2002-09-23 09:36:25 +0000 | [diff] [blame] | 73 | # If results don't match, the output can be found in <test>.std<strm>.out, |
njn | 7866031 | 2005-06-29 04:02:24 +0000 | [diff] [blame] | 74 | # and the diff between expected and actual in <test>.std<strm>.diff[0-9]*. |
njn25 | e49d8e7 | 2002-09-23 09:36:25 +0000 | [diff] [blame] | 75 | # |
sewardj | 9136899 | 2006-05-26 00:13:21 +0000 | [diff] [blame] | 76 | # Sometimes it is useful to run all the tests at a high sanity check |
| 77 | # level or with arbitrary other flags. To make this simple, extra |
| 78 | # options, applied to all tests run, are read from $EXTRA_REGTEST_OPTS, |
| 79 | # and handed to valgrind prior to any other flags specified by the |
| 80 | # .vgtest file. |
| 81 | # |
njn | 7358d52 | 2006-11-26 22:49:58 +0000 | [diff] [blame] | 82 | # Some more notes on adding regression tests for a new tool are in |
| 83 | # docs/xml/manual-writing-tools.xml. |
njn25 | e49d8e7 | 2002-09-23 09:36:25 +0000 | [diff] [blame] | 84 | #---------------------------------------------------------------------------- |
| 85 | |
njn | 9fb16f5 | 2003-04-23 17:47:13 +0000 | [diff] [blame] | 86 | use warnings; |
njn25 | e49d8e7 | 2002-09-23 09:36:25 +0000 | [diff] [blame] | 87 | use strict; |
| 88 | |
| 89 | #---------------------------------------------------------------------------- |
| 90 | # Global vars |
| 91 | #---------------------------------------------------------------------------- |
njn | 3ed8960 | 2006-10-23 18:38:35 +0000 | [diff] [blame] | 92 | my $usage="vg_regtest [--all, --valgrind, --valgrind-lib]\n"; |
njn25 | e49d8e7 | 2002-09-23 09:36:25 +0000 | [diff] [blame] | 93 | |
| 94 | my $tmp="vg_regtest.tmp.$$"; |
| 95 | |
| 96 | # Test variables |
| 97 | my $vgopts; # valgrind options |
| 98 | my $prog; # test prog |
| 99 | my $args; # test prog args |
| 100 | my $stdout_filter; # filter program to run stdout results file through |
| 101 | my $stderr_filter; # filter program to run stderr results file through |
nethercote | c5e1d80 | 2004-11-18 12:48:17 +0000 | [diff] [blame] | 102 | my $prereq; # prerequisite test to satisfy before running test |
njn | 734b805 | 2007-11-01 04:40:37 +0000 | [diff] [blame] | 103 | my $post; # check command after running test |
nethercote | 64bc5af | 2004-11-18 11:57:00 +0000 | [diff] [blame] | 104 | my $cleanup; # cleanup command to run |
njn25 | e49d8e7 | 2002-09-23 09:36:25 +0000 | [diff] [blame] | 105 | |
| 106 | my @failures; # List of failed tests |
| 107 | |
njn | 9fb16f5 | 2003-04-23 17:47:13 +0000 | [diff] [blame] | 108 | my $num_tests_done = 0; |
njn | 734b805 | 2007-11-01 04:40:37 +0000 | [diff] [blame] | 109 | my %num_failures = (stderr => 0, stdout => 0, post => 0); |
njn25 | e49d8e7 | 2002-09-23 09:36:25 +0000 | [diff] [blame] | 110 | |
njn | 71fe3e6 | 2003-04-23 21:48:20 +0000 | [diff] [blame] | 111 | # Default valgrind to use is this build tree's (uninstalled) one |
njn | 71fe3e6 | 2003-04-23 21:48:20 +0000 | [diff] [blame] | 112 | my $valgrind = "./coregrind/valgrind"; |
njn25 | e49d8e7 | 2002-09-23 09:36:25 +0000 | [diff] [blame] | 113 | |
| 114 | chomp(my $tests_dir = `pwd`); |
| 115 | |
njn | 3ed8960 | 2006-10-23 18:38:35 +0000 | [diff] [blame] | 116 | my $valgrind_lib = "$tests_dir/.in_place"; |
| 117 | |
njn25 | e49d8e7 | 2002-09-23 09:36:25 +0000 | [diff] [blame] | 118 | # default filter is the one named "filter_stderr" in the test's directory |
| 119 | my $default_stderr_filter = "filter_stderr"; |
| 120 | |
| 121 | |
| 122 | #---------------------------------------------------------------------------- |
| 123 | # Process command line, setup |
| 124 | #---------------------------------------------------------------------------- |
| 125 | |
| 126 | # If $prog is a relative path, it prepends $dir to it. Useful for two reasons: |
| 127 | # |
| 128 | # 1. Can prepend "." onto programs to avoid trouble with users who don't have |
| 129 | # "." in their path (by making $dir = ".") |
| 130 | # 2. Can prepend the current dir to make the command absolute to avoid |
| 131 | # subsequent trouble when we change directories. |
| 132 | # |
| 133 | # Also checks the program exists and is executable. |
nethercote | f4928da | 2004-06-15 10:54:40 +0000 | [diff] [blame] | 134 | sub validate_program ($$$$) |
njn25 | e49d8e7 | 2002-09-23 09:36:25 +0000 | [diff] [blame] | 135 | { |
nethercote | f4928da | 2004-06-15 10:54:40 +0000 | [diff] [blame] | 136 | my ($dir, $prog, $must_exist, $must_be_executable) = @_; |
njn25 | e49d8e7 | 2002-09-23 09:36:25 +0000 | [diff] [blame] | 137 | |
| 138 | # If absolute path, leave it alone. If relative, make it |
| 139 | # absolute -- by prepending current dir -- so we can change |
| 140 | # dirs and still use it. |
| 141 | $prog = "$dir/$prog" if ($prog !~ /^\//); |
nethercote | f4928da | 2004-06-15 10:54:40 +0000 | [diff] [blame] | 142 | if ($must_exist) { |
| 143 | (-f $prog) or die "vg_regtest: `$prog' not found or not a file ($dir)\n"; |
| 144 | } |
njn | 71fe3e6 | 2003-04-23 21:48:20 +0000 | [diff] [blame] | 145 | if ($must_be_executable) { |
nethercote | f4928da | 2004-06-15 10:54:40 +0000 | [diff] [blame] | 146 | (-x $prog) or die "vg_regtest: `$prog' not executable ($dir)\n"; |
njn | 71fe3e6 | 2003-04-23 21:48:20 +0000 | [diff] [blame] | 147 | } |
njn25 | e49d8e7 | 2002-09-23 09:36:25 +0000 | [diff] [blame] | 148 | |
| 149 | return $prog; |
| 150 | } |
| 151 | |
| 152 | sub process_command_line() |
| 153 | { |
| 154 | my $alldirs = 0; |
| 155 | my @fs; |
| 156 | |
| 157 | for my $arg (@ARGV) { |
| 158 | if ($arg =~ /^-/) { |
njn | d8ced86 | 2003-04-08 00:47:05 +0000 | [diff] [blame] | 159 | if ($arg =~ /^--all$/) { |
njn25 | e49d8e7 | 2002-09-23 09:36:25 +0000 | [diff] [blame] | 160 | $alldirs = 1; |
| 161 | } elsif ($arg =~ /^--valgrind=(.*)$/) { |
| 162 | $valgrind = $1; |
njn | 3ed8960 | 2006-10-23 18:38:35 +0000 | [diff] [blame] | 163 | } elsif ($arg =~ /^--valgrind-lib=(.*)$/) { |
| 164 | $valgrind_lib = $1; |
njn25 | e49d8e7 | 2002-09-23 09:36:25 +0000 | [diff] [blame] | 165 | } else { |
| 166 | die $usage; |
| 167 | } |
| 168 | } else { |
| 169 | push(@fs, $arg); |
| 170 | } |
| 171 | } |
nethercote | f4928da | 2004-06-15 10:54:40 +0000 | [diff] [blame] | 172 | $valgrind = validate_program($tests_dir, $valgrind, 1, 0); |
njn25 | e49d8e7 | 2002-09-23 09:36:25 +0000 | [diff] [blame] | 173 | |
| 174 | if ($alldirs) { |
| 175 | @fs = (); |
| 176 | foreach my $f (glob "*") { |
| 177 | push(@fs, $f) if (-d $f); |
| 178 | } |
| 179 | } |
| 180 | |
| 181 | (0 != @fs) or die "No test files or directories specified\n"; |
| 182 | |
| 183 | return @fs; |
| 184 | } |
| 185 | |
| 186 | #---------------------------------------------------------------------------- |
| 187 | # Read a .vgtest file |
| 188 | #---------------------------------------------------------------------------- |
| 189 | sub read_vgtest_file($) |
| 190 | { |
| 191 | my ($f) = @_; |
| 192 | |
| 193 | # Defaults. |
njn | 0001fc3 | 2006-04-03 14:25:23 +0000 | [diff] [blame] | 194 | ($vgopts, $prog, $args) = ("", undef, ""); |
| 195 | ($stdout_filter, $stderr_filter) = (undef, undef); |
njn | 734b805 | 2007-11-01 04:40:37 +0000 | [diff] [blame] | 196 | ($prereq, $post, $cleanup) = (undef, undef, undef); |
njn25 | e49d8e7 | 2002-09-23 09:36:25 +0000 | [diff] [blame] | 197 | |
| 198 | # Every test directory must have a "filter_stderr" |
nethercote | f4928da | 2004-06-15 10:54:40 +0000 | [diff] [blame] | 199 | $stderr_filter = validate_program(".", $default_stderr_filter, 1, 1); |
njn25 | e49d8e7 | 2002-09-23 09:36:25 +0000 | [diff] [blame] | 200 | |
| 201 | open(INPUTFILE, "< $f") || die "File $f not openable\n"; |
| 202 | |
| 203 | while (my $line = <INPUTFILE>) { |
sewardj | b5f6f51 | 2005-03-10 23:59:00 +0000 | [diff] [blame] | 204 | if ($line =~ /^\s*#/ || $line =~ /^\s*$/) { |
| 205 | next; |
| 206 | } elsif ($line =~ /^\s*vgopts:\s*(.*)$/) { |
njn25 | e49d8e7 | 2002-09-23 09:36:25 +0000 | [diff] [blame] | 207 | $vgopts = $1; |
| 208 | } elsif ($line =~ /^\s*prog:\s*(.*)$/) { |
nethercote | f4928da | 2004-06-15 10:54:40 +0000 | [diff] [blame] | 209 | $prog = validate_program(".", $1, 0, 0); |
njn25 | e49d8e7 | 2002-09-23 09:36:25 +0000 | [diff] [blame] | 210 | } elsif ($line =~ /^\s*args:\s*(.*)$/) { |
| 211 | $args = $1; |
njn25 | e49d8e7 | 2002-09-23 09:36:25 +0000 | [diff] [blame] | 212 | } elsif ($line =~ /^\s*stdout_filter:\s*(.*)$/) { |
nethercote | f4928da | 2004-06-15 10:54:40 +0000 | [diff] [blame] | 213 | $stdout_filter = validate_program(".", $1, 1, 1); |
njn25 | e49d8e7 | 2002-09-23 09:36:25 +0000 | [diff] [blame] | 214 | } elsif ($line =~ /^\s*stderr_filter:\s*(.*)$/) { |
nethercote | f4928da | 2004-06-15 10:54:40 +0000 | [diff] [blame] | 215 | $stderr_filter = validate_program(".", $1, 1, 1); |
nethercote | c5e1d80 | 2004-11-18 12:48:17 +0000 | [diff] [blame] | 216 | } elsif ($line =~ /^\s*prereq:\s*(.*)$/) { |
| 217 | $prereq = $1; |
njn | 734b805 | 2007-11-01 04:40:37 +0000 | [diff] [blame] | 218 | } elsif ($line =~ /^\s*post:\s*(.*)$/) { |
| 219 | $post = $1; |
nethercote | 64bc5af | 2004-11-18 11:57:00 +0000 | [diff] [blame] | 220 | } elsif ($line =~ /^\s*cleanup:\s*(.*)$/) { |
| 221 | $cleanup = $1; |
njn25 | e49d8e7 | 2002-09-23 09:36:25 +0000 | [diff] [blame] | 222 | } else { |
| 223 | die "Bad line in $f: $line\n"; |
| 224 | } |
| 225 | } |
| 226 | close(INPUTFILE); |
| 227 | |
| 228 | if (!defined $prog) { |
nethercote | f4928da | 2004-06-15 10:54:40 +0000 | [diff] [blame] | 229 | $prog = ""; # allow no prog for testing error and --help cases |
njn25 | e49d8e7 | 2002-09-23 09:36:25 +0000 | [diff] [blame] | 230 | } |
| 231 | } |
| 232 | |
| 233 | #---------------------------------------------------------------------------- |
| 234 | # Do one test |
| 235 | #---------------------------------------------------------------------------- |
| 236 | # Since most of the program time is spent in system() calls, need this to |
| 237 | # propagate a Ctrl-C enabling us to quit. |
| 238 | sub mysystem($) |
| 239 | { |
njn | 734b805 | 2007-11-01 04:40:37 +0000 | [diff] [blame] | 240 | my $exit_code = system($_[0]); |
| 241 | ($exit_code == 2) and exit 1; # 2 is SIGINT |
| 242 | return $exit_code; |
njn25 | e49d8e7 | 2002-09-23 09:36:25 +0000 | [diff] [blame] | 243 | } |
| 244 | |
nethercote | 137bc55 | 2003-11-14 17:47:54 +0000 | [diff] [blame] | 245 | # from a directory name like "/foo/cachesim/tests/" determine the tool name |
| 246 | sub determine_tool() |
njn25 | cac76cb | 2002-09-23 11:21:57 +0000 | [diff] [blame] | 247 | { |
| 248 | my $dir = `pwd`; |
nethercote | 137bc55 | 2003-11-14 17:47:54 +0000 | [diff] [blame] | 249 | $dir =~ /.*\/([^\/]+)\/tests.*/; # foo/tool_name/tests/foo |
njn25 | cac76cb | 2002-09-23 11:21:57 +0000 | [diff] [blame] | 250 | return $1; |
| 251 | } |
| 252 | |
nethercote | 4592db6 | 2004-02-29 01:31:09 +0000 | [diff] [blame] | 253 | # Compare output against expected output; it should match at least one of |
| 254 | # them. |
| 255 | sub do_diffs($$$$) |
| 256 | { |
| 257 | my ($fullname, $name, $mid, $f_exps) = @_; |
| 258 | |
| 259 | for my $f_exp (@$f_exps) { |
| 260 | (-r $f_exp) or die "Could not read `$f_exp'\n"; |
| 261 | |
| 262 | my $n = ""; |
njn | 7866031 | 2005-06-29 04:02:24 +0000 | [diff] [blame] | 263 | if ($f_exp =~ /.*\.exp(\d*)/) { |
nethercote | 4592db6 | 2004-02-29 01:31:09 +0000 | [diff] [blame] | 264 | $n = $1; |
| 265 | } else { |
| 266 | $n = ""; |
| 267 | ($f_exp eq "/dev/null") or die "Unexpected .exp file: $f_exp\n"; |
| 268 | } |
| 269 | |
sewardj | 2659b16 | 2006-10-17 02:24:51 +0000 | [diff] [blame] | 270 | #print("diff $f_exp $name.$mid.out > $name.$mid.diff$n\n"); |
| 271 | mysystem("diff $f_exp $name.$mid.out > $name.$mid.diff$n"); |
nethercote | 4592db6 | 2004-02-29 01:31:09 +0000 | [diff] [blame] | 272 | |
| 273 | if (not -s "$name.$mid.diff$n") { |
| 274 | # A match; remove .out and any previously created .diff files. |
| 275 | unlink("$name.$mid.out"); |
| 276 | unlink(<$name.$mid.diff*>); |
| 277 | return; |
| 278 | } |
| 279 | } |
| 280 | # If we reach here, none of the .exp files matched. |
| 281 | print "*** $name failed ($mid) ***\n"; |
| 282 | push(@failures, sprintf("%-40s ($mid)", "$fullname")); |
| 283 | $num_failures{$mid}++; |
| 284 | } |
| 285 | |
njn25 | e49d8e7 | 2002-09-23 09:36:25 +0000 | [diff] [blame] | 286 | sub do_one_test($$) |
| 287 | { |
| 288 | my ($dir, $vgtest) = @_; |
| 289 | $vgtest =~ /^(.*)\.vgtest/; |
| 290 | my $name = $1; |
| 291 | my $fullname = "$dir/$name"; |
| 292 | |
sewardj | 9136899 | 2006-05-26 00:13:21 +0000 | [diff] [blame] | 293 | # Pull any extra options (for example, --sanity-level=4) |
| 294 | # from $EXTRA_REGTEST_OPTS. |
| 295 | my $maybe_extraopts = $ENV{"EXTRA_REGTEST_OPTS"}; |
| 296 | my $extraopts = $maybe_extraopts ? $maybe_extraopts : ""; |
| 297 | |
njn25 | e49d8e7 | 2002-09-23 09:36:25 +0000 | [diff] [blame] | 298 | read_vgtest_file($vgtest); |
| 299 | |
nethercote | c5e1d80 | 2004-11-18 12:48:17 +0000 | [diff] [blame] | 300 | if (defined $prereq) { |
| 301 | if (system("$prereq") != 0) { |
| 302 | printf("%-16s (skipping, prereq failed: $prereq)\n", "$name:"); |
nethercote | 781bed4 | 2004-10-19 16:56:41 +0000 | [diff] [blame] | 303 | return; |
| 304 | } |
nethercote | b1affa8 | 2004-01-19 19:14:18 +0000 | [diff] [blame] | 305 | } |
| 306 | |
sewardj | 9136899 | 2006-05-26 00:13:21 +0000 | [diff] [blame] | 307 | printf("%-16s valgrind $extraopts $vgopts $prog $args\n", "$name:"); |
njn25 | e49d8e7 | 2002-09-23 09:36:25 +0000 | [diff] [blame] | 308 | |
nethercote | 137bc55 | 2003-11-14 17:47:54 +0000 | [diff] [blame] | 309 | # Pass the appropriate --tool option for the directory (can be overridden |
njn | efc94ad | 2005-11-12 16:08:09 +0000 | [diff] [blame] | 310 | # by an "args:" line, though). Set both VALGRIND_LIB and |
| 311 | # VALGRIND_LIB_INNER in case this Valgrind was configured with |
| 312 | # --enable-inner. |
nethercote | 137bc55 | 2003-11-14 17:47:54 +0000 | [diff] [blame] | 313 | my $tool=determine_tool(); |
njn | 3ed8960 | 2006-10-23 18:38:35 +0000 | [diff] [blame] | 314 | mysystem("VALGRIND_LIB=$valgrind_lib VALGRIND_LIB_INNER=$valgrind_lib " |
njn | efc94ad | 2005-11-12 16:08:09 +0000 | [diff] [blame] | 315 | . "$valgrind --command-line-only=yes --memcheck:leak-check=no " |
sewardj | 9136899 | 2006-05-26 00:13:21 +0000 | [diff] [blame] | 316 | . "--tool=$tool $extraopts $vgopts " |
njn | efc94ad | 2005-11-12 16:08:09 +0000 | [diff] [blame] | 317 | . "$prog $args > $name.stdout.out 2> $name.stderr.out"); |
njn25 | e49d8e7 | 2002-09-23 09:36:25 +0000 | [diff] [blame] | 318 | |
njn | 0001fc3 | 2006-04-03 14:25:23 +0000 | [diff] [blame] | 319 | # Filter stdout |
njn25 | e49d8e7 | 2002-09-23 09:36:25 +0000 | [diff] [blame] | 320 | if (defined $stdout_filter) { |
| 321 | mysystem("$stdout_filter < $name.stdout.out > $tmp"); |
| 322 | rename($tmp, "$name.stdout.out"); |
| 323 | } |
nethercote | 4592db6 | 2004-02-29 01:31:09 +0000 | [diff] [blame] | 324 | # Find all the .stdout.exp files. If none, use /dev/null. |
| 325 | my @stdout_exps = <$name.stdout.exp*>; |
| 326 | @stdout_exps = ( "/dev/null" ) if (0 == scalar @stdout_exps); |
njn | 0001fc3 | 2006-04-03 14:25:23 +0000 | [diff] [blame] | 327 | do_diffs($fullname, $name, "stdout", \@stdout_exps); |
njn25 | e49d8e7 | 2002-09-23 09:36:25 +0000 | [diff] [blame] | 328 | |
njn | 0001fc3 | 2006-04-03 14:25:23 +0000 | [diff] [blame] | 329 | # Filter stderr |
| 330 | mysystem("$stderr_filter < $name.stderr.out > $tmp"); |
| 331 | rename($tmp, "$name.stderr.out"); |
sewardj | 79e88da | 2007-11-09 23:29:46 +0000 | [diff] [blame] | 332 | # Find all the .stderr.exp files. At least one must exist. |
nethercote | 4592db6 | 2004-02-29 01:31:09 +0000 | [diff] [blame] | 333 | my @stderr_exps = <$name.stderr.exp*>; |
sewardj | 79e88da | 2007-11-09 23:29:46 +0000 | [diff] [blame] | 334 | (0 != scalar @stderr_exps) or die "Could not find `$name.stderr.exp*'\n"; |
nethercote | 4592db6 | 2004-02-29 01:31:09 +0000 | [diff] [blame] | 335 | do_diffs($fullname, $name, "stderr", \@stderr_exps); |
njn | 0001fc3 | 2006-04-03 14:25:23 +0000 | [diff] [blame] | 336 | |
| 337 | # Maybe do post-test check |
njn | 734b805 | 2007-11-01 04:40:37 +0000 | [diff] [blame] | 338 | if (defined $post) { |
| 339 | if (mysystem("$post > $name.post.out") != 0) { |
| 340 | print("post check failed: $post\n"); |
| 341 | $num_failures{"post"}++; |
njn | 0001fc3 | 2006-04-03 14:25:23 +0000 | [diff] [blame] | 342 | } else { |
njn | 734b805 | 2007-11-01 04:40:37 +0000 | [diff] [blame] | 343 | # Find all the .post.exp files. If none, use /dev/null. |
| 344 | my @post_exps = <$name.post.exp*>; |
| 345 | @post_exps = ( "/dev/null" ) if (0 == scalar @post_exps); |
| 346 | do_diffs($fullname, $name, "post", \@post_exps); |
njn | 0001fc3 | 2006-04-03 14:25:23 +0000 | [diff] [blame] | 347 | } |
| 348 | } |
nethercote | c1f8ad9 | 2004-04-17 17:25:08 +0000 | [diff] [blame] | 349 | |
nethercote | 64bc5af | 2004-11-18 11:57:00 +0000 | [diff] [blame] | 350 | if (defined $cleanup) { |
| 351 | (system("$cleanup") == 0) or |
| 352 | print("(cleanup operation failed: $cleanup)\n"); |
nethercote | c1f8ad9 | 2004-04-17 17:25:08 +0000 | [diff] [blame] | 353 | } |
| 354 | |
njn | 9fb16f5 | 2003-04-23 17:47:13 +0000 | [diff] [blame] | 355 | $num_tests_done++; |
njn25 | e49d8e7 | 2002-09-23 09:36:25 +0000 | [diff] [blame] | 356 | } |
| 357 | |
| 358 | #---------------------------------------------------------------------------- |
njn25 | cac76cb | 2002-09-23 11:21:57 +0000 | [diff] [blame] | 359 | # Test one directory (and any subdirs) |
njn25 | e49d8e7 | 2002-09-23 09:36:25 +0000 | [diff] [blame] | 360 | #---------------------------------------------------------------------------- |
njn | db3c469 | 2002-10-04 10:03:34 +0000 | [diff] [blame] | 361 | sub test_one_dir($$); # forward declaration |
njn25 | cac76cb | 2002-09-23 11:21:57 +0000 | [diff] [blame] | 362 | |
njn | db3c469 | 2002-10-04 10:03:34 +0000 | [diff] [blame] | 363 | sub test_one_dir($$) |
njn25 | e49d8e7 | 2002-09-23 09:36:25 +0000 | [diff] [blame] | 364 | { |
njn | db3c469 | 2002-10-04 10:03:34 +0000 | [diff] [blame] | 365 | my ($dir, $prev_dirs) = @_; |
njn25 | e49d8e7 | 2002-09-23 09:36:25 +0000 | [diff] [blame] | 366 | $dir =~ s/\/$//; # trim a trailing '/' |
| 367 | |
nethercote | 362c0d2 | 2004-11-18 18:21:56 +0000 | [diff] [blame] | 368 | # Ignore dirs into which we should not recurse. |
mueller | 92f0b80 | 2003-11-19 00:55:32 +0000 | [diff] [blame] | 369 | if ($dir =~ /^(BitKeeper|CVS|SCCS|docs|doc)$/) { return; } |
njn25 | cac76cb | 2002-09-23 11:21:57 +0000 | [diff] [blame] | 370 | |
njn | 52783ca | 2005-12-08 22:39:04 +0000 | [diff] [blame] | 371 | (-x "$tests_dir/tests/cputest") or die |
| 372 | "vg_regtest: 'cputest' is missing. Did you forget to 'make check'?\n"; |
| 373 | |
nethercote | 362c0d2 | 2004-11-18 18:21:56 +0000 | [diff] [blame] | 374 | # Ignore any dir whose name matches that of an architecture which is not |
| 375 | # the architecture we are running on (eg. when running on x86, ignore ppc/ |
| 376 | # directories). |
| 377 | # Nb: weird Perl-ism -- exit code of '1' is seen by Perl as 256... |
| 378 | if (256 == system("$tests_dir/tests/cputest $dir")) { return; } |
| 379 | |
njn25 | e49d8e7 | 2002-09-23 09:36:25 +0000 | [diff] [blame] | 380 | chdir($dir) or die "Could not change into $dir\n"; |
| 381 | |
njn | 584eaac | 2002-10-04 15:30:48 +0000 | [diff] [blame] | 382 | # Nb: Don't prepend a '/' to the base directory |
| 383 | my $full_dir = $prev_dirs . ($prev_dirs eq "" ? "" : "/") . $dir; |
njn | db3c469 | 2002-10-04 10:03:34 +0000 | [diff] [blame] | 384 | my $dashes = "-" x (50 - length $full_dir); |
njn25 | cac76cb | 2002-09-23 11:21:57 +0000 | [diff] [blame] | 385 | |
njn | db3c469 | 2002-10-04 10:03:34 +0000 | [diff] [blame] | 386 | my @fs = glob "*"; |
njn | db3c469 | 2002-10-04 10:03:34 +0000 | [diff] [blame] | 387 | my $found_tests = (0 != (grep { $_ =~ /\.vgtest$/ } @fs)); |
| 388 | |
| 389 | if ($found_tests) { |
| 390 | print "-- Running tests in $full_dir $dashes\n"; |
njn | db3c469 | 2002-10-04 10:03:34 +0000 | [diff] [blame] | 391 | } |
njn25 | cac76cb | 2002-09-23 11:21:57 +0000 | [diff] [blame] | 392 | foreach my $f (@fs) { |
| 393 | if (-d $f) { |
njn | db3c469 | 2002-10-04 10:03:34 +0000 | [diff] [blame] | 394 | test_one_dir($f, $full_dir); |
njn25 | cac76cb | 2002-09-23 11:21:57 +0000 | [diff] [blame] | 395 | } elsif ($f =~ /\.vgtest$/) { |
njn | db3c469 | 2002-10-04 10:03:34 +0000 | [diff] [blame] | 396 | do_one_test($full_dir, $f); |
njn25 | cac76cb | 2002-09-23 11:21:57 +0000 | [diff] [blame] | 397 | } |
njn25 | e49d8e7 | 2002-09-23 09:36:25 +0000 | [diff] [blame] | 398 | } |
njn | db3c469 | 2002-10-04 10:03:34 +0000 | [diff] [blame] | 399 | if ($found_tests) { |
| 400 | print "-- Finished tests in $full_dir $dashes\n"; |
| 401 | } |
| 402 | |
njn25 | e49d8e7 | 2002-09-23 09:36:25 +0000 | [diff] [blame] | 403 | chdir(".."); |
njn25 | e49d8e7 | 2002-09-23 09:36:25 +0000 | [diff] [blame] | 404 | } |
| 405 | |
| 406 | #---------------------------------------------------------------------------- |
| 407 | # Summarise results |
| 408 | #---------------------------------------------------------------------------- |
njn | 9fb16f5 | 2003-04-23 17:47:13 +0000 | [diff] [blame] | 409 | sub plural($) |
| 410 | { |
| 411 | return ( $_[0] == 1 ? "" : "s" ); |
| 412 | } |
| 413 | |
njn25 | e49d8e7 | 2002-09-23 09:36:25 +0000 | [diff] [blame] | 414 | sub summarise_results |
| 415 | { |
njn | d8ced86 | 2003-04-08 00:47:05 +0000 | [diff] [blame] | 416 | my $x = ( $num_tests_done == 1 ? "test" : "tests" ); |
njn | d8ced86 | 2003-04-08 00:47:05 +0000 | [diff] [blame] | 417 | |
njn | 0001fc3 | 2006-04-03 14:25:23 +0000 | [diff] [blame] | 418 | printf("\n== %d test%s, %d stderr failure%s, %d stdout failure%s, " |
njn | 734b805 | 2007-11-01 04:40:37 +0000 | [diff] [blame] | 419 | . "%d post failure%s ==\n", |
njn | 9fb16f5 | 2003-04-23 17:47:13 +0000 | [diff] [blame] | 420 | $num_tests_done, plural($num_tests_done), |
njn | 0001fc3 | 2006-04-03 14:25:23 +0000 | [diff] [blame] | 421 | $num_failures{"stderr"}, plural($num_failures{"stderr"}), |
| 422 | $num_failures{"stdout"}, plural($num_failures{"stdout"}), |
njn | 734b805 | 2007-11-01 04:40:37 +0000 | [diff] [blame] | 423 | $num_failures{"post"}, plural($num_failures{"post"})); |
njn | 9fb16f5 | 2003-04-23 17:47:13 +0000 | [diff] [blame] | 424 | |
| 425 | foreach my $failure (@failures) { |
| 426 | print "$failure\n"; |
njn25 | e49d8e7 | 2002-09-23 09:36:25 +0000 | [diff] [blame] | 427 | } |
njn | 9fb16f5 | 2003-04-23 17:47:13 +0000 | [diff] [blame] | 428 | print "\n"; |
njn25 | e49d8e7 | 2002-09-23 09:36:25 +0000 | [diff] [blame] | 429 | } |
| 430 | |
| 431 | #---------------------------------------------------------------------------- |
| 432 | # main(), sort of |
| 433 | #---------------------------------------------------------------------------- |
sewardj | 9136899 | 2006-05-26 00:13:21 +0000 | [diff] [blame] | 434 | sub warn_about_EXTRA_REGTEST_OPTS() |
| 435 | { |
| 436 | print "WARNING: \$EXTRA_REGTEST_OPTS is set. You probably don't want\n"; |
| 437 | print "to run the regression tests with it set, unless you are doing some\n"; |
| 438 | print "strange experiment, and/or you really know what you are doing.\n"; |
| 439 | print "\n"; |
| 440 | } |
njn25 | e49d8e7 | 2002-09-23 09:36:25 +0000 | [diff] [blame] | 441 | |
daywalker | bb93698 | 2003-04-23 16:52:06 +0000 | [diff] [blame] | 442 | # nuke VALGRIND_OPTS |
| 443 | $ENV{"VALGRIND_OPTS"} = ""; |
njn25 | e49d8e7 | 2002-09-23 09:36:25 +0000 | [diff] [blame] | 444 | |
sewardj | 9136899 | 2006-05-26 00:13:21 +0000 | [diff] [blame] | 445 | if ($ENV{"EXTRA_REGTEST_OPTS"}) { |
| 446 | print "\n"; |
| 447 | warn_about_EXTRA_REGTEST_OPTS(); |
| 448 | } |
| 449 | |
njn25 | e49d8e7 | 2002-09-23 09:36:25 +0000 | [diff] [blame] | 450 | my @fs = process_command_line(); |
| 451 | foreach my $f (@fs) { |
| 452 | if (-d $f) { |
njn | 584eaac | 2002-10-04 15:30:48 +0000 | [diff] [blame] | 453 | test_one_dir($f, ""); |
njn25 | e49d8e7 | 2002-09-23 09:36:25 +0000 | [diff] [blame] | 454 | } else { |
| 455 | # Allow the .vgtest suffix to be given or omitted |
| 456 | if ($f =~ /.vgtest$/ && -r $f) { |
| 457 | # do nothing |
| 458 | } elsif (-r "$f.vgtest") { |
| 459 | $f = "$f.vgtest"; |
| 460 | } else { |
| 461 | die "`$f' neither a directory nor a readable test file/name\n" |
| 462 | } |
| 463 | my $dir = `dirname $f`; chomp $dir; |
| 464 | my $file = `basename $f`; chomp $file; |
| 465 | chdir($dir) or die "Could not change into $dir\n"; |
| 466 | do_one_test($dir, $file); |
| 467 | chdir($tests_dir); |
| 468 | } |
| 469 | } |
| 470 | summarise_results(); |
| 471 | |
sewardj | 9136899 | 2006-05-26 00:13:21 +0000 | [diff] [blame] | 472 | if ($ENV{"EXTRA_REGTEST_OPTS"}) { |
| 473 | warn_about_EXTRA_REGTEST_OPTS(); |
| 474 | } |
| 475 | |
njn | 0001fc3 | 2006-04-03 14:25:23 +0000 | [diff] [blame] | 476 | if (0 == $num_failures{"stdout"} && |
| 477 | 0 == $num_failures{"stderr"} && |
njn | 734b805 | 2007-11-01 04:40:37 +0000 | [diff] [blame] | 478 | 0 == $num_failures{"post"}) { |
nethercote | ab42219 | 2004-03-01 08:27:37 +0000 | [diff] [blame] | 479 | exit 0; |
| 480 | } else { |
| 481 | exit 1; |
| 482 | } |
| 483 | |
njn | c2e7f48 | 2002-09-27 08:44:17 +0000 | [diff] [blame] | 484 | ##--------------------------------------------------------------------## |
| 485 | ##--- end vg_regtest ---## |
| 486 | ##--------------------------------------------------------------------## |