← Back to branch summary

~ubuntu-branches/ubuntu/natty/phpunit/natty

« back to all changes in this revision

Viewing changes to PHPUnit-3.5.5/PHPUnit/Framework/TestFailure.php

  • Committer: Package Import Robot
  • Author(s): Ivan Borzenkov
  • Date: 2010-12-11 18:19:39 UTC
  • mfrom: (0.11.1) (1.5.3) (12.1.7 sid)
  • Revision ID: package-import@ubuntu.com-20101211181939-8650nbu08hf2z9v1
Tags: 3.5.5-2
fix doc-base-file-references-missing-file

Show diffs side-by-side

added added

removed removed

Lines of Context:
PHPUnit-3.5.5/PHPUnit/Framework/TestFailure.php
 
1
<?php
 
2
/**
 
3
 * PHPUnit
 
4
 *
 
5
 * Copyright (c) 2002-2010, 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 Framework
 
39
 * @author     Sebastian Bergmann <sebastian@phpunit.de>
 
40
 * @copyright  2002-2010 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
 
44
 */
 
45
 
 
46
/**
 
47
 * A TestFailure collects a failed test together with the caught exception.
 
48
 *
 
49
 * @package    PHPUnit
 
50
 * @subpackage Framework
 
51
 * @author     Sebastian Bergmann <sebastian@phpunit.de>
 
52
 * @copyright  2002-2010 Sebastian Bergmann <sebastian@phpunit.de>
 
53
 * @license    http://www.opensource.org/licenses/bsd-license.php  BSD License
 
54
 * @version    Release: 3.5.5
 
55
 * @link       http://www.phpunit.de/
 
56
 * @since      Class available since Release 2.0.0
 
57
 */
 
58
class PHPUnit_Framework_TestFailure
 
59
{
 
60
    /**
 
61
     * @var    PHPUnit_Framework_Test
 
62
     */
 
63
    protected $failedTest;
 
64
 
 
65
    /**
 
66
     * @var    Exception
 
67
     */
 
68
    protected $thrownException;
 
69
 
 
70
    /**
 
71
     * Constructs a TestFailure with the given test and exception.
 
72
     *
 
73
     * @param  PHPUnit_Framework_Test $failedTest
 
74
     * @param  Exception               $thrownException
 
75
     */
 
76
    public function __construct(PHPUnit_Framework_Test $failedTest, Exception $thrownException)
 
77
    {
 
78
        $this->failedTest      = $failedTest;
 
79
        $this->thrownException = $thrownException;
 
80
    }
 
81
 
 
82
    /**
 
83
     * Returns a short description of the failure.
 
84
     *
 
85
     * @return string
 
86
     */
 
87
    public function toString()
 
88
    {
 
89
        return sprintf(
 
90
          '%s: %s',
 
91
 
 
92
          $this->failedTest,
 
93
          $this->thrownException->getMessage()
 
94
        );
 
95
    }
 
96
 
 
97
    /**
 
98
     * Returns a description for the thrown exception.
 
99
     *
 
100
     * @return string
 
101
     * @since  Method available since Release 3.4.0
 
102
     */
 
103
    public function getExceptionAsString()
 
104
    {
 
105
        return self::exceptionToString($this->thrownException);
 
106
    }
 
107
 
 
108
    /**
 
109
     * Returns a description for an exception.
 
110
     *
 
111
     * @param  Exception $e
 
112
     * @return string
 
113
     * @since  Method available since Release 3.2.0
 
114
     */
 
115
    public static function exceptionToString(Exception $e)
 
116
    {
 
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();
 
122
 
 
123
                if ($message == '') {
 
124
                    $buffer = '';
 
125
                } else {
 
126
                    $buffer = $message . "\n";
 
127
                }
 
128
 
 
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";
 
134
                        } else {
 
135
                            $buffer .= $comparisonFailure->toString() . "\n";
 
136
                        }
 
137
                    } else {
 
138
                        if ($comparisonFailure instanceof PHPUnit_Framework_ComparisonFailure_Scalar) {
 
139
                            $buffer .= $comparisonFailure->toString() . "\n";
 
140
                        }
 
141
 
 
142
                        else if ($comparisonFailure instanceof PHPUnit_Framework_ComparisonFailure_Array ||
 
143
                                 $comparisonFailure instanceof PHPUnit_Framework_ComparisonFailure_Object ||
 
144
                                 $comparisonFailure instanceof PHPUnit_Framework_ComparisonFailure_String) {
 
145
                            $buffer .= sprintf(
 
146
                              "Failed asserting that two %ss are equal.\n%s\n",
 
147
 
 
148
                              strtolower(
 
149
                                substr(get_class($comparisonFailure), 36)
 
150
                              ),
 
151
                              $comparisonFailure->toString()
 
152
                            );
 
153
                        }
 
154
                    }
 
155
                } else {
 
156
                    $buffer .= $e->toString();
 
157
 
 
158
                    if (!empty($buffer)) {
 
159
                        $buffer .= "\n";
 
160
                    }
 
161
 
 
162
                    if (strpos($buffer, $description) === FALSE) {
 
163
                        $buffer .= $description . "\n";
 
164
                    }
 
165
                }
 
166
            }
 
167
 
 
168
            else {
 
169
                $buffer = $e->toString();
 
170
 
 
171
                if (!empty($buffer)) {
 
172
                    $buffer .= "\n";
 
173
                }
 
174
            }
 
175
        }
 
176
 
 
177
        else if ($e instanceof PHPUnit_Framework_Error) {
 
178
            $buffer = $e->getMessage() . "\n";
 
179
        }
 
180
 
 
181
        else {
 
182
            $buffer = get_class($e) . ': ' . $e->getMessage() . "\n";
 
183
        }
 
184
 
 
185
        return $buffer;
 
186
    }
 
187
 
 
188
    /**
 
189
     * Gets the failed test.
 
190
     *
 
191
     * @return Test
 
192
     */
 
193
    public function failedTest()
 
194
    {
 
195
        return $this->failedTest;
 
196
    }
 
197
 
 
198
    /**
 
199
     * Gets the thrown exception.
 
200
     *
 
201
     * @return Exception
 
202
     */
 
203
    public function thrownException()
 
204
    {
 
205
        return $this->thrownException;
 
206
    }
 
207
 
 
208
    /**
 
209
     * Returns the exception's message.
 
210
     *
 
211
     * @return string
 
212
     */
 
213
    public function exceptionMessage()
 
214
    {
 
215
        return $this->thrownException()->getMessage();
 
216
    }
 
217
 
 
218
    /**
 
219
     * Returns TRUE if the thrown exception
 
220
     * is of type AssertionFailedError.
 
221
     *
 
222
     * @return boolean
 
223
     */
 
224
    public function isFailure()
 
225
    {
 
226
        return ($this->thrownException() instanceof PHPUnit_Framework_AssertionFailedError);
 
227
    }
 
228
}