2 /* vim: set expandtab tabstop=4 shiftwidth=4 softtabstop=4: */
7 * LICENSE: This source file is subject to version 3.0 of the PHP license
8 * that is available through the world-wide-web at the following URI:
9 * http://www.php.net/license/3_0.txt. If you did not receive a copy of
10 * the PHP License and are unable to obtain it through the web, please
11 * send a note to license@php.net so we can mail you a copy immediately.
15 * @author Sebastian Bergmann <sb@sebastian-bergmann.de>
16 * @copyright 2002-2005 Sebastian Bergmann <sb@sebastian-bergmann.de>
17 * @license http://www.php.net/license/3_0.txt PHP License 3.0
19 * @link http://pear.php.net/package/PHPUnit
20 * @since File available since Release 1.0.0
24 * A set of assert methods.
28 * @author Sebastian Bergmann <sb@sebastian-bergmann.de>
29 * @copyright 2002-2005 Sebastian Bergmann <sb@sebastian-bergmann.de>
30 * @license http://www.php.net/license/3_0.txt PHP License 3.0
31 * @version Release: @package_version@
32 * @link http://pear.php.net/package/PHPUnit
33 * @since Class available since Release 1.0.0
35 class PHPUnit_Assert {
40 var $_looselyTyped = FALSE;
43 * Asserts that a haystack contains a needle.
49 * @since Method available since Release 1.1.0
51 function assertContains($needle, $haystack, $message = '') {
52 if (is_string($needle) && is_string($haystack)) {
53 $this->assertTrue(strpos($haystack, $needle) !== FALSE, $message);
56 else if (is_array($haystack) && !is_object($needle)) {
57 $this->assertTrue(in_array($needle, $haystack), $message);
61 $this->fail('Unsupported parameter passed to assertContains().');
66 * Asserts that a haystack does not contain a needle.
72 * @since Method available since Release 1.1.0
74 function assertNotContains($needle, $haystack, $message = '') {
75 if (is_string($needle) && is_string($haystack)) {
76 $this->assertFalse(strpos($haystack, $needle) !== FALSE, $message);
79 else if (is_array($haystack) && !is_object($needle)) {
80 $this->assertFalse(in_array($needle, $haystack), $message);
84 $this->fail('Unsupported parameter passed to assertNotContains().');
89 * Asserts that two variables are equal.
97 function assertEquals($expected, $actual, $message = '', $delta = 0) {
98 if ((is_array($actual) && is_array($expected)) ||
99 (is_object($actual) && is_object($expected))) {
100 if (is_array($actual) && is_array($expected)) {
105 if ($this->_looselyTyped) {
106 $actual = $this->_convertToString($actual);
107 $expected = $this->_convertToString($expected);
110 $actual = serialize($actual);
111 $expected = serialize($expected);
114 '%sexpected %s, actual %s',
116 !empty($message) ? $message . ' ' : '',
121 if ($actual !== $expected) {
122 return $this->fail($message);
126 elseif (is_numeric($actual) && is_numeric($expected)) {
128 '%sexpected %s%s, actual %s',
130 !empty($message) ? $message . ' ' : '',
132 ($delta != 0) ? ('+/- ' . $delta) : '',
136 if (!($actual >= ($expected - $delta) && $actual <= ($expected + $delta))) {
137 return $this->fail($message);
143 '%sexpected %s, actual %s',
145 !empty($message) ? $message . ' ' : '',
150 if ($actual !== $expected) {
151 return $this->fail($message);
157 * Asserts that two variables reference the same object.
158 * This requires the Zend Engine 2 to work.
166 function assertSame($expected, $actual, $message = '') {
167 if (!version_compare(phpversion(), '5.0.0', '>=')) {
168 $this->fail('assertSame() only works with PHP >= 5.0.0.');
171 if ((is_object($expected) || is_null($expected)) &&
172 (is_object($actual) || is_null($actual))) {
174 '%sexpected two variables to reference the same object',
176 !empty($message) ? $message . ' ' : ''
179 if ($expected !== $actual) {
180 return $this->fail($message);
183 $this->fail('Unsupported parameter passed to assertSame().');
188 * Asserts that two variables do not reference the same object.
189 * This requires the Zend Engine 2 to work.
197 function assertNotSame($expected, $actual, $message = '') {
198 if (!version_compare(phpversion(), '5.0.0', '>=')) {
199 $this->fail('assertNotSame() only works with PHP >= 5.0.0.');
202 if ((is_object($expected) || is_null($expected)) &&
203 (is_object($actual) || is_null($actual))) {
205 '%sexpected two variables to reference different objects',
207 !empty($message) ? $message . ' ' : ''
210 if ($expected === $actual) {
211 return $this->fail($message);
214 $this->fail('Unsupported parameter passed to assertNotSame().');
219 * Asserts that a variable is not NULL.
225 function assertNotNull($actual, $message = '') {
227 '%sexpected NOT NULL, actual NULL',
229 !empty($message) ? $message . ' ' : ''
232 if (is_null($actual)) {
233 return $this->fail($message);
238 * Asserts that a variable is NULL.
244 function assertNull($actual, $message = '') {
246 '%sexpected NULL, actual NOT NULL',
248 !empty($message) ? $message . ' ' : ''
251 if (!is_null($actual)) {
252 return $this->fail($message);
257 * Asserts that a condition is true.
263 function assertTrue($condition, $message = '') {
265 '%sexpected TRUE, actual FALSE',
267 !empty($message) ? $message . ' ' : ''
271 return $this->fail($message);
276 * Asserts that a condition is false.
282 function assertFalse($condition, $message = '') {
284 '%sexpected FALSE, actual TRUE',
286 !empty($message) ? $message . ' ' : ''
290 return $this->fail($message);
295 * Asserts that a string matches a given regular expression.
302 function assertRegExp($pattern, $string, $message = '') {
304 '%s"%s" does not match pattern "%s"',
306 !empty($message) ? $message . ' ' : '',
311 if (!preg_match($pattern, $string)) {
312 return $this->fail($message);
317 * Asserts that a string does not match a given regular expression.
323 * @since Method available since Release 1.1.0
325 function assertNotRegExp($pattern, $string, $message = '') {
327 '%s"%s" matches pattern "%s"',
329 !empty($message) ? $message . ' ' : '',
334 if (preg_match($pattern, $string)) {
335 return $this->fail($message);
340 * Asserts that a variable is of a given type.
342 * @param string $expected
343 * @param mixed $actual
344 * @param optional string $message
347 function assertType($expected, $actual, $message = '') {
348 return $this->assertEquals(
356 * Converts a value to a string.
358 * @param mixed $value
361 function _convertToString($value) {
362 foreach ($value as $k => $v) {
364 $value[$k] = $this->_convertToString($value[$k]);
366 settype($value[$k], 'string');
374 * @param boolean $looselyTyped
377 function setLooselyTyped($looselyTyped) {
378 if (is_bool($looselyTyped)) {
379 $this->_looselyTyped = $looselyTyped;
384 * Fails a test with the given message.
390 function fail($message = '') { /* abstract */ }
397 * c-hanging-comment-ender-p: nil