Class IntegrationTestCase
A test case class intended to make integration tests of your controllers easier.
This test class provides a number of helper methods and features that make dispatching requests and checking their responses simpler. It favours full integration tests over mock objects as you can test more of your code easily and avoid some of the maintenance pitfalls that mock objects create.
Properties summary
- $_appArgs protected
array|nullThe customized application constructor arguments.
- $_appClass protected
string|nullThe customized application class name.
- $_configure protected
arrayConfigure values to restore at end of test.
- $_controller protected
\Cake\Controller\Controller|nullThe controller used in the last request.
- $_cookie protected
arrayCookie data to use in the next request.
- $_cookieEncryptionKey protected
string|null - $_csrfToken protected
boolBoolean flag for whether or not the request should have a CSRF token added.
- $_exception protected
\Exception|nullThe exception being thrown if the case.
- $_flashMessages protected
array|nullStored flash messages before render
- $_layoutName protected
string|nullThe last rendered layout
- $_request protected
arrayThe data used to build the next request.
- $_requestSession protected
\Cake\Http\Session|nullThe session instance from the last request
- $_response protected
\Cake\Http\Response|nullThe response for the most recent request.
- $_retainFlashMessages protected
boolBoolean flag for whether or not the request should re-store flash messages
- $_securityToken protected
boolBoolean flag for whether or not the request should have a SecurityComponent token added.
- $_session protected
arraySession data to use in the next request.
- $_tableLocator protected
\Cake\ORM\Locator\LocatorInterfaceTable locator instance
- $_unlockedFields protected
string[]List of fields that are excluded from field validation.
- $_useHttpServer protected
boolTrack whether or not tests are run against the PSR7 HTTP stack.
- $_validCiphers protected
string[]Valid cipher names for encrypted cookies.
- $_viewName protected
string|nullThe last rendered view
- $autoFixtures public
boolBy default, all fixtures attached to this class will be truncated and reloaded after each test.
- $backupGlobals protected
boolEnable or disable the backup and restoration of the $GLOBALS array.
- $backupGlobalsBlacklist protected
array - $backupStaticAttributes protected
boolEnable or disable the backup and restoration of static attributes.
- $backupStaticAttributesBlacklist protected
array - $dropTables public
boolControl table create/drops on each test method.
- $fixtureManager public
\Cake\TestSuite\Fixture\FixtureManager|nullThe class responsible for managing the creation, loading and removing of fixtures
- $fixtures public
string[]|string|nullFixtures used by this test case.
- $preserveGlobalState protected
boolWhether or not this test should preserve the global state when running in a separate PHP process.
- $runTestInSeparateProcess protected
boolWhether or not this test is to be run in a separate PHP process.
Method Summary
- _castToString() protected
Recursively casts all data to string as that is how data would be POSTed in the real world
- _explode() protected
Explode method to return array from string set in CookieComponent::_implode() Maintains reading backwards compatibility with 1.x CookieComponent::_implode().
- assertAttributeContains() public static
Asserts that a haystack that is stored in a static attribute of a class or an attribute of an object contains a needle.
- assertAttributeContainsOnly() public static
Asserts that a haystack that is stored in a static attribute of a class or an attribute of an object contains only values of a given type.
- assertAttributeCount() public static
Asserts the number of elements of an array, Countable or Traversable that is stored in an attribute.
- assertAttributeEmpty() public static
Asserts that a static attribute of a class or an attribute of an object is empty.
- assertAttributeEquals() public static
Asserts that a variable is equal to an attribute of an object.
- assertAttributeGreaterThanOrEqual() public static
Asserts that an attribute is greater than or equal to another value.
- assertAttributeLessThanOrEqual() public static
Asserts that an attribute is smaller than or equal to another value.
- assertAttributeNotContains() public static
Asserts that a haystack that is stored in a static attribute of a class or an attribute of an object does not contain a needle.
- assertAttributeNotContainsOnly() public static
Asserts that a haystack that is stored in a static attribute of a class or an attribute of an object does not contain only values of a given type.
- assertAttributeNotCount() public static
Asserts the number of elements of an array, Countable or Traversable that is stored in an attribute.
- assertAttributeNotEmpty() public static
Asserts that a static attribute of a class or an attribute of an object is not empty.
- assertAttributeNotEquals() public static
Asserts that a variable is not equal to an attribute of an object.
- assertAttributeNotSame() public static
Asserts that a variable and an attribute of an object do not have the same type and value.
- assertAttributeSame() public static
Asserts that a variable and an attribute of an object have the same type and value.
- assertClassHasStaticAttribute() public static
Asserts that a class has a specified static attribute.
- assertClassNotHasAttribute() public static
Asserts that a class does not have a specified attribute.
- assertClassNotHasStaticAttribute() public static
Asserts that a class does not have a specified static attribute.
- assertContainsOnlyInstancesOf() public static
Asserts that a haystack contains only instances of a given classname
- assertEventFired() public
Asserts that a global event was fired. You must track events in your event manager for this assertion to work
- assertFileEquals() public static
Asserts that the contents of one file is equal to the contents of another file.
- assertFileNotEquals() public static
Asserts that the contents of one file is not equal to the contents of another file.
- assertGreaterThanOrEqual() public static
Asserts that a value is greater than or equal to another value.
- assertJsonStringEqualsJsonFile() public static
Asserts that the generated JSON encoded object and the content of the given file are equal.
- assertJsonStringEqualsJsonString() public static
Asserts that two given JSON encoded objects or arrays are equal.
- assertJsonStringNotEqualsJsonFile() public static
Asserts that the generated JSON encoded object and the content of the given file are not equal.
- assertJsonStringNotEqualsJsonString() public static
Asserts that two given JSON encoded objects or arrays are not equal.
- assertLessThanOrEqual() public static
Asserts that a value is smaller than or equal to another value.
- assertNotContainsOnly() public static
Asserts that a haystack does not contain only values of a given type.
- assertNotCount() public static
Asserts the number of elements of an array, Countable or Traversable.
- assertNotSameSize() public static
Assert that the size of two arrays (or
CountableorTraversableobjects) is not the same. - assertNotWithinRange() protected static
Compatibility function to test if a value is not between an acceptable range.
- assertObjectNotHasAttribute() public static
Asserts that an object does not have a specified attribute.
- assertRedirect() public
Asserts that the Location header is correct. Comparison is made against a full URL.
- assertRedirectEquals() public
Asserts that the Location header is correct. Comparison is made against exactly the URL provided.
- assertResponseNotRegExp() public
Asserts that the response body does not match a given regular expression.
- assertSameSize() public static
Assert that the size of two arrays (or
CountableorTraversableobjects) is the same. - assertStringEqualsFile() public static
Asserts that the contents of a string is equal to the contents of a file.
- assertStringNotEqualsFile() public static
Asserts that the contents of a string is not equal to the contents of a file.
- assertStringNotMatchesFormat() public static
Asserts that a string does not match a given format string.
- assertStringNotMatchesFormatFile() public static
Asserts that a string does not match a given format string.
- assertTextContains() public
Assert that a string contains another string, ignoring differences in newlines.
- assertTextEndsNotWith() public
Asserts that a string ends not with a given prefix, ignoring differences in newlines.
- assertTextEndsWith() public
Asserts that a string ends with a given prefix, ignoring differences in newlines.
- assertTextNotContains() public
Assert that a text doesn't contain another text, ignoring differences in newlines.
- assertTextStartsNotWith() public
Asserts that a string starts not with a given prefix, ignoring differences in newlines.
- assertTextStartsWith() public
Asserts that a string starts with a given prefix, ignoring differences in newlines.
- assertWithinRange() protected static
Compatibility function to test if a value is between an acceptable range.
- atLeast() public static
Returns a matcher that matches when the method is executed at least N times.
- atLeastOnce() public static
Returns a matcher that matches when the method is executed at least once.
- checkRequirements() protected
- dataDescription() public
- dataName() public
- doesNotPerformAssertions() public
- enableRetainFlashMessages() public
Calling this method will re-store flash messages into the test session after being removed by the FlashHelper
- enableSecurityToken() public
Calling this method will enable a SecurityComponent compatible token to be added to request data. This lets you easily test actions protected by SecurityComponent.
- exactly() public static
Returns a matcher that matches when the method is executed exactly $count times.
- expectException() public
- expectExceptionCode() public
- expectExceptionMessage() public
- expectExceptionObject() public
Sets up an expectation for an exception to be raised by the code under test.
- expectOutputRegex() public
- expectOutputString() public
- extractVerboseMessage() protected
Inspect controller to extract possible causes of the failed assertion
- getActualOutput() public
- getExpectedException() public
- getExpectedExceptionCode() public
- getGroups() public
- getMockForAbstractClass() protected
Returns a mock object for the specified abstract class with all abstract methods of the class mocked. Concrete methods are not mocked by default.
- getMockForTrait() protected
Returns a mock object for the specified trait with all abstract methods of the trait mocked. Concrete methods to mock can be specified with the
$mockedMethodsparameter. - getResult() public
- getTestResultObject() public
- handleDependencies() protected
- hasExpectationOnOutput() public
- hasOutput() public
- hasSize() public
- iniSet() protected
This method is a wrapper for the ini_set() function that automatically resets the modified php.ini setting to its original value after the test is run.
- isInIsolation() public
- isLarge() public
- isMedium() public
- isSmall() public
- markAsRisky() public
- onNotSuccessfulTest() protected
This method is called when a test method did not execute successfully.
- prophesize() protected
- registerComparator() public
- registerMockObject() public
- setExpectedExceptionFromAnnotation() protected
- setGroups() public
- setInIsolation() public
- setLocale() protected
This method is a wrapper for the setlocale() function that automatically resets the locale to its original value after the test is run.
- setOutputCallback() public
- setPreserveGlobalState() public
- setResult() public
- setTestResultObject() public
- setUpBeforeClass() public static
This method is called before the first test of this test class is run.
- setUseErrorHandler() public
- setUseErrorHandlerFromAnnotation() protected
- tearDownAfterClass() public static
This method is called after the last test of this test class is run.
- usesDataProvider() public
Method Detail
__construct() public
__construct(mixed $name, array $data, mixed $dataName)
Constructs a test case with the given name.
Parameters
-
string$name optional -
array$data optional -
string$dataName optional
_addTokens() protected
_addTokens(mixed $url, mixed $data)
Add the CSRF and Security Component tokens if necessary.
Parameters
-
string$url The URL the form is being submitted on.
-
array$data The request body data.
Returns
arrayThe request body with tokens added.
_assertAttributes() protected
_assertAttributes(mixed $assertions, mixed $string, mixed $fullDebug, mixed $regex)
Check the attributes as part of an assertTags() check.
Parameters
-
array$assertions Assertions to run.
-
string$string The HTML string to check.
-
bool$fullDebug optional Whether or not more verbose output should be used.
-
array|string$regex optional Full regexp from
assertHtml
Returns
string|bool_buildFieldToken() protected
_buildFieldToken(mixed $url, mixed $fields, mixed $unlockedFields)
Generate the token data for the provided inputs.
Parameters
-
string$url The URL the form is being submitted to.
-
array$fields If set specifies the list of fields to use when generating the hash.
-
string[]$unlockedFields optional The list of fields that are excluded from field validation.
Returns
arrayThe token data.
_buildRequest() protected
_buildRequest(mixed $url, mixed $method, mixed $data)
Creates a request object with the configured options and parameters.
Parameters
-
string|array$url The URL
-
string$method The HTTP method
-
string|array|null$data The request data.
Returns
arrayThe request context
_castToString() protected
_castToString(mixed $data)
Recursively casts all data to string as that is how data would be POSTed in the real world
Parameters
-
array$data POST data
Returns
array_checkCipher() protected
_checkCipher(mixed $encrypt)
Helper method for validating encryption cipher names.
Parameters
-
string$encrypt The cipher name.
Throws
RuntimeExceptionWhen an invalid cipher is provided.
_decode() protected
_decode(mixed $value, mixed $encrypt, mixed $key)
Decodes and decrypts a single value.
Parameters
-
string$value The value to decode & decrypt.
-
string|false$encrypt The encryption cipher to use.
-
string|null$key Used as the security salt if specified.
Returns
string|arrayDecoded values.
_decrypt() protected
_decrypt(mixed $values, mixed $mode, mixed $key)
Decrypts $value using public $type method in Security class
Parameters
-
string[]|string$values Values to decrypt
-
string|false$mode Encryption mode
-
string|null$key optional Used as the security salt if specified.
Returns
string|arrayDecrypted values
_encrypt() protected
_encrypt(mixed $value, mixed $encrypt, mixed $key)
Encrypts $value using public $type method in Security class
Parameters
-
string|array$value Value to encrypt
-
string|false$encrypt Encryption mode to use. False disabled encryption.
-
string|null$key optional Used as the security salt if specified.
Returns
stringEncoded values
_explode() protected
_explode(mixed $string)
Explode method to return array from string set in CookieComponent::_implode() Maintains reading backwards compatibility with 1.x CookieComponent::_implode().
Parameters
-
string$string A string containing JSON encoded data, or a bare string.
Returns
string|arrayMap of key and values
_getBodyAsString() protected
_getBodyAsString()
Get the response body as string
Returns
stringThe response body.
_getCookieEncryptionKey() protected
_getCookieEncryptionKey()
Returns the encryption key to be used.
Returns
string_getTableClassName() protected
_getTableClassName(mixed $alias, array $options)
Gets the class name for the table.
Parameters
-
string$alias The model to get a mock for.
-
array$options The config data for the mock's constructor.
Returns
stringThrows
Cake\ORM\Exception\MissingTableClassException_handleError() protected
_handleError(mixed $exception)
Attempts to render an error response for a given exception.
This method will attempt to use the configured exception renderer. If that class does not exist, the built-in renderer will be used.
Parameters
-
\Exception$exception Exception to handle.
Throws
Exception_implode() protected
_implode(array $array)
Implode method to keep keys are multidimensional arrays
Parameters
-
array$array Map of key and values
Returns
stringA json encoded string.
_makeDispatcher() protected
_makeDispatcher()
Get the correct dispatcher instance.
Returns
\Cake\TestSuite\MiddlewareDispatcher|\Cake\TestSuite\LegacyRequestDispatcherA dispatcher instance
_normalizePath() protected
_normalizePath(mixed $path)
Normalize a path for comparison.
Parameters
-
string$path Path separated by "/" slash.
Returns
stringNormalized path separated by DIRECTORY_SEPARATOR.
_sendRequest() protected
_sendRequest(mixed $url, mixed $method, mixed $data)
Creates and send the request into a Dispatcher instance.
Receives and stores the response for future inspection.
Parameters
-
string|array$url The URL
-
string$method The HTTP method
-
string|array|null$data optional The request data.
Throws
PHPUnit\Exception_url() protected
_url(mixed $url)
Creates a valid request url and parameter array more like Request::_url()
Parameters
-
string|array$url The URL
Returns
arrayQualified URL, the query parameters, and host data
addFixture() protected
addFixture(mixed $fixture)
Adds a fixture to this test case.
Examples:
- core.Tags
- app.MyRecords
- plugin.MyPluginName.MyModelName
Use this method inside your test cases' {@link getFixtures()} method to build up the fixture list.
Parameters
-
string$fixture Fixture
Returns
$thisaddToAssertionCount() public
addToAssertionCount(mixed $count)
Adds a value to the assertion counter.
Parameters
-
int$count
any() public static
any()
Returns a matcher that matches when the method is executed zero or more times.
Returns
\PHPUnit\Framework\MockObject\Matcher\AnyInvokedCountanything() public static
anything()
Returns
\PHPUnit\Framework\Constraint\IsAnythingarrayHasKey() public static
arrayHasKey(mixed $key)
Parameters
-
mixed$key
Returns
\PHPUnit\Framework\Constraint\ArrayHasKeyassertArrayHasKey() public static
assertArrayHasKey(mixed $key, mixed $array, mixed $message)
Asserts that an array has a specified key.
Parameters
-
mixed$key -
array|\ArrayAccess$array -
string$message optional
assertArrayNotHasKey() public static
assertArrayNotHasKey(mixed $key, mixed $array, mixed $message)
Asserts that an array does not have a specified key.
Parameters
-
mixed$key -
array|\ArrayAccess$array -
string$message optional
assertArraySubset() public static
assertArraySubset(mixed $subset, mixed $array, mixed $strict, mixed $message)
Asserts that an array has a specified subset.
Parameters
-
array|\ArrayAccess$subset -
array|\ArrayAccess$array -
bool$strict optional Check for object identity
-
string$message optional
assertAttributeContains() public static
assertAttributeContains(mixed $needle, mixed $haystackAttributeName, mixed $haystackClassOrObject, mixed $message, mixed $ignoreCase, mixed $checkForObjectIdentity, mixed $checkForNonObjectIdentity)
Asserts that a haystack that is stored in a static attribute of a class or an attribute of an object contains a needle.
Parameters
-
mixed$needle -
string$haystackAttributeName -
string|object$haystackClassOrObject -
string$message optional -
bool$ignoreCase optional -
bool$checkForObjectIdentity optional -
bool$checkForNonObjectIdentity optional
assertAttributeContainsOnly() public static
assertAttributeContainsOnly(mixed $type, mixed $haystackAttributeName, mixed $haystackClassOrObject, mixed $isNativeType, mixed $message)
Asserts that a haystack that is stored in a static attribute of a class or an attribute of an object contains only values of a given type.
Parameters
-
string$type -
string$haystackAttributeName -
string|object$haystackClassOrObject -
bool$isNativeType optional -
string$message optional
assertAttributeCount() public static
assertAttributeCount(mixed $expectedCount, mixed $haystackAttributeName, mixed $haystackClassOrObject, mixed $message)
Asserts the number of elements of an array, Countable or Traversable that is stored in an attribute.
Parameters
-
int$expectedCount -
string$haystackAttributeName -
string|object$haystackClassOrObject -
string$message optional
assertAttributeEmpty() public static
assertAttributeEmpty(mixed $haystackAttributeName, mixed $haystackClassOrObject, mixed $message)
Asserts that a static attribute of a class or an attribute of an object is empty.
Parameters
-
string$haystackAttributeName -
string|object$haystackClassOrObject -
string$message optional
assertAttributeEquals() public static
assertAttributeEquals(mixed $expected, mixed $actualAttributeName, mixed $actualClassOrObject, mixed $message, mixed $delta, mixed $maxDepth, mixed $canonicalize, mixed $ignoreCase)
Asserts that a variable is equal to an attribute of an object.
Parameters
-
mixed$expected -
string$actualAttributeName -
string|object$actualClassOrObject -
string$message optional -
float$delta optional -
int$maxDepth optional -
bool$canonicalize optional -
bool$ignoreCase optional
assertAttributeGreaterThan() public static
assertAttributeGreaterThan(mixed $expected, mixed $actualAttributeName, mixed $actualClassOrObject, mixed $message)
Asserts that an attribute is greater than another value.
Parameters
-
mixed$expected -
string$actualAttributeName -
string|object$actualClassOrObject -
string$message optional
assertAttributeGreaterThanOrEqual() public static
assertAttributeGreaterThanOrEqual(mixed $expected, mixed $actualAttributeName, mixed $actualClassOrObject, mixed $message)
Asserts that an attribute is greater than or equal to another value.
Parameters
-
mixed$expected -
string$actualAttributeName -
string|object$actualClassOrObject -
string$message optional
assertAttributeInstanceOf() public static
assertAttributeInstanceOf(mixed $expected, mixed $attributeName, mixed $classOrObject, mixed $message)
Asserts that an attribute is of a given type.
Parameters
-
string$expected -
string$attributeName -
string|object$classOrObject -
string$message optional
assertAttributeInternalType() public static
assertAttributeInternalType(mixed $expected, mixed $attributeName, mixed $classOrObject, mixed $message)
Asserts that an attribute is of a given type.
Parameters
-
string$expected -
string$attributeName -
string|object$classOrObject -
string$message optional
assertAttributeLessThan() public static
assertAttributeLessThan(mixed $expected, mixed $actualAttributeName, mixed $actualClassOrObject, mixed $message)
Asserts that an attribute is smaller than another value.
Parameters
-
mixed$expected -
string$actualAttributeName -
string|object$actualClassOrObject -
string$message optional
assertAttributeLessThanOrEqual() public static
assertAttributeLessThanOrEqual(mixed $expected, mixed $actualAttributeName, mixed $actualClassOrObject, mixed $message)
Asserts that an attribute is smaller than or equal to another value.
Parameters
-
mixed$expected -
string$actualAttributeName -
string|object$actualClassOrObject -
string$message optional
assertAttributeNotContains() public static
assertAttributeNotContains(mixed $needle, mixed $haystackAttributeName, mixed $haystackClassOrObject, mixed $message, mixed $ignoreCase, mixed $checkForObjectIdentity, mixed $checkForNonObjectIdentity)
Asserts that a haystack that is stored in a static attribute of a class or an attribute of an object does not contain a needle.
Parameters
-
mixed$needle -
string$haystackAttributeName -
string|object$haystackClassOrObject -
string$message optional -
bool$ignoreCase optional -
bool$checkForObjectIdentity optional -
bool$checkForNonObjectIdentity optional
assertAttributeNotContainsOnly() public static
assertAttributeNotContainsOnly(mixed $type, mixed $haystackAttributeName, mixed $haystackClassOrObject, mixed $isNativeType, mixed $message)
Asserts that a haystack that is stored in a static attribute of a class or an attribute of an object does not contain only values of a given type.
Parameters
-
string$type -
string$haystackAttributeName -
string|object$haystackClassOrObject -
bool$isNativeType optional -
string$message optional
assertAttributeNotCount() public static
assertAttributeNotCount(mixed $expectedCount, mixed $haystackAttributeName, mixed $haystackClassOrObject, mixed $message)
Asserts the number of elements of an array, Countable or Traversable that is stored in an attribute.
Parameters
-
int$expectedCount -
string$haystackAttributeName -
string|object$haystackClassOrObject -
string$message optional
assertAttributeNotEmpty() public static
assertAttributeNotEmpty(mixed $haystackAttributeName, mixed $haystackClassOrObject, mixed $message)
Asserts that a static attribute of a class or an attribute of an object is not empty.
Parameters
-
string$haystackAttributeName -
string|object$haystackClassOrObject -
string$message optional
assertAttributeNotEquals() public static
assertAttributeNotEquals(mixed $expected, mixed $actualAttributeName, mixed $actualClassOrObject, mixed $message, mixed $delta, mixed $maxDepth, mixed $canonicalize, mixed $ignoreCase)
Asserts that a variable is not equal to an attribute of an object.
Parameters
-
mixed$expected -
string$actualAttributeName -
string|object$actualClassOrObject -
string$message optional -
float$delta optional -
int$maxDepth optional -
bool$canonicalize optional -
bool$ignoreCase optional
assertAttributeNotInstanceOf() public static
assertAttributeNotInstanceOf(mixed $expected, mixed $attributeName, mixed $classOrObject, mixed $message)
Asserts that an attribute is of a given type.
Parameters
-
string$expected -
string$attributeName -
string|object$classOrObject -
string$message optional
assertAttributeNotInternalType() public static
assertAttributeNotInternalType(mixed $expected, mixed $attributeName, mixed $classOrObject, mixed $message)
Asserts that an attribute is of a given type.
Parameters
-
string$expected -
string$attributeName -
string|object$classOrObject -
string$message optional
assertAttributeNotSame() public static
assertAttributeNotSame(mixed $expected, mixed $actualAttributeName, mixed $actualClassOrObject, mixed $message)
Asserts that a variable and an attribute of an object do not have the same type and value.
Parameters
-
mixed$expected -
string$actualAttributeName -
string|object$actualClassOrObject -
string$message optional
assertAttributeSame() public static
assertAttributeSame(mixed $expected, mixed $actualAttributeName, mixed $actualClassOrObject, mixed $message)
Asserts that a variable and an attribute of an object have the same type and value.
Parameters
-
mixed$expected -
string$actualAttributeName -
string|object$actualClassOrObject -
string$message optional
assertClassHasAttribute() public static
assertClassHasAttribute(mixed $attributeName, mixed $className, mixed $message)
Asserts that a class has a specified attribute.
Parameters
-
string$attributeName -
string$className -
string$message optional
assertClassHasStaticAttribute() public static
assertClassHasStaticAttribute(mixed $attributeName, mixed $className, mixed $message)
Asserts that a class has a specified static attribute.
Parameters
-
string$attributeName -
string$className -
string$message optional
assertClassNotHasAttribute() public static
assertClassNotHasAttribute(mixed $attributeName, mixed $className, mixed $message)
Asserts that a class does not have a specified attribute.
Parameters
-
string$attributeName -
string$className -
string$message optional
assertClassNotHasStaticAttribute() public static
assertClassNotHasStaticAttribute(mixed $attributeName, mixed $className, mixed $message)
Asserts that a class does not have a specified static attribute.
Parameters
-
string$attributeName -
string$className -
string$message optional
assertContains() public static
assertContains(mixed $needle, mixed $haystack, mixed $message, mixed $ignoreCase, mixed $checkForObjectIdentity, mixed $checkForNonObjectIdentity)
Asserts that a haystack contains a needle.
Parameters
-
mixed$needle -
mixed$haystack -
string$message optional -
bool$ignoreCase optional -
bool$checkForObjectIdentity optional -
bool$checkForNonObjectIdentity optional
assertContainsOnly() public static
assertContainsOnly(mixed $type, mixed $haystack, mixed $isNativeType, mixed $message)
Asserts that a haystack contains only values of a given type.
Parameters
-
string$type -
mixed$haystack -
bool$isNativeType optional -
string$message optional
assertContainsOnlyInstancesOf() public static
assertContainsOnlyInstancesOf(mixed $classname, mixed $haystack, mixed $message)
Asserts that a haystack contains only instances of a given classname
Parameters
-
string$classname -
array|\Traversable$haystack -
string$message optional
assertContentType() public
assertContentType(mixed $type, mixed $message)
Asserts content type
Parameters
-
string$type The content-type to check for.
-
string$message optional The failure message that will be appended to the generated message.
assertCookie() public
assertCookie(mixed $expected, mixed $name, mixed $message)
Asserts cookie values
Parameters
-
string$expected The expected contents.
-
string$name The cookie name.
-
string$message optional The failure message that will be appended to the generated message.
assertCookieEncrypted() public
assertCookieEncrypted(mixed $expected, mixed $name, mixed $encrypt, mixed $key, mixed $message)
Asserts cookie values which are encrypted by the CookieComponent.
The difference from assertCookie() is this decrypts the cookie value like the CookieComponent for this assertion.
Parameters
-
string$expected The expected contents.
-
string$name The cookie name.
-
string|bool$encrypt optional Encryption mode to use.
-
string|null$key optional Encryption key used. Defaults to Security.salt.
-
string$message optional The failure message that will be appended to the generated message.
See Also
assertCookieNotSet() public
assertCookieNotSet(mixed $cookie, mixed $message)
Asserts a cookie has not been set in the response
Parameters
-
string$cookie The cookie name to check
-
string$message optional The failure message that will be appended to the generated message.
assertCount() public static
assertCount(mixed $expectedCount, mixed $haystack, mixed $message)
Asserts the number of elements of an array, Countable or Traversable.
Parameters
-
int$expectedCount -
mixed$haystack -
string$message optional
assertDirectoryExists() public static
assertDirectoryExists(mixed $directory, mixed $message)
Asserts that a directory exists.
Parameters
-
string$directory -
string$message optional
assertDirectoryIsReadable() public static
assertDirectoryIsReadable(mixed $directory, mixed $message)
Asserts that a directory exists and is readable.
Parameters
-
string$directory -
string$message optional
assertDirectoryIsWritable() public static
assertDirectoryIsWritable(mixed $directory, mixed $message)
Asserts that a directory exists and is writable.
Parameters
-
string$directory -
string$message optional
assertDirectoryNotExists() public static
assertDirectoryNotExists(mixed $directory, mixed $message)
Asserts that a directory does not exist.
Parameters
-
string$directory -
string$message optional
assertDirectoryNotIsReadable() public static
assertDirectoryNotIsReadable(mixed $directory, mixed $message)
Asserts that a directory exists and is not readable.
Parameters
-
string$directory -
string$message optional
assertDirectoryNotIsWritable() public static
assertDirectoryNotIsWritable(mixed $directory, mixed $message)
Asserts that a directory exists and is not writable.
Parameters
-
string$directory -
string$message optional
assertEmpty() public static
assertEmpty(mixed $actual, mixed $message)
Asserts that a variable is empty.
Parameters
-
mixed$actual -
string$message optional
Throws
PHPUnit\Framework\AssertionFailedErrorassertEqualXMLStructure() public static
assertEqualXMLStructure(\DOMElement $expectedElement, \DOMElement $actualElement, mixed $checkAttributes, mixed $message)
Asserts that a hierarchy of DOMElements matches.
Parameters
-
\DOMElement$expectedElement -
\DOMElement$actualElement -
bool$checkAttributes optional -
string$message optional
assertEquals() public static
assertEquals(mixed $expected, mixed $actual, mixed $message, mixed $delta, mixed $maxDepth, mixed $canonicalize, mixed $ignoreCase)
Asserts that two variables are equal.
Parameters
-
mixed$expected -
mixed$actual -
string$message optional -
float$delta optional -
int$maxDepth optional -
bool$canonicalize optional -
bool$ignoreCase optional
assertEventFired() public
assertEventFired(mixed $name, mixed $eventManager, mixed $message)
Asserts that a global event was fired. You must track events in your event manager for this assertion to work
Parameters
-
string$name Event name
-
\Cake\Event\EventManager|null$eventManager optional Event manager to check, defaults to global event manager
-
string$message optional Assertion failure message
assertEventFiredWith() public
assertEventFiredWith(mixed $name, mixed $dataKey, mixed $dataValue, mixed $eventManager, mixed $message)
Asserts an event was fired with data
If a third argument is passed, that value is used to compare with the value in $dataKey
Parameters
-
string$name Event name
-
string$dataKey Data key
-
string$dataValue Data value
-
\Cake\Event\EventManager|null$eventManager optional Event manager to check, defaults to global event manager
-
string$message optional Assertion failure message
assertFalse() public static
assertFalse(mixed $condition, mixed $message)
Asserts that a condition is false.
Parameters
-
bool$condition -
string$message optional
Throws
PHPUnit\Framework\AssertionFailedErrorassertFileEquals() public static
assertFileEquals(mixed $expected, mixed $actual, mixed $message, mixed $canonicalize, mixed $ignoreCase)
Asserts that the contents of one file is equal to the contents of another file.
Parameters
-
string$expected -
string$actual -
string$message optional -
bool$canonicalize optional -
bool$ignoreCase optional
assertFileExists() public static
assertFileExists(mixed $filename, mixed $message)
Asserts that a file exists.
Parameters
-
string$filename -
string$message optional
assertFileIsReadable() public static
assertFileIsReadable(mixed $file, mixed $message)
Asserts that a file exists and is readable.
Parameters
-
string$file -
string$message optional
assertFileIsWritable() public static
assertFileIsWritable(mixed $file, mixed $message)
Asserts that a file exists and is writable.
Parameters
-
string$file -
string$message optional
assertFileNotEquals() public static
assertFileNotEquals(mixed $expected, mixed $actual, mixed $message, mixed $canonicalize, mixed $ignoreCase)
Asserts that the contents of one file is not equal to the contents of another file.
Parameters
-
string$expected -
string$actual -
string$message optional -
bool$canonicalize optional -
bool$ignoreCase optional
assertFileNotExists() public static
assertFileNotExists(mixed $filename, mixed $message)
Asserts that a file does not exist.
Parameters
-
string$filename -
string$message optional
assertFileNotIsReadable() public static
assertFileNotIsReadable(mixed $file, mixed $message)
Asserts that a file exists and is not readable.
Parameters
-
string$file -
string$message optional
assertFileNotIsWritable() public static
assertFileNotIsWritable(mixed $file, mixed $message)
Asserts that a file exists and is not writable.
Parameters
-
string$file -
string$message optional
assertFileResponse() public
assertFileResponse(mixed $expected, mixed $message)
Asserts that a file with the given name was sent in the response
Parameters
-
string$expected The absolute file path that should be sent in the response.
-
string$message optional The failure message that will be appended to the generated message.
assertFinite() public static
assertFinite(mixed $actual, mixed $message)
Asserts that a variable is finite.
Parameters
-
mixed$actual -
string$message optional
assertFlashElement() public
assertFlashElement(mixed $expected, mixed $key, mixed $message)
Asserts a flash element was set
Parameters
-
string$expected Expected element name
-
string$key optional Flash key
-
string$message optional Assertion failure message
assertFlashElementAt() public
assertFlashElementAt(mixed $at, mixed $expected, mixed $key, mixed $message)
Asserts a flash element was set at a certain index
Parameters
-
int$at Flash index
-
string$expected Expected element name
-
string$key optional Flash key
-
string$message optional Assertion failure message
assertFlashMessage() public
assertFlashMessage(mixed $expected, mixed $key, mixed $message)
Asserts a flash message was set
Parameters
-
string$expected Expected message
-
string$key optional Flash key
-
string$message optional Assertion failure message
assertFlashMessageAt() public
assertFlashMessageAt(mixed $at, mixed $expected, mixed $key, mixed $message)
Asserts a flash message was set at a certain index
Parameters
-
int$at Flash index
-
string$expected Expected message
-
string$key optional Flash key
-
string$message optional Assertion failure message
assertGreaterThan() public static
assertGreaterThan(mixed $expected, mixed $actual, mixed $message)
Asserts that a value is greater than another value.
Parameters
-
mixed$expected -
mixed$actual -
string$message optional
assertGreaterThanOrEqual() public static
assertGreaterThanOrEqual(mixed $expected, mixed $actual, mixed $message)
Asserts that a value is greater than or equal to another value.
Parameters
-
mixed$expected -
mixed$actual -
string$message optional
assertHeader() public
assertHeader(mixed $header, mixed $content, mixed $message)
Asserts response headers
Parameters
-
string$header The header to check
-
string$content The content to check for.
-
string$message optional The failure message that will be appended to the generated message.
assertHeaderContains() public
assertHeaderContains(mixed $header, mixed $content, mixed $message)
Asserts response header contains a string
Parameters
-
string$header The header to check
-
string$content The content to check for.
-
string$message optional The failure message that will be appended to the generated message.
assertHeaderNotContains() public
assertHeaderNotContains(mixed $header, mixed $content, mixed $message)
Asserts response header does not contain a string
Parameters
-
string$header The header to check
-
string$content The content to check for.
-
string$message optional The failure message that will be appended to the generated message.
assertHtml() public
assertHtml(mixed $expected, mixed $string, mixed $fullDebug)
Asserts HTML tags.
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':
['input' => ['name', 'id' => 'my-input']]
Checks for two p elements with some text in them:
[ ['p' => true], 'textA', '/p', ['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:
[ ['input' => ['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
-
array$expected An array, see above
-
string$string An HTML/XHTML/XML string
-
bool$fullDebug optional Whether or not more verbose output should be used.
Returns
boolassertInfinite() public static
assertInfinite(mixed $actual, mixed $message)
Asserts that a variable is infinite.
Parameters
-
mixed$actual -
string$message optional
assertInstanceOf() public static
assertInstanceOf(mixed $expected, mixed $actual, mixed $message)
Asserts that a variable is of a given type.
Parameters
-
string$expected -
mixed$actual -
string$message optional
assertInternalType() public static
assertInternalType(mixed $expected, mixed $actual, mixed $message)
Asserts that a variable is of a given type.
Parameters
-
string$expected -
mixed$actual -
string$message optional
assertIsReadable() public static
assertIsReadable(mixed $filename, mixed $message)
Asserts that a file/dir is readable.
Parameters
-
string$filename -
string$message optional
assertIsWritable() public static
assertIsWritable(mixed $filename, mixed $message)
Asserts that a file/dir exists and is writable.
Parameters
-
string$filename -
string$message optional
assertJson() public static
assertJson(mixed $actualJson, mixed $message)
Asserts that a string is a valid JSON string.
Parameters
-
string$actualJson -
string$message optional
assertJsonFileEqualsJsonFile() public static
assertJsonFileEqualsJsonFile(mixed $expectedFile, mixed $actualFile, mixed $message)
Asserts that two JSON files are equal.
Parameters
-
string$expectedFile -
string$actualFile -
string$message optional
assertJsonFileNotEqualsJsonFile() public static
assertJsonFileNotEqualsJsonFile(mixed $expectedFile, mixed $actualFile, mixed $message)
Asserts that two JSON files are not equal.
Parameters
-
string$expectedFile -
string$actualFile -
string$message optional
assertJsonStringEqualsJsonFile() public static
assertJsonStringEqualsJsonFile(mixed $expectedFile, mixed $actualJson, mixed $message)
Asserts that the generated JSON encoded object and the content of the given file are equal.
Parameters
-
string$expectedFile -
string$actualJson -
string$message optional
assertJsonStringEqualsJsonString() public static
assertJsonStringEqualsJsonString(mixed $expectedJson, mixed $actualJson, mixed $message)
Asserts that two given JSON encoded objects or arrays are equal.
Parameters
-
string$expectedJson -
string$actualJson -
string$message optional
assertJsonStringNotEqualsJsonFile() public static
assertJsonStringNotEqualsJsonFile(mixed $expectedFile, mixed $actualJson, mixed $message)
Asserts that the generated JSON encoded object and the content of the given file are not equal.
Parameters
-
string$expectedFile -
string$actualJson -
string$message optional
assertJsonStringNotEqualsJsonString() public static
assertJsonStringNotEqualsJsonString(mixed $expectedJson, mixed $actualJson, mixed $message)
Asserts that two given JSON encoded objects or arrays are not equal.
Parameters
-
string$expectedJson -
string$actualJson -
string$message optional
assertLayout() public
assertLayout(mixed $content, mixed $message)
Asserts that the search string was in the layout name.
Parameters
-
string$content The content to check for.
-
string$message optional The failure message that will be appended to the generated message.
assertLessThan() public static
assertLessThan(mixed $expected, mixed $actual, mixed $message)
Asserts that a value is smaller than another value.
Parameters
-
mixed$expected -
mixed$actual -
string$message optional
assertLessThanOrEqual() public static
assertLessThanOrEqual(mixed $expected, mixed $actual, mixed $message)
Asserts that a value is smaller than or equal to another value.
Parameters
-
mixed$expected -
mixed$actual -
string$message optional
assertNan() public static
assertNan(mixed $actual, mixed $message)
Asserts that a variable is nan.
Parameters
-
mixed$actual -
string$message optional
assertNoRedirect() public
assertNoRedirect(mixed $message)
Asserts that the Location header is not set.
Parameters
-
string$message optional The failure message that will be appended to the generated message.
assertNotContains() public static
assertNotContains(mixed $needle, mixed $haystack, mixed $message, mixed $ignoreCase, mixed $checkForObjectIdentity, mixed $checkForNonObjectIdentity)
Asserts that a haystack does not contain a needle.
Parameters
-
mixed$needle -
mixed$haystack -
string$message optional -
bool$ignoreCase optional -
bool$checkForObjectIdentity optional -
bool$checkForNonObjectIdentity optional
assertNotContainsOnly() public static
assertNotContainsOnly(mixed $type, mixed $haystack, mixed $isNativeType, mixed $message)
Asserts that a haystack does not contain only values of a given type.
Parameters
-
string$type -
mixed$haystack -
bool$isNativeType optional -
string$message optional
assertNotCount() public static
assertNotCount(mixed $expectedCount, mixed $haystack, mixed $message)
Asserts the number of elements of an array, Countable or Traversable.
Parameters
-
int$expectedCount -
mixed$haystack -
string$message optional
assertNotEmpty() public static
assertNotEmpty(mixed $actual, mixed $message)
Asserts that a variable is not empty.
Parameters
-
mixed$actual -
string$message optional
Throws
PHPUnit\Framework\AssertionFailedErrorassertNotEquals() public static
assertNotEquals(mixed $expected, mixed $actual, mixed $message, mixed $delta, mixed $maxDepth, mixed $canonicalize, mixed $ignoreCase)
Asserts that two variables are not equal.
Parameters
-
mixed$expected -
mixed$actual -
string$message optional -
float$delta optional -
int$maxDepth optional -
bool$canonicalize optional -
bool$ignoreCase optional
assertNotFalse() public static
assertNotFalse(mixed $condition, mixed $message)
Asserts that a condition is not false.
Parameters
-
bool$condition -
string$message optional
Throws
PHPUnit\Framework\AssertionFailedErrorassertNotInstanceOf() public static
assertNotInstanceOf(mixed $expected, mixed $actual, mixed $message)
Asserts that a variable is not of a given type.
Parameters
-
string$expected -
mixed$actual -
string$message optional
assertNotInternalType() public static
assertNotInternalType(mixed $expected, mixed $actual, mixed $message)
Asserts that a variable is not of a given type.
Parameters
-
string$expected -
mixed$actual -
string$message optional
assertNotIsReadable() public static
assertNotIsReadable(mixed $filename, mixed $message)
Asserts that a file/dir exists and is not readable.
Parameters
-
string$filename -
string$message optional
assertNotIsWritable() public static
assertNotIsWritable(mixed $filename, mixed $message)
Asserts that a file/dir exists and is not writable.
Parameters
-
string$filename -
string$message optional
assertNotNull() public static
assertNotNull(mixed $actual, mixed $message)
Asserts that a variable is not null.
Parameters
-
mixed$actual -
string$message optional
assertNotRegExp() public static
assertNotRegExp(mixed $pattern, mixed $string, mixed $message)
Asserts that a string does not match a given regular expression.
Parameters
-
string$pattern -
string$string -
string$message optional
assertNotSame() public static
assertNotSame(mixed $expected, mixed $actual, mixed $message)
Asserts that two variables do not have the same type and value.
Used on objects, it asserts that two variables do not reference the same object.
Parameters
-
mixed$expected -
mixed$actual -
string$message optional
assertNotSameSize() public static
assertNotSameSize(mixed $expected, mixed $actual, mixed $message)
Assert that the size of two arrays (or Countable or Traversable objects) is not the same.
Parameters
-
array|\Countable|\Traversable$expected -
array|\Countable|\Traversable$actual -
string$message optional
assertNotTrue() public static
assertNotTrue(mixed $condition, mixed $message)
Asserts that a condition is not true.
Parameters
-
bool$condition -
string$message optional
Throws
PHPUnit\Framework\AssertionFailedErrorassertNotWithinRange() protected static
assertNotWithinRange(mixed $expected, mixed $result, mixed $margin, mixed $message)
Compatibility function to test if a value is not between an acceptable range.
Parameters
-
float$expected -
float$result -
float$margin the rage of acceptation
-
string$message optional the text to display if the assertion is not correct
assertNull() public static
assertNull(mixed $actual, mixed $message)
Asserts that a variable is null.
Parameters
-
mixed$actual -
string$message optional
assertObjectHasAttribute() public static
assertObjectHasAttribute(mixed $attributeName, mixed $object, mixed $message)
Asserts that an object has a specified attribute.
Parameters
-
string$attributeName -
object$object -
string$message optional
assertObjectNotHasAttribute() public static
assertObjectNotHasAttribute(mixed $attributeName, mixed $object, mixed $message)
Asserts that an object does not have a specified attribute.
Parameters
-
string$attributeName -
object$object -
string$message optional
assertPathEquals() protected static
assertPathEquals(mixed $expected, mixed $result, mixed $message)
Compatibility function to test paths.
Parameters
-
string$expected -
string$result -
string$message optional the text to display if the assertion is not correct
assertPostConditions() protected
assertPostConditions()
Performs assertions shared by all tests of a test case.
This method is called after the execution of a test ends and before tearDown() is called.
assertPreConditions() protected
assertPreConditions()
Performs assertions shared by all tests of a test case.
This method is called before the execution of a test starts and after setUp() is called.
assertRedirect() public
assertRedirect(mixed $url, mixed $message)
Asserts that the Location header is correct. Comparison is made against a full URL.
Parameters
-
string|array|null$url optional The URL you expected the client to go to. This can either be a string URL or an array compatible with Router::url(). Use null to simply check for the existence of this header.
-
string$message optional The failure message that will be appended to the generated message.
assertRedirectContains() public
assertRedirectContains(mixed $url, mixed $message)
Asserts that the Location header contains a substring
Parameters
-
string$url The URL you expected the client to go to.
-
string$message optional The failure message that will be appended to the generated message.
assertRedirectEquals() public
assertRedirectEquals(mixed $url, mixed $message)
Asserts that the Location header is correct. Comparison is made against exactly the URL provided.
Parameters
-
string|array|null$url optional The URL you expected the client to go to. This can either be a string URL or an array compatible with Router::url(). Use null to simply check for the existence of this header.
-
string$message optional The failure message that will be appended to the generated message.
assertRedirectNotContains() public
assertRedirectNotContains(mixed $url, mixed $message)
Asserts that the Location header does not contain a substring
Parameters
-
string$url The URL you expected the client to go to.
-
string$message optional The failure message that will be appended to the generated message.
assertRegExp() public static
assertRegExp(mixed $pattern, mixed $string, mixed $message)
Asserts that a string matches a given regular expression.
Parameters
-
string$pattern -
string$string -
string$message optional
assertResponseCode() public
assertResponseCode(mixed $code, mixed $message)
Asserts a specific response status code.
Parameters
-
int$code Status code to assert.
-
string$message optional Custom message for failure.
assertResponseContains() public
assertResponseContains(mixed $content, mixed $message, mixed $ignoreCase)
Asserts content exists in the response body.
Parameters
-
string$content The content to check for.
-
string$message optional The failure message that will be appended to the generated message.
-
bool$ignoreCase optional A flag to check whether we should ignore case or not.
assertResponseEmpty() public
assertResponseEmpty(mixed $message)
Assert response content is empty.
Parameters
-
string$message optional The failure message that will be appended to the generated message.
assertResponseEquals() public
assertResponseEquals(mixed $content, mixed $message)
Asserts content in the response body equals.
Parameters
-
mixed$content The content to check for.
-
string$message optional The failure message that will be appended to the generated message.
assertResponseError() public
assertResponseError(mixed $message)
Asserts that the response status code is in the 4xx range.
Parameters
-
string$message optional Custom message for failure.
assertResponseFailure() public
assertResponseFailure(mixed $message)
Asserts that the response status code is in the 5xx range.
Parameters
-
string$message optional Custom message for failure.
assertResponseNotContains() public
assertResponseNotContains(mixed $content, mixed $message, mixed $ignoreCase)
Asserts content does not exist in the response body.
Parameters
-
string$content The content to check for.
-
string$message optional The failure message that will be appended to the generated message.
-
bool$ignoreCase optional A flag to check whether we should ignore case or not.
assertResponseNotEmpty() public
assertResponseNotEmpty(mixed $message)
Assert response content is not empty.
Parameters
-
string$message optional The failure message that will be appended to the generated message.
assertResponseNotEquals() public
assertResponseNotEquals(mixed $content, mixed $message)
Asserts content in the response body not equals.
Parameters
-
mixed$content The content to check for.
-
string$message optional The failure message that will be appended to the generated message.
assertResponseNotRegExp() public
assertResponseNotRegExp(mixed $pattern, mixed $message)
Asserts that the response body does not match a given regular expression.
Parameters
-
string$pattern The pattern to compare against.
-
string$message optional The failure message that will be appended to the generated message.
assertResponseOk() public
assertResponseOk(mixed $message)
Asserts that the response status code is in the 2xx range.
Parameters
-
string$message optional Custom message for failure.
assertResponseRegExp() public
assertResponseRegExp(mixed $pattern, mixed $message)
Asserts that the response body matches a given regular expression.
Parameters
-
string$pattern The pattern to compare against.
-
string$message optional The failure message that will be appended to the generated message.
assertResponseSuccess() public
assertResponseSuccess(mixed $message)
Asserts that the response status code is in the 2xx/3xx range.
Parameters
-
string$message optional Custom message for failure.
assertSame() public static
assertSame(mixed $expected, mixed $actual, mixed $message)
Asserts that two variables have the same type and value.
Used on objects, it asserts that two variables reference the same object.
Parameters
-
mixed$expected -
mixed$actual -
string$message optional
assertSameSize() public static
assertSameSize(mixed $expected, mixed $actual, mixed $message)
Assert that the size of two arrays (or Countable or Traversable objects) is the same.
Parameters
-
array|\Countable|\Traversable$expected -
array|\Countable|\Traversable$actual -
string$message optional
assertSession() public
assertSession(mixed $expected, mixed $path, mixed $message)
Asserts session contents
Parameters
-
string$expected The expected contents.
-
string$path The session data path. Uses Hash::get() compatible notation
-
string$message optional The failure message that will be appended to the generated message.
assertStringEndsNotWith() public static
assertStringEndsNotWith(mixed $suffix, mixed $string, mixed $message)
Asserts that a string ends not with a given suffix.
Parameters
-
string$suffix -
string$string -
string$message optional
assertStringEndsWith() public static
assertStringEndsWith(mixed $suffix, mixed $string, mixed $message)
Asserts that a string ends with a given suffix.
Parameters
-
string$suffix -
string$string -
string$message optional
assertStringEqualsFile() public static
assertStringEqualsFile(mixed $expectedFile, mixed $actualString, mixed $message, mixed $canonicalize, mixed $ignoreCase)
Asserts that the contents of a string is equal to the contents of a file.
Parameters
-
string$expectedFile -
string$actualString -
string$message optional -
bool$canonicalize optional -
bool$ignoreCase optional
assertStringMatchesFormat() public static
assertStringMatchesFormat(mixed $format, mixed $string, mixed $message)
Asserts that a string matches a given format string.
Parameters
-
string$format -
string$string -
string$message optional
assertStringMatchesFormatFile() public static
assertStringMatchesFormatFile(mixed $formatFile, mixed $string, mixed $message)
Asserts that a string matches a given format file.
Parameters
-
string$formatFile -
string$string -
string$message optional
assertStringNotEqualsFile() public static
assertStringNotEqualsFile(mixed $expectedFile, mixed $actualString, mixed $message, mixed $canonicalize, mixed $ignoreCase)
Asserts that the contents of a string is not equal to the contents of a file.
Parameters
-
string$expectedFile -
string$actualString -
string$message optional -
bool$canonicalize optional -
bool$ignoreCase optional
assertStringNotMatchesFormat() public static
assertStringNotMatchesFormat(mixed $format, mixed $string, mixed $message)
Asserts that a string does not match a given format string.
Parameters
-
string$format -
string$string -
string$message optional
assertStringNotMatchesFormatFile() public static
assertStringNotMatchesFormatFile(mixed $formatFile, mixed $string, mixed $message)
Asserts that a string does not match a given format string.
Parameters
-
string$formatFile -
string$string -
string$message optional
assertStringStartsNotWith() public static
assertStringStartsNotWith(mixed $prefix, mixed $string, mixed $message)
Asserts that a string starts not with a given prefix.
Parameters
-
string$prefix -
string$string -
string$message optional
assertStringStartsWith() public static
assertStringStartsWith(mixed $prefix, mixed $string, mixed $message)
Asserts that a string starts with a given prefix.
Parameters
-
string$prefix -
string$string -
string$message optional
assertTags() public
assertTags(mixed $string, mixed $expected, mixed $fullDebug)
Asserts HTML tags.
Parameters
-
string$string An HTML/XHTML/XML string
-
array$expected An array, see above
-
bool$fullDebug optional Whether or not more verbose output should be used.
assertTemplate() public
assertTemplate(mixed $content, mixed $message)
Asserts that the search string was in the template name.
Parameters
-
string$content The content to check for.
-
string$message optional The failure message that will be appended to the generated message.
assertTextContains() public
assertTextContains(mixed $needle, mixed $haystack, mixed $message, mixed $ignoreCase)
Assert that a string contains another string, ignoring differences in newlines.
Helpful for doing cross platform tests of blocks of text.
Parameters
-
string$needle The string to search for.
-
string$haystack The string to search through.
-
string$message optional The message to display on failure.
-
bool$ignoreCase optional Whether or not the search should be case-sensitive.
assertTextEndsNotWith() public
assertTextEndsNotWith(mixed $suffix, mixed $string, mixed $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 The suffix to not find.
-
string$string The string to search.
-
string$message optional The message to use for failure.
assertTextEndsWith() public
assertTextEndsWith(mixed $suffix, mixed $string, mixed $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 The suffix to find.
-
string$string The string to search.
-
string$message optional The message to use for failure.
assertTextEquals() public
assertTextEquals(mixed $expected, mixed $result, mixed $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.
-
string$message optional The message to use for failure.
assertTextNotContains() public
assertTextNotContains(mixed $needle, mixed $haystack, mixed $message, mixed $ignoreCase)
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 The string to search for.
-
string$haystack The string to search through.
-
string$message optional The message to display on failure.
-
bool$ignoreCase optional Whether or not the search should be case-sensitive.
assertTextNotEquals() public
assertTextNotEquals(mixed $expected, mixed $result, mixed $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.
-
string$message optional The message to use for failure.
assertTextStartsNotWith() public
assertTextStartsNotWith(mixed $prefix, mixed $string, mixed $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 The prefix to not find.
-
string$string The string to search.
-
string$message optional The message to use for failure.
assertTextStartsWith() public
assertTextStartsWith(mixed $prefix, mixed $string, mixed $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 The prefix to check for.
-
string$string The string to search in.
-
string$message optional The message to use for failure.
assertThat() public static
assertThat(mixed $value, \PHPUnit\Framework\Constraint\Constraint $constraint, mixed $message)
Evaluates a PHPUnit\Framework\Constraint matcher object.
Parameters
-
mixed$value -
\PHPUnit\Framework\Constraint\Constraint$constraint -
string$message optional
assertTrue() public static
assertTrue(mixed $condition, mixed $message)
Asserts that a condition is true.
Parameters
-
bool$condition -
string$message optional
Throws
PHPUnit\Framework\AssertionFailedErrorassertWithinRange() protected static
assertWithinRange(mixed $expected, mixed $result, mixed $margin, mixed $message)
Compatibility function to test if a value is between an acceptable range.
Parameters
-
float$expected -
float$result -
float$margin the rage of acceptation
-
string$message optional the text to display if the assertion is not correct
assertXmlFileEqualsXmlFile() public static
assertXmlFileEqualsXmlFile(mixed $expectedFile, mixed $actualFile, mixed $message)
Asserts that two XML files are equal.
Parameters
-
string$expectedFile -
string$actualFile -
string$message optional
assertXmlFileNotEqualsXmlFile() public static
assertXmlFileNotEqualsXmlFile(mixed $expectedFile, mixed $actualFile, mixed $message)
Asserts that two XML files are not equal.
Parameters
-
string$expectedFile -
string$actualFile -
string$message optional
assertXmlStringEqualsXmlFile() public static
assertXmlStringEqualsXmlFile(mixed $expectedFile, mixed $actualXml, mixed $message)
Asserts that two XML documents are equal.
Parameters
-
string$expectedFile -
string|\DOMDocument$actualXml -
string$message optional
assertXmlStringEqualsXmlString() public static
assertXmlStringEqualsXmlString(mixed $expectedXml, mixed $actualXml, mixed $message)
Asserts that two XML documents are equal.
Parameters
-
string|\DOMDocument$expectedXml -
string|\DOMDocument$actualXml -
string$message optional
assertXmlStringNotEqualsXmlFile() public static
assertXmlStringNotEqualsXmlFile(mixed $expectedFile, mixed $actualXml, mixed $message)
Asserts that two XML documents are not equal.
Parameters
-
string$expectedFile -
string|\DOMDocument$actualXml -
string$message optional
assertXmlStringNotEqualsXmlString() public static
assertXmlStringNotEqualsXmlString(mixed $expectedXml, mixed $actualXml, mixed $message)
Asserts that two XML documents are not equal.
Parameters
-
string|\DOMDocument$expectedXml -
string|\DOMDocument$actualXml -
string$message optional
at() public static
at(mixed $index)
Returns a matcher that matches when the method is executed at the given index.
Parameters
-
int$index
Returns
\PHPUnit\Framework\MockObject\Matcher\InvokedAtIndexatLeast() public static
atLeast(mixed $requiredInvocations)
Returns a matcher that matches when the method is executed at least N times.
Parameters
-
int$requiredInvocations
Returns
\PHPUnit\Framework\MockObject\Matcher\InvokedAtLeastCountatLeastOnce() public static
atLeastOnce()
Returns a matcher that matches when the method is executed at least once.
Returns
\PHPUnit\Framework\MockObject\Matcher\InvokedAtLeastOnceatMost() public static
atMost(mixed $allowedInvocations)
Returns a matcher that matches when the method is executed at most N times.
Parameters
-
int$allowedInvocations
Returns
\PHPUnit\Framework\MockObject\Matcher\InvokedAtMostCountattribute() public static
attribute(\PHPUnit\Framework\Constraint\Constraint $constraint, mixed $attributeName)
Parameters
-
\PHPUnit\Framework\Constraint\Constraint$constraint -
string$attributeName
Returns
\PHPUnit\Framework\Constraint\AttributeattributeEqualTo() public static
attributeEqualTo(mixed $attributeName, mixed $value, mixed $delta, mixed $maxDepth, mixed $canonicalize, mixed $ignoreCase)
Parameters
-
string$attributeName -
mixed$value -
float$delta optional -
int$maxDepth optional -
bool$canonicalize optional -
bool$ignoreCase optional
Returns
\PHPUnit\Framework\Constraint\Attributecallback() public static
callback(mixed $callback)
Parameters
-
callable$callback
Returns
callablecheckRequirements() protected
checkRequirements()
classHasAttribute() public static
classHasAttribute(mixed $attributeName)
Parameters
-
string$attributeName
Returns
\PHPUnit\Framework\Constraint\ClassHasAttributeclassHasStaticAttribute() public static
classHasStaticAttribute(mixed $attributeName)
Parameters
-
string$attributeName
Returns
\PHPUnit\Framework\Constraint\ClassHasStaticAttributecleanup() public
cleanup()
Clears the state used for requests.
clearPlugins() public
clearPlugins()
Clear all plugins from the global plugin collection.
Useful in test case teardown methods.
configApplication() public
configApplication(mixed $class, mixed $constructorArgs)
Configure the application class to use in integration tests.
Combined with useHttpServer() to customize the class name and constructor arguments of your application class.
Parameters
-
string$class The application class name.
-
array|null$constructorArgs The constructor arguments for your application class.
configRequest() public
configRequest(array $data)
Configures the data for the next request.
This data is cleared in the tearDown() method.
You can call this method multiple times to append into the current state.
Parameters
-
array$data The request data to use.
contains() public static
contains(mixed $value, mixed $checkForObjectIdentity, mixed $checkForNonObjectIdentity)
Parameters
-
mixed$value -
bool$checkForObjectIdentity optional -
bool$checkForNonObjectIdentity optional
Returns
\PHPUnit\Framework\Constraint\TraversableContainscontainsOnly() public static
containsOnly(mixed $type)
Parameters
-
string$type
Returns
\PHPUnit\Framework\Constraint\TraversableContainsOnlycontainsOnlyInstancesOf() public static
containsOnlyInstancesOf(mixed $classname)
Parameters
-
string$classname
Returns
\PHPUnit\Framework\Constraint\TraversableContainsOnlycontrollerSpy() public
controllerSpy(mixed $event, mixed $controller)
Adds additional event spies to the controller/view event manager.
Parameters
-
\Cake\Event\Event$event A dispatcher event.
-
\Cake\Controller\Controller|null$controller optional Controller instance.
cookie() public
cookie(mixed $name, mixed $value)
Sets a request cookie for future requests.
This method lets you configure the session data you want to be used for requests that follow. The session state is reset in each tearDown().
You can call this method multiple times to append into the current state.
Parameters
-
string$name The cookie name to use.
-
mixed$value The value of the cookie.
cookieEncrypted() public
cookieEncrypted(mixed $name, mixed $value, mixed $encrypt, mixed $key)
Sets a encrypted request cookie for future requests.
The difference from cookie() is this encrypts the cookie value like the CookieComponent.
Parameters
-
string$name The cookie name to use.
-
mixed$value The value of the cookie.
-
string|bool$encrypt optional Encryption mode to use.
-
string|null$key optional Encryption key used. Defaults to Security.salt.
See Also
count() public
count()
Counts the number of test cases executed by run(TestResult result).
Returns
intcountOf() public static
countOf(mixed $count)
Parameters
-
int$count
Returns
\PHPUnit\Framework\Constraint\CountcreateConfiguredMock() protected
createConfiguredMock(mixed $originalClassName, array $configuration)
Returns a configured test double for the specified class.
Parameters
-
string$originalClassName -
array$configuration
Returns
\PHPUnit\Framework\MockObject\MockObjectThrows
PHPUnit\Framework\ExceptioncreateMock() protected
createMock(mixed $originalClassName)
Returns a test double for the specified class.
Parameters
-
string$originalClassName
Returns
\PHPUnit\Framework\MockObject\MockObjectThrows
PHPUnit\Framework\ExceptioncreatePartialMock() protected
createPartialMock(mixed $originalClassName, array $methods)
Returns a partial test double for the specified class.
Parameters
-
string$originalClassName -
string[]$methods
Returns
\PHPUnit\Framework\MockObject\MockObjectThrows
PHPUnit\Framework\ExceptioncreateResult() protected
createResult()
Creates a default TestResult object.
Returns
\PHPUnit\Framework\TestResultcreateTestProxy() protected
createTestProxy(mixed $originalClassName, array $constructorArguments)
Returns a test proxy for the specified class.
Parameters
-
string$originalClassName -
array$constructorArguments optional
Returns
\PHPUnit\Framework\MockObject\MockObjectThrows
PHPUnit\Framework\ExceptiondataDescription() public
dataDescription()
Returns
stringdataName() public
dataName()
Returns
int|stringdelete() public
delete(mixed $url)
Performs a DELETE request using the current request data.
The response of the dispatched request will be stored as a property. You can use various assert methods to check the response.
Parameters
-
string|array$url The URL to request.
Throws
PHPUnit\Exceptiondeprecated() public
deprecated(mixed $callable)
Helper method for check deprecation methods
Parameters
-
callable$callable callable function that will receive asserts
directoryExists() public static
directoryExists()
Returns
\PHPUnit\Framework\Constraint\DirectoryExistsdisableErrorHandlerMiddleware() public
disableErrorHandlerMiddleware()
Disable the error handler middleware.
By using this function, exceptions are no longer caught by the ErrorHandlerMiddleware and are instead re-thrown by the TestExceptionRenderer. This can be helpful when trying to diagnose/debug unexpected failures in test cases.
doesNotPerformAssertions() public
doesNotPerformAssertions()
Returns
boolenableCsrfToken() public
enableCsrfToken()
Calling this method will add a CSRF token to the request.
Both the POST data and cookie will be populated when this option is enabled. The default parameter names will be used.
enableRetainFlashMessages() public
enableRetainFlashMessages()
Calling this method will re-store flash messages into the test session after being removed by the FlashHelper
enableSecurityToken() public
enableSecurityToken()
Calling this method will enable a SecurityComponent compatible token to be added to request data. This lets you easily test actions protected by SecurityComponent.
equalTo() public static
equalTo(mixed $value, mixed $delta, mixed $maxDepth, mixed $canonicalize, mixed $ignoreCase)
Parameters
-
mixed$value -
float$delta optional -
int$maxDepth optional -
bool$canonicalize optional -
bool$ignoreCase optional
Returns
\PHPUnit\Framework\Constraint\IsEqualexactly() public static
exactly(mixed $count)
Returns a matcher that matches when the method is executed exactly $count times.
Parameters
-
int$count
Returns
\PHPUnit\Framework\MockObject\Matcher\InvokedCountexpectException() public
expectException(mixed $exception)
Parameters
-
string$exception
expectExceptionCode() public
expectExceptionCode(mixed $code)
Parameters
-
int|string$code
Throws
PHPUnit\Framework\ExceptionexpectExceptionMessage() public
expectExceptionMessage(mixed $message)
Parameters
-
string$message
Throws
PHPUnit\Framework\ExceptionexpectExceptionMessageRegExp() public
expectExceptionMessageRegExp(mixed $messageRegExp)
Parameters
-
string$messageRegExp
Throws
PHPUnit\Framework\ExceptionexpectExceptionObject() public
expectExceptionObject(\Exception $exception)
Sets up an expectation for an exception to be raised by the code under test.
Information for expected exception class, expected exception message, and expected exception code are retrieved from a given Exception object.
Parameters
-
\Exception$exception
expectOutputRegex() public
expectOutputRegex(mixed $expectedRegex)
Parameters
-
string$expectedRegex
Throws
PHPUnit\Framework\ExceptionexpectOutputString() public
expectOutputString(mixed $expectedString)
Parameters
-
string$expectedString
extractExceptionMessage() protected
extractExceptionMessage(\Exception $exception)
Extract verbose message for existing exception
Parameters
-
\Exception$exception Exception to extract
Returns
stringextractVerboseMessage() protected
extractVerboseMessage(mixed $message)
Inspect controller to extract possible causes of the failed assertion
Parameters
-
string$message optional Original message to use as a base
Returns
string|nullfail() public static
fail(mixed $message)
Fails a test with the given message.
Parameters
-
string$message optional
Throws
PHPUnit\Framework\AssertionFailedErrorfileExists() public static
fileExists()
Returns
\PHPUnit\Framework\Constraint\FileExistsget() public
get(mixed $url)
Performs a GET request using the current request data.
The response of the dispatched request will be stored as a property. You can use various assert methods to check the response.
Parameters
-
string|array$url The URL to request.
Throws
PHPUnit\ExceptiongetActualOutput() public
getActualOutput()
Returns
stringgetAnnotations() public
getAnnotations()
Returns the annotations for this test.
Returns
arraygetCount() public static
getCount()
Return the current assertion count.
Returns
intgetDataSetAsString() public
getDataSetAsString(mixed $includeData)
Gets the data set description of a TestCase.
Parameters
-
bool$includeData optional
Returns
stringgetExpectedException() public
getExpectedException()
Returns
null|stringgetExpectedExceptionCode() public
getExpectedExceptionCode()
Returns
null|int|stringgetExpectedExceptionMessage() public
getExpectedExceptionMessage()
Returns
stringgetExpectedExceptionMessageRegExp() public
getExpectedExceptionMessageRegExp()
Returns
stringgetFixtures() public
getFixtures()
Gets fixtures.
Returns
arraygetGroups() public
getGroups()
getMockBuilder() public
getMockBuilder(mixed $className)
Returns a builder object to create mock objects using a fluent interface.
Parameters
-
string|string[]$className
Returns
\PHPUnit\Framework\MockObject\MockBuildergetMockClass() protected
getMockClass(mixed $originalClassName, mixed $methods, array $arguments, mixed $mockClassName, mixed $callOriginalConstructor, mixed $callOriginalClone, mixed $callAutoload, mixed $cloneArguments)
Mocks the specified class and returns the name of the mocked class.
Parameters
-
string$originalClassName -
array$methods optional -
array$arguments optional -
string$mockClassName optional -
bool$callOriginalConstructor optional -
bool$callOriginalClone optional -
bool$callAutoload optional -
bool$cloneArguments optional
Returns
stringThrows
PHPUnit\Framework\ExceptiongetMockForAbstractClass() protected
getMockForAbstractClass(mixed $originalClassName, array $arguments, mixed $mockClassName, mixed $callOriginalConstructor, mixed $callOriginalClone, mixed $callAutoload, mixed $mockedMethods, mixed $cloneArguments)
Returns a mock object for the specified abstract class with all abstract methods of the class mocked. Concrete methods are not mocked by default.
To mock concrete methods, use the 7th parameter ($mockedMethods).
Parameters
-
string$originalClassName -
array$arguments optional -
string$mockClassName optional -
bool$callOriginalConstructor optional -
bool$callOriginalClone optional -
bool$callAutoload optional -
array$mockedMethods optional -
bool$cloneArguments optional
Returns
\PHPUnit\Framework\MockObject\MockObjectThrows
PHPUnit\Framework\ExceptiongetMockForModel() public
getMockForModel(mixed $alias, mixed $methods, array $options)
Mock a model, maintain fixtures and table association
Parameters
-
string$alias The model to get a mock for.
-
string[]|null$methods optional The list of methods to mock
-
array$options optional The config data for the mock's constructor.
Returns
\Cake\ORM\Table|\PHPUnit_Framework_MockObject_MockObjectThrows
Cake\ORM\Exception\MissingTableClassExceptiongetMockForTrait() protected
getMockForTrait(mixed $traitName, array $arguments, mixed $mockClassName, mixed $callOriginalConstructor, mixed $callOriginalClone, mixed $callAutoload, mixed $mockedMethods, mixed $cloneArguments)
Returns a mock object for the specified trait with all abstract methods of the trait mocked. Concrete methods to mock can be specified with the $mockedMethods parameter.
Parameters
-
string$traitName -
array$arguments optional -
string$mockClassName optional -
bool$callOriginalConstructor optional -
bool$callOriginalClone optional -
bool$callAutoload optional -
array$mockedMethods optional -
bool$cloneArguments optional
Returns
\PHPUnit\Framework\MockObject\MockObjectThrows
PHPUnit\Framework\ExceptiongetMockFromWsdl() protected
getMockFromWsdl(mixed $wsdlFile, mixed $originalClassName, mixed $mockClassName, array $methods, mixed $callOriginalConstructor, array $options)
Returns a mock object based on the given WSDL file.
Parameters
-
string$wsdlFile -
string$originalClassName optional -
string$mockClassName optional -
array$methods optional -
bool$callOriginalConstructor optional -
array$options optional An array of options passed to SOAPClient::_construct
Returns
\PHPUnit\Framework\MockObject\MockObjectgetName() public
getName(mixed $withDataSet)
Gets the name of a TestCase.
Parameters
-
bool$withDataSet optional
Returns
stringgetNumAssertions() public
getNumAssertions()
Returns the number of assertions performed by this test.
Returns
intgetObjectAttribute() public static
getObjectAttribute(mixed $object, mixed $attributeName)
Returns the value of an object's attribute.
This also works for attributes that are declared protected or private.
Parameters
-
object$object -
string$attributeName
Returns
mixedThrows
PHPUnit\Framework\ExceptiongetObjectForTrait() protected
getObjectForTrait(mixed $traitName, array $arguments, mixed $traitClassName, mixed $callOriginalConstructor, mixed $callOriginalClone, mixed $callAutoload)
Returns an object for the specified trait.
Parameters
-
string$traitName -
array$arguments optional -
string$traitClassName optional -
bool$callOriginalConstructor optional -
bool$callOriginalClone optional -
bool$callAutoload optional
Returns
objectThrows
PHPUnit\Framework\ExceptiongetProvidedData() protected
getProvidedData()
Gets the data set of a TestCase.
Returns
arraygetResult() public
getResult()
Returns
mixedgetSize() public
getSize()
Returns the size of the test.
Returns
intgetStaticAttribute() public static
getStaticAttribute(mixed $className, mixed $attributeName)
Returns the value of a static attribute.
This also works for attributes that are declared protected or private.
Parameters
-
string$className -
string$attributeName
Returns
mixedThrows
PHPUnit\Framework\ExceptiongetStatus() public
getStatus()
Returns the status of this test.
Returns
intgetStatusMessage() public
getStatusMessage()
Returns the status message of this test.
Returns
stringgetTableLocator() public
getTableLocator()
Gets the table locator.
Returns
\Cake\ORM\Locator\LocatorInterfacegetTestResultObject() public
getTestResultObject()
Returns
\PHPUnit\Framework\TestResultgreaterThan() public static
greaterThan(mixed $value)
Parameters
-
mixed$value
Returns
\PHPUnit\Framework\Constraint\GreaterThangreaterThanOrEqual() public static
greaterThanOrEqual(mixed $value)
Parameters
-
mixed$value
Returns
\PHPUnit\Framework\Constraint\LogicalOrhandleDependencies() protected
handleDependencies()
hasDependencies() public
hasDependencies()
Returns true if the tests has dependencies
Returns
boolhasExpectationOnOutput() public
hasExpectationOnOutput()
Returns
boolhasFailed() public
hasFailed()
Returns whether or not this test has failed.
Returns
boolhasOutput() public
hasOutput()
Returns
boolhasSize() public
hasSize()
Returns
boolhead() public
head(mixed $url)
Performs a HEAD request using the current request data.
The response of the dispatched request will be stored as a property. You can use various assert methods to check the response.
Parameters
-
string|array$url The URL to request.
Throws
PHPUnit\ExceptionidenticalTo() public static
identicalTo(mixed $value)
Parameters
-
mixed$value
Returns
\PHPUnit\Framework\Constraint\IsIdenticaliniSet() protected
iniSet(mixed $varName, mixed $newValue)
This method is a wrapper for the ini_set() function that automatically resets the modified php.ini setting to its original value after the test is run.
Parameters
-
string$varName -
string$newValue
Throws
PHPUnit\Framework\ExceptionisEmpty() public static
isEmpty()
Returns
\PHPUnit\Framework\Constraint\IsEmptyisFalse() public static
isFalse()
Returns
\PHPUnit\Framework\Constraint\IsFalseisFinite() public static
isFinite()
Returns
\PHPUnit\Framework\Constraint\IsFiniteisInIsolation() public
isInIsolation()
Returns
boolisInfinite() public static
isInfinite()
Returns
\PHPUnit\Framework\Constraint\IsInfiniteisInstanceOf() public static
isInstanceOf(mixed $className)
Parameters
-
string$className
Returns
\PHPUnit\Framework\Constraint\IsInstanceOfisJson() public static
isJson()
Returns
\PHPUnit\Framework\Constraint\IsJsonisLarge() public
isLarge()
Returns
boolisMedium() public
isMedium()
Returns
boolisNan() public static
isNan()
Returns
\PHPUnit\Framework\Constraint\IsNanisNull() public static
isNull()
Returns
\PHPUnit\Framework\Constraint\IsNullisReadable() public static
isReadable()
Returns
\PHPUnit\Framework\Constraint\IsReadableisSmall() public
isSmall()
Returns
boolisTrue() public static
isTrue()
Returns
\PHPUnit\Framework\Constraint\IsTrueisType() public static
isType(mixed $type)
Parameters
-
string$type
Returns
\PHPUnit\Framework\Constraint\IsTypeisWritable() public static
isWritable()
Returns
\PHPUnit\Framework\Constraint\IsWritablelessThan() public static
lessThan(mixed $value)
Parameters
-
mixed$value
Returns
\PHPUnit\Framework\Constraint\LessThanlessThanOrEqual() public static
lessThanOrEqual(mixed $value)
Parameters
-
mixed$value
Returns
\PHPUnit\Framework\Constraint\LogicalOrloadFixtures() public
loadFixtures()
Chooses which fixtures to load for a given test
Each parameter is a model name that corresponds to a fixture, i.e. 'Posts', 'Authors', etc. Passing no parameters will cause all fixtures on the test case to load.
Throws
Exceptionwhen no fixture manager is available.
See Also
loadPlugins() public
loadPlugins(array $plugins)
Load plugins into a simulated application.
Useful to test how plugins being loaded/not loaded interact with other elements in CakePHP or applications.
Parameters
-
array$plugins optional List of Plugins to load.
Returns
\Cake\Http\BaseApplicationlogicalAnd() public static
logicalAnd()
Returns
\PHPUnit\Framework\Constraint\LogicalAndlogicalNot() public static
logicalNot(\PHPUnit\Framework\Constraint\Constraint $constraint)
Parameters
-
\PHPUnit\Framework\Constraint\Constraint$constraint
Returns
\PHPUnit\Framework\Constraint\LogicalNotlogicalOr() public static
logicalOr()
Returns
\PHPUnit\Framework\Constraint\LogicalOrlogicalXor() public static
logicalXor()
Returns
\PHPUnit\Framework\Constraint\LogicalXormarkAsRisky() public
markAsRisky()
markTestIncomplete() public static
markTestIncomplete(mixed $message)
Mark the test as incomplete.
Parameters
-
string$message optional
Throws
PHPUnit\Framework\IncompleteTestErrormarkTestSkipped() public static
markTestSkipped(mixed $message)
Mark the test as skipped.
Parameters
-
string$message optional
Throws
PHPUnit\Framework\SkippedTestErrormatches() public static
matches(mixed $string)
Parameters
-
string$string
Returns
\PHPUnit\Framework\Constraint\StringMatchesFormatDescriptionmatchesRegularExpression() public static
matchesRegularExpression(mixed $pattern)
Parameters
-
string$pattern
Returns
\PHPUnit\Framework\Constraint\RegularExpressionnever() public static
never()
Returns a matcher that matches when the method is never executed.
Returns
\PHPUnit\Framework\MockObject\Matcher\InvokedCountobjectHasAttribute() public static
objectHasAttribute(mixed $attributeName)
Parameters
-
string$attributeName
Returns
\PHPUnit\Framework\Constraint\ObjectHasAttributeonConsecutiveCalls() public static
onConsecutiveCalls()
Returns
\PHPUnit\Framework\MockObject\Stub\ConsecutiveCallsonNotSuccessfulTest() protected
onNotSuccessfulTest(\Throwable $t)
This method is called when a test method did not execute successfully.
Parameters
-
\Throwable$t
Throws
Throwableonce() public static
once()
Returns a matcher that matches when the method is executed exactly once.
Returns
\PHPUnit\Framework\MockObject\Matcher\InvokedCountoptions() public
options(mixed $url)
Performs an OPTIONS request using the current request data.
The response of the dispatched request will be stored as a property. You can use various assert methods to check the response.
Parameters
-
string|array$url The URL to request.
Throws
PHPUnit\Exceptionpatch() public
patch(mixed $url, mixed $data)
Performs a PATCH request using the current request data.
The response of the dispatched request will be stored as a property. You can use various assert methods to check the response.
Parameters
-
string|array$url The URL to request.
-
string|array|null$data optional The data for the request.
Throws
PHPUnit\Exceptionpost() public
post(mixed $url, mixed $data)
Performs a POST request using the current request data.
The response of the dispatched request will be stored as a property. You can use various assert methods to check the response.
Parameters
-
string|array$url The URL to request.
-
string|array|null$data optional The data for the request.
Throws
PHPUnit\ExceptionprepareTemplate() protected
prepareTemplate(\Text_Template $template)
Performs custom preparations on the process isolation template.
Parameters
-
\Text_Template$template
prophesize() protected
prophesize(mixed $classOrInterface)
Parameters
-
string|null$classOrInterface optional
Returns
\Prophecy\Prophecy\ObjectProphecyThrows
LogicExceptionput() public
put(mixed $url, mixed $data)
Performs a PUT request using the current request data.
The response of the dispatched request will be stored as a property. You can use various assert methods to check the response.
Parameters
-
string|array$url The URL to request.
-
string|array|null$data optional The data for the request.
Throws
PHPUnit\ExceptionreadAttribute() public static
readAttribute(mixed $classOrObject, mixed $attributeName)
Returns the value of an attribute of a class or an object.
This also works for attributes that are declared protected or private.
Parameters
-
string|object$classOrObject -
string$attributeName
Returns
mixedThrows
PHPUnit\Framework\ExceptionregisterComparator() public
registerComparator(\SebastianBergmann\Comparator\Comparator $comparator)
Parameters
-
\SebastianBergmann\Comparator\Comparator$comparator
registerMockObject() public
registerMockObject(\PHPUnit\Framework\MockObject\MockObject $mockObject)
Parameters
-
\PHPUnit\Framework\MockObject\MockObject$mockObject
removePlugins() public
removePlugins(array $names)
Remove plugins from the global plugin collection.
Useful in test case teardown methods.
Parameters
-
string[]$names optional A list of plugins you want to remove.
resetCount() public static
resetCount()
Reset the assertion counter.
returnArgument() public static
returnArgument(mixed $argumentIndex)
Parameters
-
int$argumentIndex
Returns
\PHPUnit\Framework\MockObject\Stub\ReturnArgumentreturnCallback() public static
returnCallback(mixed $callback)
Parameters
-
mixed$callback
Returns
\PHPUnit\Framework\MockObject\Stub\ReturnCallbackreturnSelf() public static
returnSelf()
Returns the current object.
This method is useful when mocking a fluent interface.
Returns
\PHPUnit\Framework\MockObject\Stub\ReturnSelfreturnValue() public static
returnValue(mixed $value)
Parameters
-
mixed$value
Returns
\PHPUnit\Framework\MockObject\Stub\ReturnStubreturnValueMap() public static
returnValueMap(array $valueMap)
Parameters
-
array$valueMap
Returns
\PHPUnit\Framework\MockObject\Stub\ReturnValueMaprun() public
run(\PHPUnit\Framework\TestResult $result)
Runs the test case and collects the results in a TestResult object.
If no TestResult object is passed a new one will be created.
Parameters
-
\PHPUnit\Framework\TestResult$result optional
Returns
\PHPUnit\Framework\TestResultThrows
PHPUnit\Framework\ExceptionrunBare() public
runBare()
Runs the bare test sequence.
runTest() protected
runTest()
Override to run the test and assert its state.
Returns
mixedThrows
PHPUnit\Framework\ExceptionPHPUnit\Framework\Exceptionsession() public
session(array $data)
Sets session data.
This method lets you configure the session data you want to be used for requests that follow. The session state is reset in each tearDown().
You can call this method multiple times to append into the current state.
Parameters
-
array$data The session data to use.
setAppNamespace() public static
setAppNamespace(mixed $appNamespace)
Set the app namespace
Parameters
-
string$appNamespace optional The app namespace, defaults to "TestApp".
setBackupGlobals() public
setBackupGlobals(mixed $backupGlobals)
Calling this method in setUp() has no effect!
Parameters
-
bool$backupGlobals
setBackupStaticAttributes() public
setBackupStaticAttributes(mixed $backupStaticAttributes)
Calling this method in setUp() has no effect!
Parameters
-
bool$backupStaticAttributes
setBeStrictAboutChangesToGlobalState() public
setBeStrictAboutChangesToGlobalState(mixed $beStrictAboutChangesToGlobalState)
Parameters
-
bool$beStrictAboutChangesToGlobalState
setDependencies() public
setDependencies(array $dependencies)
Sets the dependencies of a TestCase.
Parameters
-
string[]$dependencies
setDependencyInput() public
setDependencyInput(array $dependencyInput)
Sets
Parameters
-
array$dependencyInput
setExpectedExceptionFromAnnotation() protected
setExpectedExceptionFromAnnotation()
setGroups() public
setGroups(array $groups)
Parameters
-
array$groups
setInIsolation() public
setInIsolation(mixed $inIsolation)
Parameters
-
bool$inIsolation
Throws
PHPUnit\Framework\ExceptionsetLocale() protected
setLocale()
This method is a wrapper for the setlocale() function that automatically resets the locale to its original value after the test is run.
Throws
PHPUnit\Framework\ExceptionsetName() public
setName(mixed $name)
Sets the name of a TestCase.
Parameters
-
mixed$name
setOutputCallback() public
setOutputCallback(mixed $callback)
Parameters
-
callable$callback
Throws
PHPUnit\Framework\ExceptionsetPreserveGlobalState() public
setPreserveGlobalState(mixed $preserveGlobalState)
Parameters
-
bool$preserveGlobalState
Throws
PHPUnit\Framework\ExceptionsetRegisterMockObjectsFromTestArgumentsRecursively() public
setRegisterMockObjectsFromTestArgumentsRecursively(mixed $flag)
Parameters
-
bool$flag
setResult() public
setResult(mixed $result)
Parameters
-
mixed$result
setRunClassInSeparateProcess() public
setRunClassInSeparateProcess(mixed $runClassInSeparateProcess)
Parameters
-
bool$runClassInSeparateProcess
Throws
PHPUnit\Framework\ExceptionsetRunTestInSeparateProcess() public
setRunTestInSeparateProcess(mixed $runTestInSeparateProcess)
Parameters
-
bool$runTestInSeparateProcess
Throws
PHPUnit\Framework\ExceptionsetTableLocator() public
setTableLocator(\Cake\ORM\Locator\LocatorInterface $tableLocator)
Sets the table locator.
Parameters
-
\Cake\ORM\Locator\LocatorInterface$tableLocator LocatorInterface instance.
Returns
$thissetTestResultObject() public
setTestResultObject(\PHPUnit\Framework\TestResult $result)
Parameters
-
\PHPUnit\Framework\TestResult$result
setUnlockedFields() public
setUnlockedFields(array $unlockedFields)
Set list of fields that are excluded from field validation.
Parameters
-
string[]$unlockedFields optional List of fields that are excluded from field validation.
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.
setUpBeforeClass() public static
setUpBeforeClass()
This method is called before the first test of this test class is run.
setUseErrorHandler() public
setUseErrorHandler(mixed $useErrorHandler)
Parameters
-
bool$useErrorHandler
setUseErrorHandlerFromAnnotation() protected
setUseErrorHandlerFromAnnotation()
setupServer() public
setupServer()
Auto-detect if the HTTP middleware stack should be used.
skipIf() public
skipIf(mixed $shouldSkip, mixed $message)
Overrides SimpleTestCase::skipIf to provide a boolean return value
Parameters
-
bool$shouldSkip Whether or not the test should be skipped.
-
string$message optional The message to display.
Returns
boolskipUnless() protected
skipUnless(mixed $condition, mixed $message)
Compatibility function for skipping.
Parameters
-
bool$condition Condition to trigger skipping
-
string$message optional Message for skip
Returns
boolstringContains() public static
stringContains(mixed $string, mixed $case)
Parameters
-
string$string -
bool$case optional
Returns
\PHPUnit\Framework\Constraint\StringContainsstringEndsWith() public static
stringEndsWith(mixed $suffix)
Parameters
-
mixed$suffix
Returns
\PHPUnit\Framework\Constraint\StringEndsWithstringStartsWith() public static
stringStartsWith(mixed $prefix)
Parameters
-
mixed$prefix
Returns
\PHPUnit\Framework\Constraint\StringStartsWithtableLocator() public
tableLocator(\Cake\ORM\Locator\LocatorInterface $tableLocator)
Sets the table locator.
If no parameters are passed, it will return the currently used locator.
Parameters
-
\Cake\ORM\Locator\LocatorInterface|null$tableLocator optional LocatorInterface instance.
Returns
\Cake\ORM\Locator\LocatorInterfacetearDown() public
tearDown()
teardown any static object changes and restore them.
tearDownAfterClass() public static
tearDownAfterClass()
This method is called after the last test of this test class is run.
throwException() public static
throwException(\Throwable $exception)
Parameters
-
\Throwable$exception
Returns
\PHPUnit\Framework\MockObject\Stub\ExceptiontoString() public
toString()
Returns a string representation of the test case.
Returns
stringuseHttpServer() public
useHttpServer(mixed $enable)
Toggle whether or not you want to use the HTTP Server stack.
Parameters
-
bool$enable Enable/disable the usage of the HTTP Stack.
usesDataProvider() public
usesDataProvider()
Returns
boolverifyMockObjects() protected
verifyMockObjects()
Verifies the mock object expectations.
viewVariable() public
viewVariable(mixed $name)
Fetches a view variable by name.
If the view variable does not exist, null will be returned.
Parameters
-
string$name The view variable to get.
Returns
mixedThe view variable if set.
withErrorReporting() public
withErrorReporting(mixed $errorLevel, mixed $callable)
Helper method for tests that needs to use error_reporting()
Parameters
-
int$errorLevel value of error_reporting() that needs to use
-
callable$callable callable function that will receive asserts
Property Detail
$_appArgs protected
The customized application constructor arguments.
Type
array|null$_appClass protected
The customized application class name.
Type
string|null$_configure protected
Configure values to restore at end of test.
Type
array$_controller protected
The controller used in the last request.
Type
\Cake\Controller\Controller|null$_cookie protected
Cookie data to use in the next request.
Type
array$_cookieEncryptionKey protected
Type
string|null$_csrfToken protected
Boolean flag for whether or not the request should have a CSRF token added.
Type
bool$_exception protected
The exception being thrown if the case.
Type
\Exception|null$_flashMessages protected
Stored flash messages before render
Type
array|null$_layoutName protected
The last rendered layout
Type
string|null$_request protected
The data used to build the next request.
Type
array$_requestSession protected
The session instance from the last request
Type
\Cake\Http\Session|null$_response protected
The response for the most recent request.
Type
\Cake\Http\Response|null$_retainFlashMessages protected
Boolean flag for whether or not the request should re-store flash messages
Type
bool$_securityToken protected
Boolean flag for whether or not the request should have a SecurityComponent token added.
Type
bool$_session protected
Session data to use in the next request.
Type
array$_tableLocator protected
Table locator instance
Type
\Cake\ORM\Locator\LocatorInterface$_unlockedFields protected
List of fields that are excluded from field validation.
Type
string[]$_useHttpServer protected
Track whether or not tests are run against the PSR7 HTTP stack.
Type
bool$_validCiphers protected
Valid cipher names for encrypted cookies.
Type
string[]$_viewName protected
The last rendered view
Type
string|null$autoFixtures public
By default, all fixtures attached to this class will be truncated and reloaded after each test.
Set this to false to handle manually
Type
bool$backupGlobals protected
Enable or disable the backup and restoration of the $GLOBALS array.
Overwrite this attribute in a child class of TestCase. Setting this attribute in setUp() has no effect!
Type
bool$backupGlobalsBlacklist protected
Type
array$backupStaticAttributes protected
Enable or disable the backup and restoration of static attributes.
Overwrite this attribute in a child class of TestCase. Setting this attribute in setUp() has no effect!
Type
bool$backupStaticAttributesBlacklist protected
Type
array$dropTables public
Control table create/drops on each test method.
If true, tables will still be dropped at the end of each test runner execution.
Type
bool$fixtureManager public
The class responsible for managing the creation, loading and removing of fixtures
Type
\Cake\TestSuite\Fixture\FixtureManager|null$fixtures public
Fixtures used by this test case.
Type
string[]|string|null$preserveGlobalState protected
Whether or not this test should preserve the global state when running in a separate PHP process.
Type
bool$runTestInSeparateProcess protected
Whether or not this test is to be run in a separate PHP process.
Type
bool
© 2005–present The Cake Software Foundation, Inc.
Licensed under the MIT License.
CakePHP is a registered trademark of Cake Software Foundation, Inc.
We are not endorsed by or affiliated with CakePHP.
https://api.cakephp.org/3.9/class-Cake.TestSuite.IntegrationTestCase.html