summaryrefslogtreecommitdiff
path: root/tests/test_tools/simpletest/reporter.php
blob: a6b5a85a5393daed73284b71ec7480b50d4c6136 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
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
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
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
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
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
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
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
<?php
    /**
     *	base include file for SimpleTest
     *	@package	SimpleTest
     *	@subpackage	UnitTester
     *	@version	$Id: reporter.php 1532 2006-12-01 12:28:55Z xue $
     */

    /**#@+
     *	include other SimpleTest class files
     */
    require_once(dirname(__FILE__) . '/scorer.php');
    /**#@-*/

    /**
     *    Sample minimal test displayer. Generates only
     *    failure messages and a pass count.
	 *	  @package SimpleTest
	 *	  @subpackage UnitTester
     */
    class HtmlReporter extends SimpleReporter {
        protected $_character_set;

        /**
         *    Does nothing yet. The first output will
         *    be sent on the first test start. For use
         *    by a web browser.
         *    @access public
         */
        function HtmlReporter($character_set = 'ISO-8859-1') {
            $this->SimpleReporter();
            $this->_character_set = $character_set;
        }

        /**
         *    Paints the top of the web page setting the
         *    title to the name of the starting test.
         *    @param string $test_name      Name class of test.
         *    @access public
         */
        function paintHeader($test_name) {
            $this->sendNoCacheHeaders();
            print "<html>\n<head>\n<title>$test_name</title>\n";
            print "<meta http-equiv=\"Content-Type\" content=\"text/html; charset=" .
                    $this->_character_set . "\">\n";
            print "<style type=\"text/css\">\n";
            print $this->_getCss() . "\n";
            print "</style>\n";
            print "</head>\n<body>\n";
            print "<h1>$test_name</h1>\n";
            flush();
        }

        /**
         *    Send the headers necessary to ensure the page is
         *    reloaded on every request. Otherwise you could be
         *    scratching your head over out of date test data.
         *    @access public
         *    @static
         */
        static function sendNoCacheHeaders() {
            if (! headers_sent()) {
                header("Expires: Mon, 26 Jul 1997 05:00:00 GMT");
                header("Last-Modified: " . gmdate("D, d M Y H:i:s") . " GMT");
                header("Cache-Control: no-store, no-cache, must-revalidate");
                header("Cache-Control: post-check=0, pre-check=0", false);
                header("Pragma: no-cache");
            }
        }

        /**
         *    Paints the CSS. Add additional styles here.
         *    @return string            CSS code as text.
         *    @access protected
         */
        function _getCss() {
            return ".fail { color: red; } pre { background-color: lightgray; }";
        }

        /**
         *    Paints the end of the test with a summary of
         *    the passes and failures.
         *    @param string $test_name        Name class of test.
         *    @access public
         */
        function paintFooter($test_name) {
            $colour = ($this->getFailCount() + $this->getExceptionCount() > 0 ? "red" : "green");
            print "<div style=\"";
            print "padding: 8px; margin-top: 1em; background-color: $colour; color: white;";
            print "\">";
            print $this->getTestCaseProgress() . "/" . $this->getTestCaseCount();
            print " test cases complete:\n";
            print "<strong>" . $this->getPassCount() . "</strong> passes, ";
            print "<strong>" . $this->getFailCount() . "</strong> fails and ";
            print "<strong>" . $this->getExceptionCount() . "</strong> exceptions.";
            print "</div>\n";
            print "</body>\n</html>\n";
        }

        /**
         *    Paints the test failure with a breadcrumbs
         *    trail of the nesting test suites below the
         *    top level test.
         *    @param string $message    Failure message displayed in
         *                              the context of the other tests.
         *    @access public
         */
        function paintFail($message) {
            parent::paintFail($message);
            print "<span class=\"fail\">Fail</span>: ";
            $breadcrumb = $this->getTestList();
            array_shift($breadcrumb);
            print implode(" -&gt; ", $breadcrumb);
            print " -&gt; " . $this->_htmlEntities($message) . "<br />\n";
        }

        /**
         *    Paints a PHP error or exception.
         *    @param string $message        Message is ignored.
         *    @access public
         *    @abstract
         */
        function paintError($message) {
            parent::paintError($message);
            print "<span class=\"fail\">Exception</span>: ";
            $breadcrumb = $this->getTestList();
            array_shift($breadcrumb);
            print implode(" -&gt; ", $breadcrumb);
            print " -&gt; <strong>" . $this->_htmlEntities($message) . "</strong><br />\n";
        }

        /**
         *    Paints formatted text such as dumped variables.
         *    @param string $message        Text to show.
         *    @access public
         */
        function paintFormattedMessage($message) {
            print '<pre>' . $this->_htmlEntities($message) . '</pre>';
        }

        /**
         *    Character set adjusted entity conversion.
         *    @param string $message    Plain text or Unicode message.
         *    @return string            Browser readable message.
         *    @access protected
         */
        function _htmlEntities($message) {
            return htmlentities($message, ENT_COMPAT, $this->_character_set);
        }
    }

    /**
     *    Sample minimal test displayer. Generates only
     *    failure messages and a pass count. For command
     *    line use. I've tried to make it look like JUnit,
     *    but I wanted to output the errors as they arrived
     *    which meant dropping the dots.
	 *	  @package SimpleTest
	 *	  @subpackage UnitTester
     */
    class TextReporter extends SimpleReporter {

        /**
         *    Does nothing yet. The first output will
         *    be sent on the first test start.
         *    @access public
         */
        function TextReporter() {
            $this->SimpleReporter();
        }

        /**
         *    Paints the title only.
         *    @param string $test_name        Name class of test.
         *    @access public
         */
        function paintHeader($test_name) {
            if (! SimpleReporter::inCli()) {
                header('Content-type: text/plain');
            }
            print "$test_name\n";
            flush();
        }

        /**
         *    Paints the end of the test with a summary of
         *    the passes and failures.
         *    @param string $test_name        Name class of test.
         *    @access public
         */
        function paintFooter($test_name) {
            if ($this->getFailCount() + $this->getExceptionCount() == 0) {
                print "OK\n";
            } else {
                print "FAILURES!!!\n";
            }
            print "Test cases run: " . $this->getTestCaseProgress() .
                    "/" . $this->getTestCaseCount() .
                    ", Passes: " . $this->getPassCount() .
                    ", Failures: " . $this->getFailCount() .
                    ", Exceptions: " . $this->getExceptionCount() . "\n";
        }

        /**
         *    Paints the test failure as a stack trace.
         *    @param string $message    Failure message displayed in
         *                              the context of the other tests.
         *    @access public
         */
        function paintFail($message) {
            parent::paintFail($message);
            print $this->getFailCount() . ") $message\n";
            $breadcrumb = $this->getTestList();
            array_shift($breadcrumb);
            print "\tin " . implode("\n\tin ", array_reverse($breadcrumb));
            print "\n";
        }

        /**
         *    Paints a PHP error or exception.
         *    @param string $message        Message is ignored.
         *    @access public
         *    @abstract
         */
        function paintError($message) {
            parent::paintError($message);
            print "Exception " . $this->getExceptionCount() . "!\n$message\n";
        }

        /**
         *    Paints formatted text such as dumped variables.
         *    @param string $message        Text to show.
         *    @access public
         */
        function paintFormattedMessage($message) {
            print "$message\n";
            flush();
        }
    }

    /**
     *    Runs just a single test group, a single case or
     *    even a single test within that case.
	 *	  @package SimpleTest
	 *	  @subpackage UnitTester
     */
    class SelectiveReporter extends SimpleReporterDecorator {
        protected $_just_this_case =false;
        protected $_just_this_test = false;
        protected $_within_test_case = true;

        /**
         *    Selects the test case or group to be run,
         *    and optionally a specific test.
         *    @param SimpleScorer $reporter    Reporter to receive events.
         *    @param string $just_this_case    Only this case or group will run.
         *    @param string $just_this_test    Only this test method will run.
         */
        function SelectiveReporter($reporter, $just_this_case = false, $just_this_test = false) {
            if (isset($just_this_case) && $just_this_case) {
                $this->_just_this_case = strtolower($just_this_case);
                $this->_within_test_case = false;
            }
            if (isset($just_this_test) && $just_this_test) {
                $this->_just_this_test = strtolower($just_this_test);
            }
            $this->SimpleReporterDecorator($reporter);
        }

        /**
         *    Compares criteria to actual the case/group name.
         *    @param string $test_case    The incoming test.
         *    @return boolean             True if matched.
         *    @access protected
         */
        function _isCaseMatch($test_case) {
            if ($this->_just_this_case) {
                return $this->_just_this_case == strtolower($test_case);
            }
            return false;
        }

        /**
         *    Compares criteria to actual the test name.
         *    @param string $method       The incoming test method.
         *    @return boolean             True if matched.
         *    @access protected
         */
        function _isTestMatch($method) {
            if ($this->_just_this_test) {
                return $this->_just_this_test == strtolower($method);
            }
            return true;
        }

        /**
         *    Veto everything that doesn't match the method wanted.
         *    @param string $test_case       Name of test case.
         *    @param string $method          Name of test method.
         *    @return boolean                True if test should be run.
         *    @access public
         */
        function shouldInvoke($test_case, $method) {
            if ($this->_within_test_case && $this->_isTestMatch($method)) {
                return $this->_reporter->shouldInvoke($test_case, $method);
            }
            return false;
        }

        /**
         *    Paints the start of a group test.
         *    @param string $test_case     Name of test or other label.
         *    @param integer $size         Number of test cases starting.
         *    @access public
         */
        function paintGroupStart($test_case, $size) {
            if ($this->_isCaseMatch($test_case)) {
                $this->_within_test_case = true;
            }
            if ($this->_within_test_case) {
                $this->_reporter->paintGroupStart($test_case, $size);
            }
        }

        /**
         *    Paints the end of a group test.
         *    @param string $test_case     Name of test or other label.
         *    @access public
         */
        function paintGroupEnd($test_case) {
            if ($this->_within_test_case) {
                $this->_reporter->paintGroupEnd($test_case);
            }
            if ($this->_isCaseMatch($test_case)) {
                $this->_within_test_case = false;
            }
        }

        /**
         *    Paints the start of a test case.
         *    @param string $test_case     Name of test or other label.
         *    @access public
         */
        function paintCaseStart($test_case) {
            if ($this->_isCaseMatch($test_case)) {
                $this->_within_test_case = true;
            }
            if ($this->_within_test_case) {
                $this->_reporter->paintCaseStart($test_case);
            }
        }

        /**
         *    Paints the end of a test case.
         *    @param string $test_case     Name of test or other label.
         *    @access public
         */
        function paintCaseEnd($test_case) {
            if ($this->_within_test_case) {
                $this->_reporter->paintCaseEnd($test_case);
            }
            if ($this->_isCaseMatch($test_case)) {
                $this->_within_test_case = false;
            }
        }
    }