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

@ISA = "Exporter";
5
@EXPORT = qw (test test_cmd test_ssh test_rcmd test_experiment exit_str
6
	      ERR_MASK ERR_NONE ERR_EXPECTED ERR_FAILED ERR_FATAL ERR_INT
7 8
	      STATUS_MASK STATUS_NONE STATUS_SWAPPEDIN STATUS_EXISTS STATUS_CLEANUP);

9 10 11 12 13 14
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);
15
use vars qw($EXPECTED $FAILED);
16 17 18 19 20 21 22 23
use vars qw(%ERR %STATUS);

sub true() {1}
sub false() {0}

#
# exit values, or two parts together
#
24

25 26 27 28 29 30
sub ERR_MASK     {7};
sub ERR_NONE     {0};
sub ERR_EXPECTED {1}; # expected failures
sub ERR_FAILED   {2}; # tests failed
sub ERR_FATAL    {3}; # fatal error
sub ERR_INT      {4}; # interrupted
31
%ERR = (ERR_NONE, 'ERR_NONE',
32
	ERR_EXPECTED, 'ERR_EXPECTED',
33 34 35 36
	ERR_FAILED, 'ERR_FAILED',
	ERR_FATAL, 'ERR_FATAL',
	ERR_INT, 'ERR_INT');

37 38 39 40 41
sub STATUS_MASK      {3 << 3};
sub STATUS_NONE      {0 << 3};
sub STATUS_SWAPPEDIN {1 << 3}; # experment still swapped in
sub STATUS_EXISTS    {2 << 3}; # experment still exists
sub STATUS_CLEANUP   {3 << 3}; # requires cleanup
42 43 44 45 46 47 48 49 50
%STATUS = (STATUS_NONE, 'STATUS_NONE',
	   STATUS_SWAPPEDIN, 'STATUS_SWAPPEDIN',
	   STATUS_EXISTS, 'STATUS_EXISTS',
	   STATUS_CLEANUP, 'STATUS_CLEANUP');

sub exit_str($) {
  my ($exit) = @_;
  return join(' ', $ERR{$exit &  ERR_MASK}, $STATUS{$exit & STATUS_MASK});
}
51

52 53 54 55 56 57 58 59 60 61 62 63
#
#
#

sub oneof ($$) {
  my ($what, $which) = @_;
  foreach (@{$parms{$which}}) {
    return true if ($_ eq $what);
  }
  return false;
}

64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80
#
# 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) = @_;
81 82 83 84 85

  if (oneof($name, 'skip')) {
    return 0;
  }

86 87 88 89 90 91 92 93 94 95
  $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;
  }

96
  print "<=== Starting Test: $name\n";
97

98 99 100 101 102 103
  my $res;
  eval {$res = &$test(%parms)};

  if ($res) {
    $tally{passed}++;
    $dependencies{$name} = 1;
104
    print ">=== \"$name\" succeeded\n";
105
    return true;
106
  } elsif ($@) {
107 108 109 110 111 112 113 114 115
    if (oneof($name, 'ignore')) {
      $tally{expected}++;
      print $EXPECTED "$name\n";
      print ">=== \"$name\" died: $@ -- ignored";
    } else {
      $tally{failed}++;
      print $FAILED "$name\n";
      print ">*** \"$name\" died: $@";
    }
116
    return false;
117
  } else {
118 119 120 121 122 123 124 125 126
    if (oneof($name, 'ignore')) {
      $tally{expected}++;
      print $EXPECTED "$name\n";
      print ">=== \"$name\" failed -- ignored\n";
    } else {
      $tally{failed}++;
      print $FAILED "$name\n";
      print ">*** \"$name\" failed\n";
    }
127
    return false;
128 129 130
  }
}

131 132 133 134
#
#
#
sub sys (@) {
135
  print "<- Executing: ", join(' ', @_), "\n";
136
  system @_;
137
  print ">- Done\n";
138 139 140
  return $? >> 8 == 0;
}

141 142 143 144 145 146 147 148 149 150
#
# 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 {
    if (not defined $output_test) {
151
      return sys($cmd);
152 153 154
    } else {
      local $/ = undef;
      my $F = new IO::File;
155
      print "<- Executing: $cmd\n";
156
      open $F, "$cmd |" or return false;
157 158
      local $_ = <$F>;
      close $F;
159
      print ">- Done\n";
160 161 162 163 164
      return 0 unless ($? >> 8 == 0);
      open $F, ">$resultsdir/$name.out";
      print $F $_;
      close $F;
      my $res = &$output_test;
165
      print "*** Output of \"$cmd\" did not match expected output\n" unless $res;
166 167 168 169 170 171 172 173 174 175 176 177 178
      return $res;
    }
  };
}

#
# Test that ssh is working on a node
#
# Example:
#   test_ssh 'node';
#
sub test_ssh ($) {
  my ($node) = @_;
179
  test_cmd "ssh-$node", [], "ssh-node $node true";
180 181 182 183 184 185 186 187 188 189 190 191 192 193
}

#
# 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],
194
	    "ssh-node $node $cmd", $output_test);
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
}

#
# 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;

241 242
  return if $parms{skip_std_tests};

243 244 245 246 247 248 249 250 251 252 253
  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\: /;
  };

254 255 256 257 258 259
  test "proj_mount-$node", ["ssh-$node"], sub {
    sys "ssh-node $node touch $resultsdir/working/$node"
      or return false;
    return -e "$resultsdir/working/$node";
  }

260 261 262 263 264 265 266 267 268
}

