selftest/output/plain.pm

   1 #!/usr/bin/perl
   2 # Plain text output for selftest
   3 # Copyright (C) 2008 Jelmer Vernooij <jelmer@samba.org>
   4 #
   5 # This program is free software; you can redistribute it and/or modify
   6 # it under the terms of the GNU General Public License as published by
   7 # the Free Software Foundation; either version 3 of the License, or
   8 # (at your option) any later version.
   9
  10 # This program is distributed in the hope that it will be useful,
  11 # but WITHOUT ANY WARRANTY; without even the implied warranty of
  12 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13 # GNU General Public License for more details.
  14
  15 # You should have received a copy of the GNU General Public License
  16 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
  17 package output::plain;
  18 use Exporter;
  19 @ISA = qw(Exporter);
  20
  21 use FindBin qw($RealBin);
  22 use lib "$RealBin/..";
  23
  24 use strict;
  25
  26 sub new($$$$$$$) {
  27         my ($class, $summaryfile, $verbose, $immediate, $statistics, $totaltests) = @_;
  28         my $self = {
  29                 verbose => $verbose,
  30                 immediate => $immediate,
  31                 statistics => $statistics,
  32                 start_time => undef,
  33                 test_output => {},
  34                 suitesfailed => [],
  35                 suites_ok => 0,
  36                 skips => {},
  37                 summaryfile => $summaryfile,
  38                 index => 0,
  39                 totalsuites => $totaltests,
  40         };
  41         bless($self, $class);
  42 }
  43
  44 sub report_time($$)
  45 {
  46         my ($self, $time) = @_;
  47         unless ($self->{start_time}) {
  48                 $self->{start_time} = $time;
  49         }
  50         $self->{last_time} = $time;
  51 }
  52
  53 sub output_msg($$);
  54
  55 sub start_testsuite($$)
  56 {
  57         my ($self, $name) = @_;
  58
  59         $self->{index}++;
  60         $self->{NAME} = $name;
  61         $self->{START_TIME} = $self->{last_time};
  62
  63         my $duration = $self->{START_TIME} - $self->{start_time};
  64
  65         $self->{test_output}->{$name} = "" unless($self->{verbose});
  66
  67         my $out = "";
  68         $out .= "[$self->{index}";
  69         if ($self->{totalsuites}) {
  70                 $out .= "/$self->{totalsuites}";
  71         }
  72         $out.= " in ".$duration."s";
  73         $out .= sprintf(", %d errors", ($#{$self->{suitesfailed}}+1)) if ($#{$self->{suitesfailed}} > -1);
  74         $out .= "] $name";
  75         if ($self->{immediate}) {
  76                 print "$out\n";
  77         } else {
  78                 print "$out: ";
  79         }
  80 }
  81
  82 sub output_msg($$)
  83 {
  84         my ($self, $output) = @_;
  85
  86         if ($self->{verbose}) {
  87                 require FileHandle;
  88                 print $output;
  89                 STDOUT->flush();
  90         } elsif (defined($self->{NAME})) {
  91                 $self->{test_output}->{$self->{NAME}} .= $output;
  92         } else {
  93                 print $output;
  94         }
  95 }
  96
  97 sub control_msg($$)
  98 {
  99         my ($self, $output) = @_;
 100
 101         #$self->output_msg($output);
 102 }
 103
 104 sub end_testsuite($$$$$)
 105 {
 106         my ($self, $name, $result, $unexpected, $reason) = @_;
 107         my $out = "";
 108
 109         if ($unexpected) {
 110                 if ($result eq "success" and not defined($reason)) {
 111                         $reason = "Expected negative exit code, got positive exit code";
 112                 }
 113                 $self->output_msg("ERROR: $reason\n");
 114                 push (@{$self->{suitesfailed}}, $name);
 115         } else {
 116                 $self->{suites_ok}++;
 117         }
 118
 119         if ($unexpected and $self->{immediate} and not $self->{verbose}) {
 120                 $out .= $self->{test_output}->{$name};
 121         }
 122
 123         if (not $self->{immediate}) {
 124                 if (not $unexpected) {
 125                         $out .= " ok\n";
 126                 } else {
 127                         $out .= " " . uc($result) . "\n";
 128                 }
 129         }
 130
 131         print $out;
 132 }
 133
 134 sub start_test($$$)
 135 {
 136         my ($self, $parents, $testname) = @_;
 137
 138         if ($#$parents == -1) {
 139                 $self->start_testsuite($testname);
 140         }
 141 }
 142
 143 sub end_test($$$$$)
 144 {
 145         my ($self, $parents, $testname, $result, $unexpected, $reason) = @_;
 146
 147         if ($#$parents == -1) {
 148                 if ($result eq "skip") {
 149                         $self->skip_testsuite($testname, $reason);
 150                 } else {
 151                         $self->end_testsuite($testname, $result, $unexpected, $reason);
 152                 }
 153                 return;
 154         }
 155
 156         my $append = "";
 157
 158         unless ($unexpected) {
 159                 $self->{test_output}->{$self->{NAME}} = "";
 160                 if (not $self->{immediate}) {
 161                         if ($result eq "failure") { print "f"; }
 162                         elsif ($result eq "xfail") { print "X"; }
 163                         elsif ($result eq "skip") { print "s"; }
 164                         elsif ($result eq "success") { print "."; }
 165                         else { print "?($result)"; }
 166                 }
 167                 return;
 168         }
 169
 170         my $fullname = join(".", @$parents).".$testname";
 171
 172         $append = "UNEXPECTED($result): $testname ($fullname)\n";
 173
 174         $self->{test_output}->{$self->{NAME}} .= $append;
 175
 176         if ($self->{immediate} and not $self->{verbose}) {
 177                 print $self->{test_output}->{$self->{NAME}};
 178                 $self->{test_output}->{$self->{NAME}} = "";
 179         }
 180
 181         if (not $self->{immediate}) {
 182                 if ($result eq "error") { print "E"; }
 183                 elsif ($result eq "failure") { print "F"; }
 184                 elsif ($result eq "success") { print "S"; }
 185                 else { print "?"; }
 186         }
 187 }
 188
 189 sub summary($)
 190 {
 191         my ($self) = @_;
 192
 193         open(SUMMARY, ">$self->{summaryfile}");
 194
 195         if ($#{$self->{suitesfailed}} > -1) {
 196                 print SUMMARY "= Failed tests =\n";
 197
 198                 foreach (@{$self->{suitesfailed}}) {
 199                         print SUMMARY "== $_ ==\n";
 200                         print SUMMARY $self->{test_output}->{$_}."\n\n";
 201                 }
 202
 203                 print SUMMARY "\n";
 204         }
 205
 206         if (not $self->{immediate} and not $self->{verbose}) {
 207                 foreach (@{$self->{suitesfailed}}) {
 208                         print "===============================================================================\n";
 209                         print "FAIL: $_\n";
 210                         print $self->{test_output}->{$_};
 211                         print "\n";
 212                 }
 213         }
 214
 215         print SUMMARY "= Skipped tests =\n";
 216         foreach my $reason (keys %{$self->{skips}}) {
 217                 print SUMMARY "$reason\n";
 218                 foreach my $name (@{$self->{skips}->{$reason}}) {
 219                         print SUMMARY "\t$name\n";
 220                 }
 221                 print SUMMARY "\n";
 222         }
 223         close(SUMMARY);
 224
 225         print "\nA summary with detailed information can be found in:\n  $self->{summaryfile}\n";
 226
 227         if ($#{$self->{suitesfailed}} == -1) {
 228                 my $ok = $self->{statistics}->{TESTS_EXPECTED_OK} +
 229                                  $self->{statistics}->{TESTS_EXPECTED_FAIL};
 230                 print "\nALL OK ($ok tests in $self->{suites_ok} testsuites)\n";
 231         } else {
 232                 print "\nFAILED ($self->{statistics}->{TESTS_UNEXPECTED_FAIL} failures and $self->{statistics}->{TESTS_ERROR} errors in ". ($#{$self->{suitesfailed}}+1) ." testsuites)\n";
 233         }
 234
 235 }
 236
 237 sub skip_testsuite($$$)
 238 {
 239         my ($self, $name, $reason) = @_;
 240
 241         unless (defined($reason)) {
 242                 $reason = "UNKNOWN";
 243         }
 244         push (@{$self->{skips}->{$reason}}, $name);
 245
 246         if ($self->{totalsuites}) {
 247                 $self->{totalsuites}--;
 248         }
 249 }
 250
 251 1;