ImageTest.pm 9.22 KB
Newer Older
1 2 3 4 5
package ImageTest;
use Exporter;

@ISA = "Exporter";
@EXPORT = qw (test test_cmd test_ssh test_rcmd test_experiment
6
	      ERR_NONE ERR_FAILED ERR_SWAPIN ERR_FATAL ERR_CLEANUP ERR_INT);
7 8 9 10 11 12 13 14 15 16 17 18 19 20
use IO::File;
use strict;

use vars qw(%parms %dependencies %tally);
use vars qw($eid $pid $datadir $resultsdir);
use vars qw(@mapping @nodes @pnodes %to_physical %from_physical);
use vars qw($FAILED);

# exit values
sub ERR_NONE    {0};
sub ERR_FAILED  {1}; # tests failed
sub ERR_SWAPIN  {2}; # swapin failed
sub ERR_FATAL   {3}; # fatal error
sub ERR_CLEANUP {4}; # fatal error - cleanup needed
21
sub ERR_INT     {5}; # interrupted
22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243

#
# Performs a test on a swapped in experient.  Returns true if the test
# passed.
#
# Each test can depend and on any number of other tests.  The test
# will be skipped unless all the dependencies are satisfied.
#
# Examples:
#   test 'test 1', [], sub {...};
#   test 'test 2', ['test 1'], sub {...};
#   test 'login prompt', [], sub {
#     local $_ = cat "/var/log/tiplogs/$pnode.run";
#     /login\: /;
#   }
#
sub test ($$&) {
  my ($name,$requires,$test) = @_;
  $tally{total}++;

  my $deps_sat = 1;
  foreach (@$requires) {$deps_sat = 0 unless $dependencies{$_}}

  unless ($deps_sat) {
    print "Skipping test \"$name\" due to unsatisfied dependies.\n";
    return 0;
  }

  my $res;
  eval {$res = &$test(%parms)};

  if ($res) {
    $tally{passed}++;
    $dependencies{$name} = 1;
    print "\"$name\" succeeded\n";
    return 1;
  } elsif ($@) {
    $tally{failed}++;
    print $FAILED "$name\n";
    print "*** \"$name\" died: $@";
    return 0;
  } else {
    $tally{failed}++;
    print $FAILED "$name\n";
    print "*** \"$name\" failed\n";
    return 0;
  }
}

#
# Performs a test by executing a command and optionally checking the output
#
# Example :
#   test_cmd "ssh $node", [], "ssh $node.$eid.$pid true";
#
sub test_cmd ($$$;&) {
  my ($name,$requires,$cmd,$output_test) = @_;
  test $name, $requires, sub {
    print "Executing: $cmd\n";
    if (not defined $output_test) {
      system $cmd;
      return ($? >> 8 == 0);
    } else {
      local $/ = undef;
      my $F = new IO::File;
      open $F, "$cmd |" or return 0;
      local $_ = <$F>;
      close $F;
      return 0 unless ($? >> 8 == 0);
      open $F, ">$resultsdir/$name.out";
      print $F $_;
      close $F;
      my $res = &$output_test;
      print "*** output of \"$cmd\" did not match expected output\n" unless $res;
      return $res;
    }
  };
}

#
# Test that ssh is working on a node
#
# Example:
#   test_ssh 'node';
#
sub test_ssh ($) {
  my ($node) = @_;
  test_cmd "ssh-$node", [], "ssh  -o BatchMode=yes -o StrictHostKeyChecking=no $node.$parms{eid}.$parms{pid} true";
}

#
# Performs a test by executing a remote command and optionally
# checking the output.  test_ssh must be executed on the node before
# any remote commands for the node.
#
# Examples:
#   test_rcmd 'sudo', [], 'node', 'sudo touch /afile.txt';
#   test_rcmd 'hostname' , [], 'node', 'hostname', sub {/^node\.$eid\.$pid/};
#
sub test_rcmd ($$$$;&) {
  my ($name,$requires,$node,$cmd,$output_test) = @_;
  &test_cmd($name, ["ssh-$node", @$requires],
	    "ssh -o BatchMode=yes $node.$parms{eid}.$parms{pid} $cmd", $output_test);
}

