5 * Copyright (c) 2002-2011, Sebastian Bergmann <sebastian@phpunit.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.
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
47 * A TestCase that expects a specified output.
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.14
55 * @link http://www.phpunit.de/
56 * @since Class available since Release 3.0.0
58 abstract class PHPUnit_Extensions_OutputTestCase extends PHPUnit_Framework_TestCase
63 protected $expectedRegex = NULL;
68 protected $expectedString = NULL;
73 protected $output = '';
78 protected $obActive = FALSE;
83 protected $outputCallback = FALSE;
88 public function setOutputCallback($callback)
90 if (is_callable($callback)) {
91 $this->outputCallback = $callback;
101 public function normalizeOutput($buffer)
103 return str_replace("\r", '', $buffer);
109 public function getActualOutput()
111 if (!$this->obActive) {
112 return $this->output;
114 return ob_get_contents();
121 public function expectedRegex()
123 return $this->expectedRegex;
127 * @param string $expectedRegex
129 public function expectOutputRegex($expectedRegex)
131 if ($this->expectedString !== NULL) {
132 throw new PHPUnit_Framework_Exception;
135 if (is_string($expectedRegex) || is_null($expectedRegex)) {
136 $this->expectedRegex = $expectedRegex;
143 public function expectedString()
145 return $this->expectedString;
149 * @param string $expectedString
151 public function expectOutputString($expectedString)
153 if ($this->expectedRegex !== NULL) {
154 throw new PHPUnit_Framework_Exception;
157 if (is_string($expectedString) || is_null($expectedString)) {
158 $this->expectedString = $expectedString;
164 * @throws RuntimeException
166 protected function runTest()
169 $this->obActive = TRUE;
172 $testResult = parent::runTest();
175 catch (Exception $e) {
177 $this->obActive = FALSE;
181 if ($this->outputCallback === FALSE) {
182 $this->output = ob_get_contents();
184 $this->output = call_user_func_array($this->outputCallback, array(ob_get_contents()));
188 $this->obActive = FALSE;
190 if ($this->expectedRegex !== NULL) {
191 $this->assertRegExp($this->expectedRegex, $this->output);
192 $this->expectedRegex = NULL;
195 else if ($this->expectedString !== NULL) {
196 $this->assertEquals($this->expectedString, $this->output);
197 $this->expectedString = NULL;