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