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.
array|nullThe customized application constructor arguments.
string|nullThe customized application class name.
arrayConfigure values to restore at end of test.
\Cake\Controller\ControllerThe controller used in the last request.
arrayCookie data to use in the next request.
string|nullboolBoolean flag for whether or not the request should have a CSRF token added.
\Throwable|nullThe exception being thrown if the case.
array|nullStored flash messages before render
stringThe last rendered layout
arrayThe data used to build the next request.
\Cake\Http\SessionThe session instance from the last request
\Psr\Http\Message\ResponseInterfaceThe response for the most recent request.
boolBoolean flag for whether or not the request should re-store flash messages
boolBoolean flag for whether or not the request should have a SecurityComponent token added.
arraySession data to use in the next request.
\Cake\ORM\Locator\LocatorInterface|nullTable locator instance
string[]List of fields that are excluded from field validation.
string[]Valid cipher names for encrypted cookies.
stringThe last rendered view
boolBy default, all fixtures attached to this class will be truncated and reloaded after each test.
?boolstring[]boolarray<string,array<int,string>>boolControl table create/drops on each test method.
\Cake\TestSuite\Fixture\FixtureManager|nullThe class responsible for managing the creation, loading and removing of fixtures
string[]Fixtures used by this test case.
boolboolRecursively casts all data to string as that is how data would be POSTed in the real world
Explode method to return array from string set in CookieComponent::_implode() Maintains reading backwards compatibility with 1.x CookieComponent::_implode().
Asserts that a haystack that is stored in a static attribute of a class or an attribute of an object contains a needle.
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.
Asserts the number of elements of an array, Countable or Traversable that is stored in an attribute.
Asserts that a static attribute of a class or an attribute of an object is empty.
Asserts that a variable is equal to an attribute of an object.
Asserts that an attribute is greater than or equal to another value.
Asserts that an attribute is smaller than or equal to another value.
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.
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.
Asserts the number of elements of an array, Countable or Traversable that is stored in an attribute.
Asserts that a static attribute of a class or an attribute of an object is not empty.
Asserts that a variable is not equal to an attribute of an object.
Asserts that a variable and an attribute of an object do not have the same type and value.
Asserts that a variable and an attribute of an object have the same type and value.
Asserts that a class has a specified static attribute.
Asserts that a class does not have a specified attribute.
Asserts that a class does not have a specified static attribute.
Asserts that a haystack contains only instances of a given class name.
Assert that a string matches SQL with db-specific characters like quotes removed.
Asserts that a global event was fired. You must track events in your event manager for this assertion to work
Asserts that the contents of one file is equal to the contents of another file.
Asserts that the contents of one file is equal to the contents of another file (canonicalizing).
Asserts that the contents of one file is equal to the contents of another file (ignoring case).
Asserts that the contents of one file is not equal to the contents of another file.
Asserts that the contents of one file is not equal to the contents of another file (canonicalizing).
Asserts that the contents of one file is not equal to the contents of another file (ignoring case).
Asserts that a value is greater than or equal to another value.
Asserts that the generated JSON encoded object and the content of the given file are equal.
Asserts that two given JSON encoded objects or arrays are equal.
Asserts that the generated JSON encoded object and the content of the given file are not equal.
Asserts that two given JSON encoded objects or arrays are not equal.
Asserts that a value is smaller than or equal to another value.
Asserts that a haystack does not contain only values of a given type.
Asserts the number of elements of an array, Countable or Traversable.
Asserts that two variables are not equal (canonicalizing).
Asserts that two variables are not equal (ignoring case).
Assert that the size of two arrays (or Countable or Traversable objects) is not the same.
Compatibility function to test if a value is not between an acceptable range.
Asserts that an object does not have a specified attribute.
Asserts that the Location header is correct. Comparison is made against a full URL.
Asserts that the Location header is correct. Comparison is made against exactly the URL provided.
Assertion for comparing a regex pattern against a query having its identifiers quoted. It accepts queries quoted with the characters < and >. If the third parameter is set to true, it will alter the pattern to both accept quoted and unquoted queries
Asserts that the response body does not match a given regular expression.
Assert that the size of two arrays (or Countable or Traversable objects) is the same.
Asserts that the contents of a string is equal to the contents of a file.
Asserts that the contents of a string is equal to the contents of a file (canonicalizing).
Asserts that the contents of a string is equal to the contents of a file (ignoring case).
Asserts that the contents of a string is not equal to the contents of a file.
Asserts that the contents of a string is not equal to the contents of a file (canonicalizing).
Asserts that the contents of a string is not equal to the contents of a file (ignoring case).
Asserts that a string does not match a given format string.
Asserts that a string does not match a given format string.
Assert that a string contains another string, ignoring differences in newlines.
Asserts that a string ends not with a given prefix, ignoring differences in newlines.
Asserts that a string ends with a given prefix, ignoring differences in newlines.
Assert that a text doesn't contain another text, ignoring differences in newlines.
Asserts that a string starts not with a given prefix, ignoring differences in newlines.
Asserts that a string starts with a given prefix, ignoring differences in newlines.
Compatibility function to test if a value is between an acceptable range.
Returns a matcher that matches when the method is executed at least N times.
Returns a matcher that matches when the method is executed at least once.
Calling this method will re-store flash messages into the test session after being removed by the FlashHelper
Calling this method will enable a SecurityComponent compatible token to be added to request data. This lets you easily test actions protected by SecurityComponent.
Returns a matcher that matches when the method is executed exactly $count times.
Sets up an expectation for an exception to be raised by the code under test.
Inspect controller to extract possible causes of the failed assertion
Returns a mock object for the specified abstract class with all abstract methods of the class mocked. Concrete methods are not mocked by default.
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.
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.
This method is called when a test method did not execute successfully.
This method is a wrapper for the setlocale() function that automatically resets the locale to its original value after the test is run.
This method is called before the first test of this test class is run.
This method is called after the last test of this test class is run.
__construct(mixed $name, array $data, mixed $dataName)
string $name optional array $data optional string $dataName optional _addTokens(string $url, array $data)
Add the CSRF and Security Component tokens if necessary.
string $url The URL the form is being submitted on.
array $data The request body data.
arrayThe request body with tokens added.
_assertAttributes(array $assertions, string $string, bool $fullDebug, mixed $regex)
Check the attributes as part of an assertTags() check.
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
string|false_buildRequest(string $url, mixed $method, mixed $data)
Creates a request object with the configured options and parameters.
string $url The URL
string $method The HTTP method
string|array $data optional The request data.
arrayThe request context
_castToString(array $data)
Recursively casts all data to string as that is how data would be POSTed in the real world
array $data POST data
array_checkCipher(string $encrypt)
Helper method for validating encryption cipher names.
string $encrypt The cipher name.
RuntimeException_decode(string $value, mixed $encrypt, ?string $key)
Decodes and decrypts a single value.
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.
string|arrayDecoded values.
_decrypt(mixed $values, mixed $mode, ?string $key)
Decrypts $value using public $type method in Security class
string[]|string $values Values to decrypt
string|false $mode Encryption mode
string|null $key optional Used as the security salt if specified.
string|arrayDecrypted values
_encrypt(mixed $value, mixed $encrypt, ?string $key)
Encrypts $value using public $type method in Security class
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.
stringEncoded values
_explode(string $string)
Explode method to return array from string set in CookieComponent::_implode() Maintains reading backwards compatibility with 1.x CookieComponent::_implode().
string $string A string containing JSON encoded data, or a bare string.
string|arrayMap of key and values
_getBodyAsString()
Get the response body as string
stringThe response body.
_getCookieEncryptionKey()
Returns the encryption key to be used.
string_getTableClassName(string $alias, array $options)
Gets the class name for the table.
string $alias The model to get a mock for.
array $options The config data for the mock's constructor.
stringCake\ORM\Exception\MissingTableClassException_handleError(\Throwable $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.
\Throwable $exception Exception to handle.
_implode(array $array)
Implode method to keep keys are multidimensional arrays
array $array Map of key and values
stringA JSON encoded string.
_makeDispatcher()
Get the correct dispatcher instance.
\Cake\TestSuite\MiddlewareDispatcherA dispatcher instance
_normalizePath(string $path)
Normalize a path for comparison.
string $path Path separated by "/" slash.
stringNormalized path separated by DIRECTORY_SEPARATOR.
_sendRequest(mixed $url, mixed $method, mixed $data)
Creates and send the request into a Dispatcher instance.
Receives and stores the response for future inspection.
string|array $url The URL
string $method The HTTP method
string|array $data optional The request data.
PHPUnit\Exception|\Throwable_url(string $url)
Creates a valid request url and parameter array more like Request::_url()
string $url The URL
arrayQualified URL, the query parameters, and host data
addFixture(string $fixture)
Adds a fixture to this test case.
Examples:
Use this method inside your test cases' {@link getFixtures()} method to build up the fixture list.
string $fixture Fixture
$thisaddToAssertionCount(int $count)
int $count addWarning(string $warning)
string $warning any()
Returns a matcher that matches when the method is executed zero or more times.
anything()
arrayHasKey(mixed $key)
int|string $key assertArrayHasKey(mixed $key, mixed $array, string $message)
Asserts that an array has a specified key.
int|string $key array|\ArrayAccess $array string $message optional PHPUnit\Framework\ExpectationFailedExceptionSebastianBergmann\RecursionContext\InvalidArgumentExceptionPHPUnit\Framework\ExceptionassertArrayNotHasKey(mixed $key, mixed $array, string $message)
Asserts that an array does not have a specified key.
int|string $key array|\ArrayAccess $array string $message optional PHPUnit\Framework\ExpectationFailedExceptionSebastianBergmann\RecursionContext\InvalidArgumentExceptionPHPUnit\Framework\ExceptionassertArraySubset(mixed $subset, mixed $array, bool $checkForObjectIdentity, string $message)
Asserts that an array has a specified subset.
array|\ArrayAccess $subset array|\ArrayAccess $array bool $checkForObjectIdentity optional string $message optional PHPUnit\Framework\ExpectationFailedExceptionSebastianBergmann\RecursionContext\InvalidArgumentExceptionPHPUnit\Framework\ExceptionassertAttributeContains(mixed $needle, string $haystackAttributeName, mixed $haystackClassOrObject, string $message, bool $ignoreCase, bool $checkForObjectIdentity, bool $checkForNonObjectIdentity)
Asserts that a haystack that is stored in a static attribute of a class or an attribute of an object contains a needle.
mixed $needle string $haystackAttributeName object|string $haystackClassOrObject string $message optional bool $ignoreCase optional bool $checkForObjectIdentity optional bool $checkForNonObjectIdentity optional PHPUnit\Framework\ExpectationFailedExceptionSebastianBergmann\RecursionContext\InvalidArgumentExceptionPHPUnit\Framework\ExceptionassertAttributeContainsOnly(string $type, string $haystackAttributeName, mixed $haystackClassOrObject, ?bool $isNativeType, string $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.
string $type string $haystackAttributeName object|string $haystackClassOrObject bool $isNativeType optional string $message optional PHPUnit\Framework\ExpectationFailedExceptionSebastianBergmann\RecursionContext\InvalidArgumentExceptionPHPUnit\Framework\ExceptionassertAttributeCount(int $expectedCount, string $haystackAttributeName, mixed $haystackClassOrObject, string $message)
Asserts the number of elements of an array, Countable or Traversable that is stored in an attribute.
int $expectedCount string $haystackAttributeName object|string $haystackClassOrObject string $message optional PHPUnit\Framework\ExpectationFailedExceptionSebastianBergmann\RecursionContext\InvalidArgumentExceptionPHPUnit\Framework\ExceptionassertAttributeEmpty(string $haystackAttributeName, mixed $haystackClassOrObject, string $message)
Asserts that a static attribute of a class or an attribute of an object is empty.
string $haystackAttributeName object|string $haystackClassOrObject string $message optional PHPUnit\Framework\ExpectationFailedExceptionSebastianBergmann\RecursionContext\InvalidArgumentExceptionPHPUnit\Framework\ExceptionassertAttributeEquals(mixed $expected, string $actualAttributeName, mixed $actualClassOrObject, string $message, float $delta, int $maxDepth, bool $canonicalize, bool $ignoreCase)
Asserts that a variable is equal to an attribute of an object.
mixed $expected string $actualAttributeName object|string $actualClassOrObject string $message optional float $delta optional int $maxDepth optional bool $canonicalize optional bool $ignoreCase optional PHPUnit\Framework\ExpectationFailedExceptionSebastianBergmann\RecursionContext\InvalidArgumentExceptionPHPUnit\Framework\ExceptionassertAttributeGreaterThan(mixed $expected, string $actualAttributeName, mixed $actualClassOrObject, string $message)
Asserts that an attribute is greater than another value.
mixed $expected string $actualAttributeName object|string $actualClassOrObject string $message optional PHPUnit\Framework\ExpectationFailedExceptionSebastianBergmann\RecursionContext\InvalidArgumentExceptionPHPUnit\Framework\ExceptionassertAttributeGreaterThanOrEqual(mixed $expected, string $actualAttributeName, mixed $actualClassOrObject, string $message)
Asserts that an attribute is greater than or equal to another value.
mixed $expected string $actualAttributeName object|string $actualClassOrObject string $message optional PHPUnit\Framework\ExpectationFailedExceptionSebastianBergmann\RecursionContext\InvalidArgumentExceptionPHPUnit\Framework\ExceptionassertAttributeInstanceOf(string $expected, string $attributeName, mixed $classOrObject, string $message)
Asserts that an attribute is of a given type.
string $expected string $attributeName object|string $classOrObject string $message optional PHPUnit\Framework\ExpectationFailedExceptionSebastianBergmann\RecursionContext\InvalidArgumentExceptionPHPUnit\Framework\ExceptionassertAttributeInternalType(string $expected, string $attributeName, mixed $classOrObject, string $message)
Asserts that an attribute is of a given type.
string $expected string $attributeName object|string $classOrObject string $message optional PHPUnit\Framework\ExpectationFailedExceptionSebastianBergmann\RecursionContext\InvalidArgumentExceptionPHPUnit\Framework\ExceptionassertAttributeLessThan(mixed $expected, string $actualAttributeName, mixed $actualClassOrObject, string $message)
Asserts that an attribute is smaller than another value.
mixed $expected string $actualAttributeName object|string $actualClassOrObject string $message optional PHPUnit\Framework\ExpectationFailedExceptionSebastianBergmann\RecursionContext\InvalidArgumentExceptionPHPUnit\Framework\ExceptionassertAttributeLessThanOrEqual(mixed $expected, string $actualAttributeName, mixed $actualClassOrObject, string $message)
Asserts that an attribute is smaller than or equal to another value.
mixed $expected string $actualAttributeName object|string $actualClassOrObject string $message optional PHPUnit\Framework\ExpectationFailedExceptionSebastianBergmann\RecursionContext\InvalidArgumentExceptionPHPUnit\Framework\ExceptionassertAttributeNotContains(mixed $needle, string $haystackAttributeName, mixed $haystackClassOrObject, string $message, bool $ignoreCase, bool $checkForObjectIdentity, bool $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.
mixed $needle string $haystackAttributeName object|string $haystackClassOrObject string $message optional bool $ignoreCase optional bool $checkForObjectIdentity optional bool $checkForNonObjectIdentity optional PHPUnit\Framework\ExpectationFailedExceptionSebastianBergmann\RecursionContext\InvalidArgumentExceptionPHPUnit\Framework\ExceptionassertAttributeNotContainsOnly(string $type, string $haystackAttributeName, mixed $haystackClassOrObject, ?bool $isNativeType, string $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.
string $type string $haystackAttributeName object|string $haystackClassOrObject bool $isNativeType optional string $message optional PHPUnit\Framework\ExpectationFailedExceptionSebastianBergmann\RecursionContext\InvalidArgumentExceptionPHPUnit\Framework\ExceptionassertAttributeNotCount(int $expectedCount, string $haystackAttributeName, mixed $haystackClassOrObject, string $message)
Asserts the number of elements of an array, Countable or Traversable that is stored in an attribute.
int $expectedCount string $haystackAttributeName object|string $haystackClassOrObject string $message optional PHPUnit\Framework\ExpectationFailedExceptionSebastianBergmann\RecursionContext\InvalidArgumentExceptionPHPUnit\Framework\ExceptionassertAttributeNotEmpty(string $haystackAttributeName, mixed $haystackClassOrObject, string $message)
Asserts that a static attribute of a class or an attribute of an object is not empty.
string $haystackAttributeName object|string $haystackClassOrObject string $message optional PHPUnit\Framework\ExpectationFailedExceptionSebastianBergmann\RecursionContext\InvalidArgumentExceptionPHPUnit\Framework\ExceptionassertAttributeNotEquals(mixed $expected, string $actualAttributeName, mixed $actualClassOrObject, string $message, float $delta, int $maxDepth, bool $canonicalize, bool $ignoreCase)
Asserts that a variable is not equal to an attribute of an object.
mixed $expected string $actualAttributeName object|string $actualClassOrObject string $message optional float $delta optional int $maxDepth optional bool $canonicalize optional bool $ignoreCase optional PHPUnit\Framework\ExpectationFailedExceptionSebastianBergmann\RecursionContext\InvalidArgumentExceptionPHPUnit\Framework\ExceptionassertAttributeNotInstanceOf(string $expected, string $attributeName, mixed $classOrObject, string $message)
Asserts that an attribute is of a given type.
string $expected string $attributeName object|string $classOrObject string $message optional PHPUnit\Framework\ExpectationFailedExceptionSebastianBergmann\RecursionContext\InvalidArgumentExceptionPHPUnit\Framework\ExceptionassertAttributeNotInternalType(string $expected, string $attributeName, mixed $classOrObject, string $message)
Asserts that an attribute is of a given type.
string $expected string $attributeName object|string $classOrObject string $message optional PHPUnit\Framework\ExpectationFailedExceptionSebastianBergmann\RecursionContext\InvalidArgumentExceptionPHPUnit\Framework\ExceptionassertAttributeNotSame(mixed $expected, string $actualAttributeName, mixed $actualClassOrObject, string $message)
Asserts that a variable and an attribute of an object do not have the same type and value.
mixed $expected string $actualAttributeName object|string $actualClassOrObject string $message optional PHPUnit\Framework\ExpectationFailedExceptionSebastianBergmann\RecursionContext\InvalidArgumentExceptionPHPUnit\Framework\ExceptionassertAttributeSame(mixed $expected, string $actualAttributeName, mixed $actualClassOrObject, string $message)
Asserts that a variable and an attribute of an object have the same type and value.
mixed $expected string $actualAttributeName object|string $actualClassOrObject string $message optional PHPUnit\Framework\ExpectationFailedExceptionSebastianBergmann\RecursionContext\InvalidArgumentExceptionPHPUnit\Framework\ExceptionassertClassHasAttribute(string $attributeName, string $className, string $message)
Asserts that a class has a specified attribute.
string $attributeName string $className string $message optional PHPUnit\Framework\ExpectationFailedExceptionSebastianBergmann\RecursionContext\InvalidArgumentExceptionPHPUnit\Framework\ExceptionassertClassHasStaticAttribute(string $attributeName, string $className, string $message)
Asserts that a class has a specified static attribute.
string $attributeName string $className string $message optional PHPUnit\Framework\ExpectationFailedExceptionSebastianBergmann\RecursionContext\InvalidArgumentExceptionPHPUnit\Framework\ExceptionassertClassNotHasAttribute(string $attributeName, string $className, string $message)
Asserts that a class does not have a specified attribute.
string $attributeName string $className string $message optional PHPUnit\Framework\ExpectationFailedExceptionSebastianBergmann\RecursionContext\InvalidArgumentExceptionPHPUnit\Framework\ExceptionassertClassNotHasStaticAttribute(string $attributeName, string $className, string $message)
Asserts that a class does not have a specified static attribute.
string $attributeName string $className string $message optional PHPUnit\Framework\ExpectationFailedExceptionSebastianBergmann\RecursionContext\InvalidArgumentExceptionPHPUnit\Framework\ExceptionassertContains(mixed $needle, mixed $haystack, string $message, bool $ignoreCase, bool $checkForObjectIdentity, bool $checkForNonObjectIdentity)
Asserts that a haystack contains a needle.
mixed $needle mixed $haystack string $message optional bool $ignoreCase optional bool $checkForObjectIdentity optional bool $checkForNonObjectIdentity optional PHPUnit\Framework\ExpectationFailedExceptionSebastianBergmann\RecursionContext\InvalidArgumentExceptionPHPUnit\Framework\ExceptionassertContainsEquals(mixed $needle, iterable $haystack, string $message)
mixed $needle iterable $haystack string $message optional assertContainsOnly(string $type, iterable $haystack, ?bool $isNativeType, string $message)
Asserts that a haystack contains only values of a given type.
string $type iterable $haystack ?bool $isNativeType optional string $message optional PHPUnit\Framework\ExpectationFailedExceptionSebastianBergmann\RecursionContext\InvalidArgumentExceptionassertContainsOnlyInstancesOf(string $className, iterable $haystack, string $message)
Asserts that a haystack contains only instances of a given class name.
string $className iterable $haystack string $message optional PHPUnit\Framework\ExpectationFailedExceptionSebastianBergmann\RecursionContext\InvalidArgumentExceptionassertContentType(string $type, string $message)
Asserts content type
string $type The content-type to check for.
string $message optional The failure message that will be appended to the generated message.
assertCookie(mixed $expected, string $name, string $message)
Asserts cookie values
mixed $expected The expected contents.
string $name The cookie name.
string $message optional The failure message that will be appended to the generated message.
assertCookieEncrypted(mixed $expected, string $name, string $encrypt, ?string $key, string $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.
mixed $expected The expected contents.
string $name The cookie name.
string $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.
assertCookieNotSet(string $cookie, string $message)
Asserts a cookie has not been set in the response
string $cookie The cookie name to check
string $message optional The failure message that will be appended to the generated message.
assertCount(int $expectedCount, mixed $haystack, string $message)
Asserts the number of elements of an array, Countable or Traversable.
int $expectedCount \Countable|iterable $haystack string $message optional PHPUnit\Framework\ExpectationFailedExceptionSebastianBergmann\RecursionContext\InvalidArgumentExceptionPHPUnit\Framework\ExceptionassertDirectoryExists(string $directory, string $message)
Asserts that a directory exists.
string $directory string $message optional PHPUnit\Framework\ExpectationFailedExceptionSebastianBergmann\RecursionContext\InvalidArgumentExceptionassertDirectoryIsReadable(string $directory, string $message)
Asserts that a directory exists and is readable.
string $directory string $message optional PHPUnit\Framework\ExpectationFailedExceptionSebastianBergmann\RecursionContext\InvalidArgumentExceptionassertDirectoryIsWritable(string $directory, string $message)
Asserts that a directory exists and is writable.
string $directory string $message optional PHPUnit\Framework\ExpectationFailedExceptionSebastianBergmann\RecursionContext\InvalidArgumentExceptionassertDirectoryNotExists(string $directory, string $message)
Asserts that a directory does not exist.
string $directory string $message optional PHPUnit\Framework\ExpectationFailedExceptionSebastianBergmann\RecursionContext\InvalidArgumentExceptionassertDirectoryNotIsReadable(string $directory, string $message)
Asserts that a directory exists and is not readable.
string $directory string $message optional PHPUnit\Framework\ExpectationFailedExceptionSebastianBergmann\RecursionContext\InvalidArgumentExceptionassertDirectoryNotIsWritable(string $directory, string $message)
Asserts that a directory exists and is not writable.
string $directory string $message optional PHPUnit\Framework\ExpectationFailedExceptionSebastianBergmann\RecursionContext\InvalidArgumentExceptionassertEmpty(mixed $actual, string $message)
Asserts that a variable is empty.
mixed $actual string $message optional PHPUnit\Framework\ExpectationFailedExceptionSebastianBergmann\RecursionContext\InvalidArgumentExceptionassertEqualXMLStructure(\DOMElement $expectedElement, \DOMElement $actualElement, bool $checkAttributes, string $message)
Asserts that a hierarchy of DOMElements matches.
\DOMElement $expectedElement \DOMElement $actualElement bool $checkAttributes optional string $message optional PHPUnit\Framework\AssertionFailedErrorPHPUnit\Framework\ExpectationFailedExceptionSebastianBergmann\RecursionContext\InvalidArgumentExceptionassertEquals(mixed $expected, mixed $actual, string $message, float $delta, int $maxDepth, bool $canonicalize, bool $ignoreCase)
Asserts that two variables are equal.
mixed $expected mixed $actual string $message optional float $delta optional int $maxDepth optional bool $canonicalize optional bool $ignoreCase optional PHPUnit\Framework\ExpectationFailedExceptionSebastianBergmann\RecursionContext\InvalidArgumentExceptionassertEqualsCanonicalizing(mixed $expected, mixed $actual, string $message)
Asserts that two variables are equal (canonicalizing).
mixed $expected mixed $actual string $message optional PHPUnit\Framework\ExpectationFailedExceptionSebastianBergmann\RecursionContext\InvalidArgumentExceptionassertEqualsIgnoringCase(mixed $expected, mixed $actual, string $message)
Asserts that two variables are equal (ignoring case).
mixed $expected mixed $actual string $message optional PHPUnit\Framework\ExpectationFailedExceptionSebastianBergmann\RecursionContext\InvalidArgumentExceptionassertEqualsSql(string $expected, string $actual, string $message)
Assert that a string matches SQL with db-specific characters like quotes removed.
string $expected The expected sql
string $actual The sql to compare
string $message optional The message to display on failure
assertEqualsWithDelta(mixed $expected, mixed $actual, float $delta, string $message)
Asserts that two variables are equal (with delta).
mixed $expected mixed $actual float $delta string $message optional PHPUnit\Framework\ExpectationFailedExceptionSebastianBergmann\RecursionContext\InvalidArgumentExceptionassertEventFired(string $name, ?\Cake\Event\EventManager $eventManager, string $message)
Asserts that a global event was fired. You must track events in your event manager for this assertion to work
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(string $name, string $dataKey, mixed $dataValue, ?\Cake\Event\EventManager $eventManager, string $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
string $name Event name
string $dataKey Data key
mixed $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(mixed $condition, string $message)
Asserts that a condition is false.
mixed $condition string $message optional PHPUnit\Framework\ExpectationFailedExceptionSebastianBergmann\RecursionContext\InvalidArgumentExceptionassertFileEquals(string $expected, string $actual, string $message, bool $canonicalize, bool $ignoreCase)
Asserts that the contents of one file is equal to the contents of another file.
string $expected string $actual string $message optional bool $canonicalize optional bool $ignoreCase optional PHPUnit\Framework\ExpectationFailedExceptionSebastianBergmann\RecursionContext\InvalidArgumentExceptionassertFileEqualsCanonicalizing(string $expected, string $actual, string $message)
Asserts that the contents of one file is equal to the contents of another file (canonicalizing).
string $expected string $actual string $message optional PHPUnit\Framework\ExpectationFailedExceptionSebastianBergmann\RecursionContext\InvalidArgumentExceptionassertFileEqualsIgnoringCase(string $expected, string $actual, string $message)
Asserts that the contents of one file is equal to the contents of another file (ignoring case).
string $expected string $actual string $message optional PHPUnit\Framework\ExpectationFailedExceptionSebastianBergmann\RecursionContext\InvalidArgumentExceptionassertFileExists(string $filename, string $message)
Asserts that a file exists.
string $filename string $message optional PHPUnit\Framework\ExpectationFailedExceptionSebastianBergmann\RecursionContext\InvalidArgumentExceptionassertFileIsReadable(string $file, string $message)
Asserts that a file exists and is readable.
string $file string $message optional PHPUnit\Framework\ExpectationFailedExceptionSebastianBergmann\RecursionContext\InvalidArgumentExceptionassertFileIsWritable(string $file, string $message)
Asserts that a file exists and is writable.
string $file string $message optional PHPUnit\Framework\ExpectationFailedExceptionSebastianBergmann\RecursionContext\InvalidArgumentExceptionassertFileNotEquals(string $expected, string $actual, string $message, bool $canonicalize, bool $ignoreCase)
Asserts that the contents of one file is not equal to the contents of another file.
string $expected string $actual string $message optional bool $canonicalize optional bool $ignoreCase optional PHPUnit\Framework\ExpectationFailedExceptionSebastianBergmann\RecursionContext\InvalidArgumentExceptionassertFileNotEqualsCanonicalizing(string $expected, string $actual, string $message)
Asserts that the contents of one file is not equal to the contents of another file (canonicalizing).
string $expected string $actual string $message optional PHPUnit\Framework\ExpectationFailedExceptionSebastianBergmann\RecursionContext\InvalidArgumentExceptionassertFileNotEqualsIgnoringCase(string $expected, string $actual, string $message)
Asserts that the contents of one file is not equal to the contents of another file (ignoring case).
string $expected string $actual string $message optional PHPUnit\Framework\ExpectationFailedExceptionSebastianBergmann\RecursionContext\InvalidArgumentExceptionassertFileNotExists(string $filename, string $message)
Asserts that a file does not exist.
string $filename string $message optional PHPUnit\Framework\ExpectationFailedExceptionSebastianBergmann\RecursionContext\InvalidArgumentExceptionassertFileNotIsReadable(string $file, string $message)
Asserts that a file exists and is not readable.
string $file string $message optional PHPUnit\Framework\ExpectationFailedExceptionSebastianBergmann\RecursionContext\InvalidArgumentExceptionassertFileNotIsWritable(string $file, string $message)
Asserts that a file exists and is not writable.
string $file string $message optional PHPUnit\Framework\ExpectationFailedExceptionSebastianBergmann\RecursionContext\InvalidArgumentExceptionassertFileResponse(string $expected, string $message)
Asserts that a file with the given name was sent in the response
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(mixed $actual, string $message)
Asserts that a variable is finite.
mixed $actual string $message optional PHPUnit\Framework\ExpectationFailedExceptionSebastianBergmann\RecursionContext\InvalidArgumentExceptionassertFlashElement(string $expected, string $key, string $message)
Asserts a flash element was set
string $expected Expected element name
string $key optional Flash key
string $message optional Assertion failure message
assertFlashElementAt(int $at, string $expected, string $key, string $message)
Asserts a flash element was set at a certain index
int $at Flash index
string $expected Expected element name
string $key optional Flash key
string $message optional Assertion failure message
assertFlashMessage(string $expected, string $key, string $message)
Asserts a flash message was set
string $expected Expected message
string $key optional Flash key
string $message optional Assertion failure message
assertFlashMessageAt(int $at, string $expected, string $key, string $message)
Asserts a flash message was set at a certain index
int $at Flash index
string $expected Expected message
string $key optional Flash key
string $message optional Assertion failure message
assertGreaterThan(mixed $expected, mixed $actual, string $message)
Asserts that a value is greater than another value.
mixed $expected mixed $actual string $message optional PHPUnit\Framework\ExpectationFailedExceptionSebastianBergmann\RecursionContext\InvalidArgumentExceptionassertGreaterThanOrEqual(mixed $expected, mixed $actual, string $message)
Asserts that a value is greater than or equal to another value.
mixed $expected mixed $actual string $message optional PHPUnit\Framework\ExpectationFailedExceptionSebastianBergmann\RecursionContext\InvalidArgumentExceptionassertHeader(string $header, string $content, string $message)
Asserts response headers
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(string $header, string $content, string $message)
Asserts response header contains a string
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(string $header, string $content, string $message)
Asserts response header does not contain a string
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(array $expected, string $string, bool $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.
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.
boolassertInfinite(mixed $actual, string $message)
Asserts that a variable is infinite.
mixed $actual string $message optional PHPUnit\Framework\ExpectationFailedExceptionSebastianBergmann\RecursionContext\InvalidArgumentExceptionassertInstanceOf(string $expected, mixed $actual, string $message)
Asserts that a variable is of a given type.
string $expected mixed $actual string $message optional PHPUnit\Framework\ExpectationFailedExceptionSebastianBergmann\RecursionContext\InvalidArgumentExceptionPHPUnit\Framework\ExceptionassertInternalType(string $expected, mixed $actual, string $message)
Asserts that a variable is of a given type.
string $expected mixed $actual string $message optional PHPUnit\Framework\ExpectationFailedExceptionSebastianBergmann\RecursionContext\InvalidArgumentExceptionassertIsArray(mixed $actual, string $message)
Asserts that a variable is of type array.
mixed $actual string $message optional PHPUnit\Framework\ExpectationFailedExceptionSebastianBergmann\RecursionContext\InvalidArgumentExceptionassertIsBool(mixed $actual, string $message)
Asserts that a variable is of type bool.
mixed $actual string $message optional PHPUnit\Framework\ExpectationFailedExceptionSebastianBergmann\RecursionContext\InvalidArgumentExceptionassertIsCallable(mixed $actual, string $message)
Asserts that a variable is of type callable.
mixed $actual string $message optional PHPUnit\Framework\ExpectationFailedExceptionSebastianBergmann\RecursionContext\InvalidArgumentExceptionassertIsFloat(mixed $actual, string $message)
Asserts that a variable is of type float.
mixed $actual string $message optional PHPUnit\Framework\ExpectationFailedExceptionSebastianBergmann\RecursionContext\InvalidArgumentExceptionassertIsInt(mixed $actual, string $message)
Asserts that a variable is of type int.
mixed $actual string $message optional PHPUnit\Framework\ExpectationFailedExceptionSebastianBergmann\RecursionContext\InvalidArgumentExceptionassertIsIterable(mixed $actual, string $message)
Asserts that a variable is of type iterable.
mixed $actual string $message optional PHPUnit\Framework\ExpectationFailedExceptionSebastianBergmann\RecursionContext\InvalidArgumentExceptionassertIsNotArray(mixed $actual, string $message)
Asserts that a variable is not of type array.
mixed $actual string $message optional PHPUnit\Framework\ExpectationFailedExceptionSebastianBergmann\RecursionContext\InvalidArgumentExceptionassertIsNotBool(mixed $actual, string $message)
Asserts that a variable is not of type bool.
mixed $actual string $message optional PHPUnit\Framework\ExpectationFailedExceptionSebastianBergmann\RecursionContext\InvalidArgumentExceptionassertIsNotCallable(mixed $actual, string $message)
Asserts that a variable is not of type callable.
mixed $actual string $message optional PHPUnit\Framework\ExpectationFailedExceptionSebastianBergmann\RecursionContext\InvalidArgumentExceptionassertIsNotFloat(mixed $actual, string $message)
Asserts that a variable is not of type float.
mixed $actual string $message optional PHPUnit\Framework\ExpectationFailedExceptionSebastianBergmann\RecursionContext\InvalidArgumentExceptionassertIsNotInt(mixed $actual, string $message)
Asserts that a variable is not of type int.
mixed $actual string $message optional PHPUnit\Framework\ExpectationFailedExceptionSebastianBergmann\RecursionContext\InvalidArgumentExceptionassertIsNotIterable(mixed $actual, string $message)
Asserts that a variable is not of type iterable.
mixed $actual string $message optional PHPUnit\Framework\ExpectationFailedExceptionSebastianBergmann\RecursionContext\InvalidArgumentExceptionassertIsNotNumeric(mixed $actual, string $message)
Asserts that a variable is not of type numeric.
mixed $actual string $message optional PHPUnit\Framework\ExpectationFailedExceptionSebastianBergmann\RecursionContext\InvalidArgumentExceptionassertIsNotObject(mixed $actual, string $message)
Asserts that a variable is not of type object.
mixed $actual string $message optional PHPUnit\Framework\ExpectationFailedExceptionSebastianBergmann\RecursionContext\InvalidArgumentExceptionassertIsNotResource(mixed $actual, string $message)
Asserts that a variable is not of type resource.
mixed $actual string $message optional PHPUnit\Framework\ExpectationFailedExceptionSebastianBergmann\RecursionContext\InvalidArgumentExceptionassertIsNotScalar(mixed $actual, string $message)
Asserts that a variable is not of type scalar.
mixed $actual string $message optional PHPUnit\Framework\ExpectationFailedExceptionSebastianBergmann\RecursionContext\InvalidArgumentExceptionassertIsNotString(mixed $actual, string $message)
Asserts that a variable is not of type string.
mixed $actual string $message optional PHPUnit\Framework\ExpectationFailedExceptionSebastianBergmann\RecursionContext\InvalidArgumentExceptionassertIsNumeric(mixed $actual, string $message)
Asserts that a variable is of type numeric.
mixed $actual string $message optional PHPUnit\Framework\ExpectationFailedExceptionSebastianBergmann\RecursionContext\InvalidArgumentExceptionassertIsObject(mixed $actual, string $message)
Asserts that a variable is of type object.
mixed $actual string $message optional PHPUnit\Framework\ExpectationFailedExceptionSebastianBergmann\RecursionContext\InvalidArgumentExceptionassertIsReadable(string $filename, string $message)
Asserts that a file/dir is readable.
string $filename string $message optional PHPUnit\Framework\ExpectationFailedExceptionSebastianBergmann\RecursionContext\InvalidArgumentExceptionassertIsResource(mixed $actual, string $message)
Asserts that a variable is of type resource.
mixed $actual string $message optional PHPUnit\Framework\ExpectationFailedExceptionSebastianBergmann\RecursionContext\InvalidArgumentExceptionassertIsScalar(mixed $actual, string $message)
Asserts that a variable is of type scalar.
mixed $actual string $message optional PHPUnit\Framework\ExpectationFailedExceptionSebastianBergmann\RecursionContext\InvalidArgumentExceptionassertIsString(mixed $actual, string $message)
Asserts that a variable is of type string.
mixed $actual string $message optional PHPUnit\Framework\ExpectationFailedExceptionSebastianBergmann\RecursionContext\InvalidArgumentExceptionassertIsWritable(string $filename, string $message)
Asserts that a file/dir exists and is writable.
string $filename string $message optional PHPUnit\Framework\ExpectationFailedExceptionSebastianBergmann\RecursionContext\InvalidArgumentExceptionassertJson(string $actualJson, string $message)
Asserts that a string is a valid JSON string.
string $actualJson string $message optional PHPUnit\Framework\ExpectationFailedExceptionSebastianBergmann\RecursionContext\InvalidArgumentExceptionassertJsonFileEqualsJsonFile(string $expectedFile, string $actualFile, string $message)
Asserts that two JSON files are equal.
string $expectedFile string $actualFile string $message optional PHPUnit\Framework\ExpectationFailedExceptionSebastianBergmann\RecursionContext\InvalidArgumentExceptionassertJsonFileNotEqualsJsonFile(string $expectedFile, string $actualFile, string $message)
Asserts that two JSON files are not equal.
string $expectedFile string $actualFile string $message optional PHPUnit\Framework\ExpectationFailedExceptionSebastianBergmann\RecursionContext\InvalidArgumentExceptionassertJsonStringEqualsJsonFile(string $expectedFile, string $actualJson, string $message)
Asserts that the generated JSON encoded object and the content of the given file are equal.
string $expectedFile string $actualJson string $message optional PHPUnit\Framework\ExpectationFailedExceptionSebastianBergmann\RecursionContext\InvalidArgumentExceptionassertJsonStringEqualsJsonString(string $expectedJson, string $actualJson, string $message)
Asserts that two given JSON encoded objects or arrays are equal.
string $expectedJson string $actualJson string $message optional PHPUnit\Framework\ExpectationFailedExceptionSebastianBergmann\RecursionContext\InvalidArgumentExceptionassertJsonStringNotEqualsJsonFile(string $expectedFile, string $actualJson, string $message)
Asserts that the generated JSON encoded object and the content of the given file are not equal.
string $expectedFile string $actualJson string $message optional PHPUnit\Framework\ExpectationFailedExceptionSebastianBergmann\RecursionContext\InvalidArgumentExceptionassertJsonStringNotEqualsJsonString(mixed $expectedJson, mixed $actualJson, string $message)
Asserts that two given JSON encoded objects or arrays are not equal.
string $expectedJson string $actualJson string $message optional PHPUnit\Framework\ExpectationFailedExceptionSebastianBergmann\RecursionContext\InvalidArgumentExceptionassertLayout(string $content, string $message)
Asserts that the search string was in the layout name.
string $content The content to check for.
string $message optional The failure message that will be appended to the generated message.
assertLessThan(mixed $expected, mixed $actual, string $message)
Asserts that a value is smaller than another value.
mixed $expected mixed $actual string $message optional PHPUnit\Framework\ExpectationFailedExceptionSebastianBergmann\RecursionContext\InvalidArgumentExceptionassertLessThanOrEqual(mixed $expected, mixed $actual, string $message)
Asserts that a value is smaller than or equal to another value.
mixed $expected mixed $actual string $message optional PHPUnit\Framework\ExpectationFailedExceptionSebastianBergmann\RecursionContext\InvalidArgumentExceptionassertNan(mixed $actual, string $message)
Asserts that a variable is nan.
mixed $actual string $message optional PHPUnit\Framework\ExpectationFailedExceptionSebastianBergmann\RecursionContext\InvalidArgumentExceptionassertNoRedirect(string $message)
Asserts that the Location header is not set.
string $message optional The failure message that will be appended to the generated message.
assertNotContains(mixed $needle, mixed $haystack, string $message, bool $ignoreCase, bool $checkForObjectIdentity, bool $checkForNonObjectIdentity)
Asserts that a haystack does not contain a needle.
mixed $needle mixed $haystack string $message optional bool $ignoreCase optional bool $checkForObjectIdentity optional bool $checkForNonObjectIdentity optional PHPUnit\Framework\ExpectationFailedExceptionSebastianBergmann\RecursionContext\InvalidArgumentExceptionPHPUnit\Framework\ExceptionassertNotContainsEquals(mixed $needle, iterable $haystack, string $message)
mixed $needle iterable $haystack string $message optional assertNotContainsOnly(string $type, iterable $haystack, ?bool $isNativeType, string $message)
Asserts that a haystack does not contain only values of a given type.
string $type iterable $haystack ?bool $isNativeType optional string $message optional PHPUnit\Framework\ExpectationFailedExceptionSebastianBergmann\RecursionContext\InvalidArgumentExceptionassertNotCount(int $expectedCount, mixed $haystack, string $message)
Asserts the number of elements of an array, Countable or Traversable.
int $expectedCount \Countable|iterable $haystack string $message optional PHPUnit\Framework\ExpectationFailedExceptionSebastianBergmann\RecursionContext\InvalidArgumentExceptionPHPUnit\Framework\ExceptionassertNotEmpty(mixed $actual, string $message)
Asserts that a variable is not empty.
mixed $actual string $message optional PHPUnit\Framework\ExpectationFailedExceptionSebastianBergmann\RecursionContext\InvalidArgumentExceptionassertNotEquals(mixed $expected, mixed $actual, string $message, mixed $delta, mixed $maxDepth, mixed $canonicalize, mixed $ignoreCase)
Asserts that two variables are not equal.
mixed $expected mixed $actual string $message optional float $delta optional int $maxDepth optional bool $canonicalize optional bool $ignoreCase optional PHPUnit\Framework\ExpectationFailedExceptionSebastianBergmann\RecursionContext\InvalidArgumentExceptionassertNotEqualsCanonicalizing(mixed $expected, mixed $actual, string $message)
Asserts that two variables are not equal (canonicalizing).
mixed $expected mixed $actual string $message optional PHPUnit\Framework\ExpectationFailedExceptionSebastianBergmann\RecursionContext\InvalidArgumentExceptionassertNotEqualsIgnoringCase(mixed $expected, mixed $actual, string $message)
Asserts that two variables are not equal (ignoring case).
mixed $expected mixed $actual string $message optional PHPUnit\Framework\ExpectationFailedExceptionSebastianBergmann\RecursionContext\InvalidArgumentExceptionassertNotEqualsWithDelta(mixed $expected, mixed $actual, float $delta, string $message)
Asserts that two variables are not equal (with delta).
mixed $expected mixed $actual float $delta string $message optional PHPUnit\Framework\ExpectationFailedExceptionSebastianBergmann\RecursionContext\InvalidArgumentExceptionassertNotFalse(mixed $condition, string $message)
Asserts that a condition is not false.
mixed $condition string $message optional PHPUnit\Framework\ExpectationFailedExceptionSebastianBergmann\RecursionContext\InvalidArgumentExceptionassertNotInstanceOf(string $expected, mixed $actual, string $message)
Asserts that a variable is not of a given type.
string $expected mixed $actual string $message optional PHPUnit\Framework\ExpectationFailedExceptionSebastianBergmann\RecursionContext\InvalidArgumentExceptionPHPUnit\Framework\ExceptionassertNotInternalType(string $expected, mixed $actual, string $message)
Asserts that a variable is not of a given type.
string $expected mixed $actual string $message optional PHPUnit\Framework\ExpectationFailedExceptionSebastianBergmann\RecursionContext\InvalidArgumentExceptionassertNotIsReadable(string $filename, string $message)
Asserts that a file/dir exists and is not readable.
string $filename string $message optional PHPUnit\Framework\ExpectationFailedExceptionSebastianBergmann\RecursionContext\InvalidArgumentExceptionassertNotIsWritable(string $filename, string $message)
Asserts that a file/dir exists and is not writable.
string $filename string $message optional PHPUnit\Framework\ExpectationFailedExceptionSebastianBergmann\RecursionContext\InvalidArgumentExceptionassertNotNull(mixed $actual, string $message)
Asserts that a variable is not null.
mixed $actual string $message optional PHPUnit\Framework\ExpectationFailedExceptionSebastianBergmann\RecursionContext\InvalidArgumentExceptionassertNotRegExp(string $pattern, string $string, string $message)
Asserts that a string does not match a given regular expression.
string $pattern string $string string $message optional PHPUnit\Framework\ExpectationFailedExceptionSebastianBergmann\RecursionContext\InvalidArgumentExceptionassertNotSame(mixed $expected, mixed $actual, string $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.
mixed $expected mixed $actual string $message optional PHPUnit\Framework\ExpectationFailedExceptionSebastianBergmann\RecursionContext\InvalidArgumentExceptionassertNotSameSize(mixed $expected, mixed $actual, string $message)
Assert that the size of two arrays (or Countable or Traversable objects) is not the same.
\Countable|iterable $expected \Countable|iterable $actual string $message optional PHPUnit\Framework\ExpectationFailedExceptionSebastianBergmann\RecursionContext\InvalidArgumentExceptionPHPUnit\Framework\ExceptionassertNotTrue(mixed $condition, string $message)
Asserts that a condition is not true.
mixed $condition string $message optional PHPUnit\Framework\ExpectationFailedExceptionSebastianBergmann\RecursionContext\InvalidArgumentExceptionassertNotWithinRange(mixed $expected, mixed $result, mixed $margin, mixed $message)
Compatibility function to test if a value is not between an acceptable range.
float $expected float $result float $margin the rage of acceptation
string $message optional the text to display if the assertion is not correct
assertNull(mixed $actual, string $message)
Asserts that a variable is null.
mixed $actual string $message optional PHPUnit\Framework\ExpectationFailedExceptionSebastianBergmann\RecursionContext\InvalidArgumentExceptionassertObjectHasAttribute(string $attributeName, mixed $object, string $message)
Asserts that an object has a specified attribute.
string $attributeName object $object string $message optional PHPUnit\Framework\ExpectationFailedExceptionSebastianBergmann\RecursionContext\InvalidArgumentExceptionPHPUnit\Framework\ExceptionassertObjectNotHasAttribute(string $attributeName, mixed $object, string $message)
Asserts that an object does not have a specified attribute.
string $attributeName object $object string $message optional PHPUnit\Framework\ExpectationFailedExceptionSebastianBergmann\RecursionContext\InvalidArgumentExceptionPHPUnit\Framework\ExceptionassertPathEquals(mixed $expected, mixed $result, mixed $message)
Compatibility function to test paths.
string $expected string $result string $message optional the text to display if the assertion is not correct
assertPostConditions()
Performs assertions shared by all tests of a test case.
This method is called between test and tearDown().
assertPreConditions()
Performs assertions shared by all tests of a test case.
This method is called between setUp() and test.
assertRedirect(mixed $url, mixed $message)
Asserts that the Location header is correct. Comparison is made against a full URL.
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(string $url, string $message)
Asserts that the Location header contains a substring
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(mixed $url, mixed $message)
Asserts that the Location header is correct. Comparison is made against exactly the URL provided.
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(string $url, string $message)
Asserts that the Location header does not contain a substring
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(string $pattern, string $string, string $message)
Asserts that a string matches a given regular expression.
string $pattern string $string string $message optional PHPUnit\Framework\ExpectationFailedExceptionSebastianBergmann\RecursionContext\InvalidArgumentExceptionassertRegExpSql(string $pattern, string $actual, bool $optional)
Assertion for comparing a regex pattern against a query having its identifiers quoted. It accepts queries quoted with the characters < and >. If the third parameter is set to true, it will alter the pattern to both accept quoted and unquoted queries
string $pattern The expected sql pattern
string $actual The sql to compare
bool $optional optional Whether quote characters (marked with <>) are optional
assertResponseCode(int $code, string $message)
Asserts a specific response status code.
int $code Status code to assert.
string $message optional Custom message for failure.
assertResponseContains(string $content, string $message, bool $ignoreCase)
Asserts content exists in the response body.
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(string $message)
Assert response content is empty.
string $message optional The failure message that will be appended to the generated message.
assertResponseEquals(mixed $content, mixed $message)
Asserts content in the response body equals.
mixed $content The content to check for.
string $message optional The failure message that will be appended to the generated message.
assertResponseError(string $message)
Asserts that the response status code is in the 4xx range.
string $message optional Custom message for failure.
assertResponseFailure(string $message)
Asserts that the response status code is in the 5xx range.
string $message optional Custom message for failure.
assertResponseNotContains(string $content, string $message, bool $ignoreCase)
Asserts content does not exist in the response body.
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(string $message)
Assert response content is not empty.
string $message optional The failure message that will be appended to the generated message.
assertResponseNotEquals(mixed $content, mixed $message)
Asserts content in the response body not equals.
mixed $content The content to check for.
string $message optional The failure message that will be appended to the generated message.
assertResponseNotRegExp(string $pattern, string $message)
Asserts that the response body does not match a given regular expression.
string $pattern The pattern to compare against.
string $message optional The failure message that will be appended to the generated message.
assertResponseOk(string $message)
Asserts that the response status code is in the 2xx range.
string $message optional Custom message for failure.
assertResponseRegExp(string $pattern, string $message)
Asserts that the response body matches a given regular expression.
string $pattern The pattern to compare against.
string $message optional The failure message that will be appended to the generated message.
assertResponseSuccess(string $message)
Asserts that the response status code is in the 2xx/3xx range.
string $message optional Custom message for failure.
assertSame(mixed $expected, mixed $actual, string $message)
Asserts that two variables have the same type and value.
Used on objects, it asserts that two variables reference the same object.
mixed $expected mixed $actual string $message optional PHPUnit\Framework\ExpectationFailedExceptionSebastianBergmann\RecursionContext\InvalidArgumentExceptionassertSameSize(mixed $expected, mixed $actual, string $message)
Assert that the size of two arrays (or Countable or Traversable objects) is the same.
\Countable|iterable $expected \Countable|iterable $actual string $message optional PHPUnit\Framework\ExpectationFailedExceptionSebastianBergmann\RecursionContext\InvalidArgumentExceptionPHPUnit\Framework\ExceptionassertSession(mixed $expected, string $path, string $message)
Asserts session contents
mixed $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.
assertSessionHasKey(string $path, string $message)
Asserts session key exists.
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.
assertSessionNotHasKey(string $path, string $message)
Asserts a session key does not exist.
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.
assertStringContainsString(string $needle, string $haystack, string $message)
string $needle string $haystack string $message optional PHPUnit\Framework\ExpectationFailedExceptionSebastianBergmann\RecursionContext\InvalidArgumentExceptionassertStringContainsStringIgnoringCase(string $needle, string $haystack, string $message)
string $needle string $haystack string $message optional PHPUnit\Framework\ExpectationFailedExceptionSebastianBergmann\RecursionContext\InvalidArgumentExceptionassertStringEndsNotWith(string $suffix, string $string, string $message)
Asserts that a string ends not with a given suffix.
string $suffix string $string string $message optional PHPUnit\Framework\ExpectationFailedExceptionSebastianBergmann\RecursionContext\InvalidArgumentExceptionassertStringEndsWith(string $suffix, string $string, string $message)
Asserts that a string ends with a given suffix.
string $suffix string $string string $message optional PHPUnit\Framework\ExpectationFailedExceptionSebastianBergmann\RecursionContext\InvalidArgumentExceptionassertStringEqualsFile(string $expectedFile, string $actualString, string $message, bool $canonicalize, bool $ignoreCase)
Asserts that the contents of a string is equal to the contents of a file.
string $expectedFile string $actualString string $message optional bool $canonicalize optional bool $ignoreCase optional PHPUnit\Framework\ExpectationFailedExceptionSebastianBergmann\RecursionContext\InvalidArgumentExceptionassertStringEqualsFileCanonicalizing(string $expectedFile, string $actualString, string $message)
Asserts that the contents of a string is equal to the contents of a file (canonicalizing).
string $expectedFile string $actualString string $message optional PHPUnit\Framework\ExpectationFailedExceptionSebastianBergmann\RecursionContext\InvalidArgumentExceptionassertStringEqualsFileIgnoringCase(string $expectedFile, string $actualString, string $message)
Asserts that the contents of a string is equal to the contents of a file (ignoring case).
string $expectedFile string $actualString string $message optional PHPUnit\Framework\ExpectationFailedExceptionSebastianBergmann\RecursionContext\InvalidArgumentExceptionassertStringMatchesFormat(string $format, string $string, string $message)
Asserts that a string matches a given format string.
string $format string $string string $message optional PHPUnit\Framework\ExpectationFailedExceptionSebastianBergmann\RecursionContext\InvalidArgumentExceptionassertStringMatchesFormatFile(string $formatFile, string $string, string $message)
Asserts that a string matches a given format file.
string $formatFile string $string string $message optional PHPUnit\Framework\ExpectationFailedExceptionSebastianBergmann\RecursionContext\InvalidArgumentExceptionassertStringNotContainsString(string $needle, string $haystack, string $message)
string $needle string $haystack string $message optional PHPUnit\Framework\ExpectationFailedExceptionSebastianBergmann\RecursionContext\InvalidArgumentExceptionassertStringNotContainsStringIgnoringCase(string $needle, string $haystack, string $message)
string $needle string $haystack string $message optional PHPUnit\Framework\ExpectationFailedExceptionSebastianBergmann\RecursionContext\InvalidArgumentExceptionassertStringNotEqualsFile(string $expectedFile, string $actualString, string $message, bool $canonicalize, bool $ignoreCase)
Asserts that the contents of a string is not equal to the contents of a file.
string $expectedFile string $actualString string $message optional bool $canonicalize optional bool $ignoreCase optional PHPUnit\Framework\ExpectationFailedExceptionSebastianBergmann\RecursionContext\InvalidArgumentExceptionassertStringNotEqualsFileCanonicalizing(string $expectedFile, string $actualString, string $message)
Asserts that the contents of a string is not equal to the contents of a file (canonicalizing).
string $expectedFile string $actualString string $message optional PHPUnit\Framework\ExpectationFailedExceptionSebastianBergmann\RecursionContext\InvalidArgumentExceptionassertStringNotEqualsFileIgnoringCase(string $expectedFile, string $actualString, string $message)
Asserts that the contents of a string is not equal to the contents of a file (ignoring case).
string $expectedFile string $actualString string $message optional PHPUnit\Framework\ExpectationFailedExceptionSebastianBergmann\RecursionContext\InvalidArgumentExceptionassertStringNotMatchesFormat(string $format, string $string, string $message)
Asserts that a string does not match a given format string.
string $format string $string string $message optional PHPUnit\Framework\ExpectationFailedExceptionSebastianBergmann\RecursionContext\InvalidArgumentExceptionassertStringNotMatchesFormatFile(string $formatFile, string $string, string $message)
Asserts that a string does not match a given format string.
string $formatFile string $string string $message optional PHPUnit\Framework\ExpectationFailedExceptionSebastianBergmann\RecursionContext\InvalidArgumentExceptionassertStringStartsNotWith(mixed $prefix, mixed $string, string $message)
Asserts that a string starts not with a given prefix.
string $prefix string $string string $message optional PHPUnit\Framework\ExpectationFailedExceptionSebastianBergmann\RecursionContext\InvalidArgumentExceptionassertStringStartsWith(string $prefix, string $string, string $message)
Asserts that a string starts with a given prefix.
string $prefix string $string string $message optional PHPUnit\Framework\ExpectationFailedExceptionSebastianBergmann\RecursionContext\InvalidArgumentExceptionassertTemplate(string $content, string $message)
Asserts that the search string was in the template name.
string $content The content to check for.
string $message optional The failure message that will be appended to the generated message.
assertTextContains(string $needle, string $haystack, string $message, bool $ignoreCase)
Assert that a string contains another string, ignoring differences in newlines.
Helpful for doing cross platform tests of blocks of text.
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(string $suffix, string $string, string $message)
Asserts that a string ends not with a given prefix, ignoring differences in newlines.
Helpful for doing cross platform tests of blocks of text.
string $suffix The suffix to not find.
string $string The string to search.
string $message optional The message to use for failure.
assertTextEndsWith(string $suffix, string $string, string $message)
Asserts that a string ends with a given prefix, ignoring differences in newlines.
Helpful for doing cross platform tests of blocks of text.
string $suffix The suffix to find.
string $string The string to search.
string $message optional The message to use for failure.
assertTextEquals(string $expected, string $result, string $message)
Assert text equality, ignoring differences in newlines.
Helpful for doing cross platform tests of blocks of text.
string $expected The expected value.
string $result The actual value.
string $message optional The message to use for failure.
assertTextNotContains(string $needle, string $haystack, string $message, bool $ignoreCase)
Assert that a text doesn't contain another text, ignoring differences in newlines.
Helpful for doing cross platform tests of blocks of text.
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(string $expected, string $result, string $message)
Assert text equality, ignoring differences in newlines.
Helpful for doing cross platform tests of blocks of text.
string $expected The expected value.
string $result The actual value.
string $message optional The message to use for failure.
assertTextStartsNotWith(string $prefix, string $string, string $message)
Asserts that a string starts not with a given prefix, ignoring differences in newlines.
Helpful for doing cross platform tests of blocks of text.
string $prefix The prefix to not find.
string $string The string to search.
string $message optional The message to use for failure.
assertTextStartsWith(string $prefix, string $string, string $message)
Asserts that a string starts with a given prefix, ignoring differences in newlines.
Helpful for doing cross platform tests of blocks of text.
string $prefix The prefix to check for.
string $string The string to search in.
string $message optional The message to use for failure.
assertThat(mixed $value, \PHPUnit\Framework\Constraint\Constraint $constraint, string $message)
Evaluates a PHPUnit\Framework\Constraint matcher object.
mixed $value \PHPUnit\Framework\Constraint\Constraint $constraint string $message optional PHPUnit\Framework\ExpectationFailedExceptionSebastianBergmann\RecursionContext\InvalidArgumentExceptionassertTrue(mixed $condition, string $message)
Asserts that a condition is true.
mixed $condition string $message optional PHPUnit\Framework\ExpectationFailedExceptionSebastianBergmann\RecursionContext\InvalidArgumentExceptionassertWithinRange(mixed $expected, mixed $result, mixed $margin, mixed $message)
Compatibility function to test if a value is between an acceptable range.
float $expected float $result float $margin the rage of acceptation
string $message optional the text to display if the assertion is not correct
assertXmlFileEqualsXmlFile(string $expectedFile, string $actualFile, string $message)
Asserts that two XML files are equal.
string $expectedFile string $actualFile string $message optional PHPUnit\Framework\ExpectationFailedExceptionSebastianBergmann\RecursionContext\InvalidArgumentExceptionPHPUnit\Framework\ExceptionassertXmlFileNotEqualsXmlFile(string $expectedFile, string $actualFile, string $message)
Asserts that two XML files are not equal.
string $expectedFile string $actualFile string $message optional PHPUnit\Framework\ExpectationFailedExceptionSebastianBergmann\RecursionContext\InvalidArgumentExceptionPHPUnit\Framework\ExceptionassertXmlStringEqualsXmlFile(string $expectedFile, mixed $actualXml, string $message)
Asserts that two XML documents are equal.
string $expectedFile \DOMDocument|string $actualXml string $message optional PHPUnit\Framework\ExpectationFailedExceptionSebastianBergmann\RecursionContext\InvalidArgumentExceptionPHPUnit\Framework\ExceptionassertXmlStringEqualsXmlString(mixed $expectedXml, mixed $actualXml, string $message)
Asserts that two XML documents are equal.
\DOMDocument|string $expectedXml \DOMDocument|string $actualXml string $message optional PHPUnit\Framework\ExpectationFailedExceptionSebastianBergmann\RecursionContext\InvalidArgumentExceptionPHPUnit\Framework\ExceptionassertXmlStringNotEqualsXmlFile(string $expectedFile, mixed $actualXml, string $message)
Asserts that two XML documents are not equal.
string $expectedFile \DOMDocument|string $actualXml string $message optional PHPUnit\Framework\ExpectationFailedExceptionSebastianBergmann\RecursionContext\InvalidArgumentExceptionPHPUnit\Framework\ExceptionassertXmlStringNotEqualsXmlString(mixed $expectedXml, mixed $actualXml, string $message)
Asserts that two XML documents are not equal.
\DOMDocument|string $expectedXml \DOMDocument|string $actualXml string $message optional PHPUnit\Framework\ExpectationFailedExceptionSebastianBergmann\RecursionContext\InvalidArgumentExceptionPHPUnit\Framework\Exceptionat(int $index)
Returns a matcher that matches when the method is executed at the given index.
int $index atLeast(int $requiredInvocations)
Returns a matcher that matches when the method is executed at least N times.
int $requiredInvocations atLeastOnce()
Returns a matcher that matches when the method is executed at least once.
atMost(int $allowedInvocations)
Returns a matcher that matches when the method is executed at most N times.
int $allowedInvocations attribute(\PHPUnit\Framework\Constraint\Constraint $constraint, string $attributeName)
\PHPUnit\Framework\Constraint\Constraint $constraint string $attributeName attributeEqualTo(string $attributeName, mixed $value, float $delta, int $maxDepth, bool $canonicalize, bool $ignoreCase)
string $attributeName mixed $value float $delta optional int $maxDepth optional bool $canonicalize optional bool $ignoreCase optional callback(callable $callback)
callable $callback classHasAttribute(string $attributeName)
string $attributeName classHasStaticAttribute(string $attributeName)
string $attributeName cleanup()
Clears the state used for requests.
clearPlugins()
Clear all plugins from the global plugin collection.
Useful in test case teardown methods.
configApplication(string $class, ?array $constructorArgs)
Configure the application class to use in integration tests.
string $class The application class name.
array|null $constructorArgs The constructor arguments for your application class.
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.
array $data The request data to use.
contains(mixed $value, bool $checkForObjectIdentity, bool $checkForNonObjectIdentity)
mixed $value bool $checkForObjectIdentity optional bool $checkForNonObjectIdentity optional containsEqual(mixed $value)
mixed $value containsIdentical(mixed $value)
mixed $value containsOnly(string $type)
string $type containsOnlyInstancesOf(string $className)
string $className controllerSpy(\Cake\Event\EventInterface $event, ?\Cake\Controller\Controller $controller)
Adds additional event spies to the controller/view event manager.
\Cake\Event\EventInterface $event A dispatcher event.
\Cake\Controller\Controller|null $controller optional Controller instance.
cookie(string $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.
string $name The cookie name to use.
mixed $value The value of the cookie.
cookieEncrypted(string $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.
string $name The cookie name to use.
mixed $value The value of the cookie.
string|false $encrypt optional Encryption mode to use.
string|null $key optional Encryption key used. Defaults to Security.salt.
count()
countOf(int $count)
int $count createConfiguredMock(mixed $originalClassName, array $configuration)
Returns a configured mock object for the specified class.
string|string[] $originalClassName array $configuration createMock(mixed $originalClassName)
Returns a mock object for the specified class.
string|string[] $originalClassName createPartialMock(mixed $originalClassName, array $methods)
Returns a partial mock object for the specified class.
string|string[] $originalClassName string[] $methods createResult()
Creates a default TestResult object.
createStub(string $originalClassName)
Makes configurable stub for the specified class.
string $originalClassName createTestProxy(string $originalClassName, array $constructorArguments)
Returns a test proxy for the specified class.
string $originalClassName array $constructorArguments optional dataDescription()
dataName()
int|stringdelete(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.
string|array $url The URL to request.
deprecated(callable $callable)
Helper method for check deprecation methods
callable $callable callable function that will receive asserts
directoryExists()
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()
doubledTypes()
string[]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()
Calling this method will re-store flash messages into the test session after being removed by the FlashHelper
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(mixed $value, float $delta, int $maxDepth, bool $canonicalize, bool $ignoreCase)
mixed $value float $delta optional int $maxDepth optional bool $canonicalize optional bool $ignoreCase optional exactly(int $count)
Returns a matcher that matches when the method is executed exactly $count times.
int $count expectDeprecation()
expectDeprecationMessage(string $message)
string $message expectDeprecationMessageMatches(string $regularExpression)
string $regularExpression expectError()
expectErrorMessage(string $message)
string $message expectErrorMessageMatches(string $regularExpression)
string $regularExpression expectException(string $exception)
string $exception expectExceptionCode(mixed $code)
int|string $code expectExceptionMessage(string $message)
string $message expectExceptionMessageMatches(string $regularExpression)
string $regularExpression expectExceptionMessageRegExp(string $regularExpression)
string $regularExpression 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.
\Exception $exception expectNotToPerformAssertions()
expectNotice()
expectNoticeMessage(string $message)
string $message expectNoticeMessageMatches(string $regularExpression)
string $regularExpression expectOutputRegex(string $expectedRegex)
string $expectedRegex expectOutputString(string $expectedString)
string $expectedString expectWarning()
expectWarningMessage(string $message)
string $message expectWarningMessageMatches(string $regularExpression)
string $regularExpression extractExceptionMessage(\Exception $exception)
Extract verbose message for existing exception
\Exception $exception Exception to extract
stringextractVerboseMessage(string $message)
Inspect controller to extract possible causes of the failed assertion
string $message Original message to use as a base
stringfail(string $message)
Fails a test with the given message.
string $message optional PHPUnit\Framework\AssertionFailedErrorfileExists()
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.
string|array $url The URL to request.
getActualOutput()
getActualOutputForAssertion()
getAnnotations()
getCount()
Return the current assertion count.
getDataSetAsString(bool $includeData)
bool $includeData optional getDependencies()
getDependencyInput()
getExpectedException()
getExpectedExceptionCode()
null|int|stringgetExpectedExceptionMessage()
getExpectedExceptionMessageRegExp()
getFixtures()
Gets fixtures.
string[]getGroups()
getMockBuilder(mixed $className)
Returns a builder object to create mock objects using a fluent interface.
string|string[] $className 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.
string $originalClassName array $methods optional array $arguments optional string $mockClassName optional bool $callOriginalConstructor optional bool $callOriginalClone optional bool $callAutoload optional bool $cloneArguments optional 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).
string $originalClassName array $arguments optional string $mockClassName optional bool $callOriginalConstructor optional bool $callOriginalClone optional bool $callAutoload optional array $mockedMethods optional bool $cloneArguments optional getMockForModel(string $alias, array $methods, array $options)
Mock a model, maintain fixtures and table association
string $alias The model to get a mock for.
string[] $methods optional The list of methods to mock
array $options optional The config data for the mock's constructor.
\Cake\ORM\Table|\PHPUnit\Framework\MockObject\MockObjectCake\ORM\Exception\MissingTableClassExceptiongetMockForTrait(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.
string $traitName array $arguments optional string $mockClassName optional bool $callOriginalConstructor optional bool $callOriginalClone optional bool $callAutoload optional array $mockedMethods optional bool $cloneArguments optional getMockFromWsdl(mixed $wsdlFile, mixed $originalClassName, mixed $mockClassName, array $methods, mixed $callOriginalConstructor, array $options)
Returns a mock object based on the given WSDL file.
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
getName(bool $withDataSet)
bool $withDataSet optional SebastianBergmann\RecursionContext\InvalidArgumentExceptiongetNumAssertions()
Returns the number of assertions performed by this test.
getObjectAttribute(mixed $object, string $attributeName)
Returns the value of an object's attribute.
This also works for attributes that are declared protected or private.
object $object string $attributeName PHPUnit\Framework\ExceptiongetObjectForTrait(mixed $traitName, array $arguments, mixed $traitClassName, mixed $callOriginalConstructor, mixed $callOriginalClone, mixed $callAutoload)
Returns an object for the specified trait.
string $traitName array $arguments optional string $traitClassName optional bool $callOriginalConstructor optional bool $callOriginalClone optional bool $callAutoload optional objectgetProvidedData()
Gets the data set of a TestCase.
getResult()
getSession()
\Cake\TestSuite\TestSessiongetSize()
Returns the size of the test.
SebastianBergmann\RecursionContext\InvalidArgumentExceptiongetStaticAttribute(string $className, string $attributeName)
Returns the value of a static attribute.
This also works for attributes that are declared protected or private.
string $className string $attributeName PHPUnit\Framework\ExceptiongetStatus()
getStatusMessage()
getTableLocator()
Gets the table locator.
\Cake\ORM\Locator\LocatorInterfacegetTestResultObject()
greaterThan(mixed $value)
mixed $value greaterThanOrEqual(mixed $value)
mixed $value hasDependencies()
hasExpectationOnOutput()
hasFailed()
hasOutput()
hasSize()
SebastianBergmann\RecursionContext\InvalidArgumentExceptionhead(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.
string|array $url The URL to request.
identicalTo(mixed $value)
mixed $value iniSet(string $varName, string $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.
string $varName string $newValue PHPUnit\Framework\ExceptionisEmpty()
isFalse()
isFinite()
isInIsolation()
isInfinite()
isInstanceOf(string $className)
string $className isJson()
isLarge()
SebastianBergmann\RecursionContext\InvalidArgumentExceptionisMedium()
SebastianBergmann\RecursionContext\InvalidArgumentExceptionisNan()
isNull()
isReadable()
isSmall()
SebastianBergmann\RecursionContext\InvalidArgumentExceptionisTrue()
isType(string $type)
string $type isWritable()
lessThan(mixed $value)
mixed $value lessThanOrEqual(mixed $value)
mixed $value 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.
RuntimeExceptionloadPlugins(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.
array $plugins optional List of Plugins to load.
\Cake\Http\BaseApplicationloadRoutes(?array $appArgs)
Load routes for the application.
If no application class can be found an exception will be raised. Routes for plugins will not be loaded. Use loadPlugins() or use Cake\TestSuite\IntegrationTestCaseTrait to better simulate all routes and plugins being loaded.
array|null $appArgs optional Constructor parameters for the application class.
logicalAnd()
PHPUnit\Framework\ExceptionlogicalNot(\PHPUnit\Framework\Constraint\Constraint $constraint)
\PHPUnit\Framework\Constraint\Constraint $constraint logicalOr()
logicalXor()
markAsRisky()
markTestIncomplete(string $message)
Mark the test as incomplete.
string $message optional PHPUnit\Framework\IncompleteTestErrormarkTestSkipped(string $message)
Mark the test as skipped.
string $message optional PHPUnit\Framework\SkippedTestErrorPHPUnit\Framework\SyntheticSkippedErrormatches(string $string)
string $string matchesRegularExpression(string $pattern)
string $pattern never()
Returns a matcher that matches when the method is never executed.
objectHasAttribute(mixed $attributeName)
mixed $attributeName onConsecutiveCalls(mixed ...$args)
mixed ...$args onNotSuccessfulTest(\Throwable $t)
This method is called when a test method did not execute successfully.
\Throwable $t Throwableonce()
Returns a matcher that matches when the method is executed exactly once.
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.
string|array $url The URL to request.
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.
string|array $url The URL to request.
string|array $data optional The data for the request.
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.
string|array $url The URL to request.
string|array $data optional The data for the request.
prophesize(mixed $classOrInterface)
null|string $classOrInterface optional Prophecy\Exception\Doubler\ClassNotFoundExceptionProphecy\Exception\Doubler\DoubleExceptionProphecy\Exception\Doubler\InterfaceNotFoundExceptionput(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.
string|array $url The URL to request.
string|array $data optional The data for the request.
readAttribute(mixed $classOrObject, string $attributeName)
Returns the value of an attribute of a class or an object.
This also works for attributes that are declared protected or private.
object|string $classOrObject string $attributeName PHPUnit\Framework\ExceptionregisterComparator(\SebastianBergmann\Comparator\Comparator $comparator)
\SebastianBergmann\Comparator\Comparator $comparator registerMockObject(\PHPUnit\Framework\MockObject\MockObject $mockObject)
\PHPUnit\Framework\MockObject\MockObject $mockObject removePlugins(array $names)
Remove plugins from the global plugin collection.
Useful in test case teardown methods.
string[] $names optional A list of plugins you want to remove.
resetCount()
Reset the assertion counter.
returnArgument(int $argumentIndex)
int $argumentIndex returnCallback(mixed $callback)
mixed $callback returnSelf()
Returns the current object.
This method is useful when mocking a fluent interface.
returnValue(mixed $value)
mixed $value returnValueMap(array $valueMap)
array $valueMap 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.
\PHPUnit\Framework\TestResult $result optional PHPUnit\Framework\CodeCoverageExceptionPHPUnit\Util\ExceptionSebastianBergmann\CodeCoverage\CoveredCodeNotExecutedExceptionSebastianBergmann\CodeCoverage\InvalidArgumentExceptionSebastianBergmann\CodeCoverage\MissingCoversAnnotationExceptionSebastianBergmann\CodeCoverage\RuntimeExceptionSebastianBergmann\CodeCoverage\UnintentionallyCoveredCodeExceptionSebastianBergmann\RecursionContext\InvalidArgumentExceptionrunBare()
ThrowablerunTest()
Override to run the test and assert its state.
PHPUnit\Framework\AssertionFailedErrorPHPUnit\Framework\ExceptionPHPUnit\Framework\ExpectationFailedExceptionSebastianBergmann\ObjectEnumerator\InvalidArgumentExceptionThrowablesession(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.
array $data The session data to use.
setAppNamespace(string $appNamespace)
Set the app namespace
string $appNamespace optional The app namespace, defaults to "TestApp".
string|nullThe previous app namespace or null if not set.
setBackupGlobals(?bool $backupGlobals)
?bool $backupGlobals setBackupStaticAttributes(?bool $backupStaticAttributes)
?bool $backupStaticAttributes setBeStrictAboutChangesToGlobalState(?bool $beStrictAboutChangesToGlobalState)
?bool $beStrictAboutChangesToGlobalState setDependencies(array $dependencies)
string[] $dependencies setDependencyInput(array $dependencyInput)
array $dependencyInput setGroups(array $groups)
array $groups setInIsolation(bool $inIsolation)
bool $inIsolation setLocale(mixed ...$args)
This method is a wrapper for the setlocale() function that automatically resets the locale to its original value after the test is run.
mixed ...$args PHPUnit\Framework\ExceptionsetName(string $name)
string $name setOutputCallback(callable $callback)
callable $callback setPreserveGlobalState(bool $preserveGlobalState)
bool $preserveGlobalState setRegisterMockObjectsFromTestArgumentsRecursively(bool $flag)
bool $flag setResult(mixed $result)
mixed $result setRunClassInSeparateProcess(bool $runClassInSeparateProcess)
bool $runClassInSeparateProcess setRunTestInSeparateProcess(bool $runTestInSeparateProcess)
bool $runTestInSeparateProcess setTableLocator(\Cake\ORM\Locator\LocatorInterface $tableLocator)
Sets the table locator.
\Cake\ORM\Locator\LocatorInterface $tableLocator LocatorInterface instance.
$thissetTestResultObject(\PHPUnit\Framework\TestResult $result)
\PHPUnit\Framework\TestResult $result setUnlockedFields(array $unlockedFields)
Set list of fields that are excluded from field validation.
string[] $unlockedFields optional List of fields that are excluded from field validation.
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()
This method is called before the first test of this test class is run.
setUseErrorHandler(bool $useErrorHandler)
bool $useErrorHandler skipIf(bool $shouldSkip, string $message)
Overrides SimpleTestCase::skipIf to provide a boolean return value
bool $shouldSkip Whether or not the test should be skipped.
string $message optional The message to display.
boolskipUnless(mixed $condition, mixed $message)
Compatibility function for skipping.
bool $condition Condition to trigger skipping
string $message optional Message for skip
boolstringContains(string $string, bool $case)
string $string bool $case optional stringEndsWith(string $suffix)
string $suffix stringStartsWith(mixed $prefix)
mixed $prefix tearDown()
teardown any static object changes and restore them.
tearDownAfterClass()
This method is called after the last test of this test class is run.
throwException(\Throwable $exception)
\Throwable $exception toString()
Returns a string representation of the test case.
SebastianBergmann\RecursionContext\InvalidArgumentExceptionPHPUnit\Framework\ExceptionuseHttpServer(bool $enable)
No-op method.
bool $enable Unused.
usesDataProvider()
viewVariable(string $name)
Fetches a view variable by name.
If the view variable does not exist, null will be returned.
string $name The view variable to get.
mixedThe view variable if set.
withErrorReporting(int $errorLevel, callable $callable)
Helper method for tests that needs to use error_reporting()
int $errorLevel value of error_reporting() that needs to use
callable $callable callable function that will receive asserts
The customized application constructor arguments.
array|nullThe customized application class name.
string|nullConfigure values to restore at end of test.
arrayThe controller used in the last request.
\Cake\Controller\ControllerCookie data to use in the next request.
arraystring|nullBoolean flag for whether or not the request should have a CSRF token added.
boolThe exception being thrown if the case.
\Throwable|nullStored flash messages before render
array|nullThe last rendered layout
stringThe data used to build the next request.
arrayThe session instance from the last request
\Cake\Http\SessionThe response for the most recent request.
\Psr\Http\Message\ResponseInterfaceBoolean flag for whether or not the request should re-store flash messages
boolBoolean flag for whether or not the request should have a SecurityComponent token added.
boolSession data to use in the next request.
arrayTable locator instance
\Cake\ORM\Locator\LocatorInterface|nullList of fields that are excluded from field validation.
string[]Valid cipher names for encrypted cookies.
string[]The last rendered view
stringBy default, all fixtures attached to this class will be truncated and reloaded after each test.
Set this to false to handle manually
bool?boolstring[]boolarray<string,array<int,string>>Control table create/drops on each test method.
If true, tables will still be dropped at the end of each test runner execution.
boolThe class responsible for managing the creation, loading and removing of fixtures
\Cake\TestSuite\Fixture\FixtureManager|nullFixtures used by this test case.
string[]boolbool
© 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/4.1/class-Cake.TestSuite.IntegrationTestCase.html