Class CakeTestCase
CakeTestCase class
- PHPUnit_Framework_TestCase
-
CakeTestCase
Direct Subclasses
Package: Cake\TestSuite
Copyright: Copyright (c) Cake Software Foundation, Inc. (http://cakefoundation.org)
License: MIT License
Location: Cake/TestSuite/CakeTestCase.php
Properties summary
-
$_configureprotectedarrayConfigure values to restore at end of test. -
$_pathRestoreprotectedarrayPath settings to restore at the end of the test. -
$autoFixturespublicarrayBy default, all fixtures attached to this class will be truncated and reloaded after each test. Set this to false to handle manually
-
$dropTablespublicbooleanControl table create/drops on each test method. -
$fixtureManagerpublicThe class responsible for managing the creation, loading and removing of fixtures
Method Summary
-
_arrayPermute() protected
Generates all permutation of an array $items and returns them in a new array. -
assertEqual() protected static
Compatibility wrapper function for assertEquals -
assertIdentical() protected static
Compatibility wrapper function for assertEquals -
assertIsA() protected static
Compatibility wrapper for assertIsA -
assertNoErrors() protected
assert no errors -
assertNoPattern() protected static
Compatibility wrapper function for assertNotRegExp -
assertNotEqual() protected static
Compatibility wrapper function for assertNotEquals -
assertNotIdentical() protected static
Compatibility wrapper function for assertNotEquals -
assertPattern() protected static
Compatibility wrapper function for assertRegexp -
assertPostConditions() protected
Announces the end of a test. -
assertPreConditions() protected
Announces the start of a test. -
assertReference() protected static
Compatibility wrapper function for assertSame -
assertTags() public
Takes an array $expected and generates a regex from it to match the provided $string. Samples for $expected:
-
assertTextContains() public
Assert that a string contains another string, ignoring differences in newlines. Helpful for doing cross platform tests of blocks of text.
-
assertTextEndsNotWith() public
Asserts that a string ends not with a given prefix, ignoring differences in newlines. Helpful for doing cross platform tests of blocks of text.
-
assertTextEndsWith() public
Asserts that a string ends with a given prefix, ignoring differences in newlines. Helpful for doing cross platform tests of blocks of text.
-
assertTextEquals() public
Assert text equality, ignoring differences in newlines. Helpful for doing cross platform tests of blocks of text.
-
assertTextNotContains() public
Assert that a text doesn't contain another text, ignoring differences in newlines. Helpful for doing cross platform tests of blocks of text.
-
assertTextNotEquals() public
Assert text equality, ignoring differences in newlines. Helpful for doing cross platform tests of blocks of text.
-
assertTextStartsNotWith() public
Asserts that a string starts not with a given prefix, ignoring differences in newlines. Helpful for doing cross platform tests of blocks of text.
-
assertTextStartsWith() public
Asserts that a string starts with a given prefix, ignoring differences in newlines. Helpful for doing cross platform tests of blocks of text.
-
assertWithinMargin() protected static
Compatibility function to test if value is between an acceptable range -
date() public static
See CakeTestSuiteDispatcher::date() -
endTest() public
Called when a test case method has been executed (to be overridden when needed.) -
expectError() protected
Compatibility wrapper function for setExpectedException -
expectException() protected
Compatibility wrapper function for setExpectedException -
getMockForModel() public
Mock a model, maintain fixtures and table association -
loadFixtures() public
Chooses which fixtures to load for a given test -
run() public
Runs the test case and collects the results in a TestResult object. If no TestResult object is passed a new one will be created. This method is run for each test method in this class
-
setUp() public
Setup the test case, backup the static object values so they can be restored. Specifically backs up the contents of Configure and paths in App if they have not already been backed up.
-
skipIf() public
Overrides SimpleTestCase::skipIf to provide a boolean return value -
skipUnless() protected
Compatibility function for skipping. -
startTest() public
Called when a test case method is about to start (to be overridden when needed.) -
tearDown() public
teardown any static object changes and restore them.
Method Detail
_arrayPermute() protected ¶
_arrayPermute( array $items , array $perms = array() )
Generates all permutation of an array $items and returns them in a new array.
Parameters
- array $items
- An array of items
- array $perms optional array()
Returns
assertEqual() protected static ¶
assertEqual( mixed $result , mixed $expected , string $message = '' )
Compatibility wrapper function for assertEquals
Parameters
- mixed $result
- mixed $expected
- string $message optional ''
- the text to display if the assertion is not correct
assertIdentical() protected static ¶
assertIdentical( mixed $actual , mixed $expected , string $message = '' )
Compatibility wrapper function for assertEquals
Parameters
- mixed $actual
- mixed $expected
- string $message optional ''
- the text to display if the assertion is not correct
assertIsA() protected static ¶
assertIsA( string $object , string $type , string $message = '' )
Compatibility wrapper for assertIsA
Parameters
- string $object
- string $type
- string $message optional ''
assertNoPattern() protected static ¶
assertNoPattern( mixed $pattern , string $string , string $message = '' )
Compatibility wrapper function for assertNotRegExp
Parameters
- mixed $pattern
- a regular expression
- string $string
- the text to be matched
- string $message optional ''
- the text to display if the assertion is not correct
assertNotEqual() protected static ¶
assertNotEqual( mixed $result , mixed $expected , string $message = '' )
Compatibility wrapper function for assertNotEquals
Parameters
- mixed $result
- mixed $expected
- string $message optional ''
- the text to display if the assertion is not correct
assertNotIdentical() protected static ¶
assertNotIdentical( mixed $actual , mixed $expected , string $message = '' )
Compatibility wrapper function for assertNotEquals
Parameters
- mixed $actual
- mixed $expected
- string $message optional ''
- the text to display if the assertion is not correct
assertPattern() protected static ¶
assertPattern( mixed $pattern , string $string , string $message = '' )
Compatibility wrapper function for assertRegexp
Parameters
- mixed $pattern
- a regular expression
- string $string
- the text to be matched
- string $message optional ''
- the text to display if the assertion is not correct
assertReference() protected static ¶
assertReference( mixed $first , mixed $second , string $message = '' )
Compatibility wrapper function for assertSame
Parameters
- mixed $first
- mixed $second
- string $message optional ''
- the text to display if the assertion is not correct
assertTags() public ¶
assertTags( string $string , array $expected , string $fullDebug = false )
Takes an array $expected and generates a regex from it to match the provided $string. Samples for $expected:
Checks for an input tag with a name attribute (contains any non-empty value) and an id attribute that contains 'my-input': array('input' => array('name', 'id' => 'my-input'))
Checks for two p elements with some text in them: array( array('p' => true), 'textA', '/p', array('p' => true), 'textB', '/p' )
You can also specify a pattern expression as part of the attribute values, or the tag being defined, if you prepend the value with preg: and enclose it with slashes, like so: array( array('input' => array('name', 'id' => 'preg:/FieldName\d+/')), 'preg:/My\s+field/' )
Important: This function is very forgiving about whitespace and also accepts any permutation of attribute order. It will also allow whitespace between specified tags.
Parameters
- string $string
- An HTML/XHTML/XML string
- array $expected
- An array, see above
- string $fullDebug optional false
- $message SimpleTest failure output string
Returns
assertTextContains() public ¶
assertTextContains( string $needle , string $haystack , string $message = '' , boolean $ignoreCase = false )
Assert that a string contains another string, ignoring differences in newlines. Helpful for doing cross platform tests of blocks of text.
Parameters
- string $needle
- string $haystack
- string $message optional ''
- boolean $ignoreCase optional false
Returns
assertTextEndsNotWith() public ¶
assertTextEndsNotWith( string $suffix , string $string , string $message = '' )
Asserts that a string ends not with a given prefix, ignoring differences in newlines. Helpful for doing cross platform tests of blocks of text.
Parameters
- string $suffix
- string $string
- string $message optional ''
Returns
assertTextEndsWith() public ¶
assertTextEndsWith( string $suffix , string $string , string $message = '' )
Asserts that a string ends with a given prefix, ignoring differences in newlines. Helpful for doing cross platform tests of blocks of text.
Parameters
- string $suffix
- string $string
- string $message optional ''
Returns
assertTextEquals() public ¶
assertTextEquals( string $expected , string $result , message $message = '' )
Assert text equality, ignoring differences in newlines. Helpful for doing cross platform tests of blocks of text.
Parameters
- string $expected
- The expected value.
- string $result
- The actual value.
- message $message optional ''
- message to use for failure.
Returns
assertTextNotContains() public ¶
assertTextNotContains( string $needle , string $haystack , string $message = '' , boolean $ignoreCase = false )
Assert that a text doesn't contain another text, ignoring differences in newlines. Helpful for doing cross platform tests of blocks of text.
Parameters
- string $needle
- string $haystack
- string $message optional ''
- boolean $ignoreCase optional false
Returns
assertTextNotEquals() public ¶
assertTextNotEquals( string $expected , string $result , message $message = '' )
Assert text equality, ignoring differences in newlines. Helpful for doing cross platform tests of blocks of text.
Parameters
- string $expected
- The expected value.
- string $result
- The actual value.
- message $message optional ''
- message to use for failure.
Returns
assertTextStartsNotWith() public ¶
assertTextStartsNotWith( string $prefix , string $string , string $message = '' )
Asserts that a string starts not with a given prefix, ignoring differences in newlines. Helpful for doing cross platform tests of blocks of text.
Parameters
- string $prefix
- string $string
- string $message optional ''
Returns
assertTextStartsWith() public ¶
assertTextStartsWith( string $prefix , string $string , string $message = '' )
Asserts that a string starts with a given prefix, ignoring differences in newlines. Helpful for doing cross platform tests of blocks of text.
Parameters
- string $prefix
- string $string
- string $message optional ''
Returns
assertWithinMargin() protected static ¶
assertWithinMargin( mixed $result , mixed $expected , mixed $margin , string $message = '' )
Compatibility function to test if value is between an acceptable range
Parameters
- mixed $result
- mixed $expected
- mixed $margin
- the rage of acceptation
- string $message optional ''
- the text to display if the assertion is not correct
date() public static ¶
date( string $format = 'Y-m-d H:i:s' )
See CakeTestSuiteDispatcher::date()
Parameters
- string $format optional 'Y-m-d H:i:s'
- format to be used.
Returns
endTest() public ¶
endTest( string $method )
Called when a test case method has been executed (to be overridden when needed.)
Parameters
- string $method
- Test method about that was executed.
expectError() protected ¶
expectError( mixed $expected = false , string $message = '' )
Compatibility wrapper function for setExpectedException
Parameters
- mixed $expected optional false
- the name of the Exception or error
- string $message optional ''
- the text to display if the assertion is not correct
expectException() protected ¶
expectException( mixed $name = 'Exception' , string $message = '' )
Compatibility wrapper function for setExpectedException
Parameters
- mixed $name optional 'Exception'
- $expected the name of the Exception
- string $message optional ''
- the text to display if the assertion is not correct
getMockForModel() public ¶
getMockForModel( string $model , mixed $methods = array() , mixed $config = null )
Mock a model, maintain fixtures and table association
Parameters
- string $model
- mixed $methods optional array()
- mixed $config optional null
Returns
loadFixtures() public ¶
loadFixtures( string $fixture ,… )
Chooses which fixtures to load for a given test
Parameters
- string $fixture ,…
Each parameter is a model name that corresponds to a fixture, i.e. 'Post', 'Author', etc.
Throws
when no fixture manager is available.
See
run() public ¶
run( PHPUnit_Framework_TestResult $result = null )
Runs the test case and collects the results in a TestResult object. If no TestResult object is passed a new one will be created. This method is run for each test method in this class
Parameters
- PHPUnit_Framework_TestResult $result optional null
Returns
Throws
setUp() public ¶
setUp( )
Setup the test case, backup the static object values so they can be restored. Specifically backs up the contents of Configure and paths in App if they have not already been backed up.
skipIf() public ¶
skipIf( boolean $shouldSkip , string $message = '' )
Overrides SimpleTestCase::skipIf to provide a boolean return value
Parameters
- boolean $shouldSkip
- string $message optional ''
Returns
skipUnless() protected ¶
skipUnless( boolean $condition , string $message = '' )
Compatibility function for skipping.
Parameters
- boolean $condition
- Condition to trigger skipping
- string $message optional ''
- Message for skip
Returns
startTest() public ¶
startTest( string $method )
Called when a test case method is about to start (to be overridden when needed.)
Parameters
- string $method
- Test method about to get executed.
Properties detail
$autoFixtures ¶
By default, all fixtures attached to this class will be truncated and reloaded after each test. Set this to false to handle manually
true
$dropTables ¶
Control table create/drops on each test method.
Set this to false to avoid tables to be dropped if they already exist between each test method. Tables will still be dropped at the end of each test runner execution.
true
$fixtureManager ¶
CakeFixtureManager
The class responsible for managing the creation, loading and removing of fixtures
null