tests/PHPUnit/Extensions/Story/ResultPrinter/HTML.php

   1 <?php
   2 /**
   3  * PHPUnit
   4  *
   5  * Copyright (c) 2002-2009, Sebastian Bergmann <sb@sebastian-bergmann.de>.
   6  * All rights reserved.
   7  *
   8  * Redistribution and use in source and binary forms, with or without
   9  * modification, are permitted provided that the following conditions
  10  * are met:
  11  *
  12  *   * Redistributions of source code must retain the above copyright
  13  *     notice, this list of conditions and the following disclaimer.
  14  *
  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
  18  *     distribution.
  19  *
  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.
  23  *
  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.
  36  *
  37  * @category   Testing
  38  * @package    PHPUnit
  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
  43
  44  * @link       http://www.phpunit.de/
  45  * @since      File available since Release 3.3.0
  46  */
  47
  48 require_once 'PHPUnit/Util/Filter.php';
  49 require_once 'PHPUnit/Util/Template.php';
  50 require_once 'PHPUnit/Extensions/Story/ResultPrinter.php';
  51
  52 PHPUnit_Util_Filter::addFileToFilter(__FILE__, 'PHPUNIT');
  53
  54 /**
  55  * Prints stories in HTML format.
  56  *
  57  * @category   Testing
  58  * @package    PHPUnit
  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
  66  */
  67 class PHPUnit_Extensions_Story_ResultPrinter_HTML extends PHPUnit_Extensions_Story_ResultPrinter
  68 {
  69     /**
  70      * @var    boolean
  71      */
  72     protected $printsHTML = TRUE;
  73
  74     protected $id = 0;
  75     protected $scenarios = '';
  76     protected $templatePath;
  77
  78     /**
  79      * Constructor.
  80      *
  81      * @param  mixed   $out
  82      * @throws InvalidArgumentException
  83      */
  84     public function __construct($out = NULL)
  85     {
  86         parent::__construct($out);
  87
  88         $this->templatePath = sprintf(
  89           '%s%sTemplate%s',
  90
  91           dirname(__FILE__),
  92           DIRECTORY_SEPARATOR,
  93           DIRECTORY_SEPARATOR
  94         );
  95     }
  96
  97     /**
  98      * Handler for 'start class' event.
  99      *
 100      * @param  string $name
 101      */
 102     protected function startClass($name)
 103     {
 104         $scenarioHeaderTemplate = new PHPUnit_Util_Template(
 105           $this->templatePath . 'scenario_header.html'
 106         );
 107
 108         $scenarioHeaderTemplate->setVar(
 109           array(
 110             'name' => $this->currentTestClassPrettified
 111           )
 112         );
 113
 114         $this->scenarios .= $scenarioHeaderTemplate->render();
 115     }
 116
 117     /**
 118      * Handler for 'on test' event.
 119      *
 120      * @param  string  $name
 121      * @param  boolean $success
 122      * @param  array   $steps
 123      */
 124     protected function onTest($name, $success = TRUE, array $steps = array())
 125     {
 126         if ($this->testStatus == PHPUnit_Runner_BaseTestRunner::STATUS_FAILURE) {
 127             $scenarioStatus = 'scenarioFailed';
 128         }
 129
 130         else if ($this->testStatus == PHPUnit_Runner_BaseTestRunner::STATUS_SKIPPED) {
 131             $scenarioStatus = 'scenarioSkipped';
 132         }
 133
 134         else if ($this->testStatus == PHPUnit_Runner_BaseTestRunner::STATUS_INCOMPLETE) {
 135             $scenarioStatus = 'scenarioIncomplete';
 136         }
 137
 138         else {
 139             $scenarioStatus = 'scenarioSuccess';
 140         }
 141
 142         $lastStepName = '';
 143         $stepsBuffer  = '';
 144
 145         foreach ($steps as $step) {
 146             $currentStepName = $step->getName();
 147
 148             if ($lastStepName == $currentStepName) {
 149                 $stepText = 'and';
 150             } else {
 151                 $stepText = $currentStepName;
 152             }
 153
 154             $lastStepName = $currentStepName;
 155
 156             $stepTemplate = new PHPUnit_Util_Template(
 157               $this->templatePath . 'step.html'
 158             );
 159
 160             $stepTemplate->setVar(
 161               array(
 162                 'text'   => $stepText,
 163                 'action' => $step->getAction() . ' ' . $step->getArguments(TRUE),
 164               )
 165             );
 166
 167             $stepsBuffer .= $stepTemplate->render();
 168         }
 169
 170         $scenarioTemplate = new PHPUnit_Util_Template(
 171           $this->templatePath . 'scenario.html'
 172         );
 173
 174         $scenarioTemplate->setVar(
 175           array(
 176             'id'             => ++$this->id,
 177             'name'           => $name,
 178             'scenarioStatus' => $scenarioStatus,
 179             'steps'          => $stepsBuffer,
 180           )
 181         );
 182
 183         $this->scenarios .= $scenarioTemplate->render();
 184     }
 185
 186     /**
 187      * Handler for 'end run' event.
 188      *
 189      */
 190     protected function endRun()
 191     {
 192         $scenariosTemplate = new PHPUnit_Util_Template(
 193           $this->templatePath . 'scenarios.html'
 194         );
 195
 196         $scenariosTemplate->setVar(
 197           array(
 198             'scenarios'           => $this->scenarios,
 199             'successfulScenarios' => $this->successful,
 200             'failedScenarios'     => $this->failed,
 201             'skippedScenarios'    => $this->skipped,
 202             'incompleteScenarios' => $this->incomplete
 203           )
 204         );
 205
 206         $this->write($scenariosTemplate->render());
 207     }
 208 }
 209 ?>