#
# Scans a log file for any errors or serious warnings.  The log file
# may also be a pipe as the string is passed directly to open.
#
# Example:
#   test_scanlog 'error free log', [], 'log';
#
sub test_scanlog ($$$) {
  my ($name,$requires,$log) = @_;
  test $name, $requires, sub {
    my $F = new IO::File;
    open $F, $log or die "Unable to open \"$log\" for reading.";
    my $errors = 0;
    while (<$F>) {
      next unless /^\*\*\* /;
      print;
      $errors = 1;
    }
    close $F;
    return $errors == 0;
  };
}

#
#
#
sub cat ($) {
  open F, $_[0];
  local $/ = undef;
  local $_ = <F>;
  close F;
  return $_;
};

#
#
#
sub single_node_tests ($) {

  my ($node) = @_;
  my ($pnode) = $to_physical{$node};

  test_ssh $node;

  test_rcmd "sudo-$node", [], $node, 'sudo touch /afile.txt';

  test_rcmd "hostname-$node" , [], $node, 'hostname', sub {
    /^$node\.$eid\.$pid/i || /^$pnode/i;
  };

  test "login_prompt-$node", [], sub {
    local $_ = cat "/var/log/tiplogs/$pnode.run";
    /login\: /;
  };

}

#
#
#
sub multi_node_tests () {

  #test_cmd 'linktest', [], "run_linktest.pl -v -e $pid/$eid";

  sleep 10;
  test_cmd 'linktest1', [], "run_linktest.pl -v -L 1 -l 1 -e $pid/$eid";
  sleep 2;
  test_cmd 'linktest2', [], "run_linktest.pl -v -L 2 -l 2 -e $pid/$eid";
  sleep 2;
  test_cmd 'linktest3', [], "run_linktest.pl -v -L 3 -l 3 -e $pid/$eid";
  sleep 2;
  test_cmd 'linktest4', [], "run_linktest.pl -v -L 4 -l 4 -e $pid/$eid";

}

