tests/PHPUnit/Util/Log/TAP.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     Sebastian Bergmann <sb@sebastian-bergmann.de>
  40  * @copyright  2002-2009 Sebastian Bergmann <sb@sebastian-bergmann.de>
  41  * @license    http://www.opensource.org/licenses/bsd-license.php  BSD License
  42
  43  * @link       http://www.phpunit.de/
  44  * @since      File available since Release 3.0.0
  45  */
  46
  47 require_once 'PHPUnit/Framework.php';
  48 require_once 'PHPUnit/Util/Filter.php';
  49 require_once 'PHPUnit/Util/Printer.php';
  50 require_once 'PHPUnit/Util/Test.php';
  51
  52 PHPUnit_Util_Filter::addFileToFilter(__FILE__, 'PHPUNIT');
  53
  54 /**
  55  * A TestListener that generates a logfile of the
  56  * test execution using the Test Anything Protocol (TAP).
  57  *
  58  * @category   Testing
  59  * @package    PHPUnit
  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.0.0
  66  */
  67 class PHPUnit_Util_Log_TAP extends PHPUnit_Util_Printer implements PHPUnit_Framework_TestListener
  68 {
  69     /**
  70      * @var    integer
  71      */
  72     protected $testNumber = 0;
  73
  74     /**
  75      * @var    integer
  76      */
  77     protected $testSuiteLevel = 0;
  78
  79     /**
  80      * @var    boolean
  81      */
  82     protected $testSuccessful = TRUE;
  83
  84     /**
  85      * Constructor.
  86      *
  87      * @param  mixed $out
  88      * @throws InvalidArgumentException
  89      * @since  Method available since Release 3.3.4
  90      */
  91     public function __construct($out = NULL)
  92     {
  93         parent::__construct($out);
  94         $this->write("TAP version 13\n");
  95     }
  96
  97     /**
  98      * An error occurred.
  99      *
 100      * @param  PHPUnit_Framework_Test $test
 101      * @param  Exception              $e
 102      * @param  float                  $time
 103      */
 104     public function addError(PHPUnit_Framework_Test $test, Exception $e, $time)
 105     {
 106         $this->writeNotOk($test, 'Error');
 107     }
 108
 109     /**
 110      * A failure occurred.
 111      *
 112      * @param  PHPUnit_Framework_Test                 $test
 113      * @param  PHPUnit_Framework_AssertionFailedError $e
 114      * @param  float                                  $time
 115      */
 116     public function addFailure(PHPUnit_Framework_Test $test, PHPUnit_Framework_AssertionFailedError $e, $time)
 117     {
 118         $this->writeNotOk($test, 'Failure');
 119     }
 120
 121     /**
 122      * Incomplete test.
 123      *
 124      * @param  PHPUnit_Framework_Test $test
 125      * @param  Exception              $e
 126      * @param  float                  $time
 127      */
 128     public function addIncompleteTest(PHPUnit_Framework_Test $test, Exception $e, $time)
 129     {
 130         $this->writeNotOk($test, '', 'TODO Incomplete Test');
 131     }
 132
 133     /**
 134      * Skipped test.
 135      *
 136      * @param  PHPUnit_Framework_Test $test
 137      * @param  Exception              $e
 138      * @param  float                  $time
 139      * @since  Method available since Release 3.0.0
 140      */
 141     public function addSkippedTest(PHPUnit_Framework_Test $test, Exception $e, $time)
 142     {
 143         $this->write(
 144           sprintf(
 145             "ok %d - # SKIP%s\n",
 146
 147             $this->testNumber,
 148             $e->getMessage() != '' ? ' ' . $e->getMessage() : ''
 149           )
 150         );
 151
 152         $this->testSuccessful = FALSE;
 153     }
 154
 155     /**
 156      * A testsuite started.
 157      *
 158      * @param  PHPUnit_Framework_TestSuite $suite
 159      */
 160     public function startTestSuite(PHPUnit_Framework_TestSuite $suite)
 161     {
 162         $this->testSuiteLevel++;
 163     }
 164
 165     /**
 166      * A testsuite ended.
 167      *
 168      * @param  PHPUnit_Framework_TestSuite $suite
 169      */
 170     public function endTestSuite(PHPUnit_Framework_TestSuite $suite)
 171     {
 172         $this->testSuiteLevel--;
 173
 174         if ($this->testSuiteLevel == 0) {
 175             $this->write(sprintf("1..%d\n", $this->testNumber));
 176         }
 177     }
 178
 179     /**
 180      * A test started.
 181      *
 182      * @param  PHPUnit_Framework_Test $test
 183      */
 184     public function startTest(PHPUnit_Framework_Test $test)
 185     {
 186         $this->testNumber++;
 187         $this->testSuccessful = TRUE;
 188     }
 189
 190     /**
 191      * A test ended.
 192      *
 193      * @param  PHPUnit_Framework_Test $test
 194      * @param  float                  $time
 195      */
 196     public function endTest(PHPUnit_Framework_Test $test, $time)
 197     {
 198         if ($this->testSuccessful === TRUE) {
 199             $this->write(
 200               sprintf(
 201                 "ok %d - %s\n",
 202
 203                 $this->testNumber,
 204                 PHPUnit_Util_Test::describe($test)
 205               )
 206             );
 207         }
 208     }
 209
 210     /**
 211      * @param  PHPUnit_Framework_Test $test
 212      * @param  string                 $prefix
 213      * @param  string                 $directive
 214      */
 215     protected function writeNotOk(PHPUnit_Framework_Test $test, $prefix = '', $directive = '')
 216     {
 217         $this->write(
 218           sprintf(
 219             "not ok %d - %s%s%s\n",
 220
 221             $this->testNumber,
 222             $prefix != '' ? $prefix . ': ' : '',
 223             PHPUnit_Util_Test::describe($test),
 224             $directive != '' ? ' # ' . $directive : ''
 225           )
 226         );
 227
 228         $this->testSuccessful = FALSE;
 229     }
 230 }
 231 ?>