#
#
#
sub multi_node_tests () {

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

269 270
  return if $parms{skip_std_tests};

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
  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 = ();
314
  %tally = (total => 0, passed => 0, expected => 0, failed => 0);
315 316 317 318 319

  $eid = $parms{eid};
  $pid = $parms{pid};
  $datadir = $parms{datadir};
  $resultsdir = $parms{resultsdir};
320 321 322

  my $err = ERR_NONE;
  my $status = STATUS_NONE;
323 324 325

  $SIG{__DIE__} = sub {
    return unless defined $^S && !$^S;
326
    $! = (ERR_FATAL | $status);
327 328 329
    die $_[0];
  };

330 331 332
  $SIG{INT} = 'IGNORE';

  $SIG{TERM} = sub {
333 334
    print "TERMINATING\n";
    exit (ERR_INT | $status);
335 336
  };

337
  mkdir $resultsdir, 0777;
338 339 340 341
  chdir $resultsdir;

  mkdir "working", 0777;
  mkdir "bin",     0777;
342

343 344 345
  #sleep 5;
  #exit 0;

346
  $ENV{PATH} = "$resultsdir/bin:$ENV{PATH}";
347

348 349
  open STDOUT, ">log"      or die;
  open STDERR, ">&STDOUT"  or die;
350 351 352

  my ($F,$O);

353 354 355 356 357
  $F = new IO::File ">pid" or die;
  print $F "$$\n";
  close $F;

  $FAILED = new IO::File ">failed-tests" or die;
358
  $EXPECTED = new IO::File ">failed-but-ignored" or die;
359 360

  $F = new IO::File ">parms" or die;
361
  foreach (sort keys %parms) {
362 363 364 365 366
    unless (ref $parms{$_}) {
      print $F "$_: $parms{$_}\n";
    } else {
      print $F "$_: @{$parms{$_}}\n";
    }
367
  }
368 369 370 371 372 373 374 375 376 377 378 379 380 381
  close $F;

  $F = new IO::File ">bin/ssh-node" or die;
  print $F "#!/bin/sh\n";
  print $F "\n";
  print $F 'cmd=$1',"\n";
  print $F 'shift', "\n";
  print $F join(' ',
		'ssh', "-x",
		"-o BatchMode=yes", "-o StrictHostKeyChecking=no",
		"-o UserKnownHostsFile=$resultsdir/working/known_hosts",
		"\$cmd.$parms{eid}.$parms{pid}", '"$@"', "\n");
  close $F;
  chmod 0755, "bin/ssh-node";
382 383 384 385

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

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

394 395 396 397
    $status = STATUS_EXISTS;
    sys("/usr/testbed/bin/startexp -w -i -f".
	" -E \"Experiment For Testing Images\"".
	" -p $pid -e $eid nsfile.ns");
398 399
    if ($? >> 8 != 0) {
      print "*** Could not create experment\n";
400
      exit (ERR_FATAL | STATUS_NONE);
401 402 403 404 405
    }
  }

  my $swapin_success = 1;
  if ($parms{stages} =~ /s/) {
406
    $status = STATUS_SWAPPEDIN;
407 408
    $swapin_success = test_cmd 'swapin', [],
      "/usr/testbed/bin/swapexp -w -e $pid,$eid in";
409
    $status = STATUS_EXISTS unless $swapin_success;
410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455
  }

  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";
456
	  $err = ERR_FATAL
457 458 459 460
	}
      }
    }

461 462 463
    if ($parms{stages} =~ /[oe]/ && 
	(!$parms{dont_swapout_unexpected} || $tally{failed} == 0)) {
      
464 465 466 467
      test_cmd 'loghole', [], "loghole -e $pid/$eid sync";
	
      foreach my $node (@nodes) {
	my $pnode = $to_physical{$node};
468 469
	sys "cp -pr /var/log/tiplogs/$pnode.run tiplog-$node"
	  or print "*** WARNING: Unable to copy tiplog for node $node.\n";
470 471 472
      }

      test_cmd 'swapout', [],
473 474
	"/usr/testbed/bin/swapexp -w -e $pid,$eid out"
	  and $status = STATUS_EXISTS;
475 476 477 478 479 480 481 482

      # 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`;
    }

  } else {

483
    $err = ERR_FATAL;
484 485 486

  }

487 488
  $err = ERR_FAILED   if $err == ERR_NONE && $tally{failed} > 0;
  $err = ERR_EXPECTED if $err == ERR_NONE && $tally{expected} > 0;
489

490 491
  if ($parms{stages} =~ /e/ &&
      (!$parms{dont_swapout_unexpected} || $tally{failed} == 0)) {
492

493
    sys("cp -pr /proj/$pid/exp/$eid exp-data");
494 495
    if ($? >> 8 != 0) {
      print "*** Unable to copy exp data.  Not terminating exp\n";
496
      exit ($err | STATUS_CLEANUP);
497 498
    }

499
    sys("/usr/testbed/bin/endexp -w -e $pid,$eid");
500 501
    if ($? >> 8 != 0) {
      print "*** Could not terminate experiment.  Must do manually\n";
502
      exit ($err | STATUS_CLEANUP);
503
    }
504 505 506 507 508 509 510

    $status = STATUS_NONE;
  }

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

    print "\n";
511 512 513 514 515 516
    print "Num Tests:           $tally{total}\n";
    print "Passed:              $tally{passed}\n";
    print "Expected Failures:   $tally{expected}\n";
    print "Unexpected Failures: $tally{failed}\n";
    my $unex = $tally{total} - $tally{passed} - $tally{expected} - $tally{failed};
    print "Unable to Execute:   $unex\n";
517

518 519
  }

520
  exit ($err | $status);
521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543
}