[ Index ]

PHP Cross Reference of Limb3

title

Body

[close]

/tests_runner/lib/simpletest/ -> unit_tester.php (summary)

base include file for SimpleTest

Version: $Id: unit_tester.php 5999 2007-06-18 13:13:08Z pachanga $
File Size: 419 lines (17 kb)
Included or required: 1 time
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

UnitTestCase:: (27 methods):
  UnitTestCase()
  assertTrue()
  assertFalse()
  assertNull()
  assertNotNull()
  assertIsA()
  assertNotA()
  assertEqual()
  assertNotEqual()
  assertWithinMargin()
  assertOutsideMargin()
  assertIdentical()
  assertNotIdentical()
  assertReference()
  assertClone()
  assertCopy()
  assertPattern()
  assertWantedPattern()
  assertNoPattern()
  assertNoUnwantedPattern()
  swallowErrors()
  assertNoErrors()
  assertError()
  expectError()
  expectException()
  _coerceExpectation()
  assertErrorPattern()


Class: UnitTestCase  - X-Ref

Standard unit test class for day to day testing
of PHP code XP style. Adds some useful standard
assertions.

UnitTestCase($label = false)   X-Ref
Creates an empty test case. Should be subclassed
with test methods for a functional test case.

param: string $label     Name of test case. Will use

assertTrue($result, $message = false)   X-Ref
Called from within the test methods to register
passes and failures.

param: boolean $result    Pass on true.
param: string $message    Message to display describing
return: boolean           True on pass

assertFalse($result, $message = '%s')   X-Ref
Will be true on false and vice versa. False
is the PHP definition of false, so that null,
empty strings, zero and an empty array all count
as false.

param: boolean $result    Pass on false.
param: string $message    Message to display.
return: boolean           True on pass

assertNull($value, $message = '%s')   X-Ref
Will be true if the value is null.

param: null $value       Supposedly null value.
param: string $message   Message to display.
return: boolean                        True on pass

assertNotNull($value, $message = '%s')   X-Ref
Will be true if the value is set.

param: mixed $value           Supposedly set value.
param: string $message        Message to display.
return: boolean               True on pass.

assertIsA($object, $type, $message = '%s')   X-Ref
Type and class test. Will pass if class
matches the type name or is a subclass or
if not an object, but the type is correct.

param: mixed $object         Object to test.
param: string $type          Type name as string.
param: string $message       Message to display.
return: boolean              True on pass.

assertNotA($object, $type, $message = '%s')   X-Ref
Type and class mismatch test. Will pass if class
name or underling type does not match the one
specified.

param: mixed $object         Object to test.
param: string $type          Type name as string.
param: string $message       Message to display.
return: boolean              True on pass.

assertEqual($first, $second, $message = '%s')   X-Ref
Will trigger a pass if the two parameters have
the same value only. Otherwise a fail.

param: mixed $first          Value to compare.
param: mixed $second         Value to compare.
param: string $message       Message to display.
return: boolean              True on pass

assertNotEqual($first, $second, $message = '%s')   X-Ref
Will trigger a pass if the two parameters have
a different value. Otherwise a fail.

param: mixed $first           Value to compare.
param: mixed $second          Value to compare.
param: string $message        Message to display.
return: boolean               True on pass

assertWithinMargin($first, $second, $margin, $message = '%s')   X-Ref
Will trigger a pass if the if the first parameter
is near enough to the second by the margin.

param: mixed $first          Value to compare.
param: mixed $second         Value to compare.
param: mixed $margin         Fuzziness of match.
param: string $message       Message to display.
return: boolean              True on pass

assertOutsideMargin($first, $second, $margin, $message = '%s')   X-Ref
Will trigger a pass if the two parameters differ
by more than the margin.

param: mixed $first          Value to compare.
param: mixed $second         Value to compare.
param: mixed $margin         Fuzziness of match.
param: string $message       Message to display.
return: boolean              True on pass

assertIdentical($first, $second, $message = '%s')   X-Ref
Will trigger a pass if the two parameters have
the same value and same type. Otherwise a fail.

param: mixed $first           Value to compare.
param: mixed $second          Value to compare.
param: string $message        Message to display.
return: boolean               True on pass

assertNotIdentical($first, $second, $message = '%s')   X-Ref
Will trigger a pass if the two parameters have
the different value or different type.

param: mixed $first           Value to compare.
param: mixed $second          Value to compare.
param: string $message        Message to display.
return: boolean               True on pass

assertReference(&$first, &$second, $message = '%s')   X-Ref
Will trigger a pass if both parameters refer
to the same object. Fail otherwise.

param: mixed $first           Object reference to check.
param: mixed $second          Hopefully the same object.
param: string $message        Message to display.
return: boolean               True on pass

assertClone(&$first, &$second, $message = '%s')   X-Ref
Will trigger a pass if both parameters refer
to different objects. Fail otherwise. The objects
have to be identical though.

param: mixed $first           Object reference to check.
param: mixed $second          Hopefully not the same object.
param: string $message        Message to display.
return: boolean               True on pass

assertCopy(&$first, &$second, $message = "%s")   X-Ref


assertPattern($pattern, $subject, $message = '%s')   X-Ref
Will trigger a pass if the Perl regex pattern
is found in the subject. Fail otherwise.

param: string $pattern    Perl regex to look for including
param: string $subject    String to search in.
param: string $message    Message to display.
return: boolean           True on pass

assertWantedPattern($pattern, $subject, $message = '%s')   X-Ref


assertNoPattern($pattern, $subject, $message = '%s')   X-Ref
Will trigger a pass if the perl regex pattern
is not present in subject. Fail if found.

param: string $pattern    Perl regex to look for including
param: string $subject    String to search in.
param: string $message    Message to display.
return: boolean           True on pass

assertNoUnwantedPattern($pattern, $subject, $message = '%s')   X-Ref


swallowErrors()   X-Ref


assertNoErrors($message = '%s')   X-Ref


assertError($expected = false, $message = '%s')   X-Ref


expectError($expected = false, $message = '%s')   X-Ref
Prepares for an error. If the error mismatches it
passes through, otherwise it is swallowed. Any
left over errors trigger failures.

param: SimpleExpectation/string $expected   The error to match.
param: string $message                      Message on failure.

expectException($expected = false, $message = '%s')   X-Ref
Prepares for an exception. If the error mismatches it
passes through, otherwise it is swallowed. Any
left over errors trigger failures.

param: SimpleExpectation/Exception $expected  The error to match.
param: string $message                        Message on failure.

_coerceExpectation($expected)   X-Ref
Creates an equality expectation if the
object/value is not already some type
of expectation.

param: mixed $expected      Expected value.
return: SimpleExpectation   Expectation object.

assertErrorPattern($pattern, $message = '%s')   X-Ref




Generated: Sat Nov 22 03:48:54 2008 Cross-referenced by PHPXref 0.7