5 * Copyright (c) 2002-2009, Sebastian Bergmann <sb@sebastian-bergmann.de>.
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
12 * * Redistributions of source code must retain the above copyright
13 * notice, this list of conditions and the following disclaimer.
15 * * Redistributions in binary form must reproduce the above copyright
16 * notice, this list of conditions and the following disclaimer in
17 * the documentation and/or other materials provided with the
20 * * Neither the name of Sebastian Bergmann nor the names of his
21 * contributors may be used to endorse or promote products derived
22 * from this software without specific prior written permission.
24 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
25 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
26 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
27 * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
28 * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
29 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
30 * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
31 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
32 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
33 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
34 * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
35 * POSSIBILITY OF SUCH DAMAGE.
39 * @author Mattis Stordalen Flister <mattis@xait.no>
40 * @author Sebastian Bergmann <sb@sebastian-bergmann.de>
41 * @copyright 2002-2009 Sebastian Bergmann <sb@sebastian-bergmann.de>
42 * @license http://www.opensource.org/licenses/bsd-license.php BSD License
44 * @link http://www.phpunit.de/
45 * @since File available since Release 3.3.0
48 require_once 'PHPUnit/Util/Filter.php';
49 require_once 'PHPUnit/Util/Template.php';
50 require_once 'PHPUnit/Extensions/Story/ResultPrinter.php';
52 PHPUnit_Util_Filter::addFileToFilter(__FILE__, 'PHPUNIT');
55 * Prints stories in HTML format.
59 * @author Mattis Stordalen Flister <mattis@xait.no>
60 * @author Sebastian Bergmann <sb@sebastian-bergmann.de>
61 * @copyright 2002-2009 Sebastian Bergmann <sb@sebastian-bergmann.de>
62 * @license http://www.opensource.org/licenses/bsd-license.php BSD License
63 * @version Release: 3.3.17
64 * @link http://www.phpunit.de/
65 * @since Class available since Release 3.3.0
67 class PHPUnit_Extensions_Story_ResultPrinter_HTML extends PHPUnit_Extensions_Story_ResultPrinter
72 protected $printsHTML = TRUE;
75 protected $scenarios = '';
76 protected $templatePath;
82 * @throws InvalidArgumentException
84 public function __construct($out = NULL)
86 parent::__construct($out);
88 $this->templatePath = sprintf(
98 * Handler for 'start class' event.
100 * @param string $name
102 protected function startClass($name)
104 $scenarioHeaderTemplate = new PHPUnit_Util_Template(
105 $this->templatePath . 'scenario_header.html'
108 $scenarioHeaderTemplate->setVar(
110 'name' => $this->currentTestClassPrettified
114 $this->scenarios .= $scenarioHeaderTemplate->render();
118 * Handler for 'on test' event.
120 * @param string $name
121 * @param boolean $success
122 * @param array $steps
124 protected function onTest($name, $success = TRUE, array $steps = array())
126 if ($this->testStatus == PHPUnit_Runner_BaseTestRunner::STATUS_FAILURE) {
127 $scenarioStatus = 'scenarioFailed';
130 else if ($this->testStatus == PHPUnit_Runner_BaseTestRunner::STATUS_SKIPPED) {
131 $scenarioStatus = 'scenarioSkipped';
134 else if ($this->testStatus == PHPUnit_Runner_BaseTestRunner::STATUS_INCOMPLETE) {
135 $scenarioStatus = 'scenarioIncomplete';
139 $scenarioStatus = 'scenarioSuccess';
145 foreach ($steps as $step) {
146 $currentStepName = $step->getName();
148 if ($lastStepName == $currentStepName) {
151 $stepText = $currentStepName;
154 $lastStepName = $currentStepName;
156 $stepTemplate = new PHPUnit_Util_Template(
157 $this->templatePath . 'step.html'
160 $stepTemplate->setVar(
163 'action' => $step->getAction() . ' ' . $step->getArguments(TRUE),
167 $stepsBuffer .= $stepTemplate->render();
170 $scenarioTemplate = new PHPUnit_Util_Template(
171 $this->templatePath . 'scenario.html'
174 $scenarioTemplate->setVar(
178 'scenarioStatus' => $scenarioStatus,
179 'steps' => $stepsBuffer,
183 $this->scenarios .= $scenarioTemplate->render();
187 * Handler for 'end run' event.
190 protected function endRun()
192 $scenariosTemplate = new PHPUnit_Util_Template(
193 $this->templatePath . 'scenarios.html'
196 $scenariosTemplate->setVar(
198 'scenarios' => $this->scenarios,
199 'successfulScenarios' => $this->successful,
200 'failedScenarios' => $this->failed,
201 'skippedScenarios' => $this->skipped,
202 'incompleteScenarios' => $this->incomplete
206 $this->write($scenariosTemplate->render());