selftest/plain: Allow caller to not specify the number of expected
[ira/wip.git] / 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         } else {
91                 $self->{test_output}->{$self->{NAME}} .= $output;
92         }
93 }
94
95 sub control_msg($$)
96 {
97         my ($self, $output) = @_;
98
99         $self->output_msg($output);
100 }
101
102 sub end_testsuite($$$$$)
103 {
104         my ($self, $name, $result, $unexpected, $reason) = @_;
105         my $out = "";
106
107         if ($unexpected) {
108                 if ($result eq "success" and not defined($reason)) {
109                         $reason = "Expected negative exit code, got positive exit code";
110                 } 
111                 $self->output_msg("ERROR: $reason\n");
112                 push (@{$self->{suitesfailed}}, $name);
113         } else {
114                 $self->{suites_ok}++;
115         }
116
117         if ($unexpected and $self->{immediate} and not $self->{verbose}) {
118                 $out .= $self->{test_output}->{$name};
119         }
120
121         if (not $self->{immediate}) {
122                 if (not $unexpected) {
123                         $out .= " ok\n";
124                 } else {
125                         $out .= " " . uc($result) . "\n";
126                 }
127         }
128
129         print $out;
130 }
131
132 sub start_test($$$)
133 {
134         my ($self, $parents, $testname) = @_;
135
136         if ($#$parents == -1) {
137                 $self->start_testsuite($testname);
138         }
139 }
140
141 sub end_test($$$$$)
142 {
143         my ($self, $parents, $testname, $result, $unexpected, $reason) = @_;
144         
145         if ($#$parents == -1) {
146                 $self->end_testsuite($testname, $result, $unexpected, $reason);
147                 return;
148         }
149
150         my $append = "";
151
152         unless ($unexpected) {
153                 $self->{test_output}->{$self->{NAME}} = "";
154                 if (not $self->{immediate}) {
155                         if ($result eq "failure") { print "f"; }
156                         elsif ($result eq "skip") { print "s"; }
157                         elsif ($result eq "success") { print "."; }
158                         else { print "?($result)"; }
159                 }
160                 return;
161         }
162
163         my $fullname = join(".", @$parents).".$testname";
164
165         $append = "UNEXPECTED($result): $testname ($fullname)\n";
166
167         $self->{test_output}->{$self->{NAME}} .= $append;
168
169         if ($self->{immediate} and not $self->{verbose}) {
170                 print $self->{test_output}->{$self->{NAME}};
171                 $self->{test_output}->{$self->{NAME}} = "";
172         }
173
174         if (not $self->{immediate}) {
175                 if ($result eq "error") { print "E"; } 
176                 elsif ($result eq "failure") { print "F"; }
177                 elsif ($result eq "success") { print "S"; }
178                 else { print "?"; }
179         }
180 }
181
182 sub summary($)
183 {
184         my ($self) = @_;
185
186         open(SUMMARY, ">$self->{summaryfile}");
187
188         if ($#{$self->{suitesfailed}} > -1) {
189                 print SUMMARY "= Failed tests =\n";
190
191                 foreach (@{$self->{suitesfailed}}) {
192                         print SUMMARY "== $_ ==\n";
193                         print SUMMARY $self->{test_output}->{$_}."\n\n";
194                 }
195
196                 print SUMMARY "\n";
197         }
198
199         if (not $self->{immediate} and not $self->{verbose}) {
200                 foreach (@{$self->{suitesfailed}}) {
201                         print "===============================================================================\n";
202                         print "FAIL: $_\n";
203                         print $self->{test_output}->{$_};
204                         print "\n";
205                 }
206         }
207
208         print SUMMARY "= Skipped tests =\n";
209         foreach my $reason (keys %{$self->{skips}}) {
210                 print SUMMARY "$reason\n";
211                 foreach my $name (@{$self->{skips}->{$reason}}) {
212                         print SUMMARY "\t$name\n";
213                 }
214                 print SUMMARY "\n";
215         }
216         close(SUMMARY);
217
218         print "\nA summary with detailed information can be found in:\n  $self->{summaryfile}\n";
219
220         if ($#{$self->{suitesfailed}} == -1) {
221                 my $ok = $self->{statistics}->{TESTS_EXPECTED_OK} + 
222                                  $self->{statistics}->{TESTS_EXPECTED_FAIL};
223                 print "\nALL OK ($ok tests in $self->{suites_ok} testsuites)\n";
224         } else {
225                 print "\nFAILED ($self->{statistics}->{TESTS_UNEXPECTED_FAIL} failures and $self->{statistics}->{TESTS_ERROR} errors in ". ($#{$self->{suitesfailed}}+1) ." testsuites)\n";
226         }
227
228 }
229
230 sub skip_testsuite($$)
231 {
232         my ($self, $name, $reason) = @_;
233
234         push (@{$self->{skips}->{$reason}}, $name);
235
236         $self->{totalsuites}--;
237 }
238
239 1;