tests/PHPUnit/PHPUnit/Extensions/OutputTestCase.php

   1 <?php
   2 /**
   3  * PHPUnit
   4  *
   5  * Copyright (c) 2002-2011, Sebastian Bergmann <sebastian@phpunit.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  * @package    PHPUnit
  38  * @subpackage Extensions
  39  * @author     Sebastian Bergmann <sebastian@phpunit.de>
  40  * @copyright  2002-2011 Sebastian Bergmann <sebastian@phpunit.de>
  41  * @license    http://www.opensource.org/licenses/bsd-license.php  BSD License
  42  * @link       http://www.phpunit.de/
  43  * @since      File available since Release 3.0.0
  44  */
  45
  46 /**
  47  * A TestCase that expects a specified output.
  48  *
  49  * @package    PHPUnit
  50  * @subpackage Extensions
  51  * @author     Sebastian Bergmann <sebastian@phpunit.de>
  52  * @copyright  2002-2011 Sebastian Bergmann <sebastian@phpunit.de>
  53  * @license    http://www.opensource.org/licenses/bsd-license.php  BSD License
  54  * @version    Release: 3.5.13
  55  * @link       http://www.phpunit.de/
  56  * @since      Class available since Release 3.0.0
  57  */
  58 abstract class PHPUnit_Extensions_OutputTestCase extends PHPUnit_Framework_TestCase
  59 {
  60     /**
  61      * @var    string
  62      */
  63     protected $expectedRegex = NULL;
  64
  65     /**
  66      * @var    string
  67      */
  68     protected $expectedString = NULL;
  69
  70     /**
  71      * @var    string
  72      */
  73     protected $output = '';
  74
  75     /**
  76      * @var    boolean
  77      */
  78     protected $obActive = FALSE;
  79
  80     /**
  81      * @var    mixed
  82      */
  83     protected $outputCallback = FALSE;
  84
  85     /**
  86      * @return bool
  87      */
  88     public function setOutputCallback($callback)
  89     {
  90         if (is_callable($callback)) {
  91             $this->outputCallback = $callback;
  92             return TRUE;
  93         }
  94
  95         return FALSE;
  96     }
  97
  98     /**
  99      * @return string
 100      */
 101     public function normalizeOutput($buffer)
 102     {
 103         return str_replace("\r", '', $buffer);
 104     }
 105
 106     /**
 107      * @return string
 108      */
 109     public function getActualOutput()
 110     {
 111         if (!$this->obActive) {
 112             return $this->output;
 113         } else {
 114             return ob_get_contents();
 115         }
 116     }
 117
 118     /**
 119      * @return string
 120      */
 121     public function expectedRegex()
 122     {
 123         return $this->expectedRegex;
 124     }
 125
 126     /**
 127      * @param  string  $expectedRegex
 128      */
 129     public function expectOutputRegex($expectedRegex)
 130     {
 131         if ($this->expectedString !== NULL) {
 132             throw new PHPUnit_Framework_Exception;
 133         }
 134
 135         if (is_string($expectedRegex) || is_null($expectedRegex)) {
 136             $this->expectedRegex = $expectedRegex;
 137         }
 138     }
 139
 140     /**
 141      * @return string
 142      */
 143     public function expectedString()
 144     {
 145         return $this->expectedString;
 146     }
 147
 148     /**
 149      * @param  string  $expectedString
 150      */
 151     public function expectOutputString($expectedString)
 152     {
 153         if ($this->expectedRegex !== NULL) {
 154             throw new PHPUnit_Framework_Exception;
 155         }
 156
 157         if (is_string($expectedString) || is_null($expectedString)) {
 158             $this->expectedString = $expectedString;
 159         }
 160     }
 161
 162     /**
 163      * @return mixed
 164      * @throws RuntimeException
 165      */
 166     protected function runTest()
 167     {
 168         ob_start();
 169         $this->obActive = TRUE;
 170
 171         try {
 172             $testResult = parent::runTest();
 173         }
 174
 175         catch (Exception $e) {
 176             ob_end_clean();
 177             $this->obActive = FALSE;
 178             throw $e;
 179         }
 180
 181         if ($this->outputCallback === FALSE) {
 182             $this->output = ob_get_contents();
 183         } else {
 184             $this->output = call_user_func_array($this->outputCallback, array(ob_get_contents()));
 185         }
 186
 187         ob_end_clean();
 188         $this->obActive = FALSE;
 189
 190         if ($this->expectedRegex !== NULL) {
 191             $this->assertRegExp($this->expectedRegex, $this->output);
 192             $this->expectedRegex = NULL;
 193         }
 194
 195         else if ($this->expectedString !== NULL) {
 196             $this->assertEquals($this->expectedString, $this->output);
 197             $this->expectedString = NULL;
 198         }
 199
 200         return $testResult;
 201     }
 202 }