#
# Creats and swaps in a test experment in and performs tests on the
# images after it is done.  When all the tests are done swap the experment out,
# copy the experment data dir to EXP-YYYYMMDDHHMM and terminate the experiment.
#
# Will fork a child to do the actual work and return the pid of the child
#
# Expects a hash of parmaters as input for example:
#   test_experiment
#     pid => 'tbres',
#     eid => 'it-single',
#     os => 'RHL73-STD',
#     hardware => 'pc850',
#     datadir => '...',
#     resultsdir => '...',
#
# The .ns file for the experiment is expected to be named "<datadir>/nsfile.ns".
# The file will be scanned and any instances of @PARM@ will be substituted
# for the value of PARM.  Any image specific tests should be located in
# "<datadir>/tests.ns".
#
sub test_experiment (%) {

  {
    my $pid = fork();
    die unless defined $pid;

    return $pid if $pid != 0; # child
  }

  %parms = @_;
  %dependencies = ();
  %tally = (total => 0, passed => 0, failed => 0);

  $eid = $parms{eid};
  $pid = $parms{pid};
  $datadir = $parms{datadir};
  $resultsdir = $parms{resultsdir};
  my $exit = 0;

  $SIG{__DIE__} = sub {
    return unless defined $^S && !$^S;
244
    $! = ERR_CLEANUP;
245 246 247
    die $_[0];
  };

248 249 250 251 252 253
  $SIG{INT} = 'IGNORE';

  $SIG{TERM} = sub {
    exit ERR_INT;
  };

254 255
  mkdir $resultsdir, 0777;

256
  open STDIN,  "/dev/null"        or die;
257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420
  open STDOUT, ">$resultsdir/log" or die;
  open STDERR, ">&STDOUT"         or die;

  $FAILED = new IO::File ">$resultsdir/failed-tests" or die;

  my ($F,$O);

  $F = new IO::File ">$resultsdir/parms" or die;
  foreach (sort keys %parms) {
    print $F "$_: $parms{$_}\n";
  }

  if ($parms{stages} =~ /c/) {

    $F = new IO::File "$datadir/nsfile.ns" or die;
    $O = new IO::File ">$resultsdir/nsfile.ns" or die;
    while (<$F>) {
      s/\@([^@]+)\@/$parms{lc $1}/g;
      print $O $_;
    }
    close $O;
    close $F;

    system("/usr/testbed/bin/startexp -w -i -f".
	   " -E \"Experiment For Testing Images\"".
	   " -p $pid -e $eid $resultsdir/nsfile.ns");
    if ($? >> 8 != 0) {
      print "*** Could not create experment\n";
      exit ERR_FATAL;
    }
  }

  my $swapin_success = 1;
  if ($parms{stages} =~ /s/) {
    $swapin_success = test_cmd 'swapin', [],
      "/usr/testbed/bin/swapexp -w -e $pid,$eid in";
  }

  if ($swapin_success) {

    if ($parms{stages} =~ /s/) {

      # FIXME: need proper way to get the log file
      test_scanlog 'error_free_swapin', [],
	`ls -t /proj/$pid/exp/$eid/tbdata/swapexp.* | head -1`;
    }

    local (@mapping, @nodes, @pnodes, %to_physical, %from_physical);

    open F, "/usr/testbed/bin/expinfo -m $pid $eid | ";

    while (<F>) {
      last if /^---/;
    }

    while (<F>) {
      next unless /\w/;
      local @_ = split /\s+/;
      push @mapping, [@_];
      push @nodes, $_[0];
      push @pnodes, $_[3];
      $to_physical{$_[0]} = $_[3];
      $from_physical{$_[3]} = $_[0];
    }

    if ($parms{stages} =~ /t/) {

      foreach my $node (@nodes) {
	single_node_tests($node);
      }

      if (@nodes > 1) {
	multi_node_tests();
      }

      if (-e "$datadir/tests.pl") {
	
	do "$datadir/tests.pl";
	
	if ($@) {
	  print "*** Unable to complete tests: $@";
	  print "*** Results may not be accurate.\n";
	  $exit = ERR_FATAL
	}
      }
    }

    if ($parms{stages} =~ /[oe]/) {

      test_cmd 'loghole', [], "loghole -e $pid/$eid sync";
	
      foreach my $node (@nodes) {
	my $pnode = $to_physical{$node};
	system "cp -pr /var/log/tiplogs/$pnode.run $resultsdir/tiplog-$node";
	if ($? >> 8 != 0) {
	  print "*** WARNING: Unable to copy tiplog for node $node.\n";
	}
      }

      test_cmd 'swapout', [],
	"/usr/testbed/bin/swapexp -w -e $pid,$eid out";

      # FIXME: need proper way to get the log file
      test_scanlog 'error_free_swapout', ['swapout'],
	`ls -t /proj/$pid/exp/$eid/tbdata/swapexp.* | head -1`;
    }

    if ($parms{stages} =~ /t/) {

      print "\n";
      print "Num Tests:         $tally{total}\n";
      print "Passed:            $tally{passed}\n";
      print "Failed:            $tally{failed}\n";
      my $unex = $tally{total} - $tally{passed} - $tally{failed};
      print "Unable to Execute: $unex\n";

    }

  } else {

    $exit = ERR_SWAPIN;

  }

  if ($parms{stages} =~ /e/) {

    system("cp -pr /proj/$pid/exp/$eid $resultsdir/exp-data");
    if ($? >> 8 != 0) {
      print "*** Unable to copy exp data.  Not terminating exp\n";
      exit ERR_CLEANUP;
    }

    system("/usr/testbed/bin/endexp -w -e $pid,$eid");
    if ($? >> 8 != 0) {
      print "*** Could not terminate experiment.  Must do manually\n";
      exit ERR_CLEANUP;
    }
  }

  $exit = ERR_FAILED if $exit == 0 && $tally{failed} > 0;
  exit $exit;
}