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

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

9 10 11 12 13 14 15
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);
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
sub ERR_MASK    {3};
26 27
sub ERR_NONE    {0};
sub ERR_FAILED  {1}; # tests failed
28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48
sub ERR_FATAL   {2}; # fatal error
sub ERR_INT     {3}; # interrupted
%ERR = (ERR_NONE, 'ERR_NONE',
	ERR_FAILED, 'ERR_FAILED',
	ERR_FATAL, 'ERR_FATAL',
	ERR_INT, 'ERR_INT');

sub STATUS_MASK      {3 << 2};
sub STATUS_NONE      {0 << 2};
sub STATUS_SWAPPEDIN {1 << 2}; # experment still swapped in
sub STATUS_EXISTS    {2 << 2}; # experment still exists
sub STATUS_CLEANUP   {3 << 2}; # requires cleanup
%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});
}
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

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

77
  print "<=== Starting Test: $name\n";
78

79 80 81 82 83 84
  my $res;
  eval {$res = &$test(%parms)};

  if ($res) {
    $tally{passed}++;
    $dependencies{$name} = 1;
85
    print ">=== \"$name\" succeeded\n";
86
    return true;
87 88 89
  } elsif ($@) {
    $tally{failed}++;
    print $FAILED "$name\n";
90 91
    print ">*** \"$name\" died: $@";
    return false;
92 93 94
  } else {
    $tally{failed}++;
    print $FAILED "$name\n";
95 96
    print ">*** \"$name\" failed\n";
    return false;
97 98 99
  }
}

100 101 102 103
#
#
#
sub sys (@) {
104
  print "<- Executing: ", join(' ', @_), "\n";
105
  system @_;
106
  print ">- Done\n";
107 108 109
  return $? >> 8 == 0;
}

110 111 112 113 114 115 116 117 118 119
#
# 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) {
120
      return sys($cmd);
121 122 123
    } else {
      local $/ = undef;
      my $F = new IO::File;
124
      print "<- Executing: $cmd\n";
125
      open $F, "$cmd |" or return false;
126 127
      local $_ = <$F>;
      close $F;
128
      print ">- Done\n";
129 130 131 132 133
      return 0 unless ($? >> 8 == 0);
      open $F, ">$resultsdir/$name.out";
      print $F $_;
      close $F;
      my $res = &$output_test;
134
      print "*** Output of \"$cmd\" did not match expected output\n" unless $res;
135 136 137 138 139 140 141 142 143 144 145 146 147
      return $res;
    }
  };
}

#
# Test that ssh is working on a node
#
# Example:
#   test_ssh 'node';
#
sub test_ssh ($) {
  my ($node) = @_;
148
  test_cmd "ssh-$node", [], "ssh-node $node true";
149 150 151 152 153 154 155 156 157 158 159 160 161 162
}

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

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

210 211
  return if $parms{skip_std_tests};

212 213 214 215 216 217 218 219 220 221 222
  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\: /;
  };

223 224 225 226 227 228
  test "proj_mount-$node", ["ssh-$node"], sub {
    sys "ssh-node $node touch $resultsdir/working/$node"
      or return false;
    return -e "$resultsdir/working/$node";
  }

229 230 231 232 233 234 235 236 237
}

#
#
#
sub multi_node_tests () {

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

238 239
  return if $parms{skip_std_tests};

240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 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
  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};
289 290 291

  my $err = ERR_NONE;
  my $status = STATUS_NONE;
292 293 294

  $SIG{__DIE__} = sub {
    return unless defined $^S && !$^S;
295
    $! = (ERR_FATAL | $status);
296 297 298
    die $_[0];
  };

299 300 301
  $SIG{INT} = 'IGNORE';

  $SIG{TERM} = sub {
302 303
    print "TERMINATING\n";
    exit (ERR_INT | $status);
304 305
  };

306
  mkdir $resultsdir, 0777;
307 308 309 310
  chdir $resultsdir;

  mkdir "working", 0777;
  mkdir "bin",     0777;
311

312 313 314
  #sleep 5;
  #exit 0;

315
  $ENV{PATH} = "$resultsdir/bin:$ENV{PATH}";
316

317 318
  open STDOUT, ">log"      or die;
  open STDERR, ">&STDOUT"  or die;
319 320 321

  my ($F,$O);

322 323 324 325 326 327 328
  $F = new IO::File ">pid" or die;
  print $F "$$\n";
  close $F;

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

  $F = new IO::File ">parms" or die;
329 330 331
  foreach (sort keys %parms) {
    print $F "$_: $parms{$_}\n";
  }
332 333 334 335 336 337 338 339 340 341 342 343 344 345
  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";
346 347 348 349

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

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

358 359 360 361
    $status = STATUS_EXISTS;
    sys("/usr/testbed/bin/startexp -w -i -f".
	" -E \"Experiment For Testing Images\"".
	" -p $pid -e $eid nsfile.ns");
362 363
    if ($? >> 8 != 0) {
      print "*** Could not create experment\n";
364
      exit (ERR_FATAL | STATUS_NONE);
365 366 367 368 369
    }
  }

  my $swapin_success = 1;
  if ($parms{stages} =~ /s/) {
370
    $status = STATUS_SWAPPEDIN;
371 372
    $swapin_success = test_cmd 'swapin', [],
      "/usr/testbed/bin/swapexp -w -e $pid,$eid in";
373
    $status = STATUS_EXISTS unless $swapin_success;
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
  }

  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";
420
	  $err = ERR_FATAL
421 422 423 424 425 426 427 428 429 430
	}
      }
    }

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

      test_cmd 'loghole', [], "loghole -e $pid/$eid sync";
	
      foreach my $node (@nodes) {
	my $pnode = $to_physical{$node};
431 432
	sys "cp -pr /var/log/tiplogs/$pnode.run tiplog-$node"
	  or print "*** WARNING: Unable to copy tiplog for node $node.\n";
433 434 435
      }

      test_cmd 'swapout', [],
436 437
	"/usr/testbed/bin/swapexp -w -e $pid,$eid out"
	  and $status = STATUS_EXISTS;
438 439 440 441 442 443 444 445

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

446
    $err = ERR_FATAL;
447 448 449

  }

450 451
  $err = ERR_FAILED if $err == ERR_NONE && $tally{failed} > 0;

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

454
    sys("cp -pr /proj/$pid/exp/$eid exp-data");
455 456
    if ($? >> 8 != 0) {
      print "*** Unable to copy exp data.  Not terminating exp\n";
457
      exit ($err | STATUS_CLEANUP);
458 459
    }

460
    sys("/usr/testbed/bin/endexp -w -e $pid,$eid");
461 462
    if ($? >> 8 != 0) {
      print "*** Could not terminate experiment.  Must do manually\n";
463
      exit ($err | STATUS_CLEANUP);
464
    }
465 466 467 468 469 470 471 472 473 474 475 476 477

    $status = STATUS_NONE;
  }

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

478 479
  }

480
  exit ($err | $status);
481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503
}