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 Framework
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 2.0.0
47 * A TestFailure collects a failed test together with the caught exception.
50 * @subpackage Framework
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 2.0.0
58 class PHPUnit_Framework_TestFailure
61 * @var PHPUnit_Framework_Test
63 protected $failedTest;
68 protected $thrownException;
71 * Constructs a TestFailure with the given test and exception.
73 * @param PHPUnit_Framework_Test $failedTest
74 * @param Exception $thrownException
76 public function __construct(PHPUnit_Framework_Test $failedTest, Exception $thrownException)
78 $this->failedTest = $failedTest;
79 $this->thrownException = $thrownException;
83 * Returns a short description of the failure.
87 public function toString()
93 $this->thrownException->getMessage()
98 * Returns a description for the thrown exception.
101 * @since Method available since Release 3.4.0
103 public function getExceptionAsString()
105 return self::exceptionToString($this->thrownException);
109 * Returns a description for an exception.
111 * @param Exception $e
113 * @since Method available since Release 3.2.0
115 public static function exceptionToString(Exception $e)
117 if ($e instanceof PHPUnit_Framework_SelfDescribing) {
118 if ($e instanceof PHPUnit_Framework_ExpectationFailedException) {
119 $comparisonFailure = $e->getComparisonFailure();
120 $description = $e->getDescription();
121 $message = $e->getCustomMessage();
123 if ($message == '') {
126 $buffer = $message . "\n";
129 if ($comparisonFailure !== NULL) {
130 if ($comparisonFailure->identical()) {
131 if ($comparisonFailure instanceof PHPUnit_Framework_ComparisonFailure_Object) {
132 $buffer .= 'Failed asserting that two variables ' .
133 "reference the same object.\n";
135 $buffer .= $comparisonFailure->toString() . "\n";
138 if ($comparisonFailure instanceof PHPUnit_Framework_ComparisonFailure_Scalar) {
139 $buffer .= $comparisonFailure->toString() . "\n";
142 else if ($comparisonFailure instanceof PHPUnit_Framework_ComparisonFailure_Array ||
143 $comparisonFailure instanceof PHPUnit_Framework_ComparisonFailure_Object ||
144 $comparisonFailure instanceof PHPUnit_Framework_ComparisonFailure_String) {
146 "Failed asserting that two %ss are equal.\n%s\n",
149 substr(get_class($comparisonFailure), 36)
151 $comparisonFailure->toString()
156 $buffer .= $e->toString();
158 if (!empty($buffer)) {
162 if (strpos($buffer, $description) === FALSE) {
163 $buffer .= $description . "\n";
169 $buffer = $e->toString();
171 if (!empty($buffer)) {
177 else if ($e instanceof PHPUnit_Framework_Error) {
178 $buffer = $e->getMessage() . "\n";
182 $buffer = get_class($e) . ': ' . $e->getMessage() . "\n";
189 * Gets the failed test.
193 public function failedTest()
195 return $this->failedTest;
199 * Gets the thrown exception.
203 public function thrownException()
205 return $this->thrownException;
209 * Returns the exception's message.
213 public function exceptionMessage()
215 return $this->thrownException()->getMessage();
219 * Returns TRUE if the thrown exception
220 * is of type AssertionFailedError.
224 public function isFailure()
226 return ($this->thrownException() instanceof PHPUnit_Framework_AssertionFailedError);