selftest/output/plain.pm

   1 #!/usr/bin/perl
   2 # Plain text output for selftest
   3 # Copyright (C) 2008-2009 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 testsuite_count($$)
  45 {
  46         my ($self, $count) = @_;
  47         $self->{totalsuites} = $count;
  48 }
  49
  50 sub report_time($$)
  51 {
  52         my ($self, $time) = @_;
  53         unless ($self->{start_time}) {
  54                 $self->{start_time} = $time;
  55         }
  56         $self->{last_time} = $time;
  57 }
  58
  59 sub output_msg($$);
  60
  61 sub start_testsuite($$)
  62 {
  63         my ($self, $name) = @_;
  64
  65         $self->{index}++;
  66         $self->{NAME} = $name;
  67         $self->{START_TIME} = $self->{last_time};
  68
  69         my $duration = $self->{START_TIME} - $self->{start_time};
  70
  71         $self->{test_output}->{$name} = "" unless($self->{verbose});
  72
  73         my $out = "";
  74         $out .= "[$self->{index}";
  75         if ($self->{totalsuites}) {
  76                 $out .= "/$self->{totalsuites}";
  77         }
  78         $out.= " in ".$duration."s";
  79         $out .= sprintf(", %d errors", ($#{$self->{suitesfailed}}+1)) if ($#{$self->{suitesfailed}} > -1);
  80         $out .= "] $name";
  81         if ($self->{immediate}) {
  82                 print "$out\n";
  83         } else {
  84                 print "$out: ";
  85         }
  86 }
  87
  88 sub output_msg($$)
  89 {
  90         my ($self, $output) = @_;
  91
  92         if ($self->{verbose}) {
  93                 require FileHandle;
  94                 print $output;
  95                 STDOUT->flush();
  96         } elsif (defined($self->{NAME})) {
  97                 $self->{test_output}->{$self->{NAME}} .= $output;
  98         } else {
  99                 print $output;
 100         }
 101 }
 102
 103 sub control_msg($$)
 104 {
 105         my ($self, $output) = @_;
 106
 107         #$self->output_msg($output);
 108 }
 109
 110 sub end_testsuite($$$$)
 111 {
 112         my ($self, $name, $result, $reason) = @_;
 113         my $out = "";
 114         my $unexpected = 0;
 115
 116         if ($result eq "success" or $result eq "xfail") {
 117                 $self->{suites_ok}++;
 118         } else {
 119                 $self->output_msg("ERROR: $reason\n");
 120                 push (@{$self->{suitesfailed}}, $name);
 121                 if ($self->{immediate} and not $self->{verbose}) {
 122                         $out .= $self->{test_output}->{$name};
 123                 }
 124                 $unexpected = 1;
 125         }
 126
 127         if (not $self->{immediate}) {
 128                 if (not $unexpected) {
 129                         $out .= " ok\n";
 130                 } else {
 131                         $out .= " " . uc($result) . "\n";
 132                 }
 133         }
 134
 135         print $out;
 136 }
 137
 138 sub start_test($$$)
 139 {
 140         my ($self, $testname) = @_;
 141 }
 142
 143 sub end_test($$$$$)
 144 {
 145         my ($self, $testname, $result, $unexpected, $reason) = @_;
 146
 147         my $append = "";
 148
 149         unless ($unexpected) {
 150                 $self->{test_output}->{$self->{NAME}} = "";
 151                 if (not $self->{immediate}) {
 152                         if ($result eq "failure") { print "f"; }
 153                         elsif ($result eq "xfail") { print "X"; }
 154                         elsif ($result eq "skip") { print "s"; }
 155                         elsif ($result eq "success") { print "."; }
 156                         else { print "?($result)"; }
 157                 }
 158                 return;
 159         }
 160
 161         $append = "UNEXPECTED($result): $testname\n";
 162
 163         $self->{test_output}->{$self->{NAME}} .= $append;
 164
 165         if ($self->{immediate} and not $self->{verbose}) {
 166                 print $self->{test_output}->{$self->{NAME}};
 167                 $self->{test_output}->{$self->{NAME}} = "";
 168         }
 169
 170         if (not $self->{immediate}) {
 171                 if ($result eq "error") { print "E"; }
 172                 elsif ($result eq "failure") { print "F"; }
 173                 elsif ($result eq "success") { print "S"; }
 174                 else { print "?"; }
 175         }
 176 }
 177
 178 sub summary($)
 179 {
 180         my ($self) = @_;
 181
 182         open(SUMMARY, ">$self->{summaryfile}");
 183
 184         if ($#{$self->{suitesfailed}} > -1) {
 185                 print SUMMARY "= Failed tests =\n";
 186
 187                 foreach (@{$self->{suitesfailed}}) {
 188                         print SUMMARY "== $_ ==\n";
 189                         print SUMMARY $self->{test_output}->{$_}."\n\n";
 190                 }
 191
 192                 print SUMMARY "\n";
 193         }
 194
 195         if (not $self->{immediate} and not $self->{verbose}) {
 196                 foreach (@{$self->{suitesfailed}}) {
 197                         print "===============================================================================\n";
 198                         print "FAIL: $_\n";
 199                         print $self->{test_output}->{$_};
 200                         print "\n";
 201                 }
 202         }
 203
 204         print SUMMARY "= Skipped tests =\n";
 205         foreach my $reason (keys %{$self->{skips}}) {
 206                 print SUMMARY "$reason\n";
 207                 foreach my $name (@{$self->{skips}->{$reason}}) {
 208                         print SUMMARY "\t$name\n";
 209                 }
 210                 print SUMMARY "\n";
 211         }
 212         close(SUMMARY);
 213
 214         print "\nA summary with detailed information can be found in:\n  $self->{summaryfile}\n";
 215
 216         if ($#{$self->{suitesfailed}} == -1) {
 217                 my $ok = $self->{statistics}->{TESTS_EXPECTED_OK} +
 218                                  $self->{statistics}->{TESTS_EXPECTED_FAIL};
 219                 print "\nALL OK ($ok tests in $self->{suites_ok} testsuites)\n";
 220         } else {
 221                 print "\nFAILED ($self->{statistics}->{TESTS_UNEXPECTED_FAIL} failures and $self->{statistics}->{TESTS_ERROR} errors in ". ($#{$self->{suitesfailed}}+1) ." testsuites)\n";
 222         }
 223
 224 }
 225
 226 sub skip_testsuite($$$)
 227 {
 228         my ($self, $name, $reason) = @_;
 229
 230         unless (defined($reason)) {
 231                 $reason = "UNKNOWN";
 232         }
 233         push (@{$self->{skips}->{$reason}}, $name);
 234
 235         if ($self->{totalsuites}) {
 236                 $self->{totalsuites}--;
 237         }
 238 }
 239
 240 1;