If you use Codeception installed using composer, install this module with the following command:
composer require --dev codeception/module-symfony
Alternatively, you can enable Symfony
module in suite configuration file and run
codecept init upgrade4
This module was bundled with Codeception 2 and 3, but since version 4 it is necessary to install it separately.
Some modules are bundled with PHAR files.
Warning. Using PHAR file and composer in the same project can cause unexpected errors.
This module uses Symfony Crawler and HttpKernel to emulate requests and test response.
https://github.com/Codeception/symfony-module-tests
functional.suite.yml
) - Symfony 4 Directory Structuremodules:
enabled:
- Symfony:
app_path: 'src'
environment: 'test'
services
: Includes methods related to the Symfony dependency injection container (DIC):
See WebDriver module for general information on how to load parts of a framework module.
Usage example:
actor: AcceptanceTester
modules:
enabled:
- Symfony:
part: services
- Doctrine2:
depends: Symfony
- WebDriver:
url: http://your-url.com
browser: firefox
If youâre using Symfony with Eloquent ORM (instead of Doctrine), you can load the ORM
part of Laravel module
in addition to Symfony module.
hidden API method, expected to be used from Helper classes
Locates element using available Codeception locator types:
Use it in Helpers or GroupObject or Extension classes:
<?php
$els = $this->getModule('Symfony')->_findElements('.items');
$els = $this->getModule('Symfony')->_findElements(['name' => 'username']);
$editLinks = $this->getModule('Symfony')->_findElements(['link' => 'Edit']);
// now you can iterate over $editLinks and check that all them have valid hrefs
WebDriver module returns Facebook\WebDriver\Remote\RemoteWebElement
instances
PhpBrowser and Framework modules return Symfony\Component\DomCrawler\Crawler
instances
param
$locatorreturn
array of interactive elementshidden API method, expected to be used from Helper classes
Returns content of the last response Use it in Helpers when you want to retrieve response of request performed by another module.
<?php
// in Helper class
public function seeResponseContains($text)
{
$this->assertStringContainsString($text, $this->getModule('Symfony')->_getResponseContent(), "response contains");
}
?>
return
string
@throws ModuleExceptionhidden API method, expected to be used from Helper classes
Opens a page with arbitrary request parameters. Useful for testing multi-step forms on a specific step.
<?php
// in Helper class
public function openCheckoutFormStep2($orderId) {
$this->getModule('Symfony')->_loadPage('POST', '/checkout/step2', ['order' => $orderId]);
}
?>
param
$methodparam
$uriparam array
$parametersparam array
$filesparam array
$serverparam null
$contenthidden API method, expected to be used from Helper classes
Send custom request to a backend using method, uri, parameters, etc. Use it in Helpers to create special request actions, like accessing API Returns a string with response body.
<?php
// in Helper class
public function createUserByApi($name) {
$userData = $this->getModule('Symfony')->_request('POST', '/api/v1/users', ['name' => $name]);
$user = json_decode($userData);
return $user->id;
}
?>
Does not load the response into the module so you canât interact with response page (click, fill forms).
To load arbitrary page for interaction, use _loadPage
method.
param
$methodparam
$uriparam array
$parametersparam array
$filesparam array
$serverparam null
$contentreturn
mixed|Crawler
@throws ExternalUrlException
@see _loadPage
hidden API method, expected to be used from Helper classes
Saves page source of to a file
$this->getModule('Symfony')->_savePageSource(codecept_output_dir().'page.html');
param
$filenameAuthenticates user for HTTP_AUTH
param
$usernameparam
$passwordLogin with the given user object.
The $user
object must have a persistent identifier.
If you have more than one firewall or firewall context, you can specify the desired one as a parameter.
<?php
$user = $I->grabEntityFromRepository(User::class, [
'email' => '[email protected]'
]);
$I->amLoggedInAs($user);
param UserInterface
$userparam string
$firewallNameparam null
$firewallContextOpens web page by action name
<?php
$I->amOnAction('PostController::index');
$I->amOnAction('HomeController');
$I->amOnAction('ArticleController', ['slug' => 'lorem-ipsum']);
param string
$actionparam array
$paramsOpens the page for the given relative URI.
<?php
// opens front page
$I->amOnPage('/');
// opens /register page
$I->amOnPage('/register');
param string
$pageOpens web page using route name and parameters.
<?php
$I->amOnRoute('posts.create');
$I->amOnRoute('posts.show', ['id' => 34]);
param string
$routeNameparam array
$paramsAttaches a file relative to the Codeception _data
directory to the given file upload field.
<?php
// file is stored in 'tests/_data/prices.xls'
$I->attachFile('input[@type="file"]', 'prices.xls');
?>
param
$fieldparam
$filenameTicks a checkbox. For radio buttons, use the selectOption
method instead.
<?php
$I->checkOption('#agree');
?>
param
$optionPerform a click on a link or a button, given by a locator. If a fuzzy locator is given, the page will be searched for a button, link, or image matching the locator string. For buttons, the âvalueâ attribute, ânameâ attribute, and inner text are searched. For links, the link text is searched. For images, the âaltâ attribute and inner text of any parent links are searched.
The second parameter is a context (CSS or XPath locator) to narrow the search.
Note that if the locator matches a button of type submit
, the form will be submitted.
<?php
// simple link
$I->click('Logout');
// button of form
$I->click('Submit');
// CSS button
$I->click('#form input[type=submit]');
// XPath
$I->click('//form/*[@type="submit"]');
// link in context
$I->click('Logout', '#nav');
// using strict locator
$I->click(['link' => 'Login']);
?>
param
$linkparam
$contextDeletes the header with the passed name. Subsequent requests will not have the deleted header in its request.
Example:
<?php
$I->haveHttpHeader('X-Requested-With', 'Codeception');
$I->amOnPage('test-headers.php');
// ...
$I->deleteHeader('X-Requested-With');
$I->amOnPage('some-other-page.php');
?>
param string
$name the name of the header to delete.Checks that the current page doesnât contain the text specified (case insensitive). Give a locator as the second parameter to match a specific region.
<?php
$I->dontSee('Login'); // I can suppose user is already logged in
$I->dontSee('Sign Up','h1'); // I can suppose it's not a signup page
$I->dontSee('Sign Up','//body/h1'); // with XPath
$I->dontSee('Sign Up', ['css' => 'body h1']); // with strict CSS locator
Note that the search is done after stripping all HTML tags from the body,
so $I->dontSee('strong')
will fail on strings like:
<p>I am Stronger than thou</p>
<script>document.createElement('strong');</script>
But will ignore strings like:
<strong>Home</strong>
<div class="strong">Home</strong>
<!-- strong -->
For checking the raw source code, use seeInSource()
.
param string
$textparam array|string
$selector optionalCheck that user is not authenticated.
<?php
$I->dontSeeAuthentication();
Check that the specified checkbox is unchecked.
<?php
$I->dontSeeCheckboxIsChecked('#agree'); // I suppose user didn't agree to terms
$I->seeCheckboxIsChecked('#signup_form input[type=checkbox]'); // I suppose user didn't check the first checkbox in form.
?>
param
$checkboxChecks that there isnât a cookie with the given name.
You can set additional cookie params like domain
, path
as array passed in last argument.
param
$cookie
param array
$params
Checks that the current URL doesnât equal the given string.
Unlike dontSeeInCurrentUrl
, this only matches the full URL.
<?php
// current url is not root
$I->dontSeeCurrentUrlEquals('/');
?>
param string
$uriChecks that current url doesnât match the given regular expression.
<?php
// to match root url
$I->dontSeeCurrentUrlMatches('~^/users/(\d+)~');
?>
param string
$uriChecks that the given element is invisible or not present on the page. You can also specify expected attributes of this element.
<?php
$I->dontSeeElement('.error');
$I->dontSeeElement('//form/input[1]');
$I->dontSeeElement('input', ['name' => 'login']);
$I->dontSeeElement('input', ['value' => '123456']);
?>
param
$selectorparam array
$attributesChecks that no email was sent.
Verifies that one or more event listeners were not called during the test.
<?php
$I->dontSeeEventTriggered('App\MyEvent');
$I->dontSeeEventTriggered(new App\Events\MyEvent());
$I->dontSeeEventTriggered(['App\MyEvent', 'App\MyOtherEvent']);
param string|object|string[]
$expectedVerifies that there are no errors bound to the submitted form.
<?php
$I->dontSeeFormErrors();
Checks that the current URI doesnât contain the given string.
<?php
$I->dontSeeInCurrentUrl('/users/');
?>
param string
$uriChecks that an input field or textarea doesnât contain the given value. For fuzzy locators, the field is matched by label text, CSS and XPath.
<?php
$I->dontSeeInField('Body','Type your comment here');
$I->dontSeeInField('form textarea[name=body]','Type your comment here');
$I->dontSeeInField('form input[type=hidden]','hidden_value');
$I->dontSeeInField('#searchform input','Search');
$I->dontSeeInField('//form/*[@name=search]','Search');
$I->dontSeeInField(['name' => 'search'], 'Search');
?>
param
$fieldparam
$valueChecks if the array of form parameters (name => value) are not set on the form matched with the passed selector.
<?php
$I->dontSeeInFormFields('form[name=myform]', [
'input1' => 'non-existent value',
'input2' => 'other non-existent value',
]);
?>
To check that an element hasnât been assigned any one of many values, an array can be passed as the value:
<?php
$I->dontSeeInFormFields('.form-class', [
'fieldName' => [
'This value shouldn\'t be set',
'And this value shouldn\'t be set',
],
]);
?>
Additionally, checkbox values can be checked with a boolean.
<?php
$I->dontSeeInFormFields('#form-id', [
'checkbox1' => true, // fails if checked
'checkbox2' => false, // fails if unchecked
]);
?>
param
$formSelectorparam
$paramsAssert that a session attribute does not exist, or is not equal to the passed value.
<?php
$I->dontSeeInSession('attribute');
$I->dontSeeInSession('attribute', 'value');
param string
$attributeparam mixed|null
$valueChecks that the current page contains the given string in its raw source code.
<?php
$I->dontSeeInSource('<h1>Green eggs & ham</h1>');
param
$rawChecks that the page title does not contain the given string.
param
$titleChecks that the page doesnât contain a link with the given string. If the second parameter is given, only links with a matching âhrefâ attribute will be checked.
<?php
$I->dontSeeLink('Logout'); // I suppose user is not logged in
$I->dontSeeLink('Checkout now', '/store/cart.php');
?>
param string
$textparam string
$url optionalChecks that the given option is not selected.
<?php
$I->dontSeeOptionIsSelected('#form input[name=payment]', 'Visa');
?>
param
$selectorparam
$optionTextVerifies that there were no orphan events during the test.
An orphan event is an event that was triggered by manually executing the
dispatch()
method
of the EventDispatcher but was not handled by any listener after it was dispatched.
<?php
$I->dontSeeOrphanEvent();
$I->dontSeeOrphanEvent('App\MyEvent');
$I->dontSeeOrphanEvent(new App\Events\MyEvent());
$I->dontSeeOrphanEvent(['App\MyEvent', 'App\MyOtherEvent']);
param string|object|string[]
$expectedCheck that user is not authenticated with the âremember meâ option.
<?php
$I->dontSeeRememberedAuthentication();
Asserts that a template was not rendered in the response.
<?php
$I->dontSeeRenderedTemplate('home.html.twig');
param string
$templateChecks that response code is equal to value provided.
<?php
$I->dontSeeResponseCodeIs(200);
// recommended \Codeception\Util\HttpCode
$I->dontSeeResponseCodeIs(\Codeception\Util\HttpCode::OK);
param
$codeFills a text field or textarea with the given string.
<?php
$I->fillField("//input[@type='text']", "Hello World!");
$I->fillField(['name' => 'email'], '[email protected]');
?>
param
$fieldparam
$valueFollow pending redirect if there is one.
<?php
$I->followRedirect();
Grabs the value of the given attribute value from the given element. Fails if element is not found.
<?php
$I->grabAttributeFrom('#tooltip', 'title');
?>
param
$cssOrXpathparam
$attributeGrabs a cookie value.
You can set additional cookie params like domain
, path
in array passed as last argument.
If the cookie is set by an ajax request (XMLHttpRequest), there might be some delay caused by the browser, so try $I->wait(0.1)
.
param
$cookie
param array
$params
Executes the given regular expression against the current URI and returns the first capturing group. If no parameters are provided, the full URI is returned.
<?php
$user_id = $I->grabFromCurrentUrl('~^/user/(\d+)/~');
$uri = $I->grabFromCurrentUrl();
?>
param string
$uri optionalReturns the last sent email.
<?php
$email = $I->grabLastSentEmail();
$address = $email->getTo()[0];
$I->assertSame('[email protected]', $address->getAddress());
return \Symfony\Component\Mime\Email |
null |
Grabs either the text content, or attribute values, of nodes matched by $cssOrXpath and returns them as an array.
<a href="#first">First</a>
<a href="#second">Second</a>
<a href="#third">Third</a>
<?php
// would return ['First', 'Second', 'Third']
$aLinkText = $I->grabMultiple('a');
// would return ['#first', '#second', '#third']
$aLinks = $I->grabMultiple('a', 'href');
?>
param
$cssOrXpathparam
$attributereturn
string[]Retrieves number of records from database âidâ is the default search parameter.
<?php
$I->grabNumRecords('User::class', ['name' => 'davert']);
param string
$entityClass The entity classparam array
$criteria Optional query criteriareturn
intGrabs current page source code.
@throws ModuleException if no page was opened.
return
string Current page source code.Grabs a Symfony parameter
<?php
$I->grabParameter('app.business_name');
param string
$namereturn mixed |
null |
Grab a Doctrine entity repository. Works with objects, entities, repositories, and repository interfaces.
<?php
$I->grabRepository($user);
$I->grabRepository(User::class);
$I->grabRepository(UserRepository::class);
$I->grabRepository(UserRepositoryInterface::class);
param object|string
$mixedreturn \Doctrine\ORM\EntityRepository |
null |
Returns an array of all sent emails.
<?php
$emails = $I->grabSentEmails();
$address = $emails[0]->getTo()[0];
$I->assertSame('[email protected]', $address->getAddress());
return
\Symfony\Component\Mime\Email[]Grabs a service from the Symfony dependency injection container (DIC).
In âtestâ environment, Symfony uses a special test.service_container
.
See the âAccessing the Containerâ documentation.
Services that arenât injected somewhere into your app, need to be defined as public
to be accessible by Codeception.
<?php
$em = $I->grabService('doctrine');
[Part]
servicesparam string
$serviceIdreturn
objectFinds and returns the text contents of the given element. If a fuzzy locator is used, the element is found using CSS, XPath, and by matching the full page source by regular expression.
<?php
$heading = $I->grabTextFrom('h1');
$heading = $I->grabTextFrom('descendant-or-self::h1');
$value = $I->grabTextFrom('~<input value=(.*?)]~sgi'); // match with a regex
?>
param
$cssOrXPathOrRegexparam
$field
return array |
mixed | null | string |
Sets the HTTP header to the passed value - which is used on subsequent HTTP requests through PhpBrowser.
Example:
<?php
$I->haveHttpHeader('X-Requested-With', 'Codeception');
$I->amOnPage('test-headers.php');
?>
To use special chars in Header Key use HTML Character Entities: Example: Header with underscore - âClient_Idâ should be represented as - âClient_Idâ or âClient_Idâ
<?php
$I->haveHttpHeader('Client_Id', 'Codeception');
?>
param string
$name the name of the request headerparam string
$value the value to set it to for subsequent
requestsSets SERVER parameter valid for all next requests.
$I->haveServerParameter('name', 'value');
param
$nameparam
$valueInvalidate previously cached routes.
Invalidate the current session.
<?php
$I->logout();
Use this method within an interactive pause to save the HTML source code of the current page.
<?php
$I->makeHtmlSnapshot('edit_page');
// saved to: tests/_output/debug/edit_page.html
$I->makeHtmlSnapshot();
// saved to: tests/_output/debug/2017-05-26_14-24-11_4b3403665fea6.html
param null
$nameMoves back in history.
param int
$numberOfSteps (default value 1)Get service $serviceName and add it to the lists of persistent services, making that service persistent between tests.
[Part]
servicesparam string
$serviceNameGet service $serviceName and add it to the lists of persistent services.
[Part]
servicesparam string
$serviceNameReboot clientâs kernel. Can be used to manually reboot kernel when ârebootable_clientâ => false
<?php
// Perform some requests
$I->rebootClientKernel();
// Perform other requests
Unsets cookie with the given name.
You can set additional cookie params like domain
, path
in array passed as last argument.
param
$cookie
param array
$params
Run Symfony console command, grab response and return as string. Recommended to use for integration or functional testing.
<?php
$result = $I->runSymfonyConsoleCommand('hello:world', ['arg' => 'argValue', 'opt1' => 'optValue'], ['input']);
param string
$command The console command to executeparam array
$parameters Parameters (arguments and options) to pass to the commandparam array
$consoleInputs Console inputs (e.g. used for interactive questions)param int
$expectedExitCode The expected exit code of the commandreturn
string Returns the console output of the commandChecks that the current page contains the given string (case insensitive).
You can specify a specific HTML element (via CSS or XPath) as the second parameter to only search within that element.
<?php
$I->see('Logout'); // I can suppose user is logged in
$I->see('Sign Up', 'h1'); // I can suppose it's a signup page
$I->see('Sign Up', '//body/h1'); // with XPath
$I->see('Sign Up', ['css' => 'body h1']); // with strict CSS locator
Note that the search is done after stripping all HTML tags from the body,
so $I->see('strong')
will return true for strings like:
<p>I am Stronger than thou</p>
<script>document.createElement('strong');</script>
But will not be true for strings like:
<strong>Home</strong>
<div class="strong">Home</strong>
<!-- strong -->
For checking the raw source code, use seeInSource()
.
param string
$textparam array|string
$selector optionalChecks that a user is authenticated.
<?php
$I->seeAuthentication();
Checks that the specified checkbox is checked.
<?php
$I->seeCheckboxIsChecked('#agree'); // I suppose user agreed to terms
$I->seeCheckboxIsChecked('#signup_form input[type=checkbox]'); // I suppose user agreed to terms, If there is only one checkbox in form.
$I->seeCheckboxIsChecked('//form/input[@type=checkbox and @name=agree]');
?>
param
$checkboxChecks that a cookie with the given name is set.
You can set additional cookie params like domain
, path
as array passed in last argument.
<?php
$I->seeCookie('PHPSESSID');
?>
param
$cookieparam array
$paramsChecks that current page matches action
<?php
$I->seeCurrentActionIs('PostController::index');
$I->seeCurrentActionIs('HomeController');
param string
$actionChecks that current url matches route.
<?php
$I->seeCurrentRouteIs('posts.index');
$I->seeCurrentRouteIs('posts.show', ['id' => 8]);
param string
$routeNameparam array
$paramsAsserts that the current template matches the expected template.
<?php
$I->seeCurrentTemplateIs('home.html.twig');
param string
$expectedTemplateChecks that the current URL is equal to the given string.
Unlike seeInCurrentUrl
, this only matches the full URL.
<?php
// to match root url
$I->seeCurrentUrlEquals('/');
?>
param string
$uriChecks that the current URL matches the given regular expression.
<?php
// to match root url
$I->seeCurrentUrlMatches('~^/users/(\d+)~');
?>
param string
$uriChecks that the given element exists on the page and is visible. You can also specify expected attributes of this element.
<?php
$I->seeElement('.error');
$I->seeElement('//form/input[1]');
$I->seeElement('input', ['name' => 'login']);
$I->seeElement('input', ['value' => '123456']);
// strict locator in first arg, attributes in second
$I->seeElement(['css' => 'form input'], ['name' => 'login']);
?>
param
$selectorparam array
$attributes
@returnChecks if the desired number of emails was sent.
Asserts that 1 email was sent by default, specify the expectedCount
parameter to modify it.
The email is checked using Symfony message logger, which means:
<?php
$I->seeEmailIsSent(2);
param int
$expectedCount The expected number of emails sentVerifies that one or more event listeners were called during the test.
<?php
$I->seeEventTriggered('App\MyEvent');
$I->seeEventTriggered(new App\Events\MyEvent());
$I->seeEventTriggered(['App\MyEvent', 'App\MyOtherEvent']);
param string|object|string[]
$expectedVerifies that a form field has an error. You can specify the expected error message as second parameter.
<?php
$I->seeFormErrorMessage('username');
$I->seeFormErrorMessage('username', 'Username is empty');
param string
$fieldparam string|null
$messageVerifies that multiple fields on a form have errors.
If you only specify the name of the fields, this method will verify that the field contains at least one error of any type:
<?php
$I->seeFormErrorMessages(['telephone', 'address']);
If you want to specify the error messages, you can do so by sending an associative array instead, with the key being the name of the field and the error message the value.
This method will validate that the expected error message is contained in the actual error message, that is, you can specify either the entire error message or just a part of it:
<?php
$I->seeFormErrorMessages([
'address' => 'The address is too long'
'telephone' => 'too short', // the full error message is 'The telephone is too short'
]);
If you donât want to specify the error message for some fields,
you can pass null
as value instead of the message string,
or you can directly omit the value of that field. If that is the case,
it will be validated that that field has at least one error of any type:
<?php
$I->seeFormErrorMessages([
'telephone' => 'too short',
'address' => null,
'postal code',
]);
param string[]
$expectedErrorsVerifies that there are one or more errors bound to the submitted form.
<?php
$I->seeFormHasErrors();
Checks that current url matches route. Unlike seeCurrentRouteIs, this can matches without exact route parameters
<?php
$I->seeInCurrentRoute('my_blog_pages');
param string
$routeNameChecks that current URI contains the given string.
<?php
// to match: /home/dashboard
$I->seeInCurrentUrl('home');
// to match: /users/1
$I->seeInCurrentUrl('/users/');
?>
param string
$uriChecks that the given input field or textarea equals (i.e. not just contains) the given value. Fields are matched by label text, the ânameâ attribute, CSS, or XPath.
<?php
$I->seeInField('Body','Type your comment here');
$I->seeInField('form textarea[name=body]','Type your comment here');
$I->seeInField('form input[type=hidden]','hidden_value');
$I->seeInField('#searchform input','Search');
$I->seeInField('//form/*[@name=search]','Search');
$I->seeInField(['name' => 'search'], 'Search');
?>
param
$fieldparam
$valueChecks if the array of form parameters (name => value) are set on the form matched with the passed selector.
<?php
$I->seeInFormFields('form[name=myform]', [
'input1' => 'value',
'input2' => 'other value',
]);
?>
For multi-select elements, or to check values of multiple elements with the same name, an array may be passed:
<?php
$I->seeInFormFields('.form-class', [
'multiselect' => [
'value1',
'value2',
],
'checkbox[]' => [
'a checked value',
'another checked value',
],
]);
?>
Additionally, checkbox values can be checked with a boolean.
<?php
$I->seeInFormFields('#form-id', [
'checkbox1' => true, // passes if checked
'checkbox2' => false, // passes if unchecked
]);
?>
Pair this with submitForm for quick testing magic.
<?php
$form = [
'field1' => 'value',
'field2' => 'another value',
'checkbox1' => true,
// ...
];
$I->submitForm('//form[@id=my-form]', $form, 'submitButton');
// $I->amOnPage('/path/to/form-page') may be needed
$I->seeInFormFields('//form[@id=my-form]', $form);
?>
param
$formSelectorparam
$paramsAssert that a session attribute exists.
<?php
$I->seeInSession('attribute');
$I->seeInSession('attribute', 'value');
param string
$attributeparam mixed|null
$valueChecks that the current page contains the given string in its raw source code.
<?php
$I->seeInSource('<h1>Green eggs & ham</h1>');
param
$rawChecks that the page title contains the given string.
<?php
$I->seeInTitle('Blog - Post #1');
?>
param
$titleChecks that thereâs a link with the specified text. Give a full URL as the second parameter to match links with that exact URL.
<?php
$I->seeLink('Logout'); // matches <a href="#">Logout</a>
$I->seeLink('Logout','/logout'); // matches <a href="/logout">Logout</a>
?>
param string
$textparam string
$url optionalChecks that number of given records were found in database. âidâ is the default search parameter.
<?php
$I->seeNumRecords(1, User::class, ['name' => 'davert']);
$I->seeNumRecords(80, User::class);
param int
$expectedNum Expected number of recordsparam string
$className A doctrine entityparam array
$criteria Optional query criteriaChecks that there are a certain number of elements matched by the given locator on the page.
<?php
$I->seeNumberOfElements('tr', 10);
$I->seeNumberOfElements('tr', [0,10]); // between 0 and 10 elements
?>
param
$selectorparam mixed
$expected int or int[]Checks that the given option is selected.
<?php
$I->seeOptionIsSelected('#form input[name=payment]', 'Visa');
?>
param
$selectorparam
$optionTextVerifies that one or more orphan events were dispatched during the test.
An orphan event is an event that was triggered by manually executing the
dispatch()
method
of the EventDispatcher but was not handled by any listener after it was dispatched.
<?php
$I->seeOrphanEvent('App\MyEvent');
$I->seeOrphanEvent(new App\Events\MyEvent());
$I->seeOrphanEvent(['App\MyEvent', 'App\MyOtherEvent']);
param string|object|string[]
$expectedVerifies that a page is available.
By default it checks the current page, specify the $url
parameter to change it.
<?php
$I->amOnPage('/dashboard');
$I->seePageIsAvailable();
$I->seePageIsAvailable('/dashboard'); // Same as above
param string|null
$urlAsserts that current page has 404 response status code.
Goes to a page and check that it redirects to another.
<?php
$I->seePageRedirectsTo('/admin', '/login');
param string
$pageparam string
$redirectsToChecks that a user is authenticated with the âremember meâ option.
<?php
$I->seeRememberedAuthentication();
Asserts that a template was rendered in the response. That includes templates built with inheritance.
<?php
$I->seeRenderedTemplate('home.html.twig');
$I->seeRenderedTemplate('layout.html.twig');
param string
$templateChecks that response code is equal to value provided.
<?php
$I->seeResponseCodeIs(200);
// recommended \Codeception\Util\HttpCode
$I->seeResponseCodeIs(\Codeception\Util\HttpCode::OK);
param
$codeChecks that response code is between a certain range. Between actually means [from <= CODE <= to]
param
$fromparam
$toChecks that the response code is 4xx
Checks that the response code 3xx
Checks that the response code is 5xx
Checks that the response code 2xx
Assert that the session has a given list of values.
<?php
$I->seeSessionHasValues(['key1', 'key2']);
$I->seeSessionHasValues(['key1' => 'value1', 'key2' => 'value2']);
param array
$bindingsCheck that the current user has a role
<?php
$I->seeUserHasRole('ROLE_ADMIN');
param string
$roleVerifies that the current user has multiple roles
<?php
$I->seeUserHasRoles(['ROLE_USER', 'ROLE_ADMIN']);
param string[]
$rolesChecks that the userâs password would not benefit from rehashing. If the user is not provided it is taken from the current session.
You might use this function after performing tasks like registering a user or submitting a password update form.
<?php
$I->seeUserPasswordDoesNotNeedRehash();
$I->seeUserPasswordDoesNotNeedRehash($user);
param UserInterface|null
$userSelects an option in a select tag or in radio button group.
<?php
$I->selectOption('form select[name=account]', 'Premium');
$I->selectOption('form input[name=payment]', 'Monthly');
$I->selectOption('//form/select[@name=account]', 'Monthly');
?>
Provide an array for the second argument to select multiple options:
<?php
$I->selectOption('Which OS do you use?', array('Windows','Linux'));
?>
Or provide an associative array for the second argument to specifically define which selection method should be used:
<?php
$I->selectOption('Which OS do you use?', array('text' => 'Windows')); // Only search by text 'Windows'
$I->selectOption('Which OS do you use?', array('value' => 'windows')); // Only search by value 'windows'
?>
param
$selectparam
$optionSends an ajax GET request with the passed parameters.
See sendAjaxPostRequest()
param
$uriparam
$paramsSends an ajax POST request with the passed parameters.
The appropriate HTTP header is added automatically:
X-Requested-With: XMLHttpRequest
Example:
<?php
$I->sendAjaxPostRequest('/add-task', ['task' => 'lorem ipsum']);
Some frameworks (e.g. Symfony) create field names in the form of an âarrayâ:
<input type="text" name="form[task]">
In this case you need to pass the fields like this:
<?php
$I->sendAjaxPostRequest('/add-task', ['form' => [
'task' => 'lorem ipsum',
'category' => 'miscellaneous',
]]);
param string
$uriparam array
$paramsSends an ajax request, using the passed HTTP method.
See sendAjaxPostRequest()
Example:
<?php
$I->sendAjaxRequest('PUT', '/posts/7', ['title' => 'new title']);
param
$methodparam
$uriparam
$paramsSets a cookie with the given name and value.
You can set additional cookie params like domain
, path
, expires
, secure
in array passed as last argument.
<?php
$I->setCookie('PHPSESSID', 'el4ukv0kqbvoirg7nkp4dncpk3');
?>
param
$nameparam
$valparam array
$paramsSets the maximum number of redirects that the Client can follow.
<?php
$I->setMaxRedirects(2);
param int
$maxRedirectsSets SERVER parameters valid for all next requests. this will remove old ones.
$I->setServerParameters([]);
param array
$paramsEnables automatic redirects to be followed by the client.
<?php
$I->startFollowingRedirects();
Prevents automatic redirects to be followed by the client.
<?php
$I->stopFollowingRedirects();
Submits the given form on the page, with the given form values. Pass the form fieldâs values as an array in the second parameter.
Although this function can be used as a short-hand version of
fillField()
, selectOption()
, click()
etc. it has some important
differences:
fillField()
or selectOption()
with
a missing field.Fields that are not provided will be filled by their values from the page,
or from any previous calls to fillField()
, selectOption()
etc.
You donât need to click the âSubmitâ button afterwards.
This command itself triggers the request to formâs action.
You can optionally specify which buttonâs value to include in the request with the last parameter (as an alternative to explicitly setting its value in the second parameter), as button values are not otherwise included in the request.
Examples:
<?php
$I->submitForm('#login', [
'login' => 'davert',
'password' => '123456'
]);
// or
$I->submitForm('#login', [
'login' => 'davert',
'password' => '123456'
], 'submitButtonName');
For example, given this sample âSign Upâ form:
<form action="/sign_up">
Login:
<input type="text" name="user[login]" /><br/>
Password:
<input type="password" name="user[password]" /><br/>
Do you agree to our terms?
<input type="checkbox" name="user[agree]" /><br/>
Select pricing plan:
<select name="plan">
<option value="1">Free</option>
<option value="2" selected="selected">Paid</option>
</select>
<input type="submit" name="submitButton" value="Submit" />
</form>
You could write the following to submit it:
<?php
$I->submitForm(
'#userForm',
[
'user' => [
'login' => 'Davert',
'password' => '123456',
'agree' => true
]
],
'submitButton'
);
Note that â2â will be the submitted value for the âplanâ field, as it is the selected option.
You can also emulate a JavaScript submission by not specifying any buttons in the third parameter to submitForm.
<?php
$I->submitForm(
'#userForm',
[
'user' => [
'login' => 'Davert',
'password' => '123456',
'agree' => true
]
]
);
This function works well when paired with seeInFormFields()
for quickly testing CRUD interfaces and form validation logic.
<?php
$form = [
'field1' => 'value',
'field2' => 'another value',
'checkbox1' => true,
// ...
];
$I->submitForm('#my-form', $form, 'submitButton');
// $I->amOnPage('/path/to/form-page') may be needed
$I->seeInFormFields('#my-form', $form);
Parameter values can be set to arrays for multiple input fields
of the same name, or multi-select combo boxes. For checkboxes,
you can use either the string value or boolean true
/false
which will
be replaced by the checkboxâs value in the DOM.
<?php
$I->submitForm('#my-form', [
'field1' => 'value',
'checkbox' => [
'value of first checkbox',
'value of second checkbox',
],
'otherCheckboxes' => [
true,
false,
false
],
'multiselect' => [
'first option value',
'second option value'
]
]);
Mixing string and boolean values for a checkboxâs value is not supported and may produce unexpected results.
Field names ending in []
must be passed without the trailing square
bracket characters, and must contain an array for its value. This allows
submitting multiple values with the same name, consider:
<?php
// This will NOT work correctly
$I->submitForm('#my-form', [
'field[]' => 'value',
'field[]' => 'another value', // 'field[]' is already a defined key
]);
The solution is to pass an array value:
<?php
// This way both values are submitted
$I->submitForm('#my-form', [
'field' => [
'value',
'another value',
]
]);
param
$selectorparam
$paramsparam
$buttonSubmit a form specifying the form name only once.
Use this function instead of $I->submitForm() to avoid repeating the form name in the field selectors. If you customized the names of the field selectors use $I->submitForm() for full control.
<?php
$I->submitSymfonyForm('login_form', [
'[email]' => '[email protected]',
'[password]' => 'secretForest'
]);
param string
$nameparam string[]
$fieldsSwitch to iframe or frame on the page.
Example:
<iframe name="another_frame" src="http://example.com">
<?php
# switch to iframe
$I->switchToIframe("another_frame");
param string
$nameUnticks a checkbox.
<?php
$I->uncheckOption('#notify');
?>
param
$optionRemove service $serviceName from the lists of persistent services.
[Part]
servicesparam string
$serviceName