Search

Symfony

Installation

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.

Description

This module uses Symfony’s DomCrawler and HttpKernel Component to emulate requests and test response.

  • Access Symfony services through the dependency injection container: $I->grabService(...)
  • Use Doctrine to test against the database: $I->seeInRepository(...) - see Doctrine Module
  • Assert that emails would have been sent: $I->seeEmailIsSent()
  • Tests are wrapped into Doctrine transaction to speed them up.
  • Symfony Router can be cached between requests to speed up testing.

Demo Project

https://github.com/Codeception/symfony-module-tests

Config

Symfony 5.x or 4.4

  • app_path: ‘src’ - Specify custom path to your app dir, where the kernel interface is located.
  • environment: ‘local’ - Environment used for load kernel
  • kernel_class: ‘App\Kernel’ - Kernel class name
  • em_service: ‘doctrine.orm.entity_manager’ - Use the stated EntityManager to pair with Doctrine Module.
  • debug: true - Turn on/off debug mode
  • cache_router: ‘false’ - Enable router caching between tests in order to increase performance
  • rebootable_client: ‘true’ - Reboot client’s kernel before each request
  • guard: ‘false’ - Enable custom authentication system with guard (only for 4.x and 5.x versions of the symfony)
  • authenticator: ‘false’ - Reboot client’s kernel before each request (only for 6.x versions of the symfony)
Example (functional.suite.yml) - Symfony 4 Directory Structure
modules:
   enabled:
      - Symfony:
          app_path: 'src'
          environment: 'test'

Public Properties

  • kernel - HttpKernel instance
  • client - current Crawler instance

Parts

  • services: Includes methods related to the Symfony dependency injection container (DIC):
    • grabService
    • persistService
    • persistPermanentService
    • unpersistService

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://example.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.

Actions

_findElements

hidden API method, expected to be used from Helper classes

  • api
  • param mixed $locator
  • return iterable

Locates element using available Codeception locator types:

  • XPath
  • CSS
  • Strict Locator

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

_getResponseContent

hidden API method, expected to be used from Helper classes

  • api
  • throws ModuleException
  • return string

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");
}

_loadPage

hidden API method, expected to be used from Helper classes

  • api
  • param string $method
  • param string $uri
  • param array $parameters
  • param array $files
  • param array $server
  • param ?string $content
  • return void

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]);
}

_request

hidden API method, expected to be used from Helper classes

  • api
  • see _loadPage
  • param string $method
  • param string $uri
  • param array $parameters
  • param array $files
  • param array $server
  • param ?string $content
  • throws ExternalUrlException|ModuleException
  • return ?string

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.

_savePageSource

hidden API method, expected to be used from Helper classes

  • api
  • param string $filename
  • return void

Saves page source of to a file

$this->getModule('Symfony')->_savePageSource(codecept_output_dir().'page.html');

amHttpAuthenticated

  • param string $username
  • param string $password
  • return void

Authenticates user for HTTP_AUTH

amLoggedInAs

  • param UserInterface $user
  • param string $firewallName
  • param null $firewallContext
  • return void

Login 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);

amOnAction

  • param string $action
  • param array $params
  • return void

Opens web page by action name

<?php
$I->amOnAction('PostController::index');
$I->amOnAction('HomeController');
$I->amOnAction('ArticleController', ['slug' => 'lorem-ipsum']);

amOnPage

  • param string $page
  • return void

Opens the page for the given relative URI.

<?php
// opens front page
$I->amOnPage('/');
// opens /register page
$I->amOnPage('/register');

amOnRoute

  • param string $routeName
  • param array $params
  • return void

Opens web page using route name and parameters.

<?php
$I->amOnRoute('posts.create');
$I->amOnRoute('posts.show', ['id' => 34]);

assertEmailAddressContains

  • param string $headerName
  • param string $expectedValue
  • param ?\Symfony\Component\Mime\Email $email
  • return void

Verify that an email contains addresses with a header $headerName and its expected value $expectedValue.

If the Email object is not specified, the last email sent is used instead.

<?php
$I->assertEmailAddressContains('To', '[email protected]');

assertEmailAttachmentCount

  • param int $count
  • param ?\Symfony\Component\Mime\Email $email
  • return void

Verify that an email has sent the specified number $count of attachments.

If the Email object is not specified, the last email sent is used instead.

<?php
$I->assertEmailAttachmentCount(1);

assertEmailHasHeader

  • param string $headerName
  • param ?\Symfony\Component\Mime\Email $email
  • return void

Verify that an email has a header $headerName.

If the Email object is not specified, the last email sent is used instead.

<?php
$I->assertEmailHasHeader('Bcc');

assertEmailHeaderNotSame

  • param string $headerName
  • param string $expectedValue
  • param ?\Symfony\Component\Mime\Email $email
  • return void

Verify that the header $headerName of an email is not the expected one $expectedValue.

If the Email object is not specified, the last email sent is used instead.

<?php
$I->assertEmailHeaderNotSame('To', '[email protected]');

assertEmailHeaderSame

  • param string $headerName
  • param string $expectedValue
  • param ?\Symfony\Component\Mime\Email $email
  • return void

Verify that the header $headerName of an email is the same as expected $expectedValue.

If the Email object is not specified, the last email sent is used instead.

<?php
$I->assertEmailHeaderSame('To', '[email protected]');

assertEmailHtmlBodyContains

  • param string $text
  • param ?\Symfony\Component\Mime\Email $email
  • return void

Verify that the HTML body of an email contains $text.

If the Email object is not specified, the last email sent is used instead.

<?php
$I->assertEmailHtmlBodyContains('Successful registration');

assertEmailHtmlBodyNotContains

  • param string $text
  • param ?\Symfony\Component\Mime\Email $email
  • return void

Verify that the HTML body of an email does not contain a text $text.

If the Email object is not specified, the last email sent is used instead.

<?php
$I->assertEmailHtmlBodyNotContains('userpassword');

assertEmailNotHasHeader

  • param string $headerName
  • param ?\Symfony\Component\Mime\Email $email
  • return void

Verify that an email does not have a header $headerName.

If the Email object is not specified, the last email sent is used instead.

<?php
$I->assertEmailNotHasHeader('Bcc');

assertEmailTextBodyContains

  • param string $text
  • param ?\Symfony\Component\Mime\Email $email
  • return void

Verify the text body of an email contains a $text.

If the Email object is not specified, the last email sent is used instead.

<?php
$I->assertEmailTextBodyContains('Example text body');

assertEmailTextBodyNotContains

  • param string $text
  • param ?\Symfony\Component\Mime\Email $email
  • return void

Verify that the text body of an email does not contain a $text.

If the Email object is not specified, the last email sent is used instead.

<?php
$I->assertEmailTextBodyNotContains('My secret text body');

attachFile

  • param $field
  • param string $filename
  • return void

Attaches 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');

checkOption

  • param $option
  • return void

Ticks a checkbox. For radio buttons, use the selectOption method instead.

<?php
$I->checkOption('#agree');

click

  • param string|array $link
  • param $context
  • return void

Perform 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']);

deleteHeader

  • param string $name the name of the header to delete.
  • return void

Deletes 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');

dontSee

  • param string $text
  • param array|string $selector optional
  • return void

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().

dontSeeAuthentication

  • return void

Check that user is not authenticated.

<?php
$I->dontSeeAuthentication();

dontSeeCheckboxIsChecked

  • param $checkbox
  • return void

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.

dontSeeCookie

  • param $cookie
  • param $params
  • return mixed|void

Checks 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.

dontSeeCurrentUrlEquals

  • param string $uri
  • return void

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('/');

dontSeeCurrentUrlMatches

  • param string $uri
  • return void

Checks that current url doesn’t match the given regular expression.

<?php
// to match root url
$I->dontSeeCurrentUrlMatches('~^/users/(\d+)~');

dontSeeElement

  • param $selector
  • param array $attributes
  • return void

Checks 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']);

dontSeeEmailIsSent

  • return void

Checks that no email was sent.

The check is based on \Symfony\Component\Mailer\EventListener\MessageLoggerListener, which means: If your app performs a HTTP redirect, you need to suppress it using stopFollowingRedirects() first; otherwise this check will always pass. Starting with version 2.0.0, codeception/module-symfony requires your app to use Symfony Mailer. If your app still uses Swift Mailer, set your version constraint to ^1.6.

dontSeeEventTriggered

  • param string|object|string[] $expected
  • return void

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']);

dontSeeFormErrors

  • return void

Verifies that there are no errors bound to the submitted form.

<?php
$I->dontSeeFormErrors();

dontSeeInCurrentUrl

  • param string $uri
  • return void

Checks that the current URI doesn’t contain the given string.

<?php
$I->dontSeeInCurrentUrl('/users/');

dontSeeInField

  • param string|array $field
  • param $value
  • return void

Checks 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');

dontSeeInFormFields

  • param $formSelector
  • param array $params
  • return void

Checks 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
]);

dontSeeInSession

  • param string $attribute
  • param mixed|null $value
  • return void

Assert that a session attribute does not exist, or is not equal to the passed value.

<?php
$I->dontSeeInSession('attribute');
$I->dontSeeInSession('attribute', 'value');

dontSeeInSource

  • param string $raw
  • return void

Checks that the current page contains the given string in its raw source code.

<?php
$I->dontSeeInSource('<h1>Green eggs &amp; ham</h1>');

dontSeeInTitle

  • param $title
  • return mixed|void

Checks that the page title does not contain the given string.

  • param string $text
  • param string $url
  • return void

Checks 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');

dontSeeOptionIsSelected

  • param $selector
  • param $optionText
  • return mixed|void

Checks that the given option is not selected.

<?php
$I->dontSeeOptionIsSelected('#form input[name=payment]', 'Visa');

dontSeeOrphanEvent

  • param string|object|string[] $expected
  • return void

Verifies 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']);

dontSeeRememberedAuthentication

  • return void

Check that user is not authenticated with the ‘remember me’ option.

<?php
$I->dontSeeRememberedAuthentication();

dontSeeRenderedTemplate

  • param string $template
  • return void

Asserts that a template was not rendered in the response.

<?php
$I->dontSeeRenderedTemplate('home.html.twig');

dontSeeResponseCodeIs

  • param int $code
  • return void

Checks that response code is equal to value provided.

<?php
$I->dontSeeResponseCodeIs(200);

// recommended \Codeception\Util\HttpCode
$I->dontSeeResponseCodeIs(\Codeception\Util\HttpCode::OK);

fillField

  • param $field
  • param $value
  • return void

Fills a text field or textarea with the given string.

<?php
$I->fillField("//input[@type='text']", "Hello World!");
$I->fillField(['name' => 'email'], '[email protected]');

followRedirect

  • return void

Follow pending redirect if there is one.

<?php
$I->followRedirect();

goToLogoutPath

  • return void

Go to the configured logout url (by default: /logout).

This method includes redirection to the destination page configured after logout.

See the Symfony documentation on ‘Logging Out’.

grabAttributeFrom

  • param $cssOrXpath
  • param string $attribute
  • return mixed

Grabs the value of the given attribute value from the given element.

Fails if element is not found.

<?php
$I->grabAttributeFrom('#tooltip', 'title');

grabCookie

  • param string $cookie
  • param array $params
  • return mixed

Grabs 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).

grabFromCurrentUrl

  • param ?string $uri
  • return mixed

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();

grabLastSentEmail

  • return \Symfony\Component\Mime\Email|null

Returns the last sent email.

The function is based on \Symfony\Component\Mailer\EventListener\MessageLoggerListener, which means: If your app performs a HTTP redirect after sending the email, you need to suppress it using stopFollowingRedirects() first. Starting with version 2.0.0, codeception/module-symfony requires your app to use Symfony Mailer. If your app still uses Swift Mailer, set your version constraint to ^1.6. See also: grabSentEmails()

<?php
$email = $I->grabLastSentEmail();
$address = $email->getTo()[0];
$I->assertSame('[email protected]', $address->getAddress());

grabMultiple

  • param $cssOrXpath
  • param ?string $attribute
  • return string[]

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');

grabNumRecords

  • param string $entityClass The entity class
  • param array $criteria Optional query criteria
  • return int

Retrieves number of records from database ‘id’ is the default search parameter.

<?php
$I->grabNumRecords('User::class', ['name' => 'davert']);

grabPageSource

  • throws ModuleException if no page was opened.
  • return string Current page source code.

Grabs current page source code.

grabParameter

  • param string $name
  • return array|bool|float|int|string|null

Grabs a Symfony parameter

<?php
$I->grabParameter('app.business_name');

grabRepository

  • param object|string $mixed
  • return \Doctrine\ORM\EntityRepository|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);

grabSentEmails

  • return \Symfony\Component\Mime\Email[]

Returns an array of all sent emails.

The function is based on \Symfony\Component\Mailer\EventListener\MessageLoggerListener, which means: If your app performs a HTTP redirect after sending the email, you need to suppress it using stopFollowingRedirects() first. Starting with version 2.0.0, codeception/module-symfony requires your app to use Symfony Mailer. If your app still uses Swift Mailer, set your version constraint to ^1.6. See also: grabLastSentEmail()

<?php
$emails = $I->grabSentEmails();

grabService

  • part services
  • param string $serviceId
  • return object

Grabs a service from the Symfony dependency injection container (DIC).

In “test” environment, Symfony uses a special test.service_container. See the “Public Versus Private Services” 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');

grabTextFrom

  • param $cssOrXPathOrRegex
  • return mixed

Finds 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

grabValueFrom

  • param $field
  • return mixed

Finds the value for the given form field.

If a fuzzy locator is used, the field is found by field name, CSS, and XPath.

<?php
$name = $I->grabValueFrom('Name');
$name = $I->grabValueFrom('input[name=username]');
$name = $I->grabValueFrom('descendant-or-self::form/descendant::input[@name = 'username']');
$name = $I->grabValueFrom(['name' => 'username']);

haveHttpHeader

  • param string $name the name of the request header
  • param string $value the value to set it to for subsequent requests
  • return void

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&#95;Id', 'Codeception');

haveServerParameter

  • param string $name
  • param string $value
  • return void

Sets SERVER parameter valid for all next requests.

$I->haveServerParameter('name', 'value');

invalidateCachedRouter

  • return void

Invalidate previously cached routes.

logout

  • return void

Alias method for logoutProgrammatically()

<?php
$I->logout();

logoutProgrammatically

  • return void

Invalidates the current user’s session and expires the session cookies.

This method does not include any redirects after logging out.

<?php
$I->logoutProgrammatically();

makeHtmlSnapshot

  • param ?string $name
  • return void

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

moveBack

  • param int $numberOfSteps (default value 1)
  • return void

Moves back in history.

persistPermanentService

  • part services
  • param string $serviceName
  • return void

Get service $serviceName and add it to the lists of persistent services, making that service persistent between tests.

persistService

  • part services
  • param string $serviceName
  • return void

Get service $serviceName and add it to the lists of persistent services.

rebootClientKernel

  • return void

Reboot client’s kernel.

Can be used to manually reboot kernel when ‘rebootable_client’ => false

<?php

// Perform some requests

$I->rebootClientKernel();

// Perform other requests

resetCookie

  • param $cookie
  • param $params
  • return mixed|void

Unsets cookie with the given name.

You can set additional cookie params like domain, path in array passed as last argument.

runSymfonyConsoleCommand

  • param string $command The console command to execute
  • param array $parameters Parameters (arguments and options) to pass to the command
  • param array $consoleInputs Console inputs (e.g. used for interactive questions)
  • param int $expectedExitCode The expected exit code of the command
  • return string Returns the console output of the command

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']);

see

  • param string $text
  • param array|string $selector optional
  • return void

Checks 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().

seeAuthentication

  • return void

Checks that a user is authenticated.

<?php
$I->seeAuthentication();

seeCheckboxIsChecked

  • param $checkbox
  • return void

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]');

seeCookie

  • param $cookie
  • param $params
  • return mixed|void

Checks 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');

seeCurrentActionIs

  • param string $action
  • return void

Checks that current page matches action

<?php
$I->seeCurrentActionIs('PostController::index');
$I->seeCurrentActionIs('HomeController');

seeCurrentRouteIs

  • param string $routeName
  • param array $params
  • return void

Checks that current url matches route.

<?php
$I->seeCurrentRouteIs('posts.index');
$I->seeCurrentRouteIs('posts.show', ['id' => 8]);

seeCurrentTemplateIs

  • param string $expectedTemplate
  • return void

Asserts that the current template matches the expected template.

<?php
$I->seeCurrentTemplateIs('home.html.twig');

seeCurrentUrlEquals

  • param string $uri
  • return void

Checks 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('/');

seeCurrentUrlMatches

  • param string $uri
  • return void

Checks that the current URL matches the given regular expression.

<?php
// to match root url
$I->seeCurrentUrlMatches('~^/users/(\d+)~');

seeElement

  • param $selector
  • param array $attributes
  • return void

Checks 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']);

seeEmailIsSent

  • param int $expectedCount The expected number of emails sent
  • return void

Checks if the given number of emails was sent (default $expectedCount: 1).

The check is based on \Symfony\Component\Mailer\EventListener\MessageLoggerListener, which means: If your app performs a HTTP redirect after sending the email, you need to suppress it using stopFollowingRedirects() first. Starting with version 2.0.0, codeception/module-symfony requires your app to use Symfony Mailer. If your app still uses Swift Mailer, set your version constraint to ^1.6.

<?php
$I->seeEmailIsSent(2);

seeEventTriggered

  • param string|object|string[] $expected
  • return void

Verifies 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']);

seeFormErrorMessage

  • param string $field
  • param string|null $message
  • return void

Verifies 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');

seeFormErrorMessages

  • param string[] $expectedErrors
  • return void

Verifies 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',
]);

seeFormHasErrors

  • return void

Verifies that there are one or more errors bound to the submitted form.

<?php
$I->seeFormHasErrors();

seeInCurrentRoute

  • param string $routeName
  • return void

Checks that current url matches route.

Unlike seeCurrentRouteIs, this can matches without exact route parameters

<?php
$I->seeInCurrentRoute('my_blog_pages');

seeInCurrentUrl

  • param string $uri
  • return void

Checks that current URI contains the given string.

<?php
// to match: /home/dashboard
$I->seeInCurrentUrl('home');
// to match: /users/1
$I->seeInCurrentUrl('/users/');

seeInField

  • param string|array $field
  • param $value
  • return void

Checks 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');

seeInFormFields

  • param $formSelector
  • param array $params
  • return void

Checks 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]', string $form, 'submitButton');
// $I->amOnPage('/path/to/form-page') may be needed
$I->seeInFormFields('//form[@id=my-form]', string $form);

seeInSession

  • param string $attribute
  • param mixed|null $value
  • return void

Assert that a session attribute exists.

<?php
$I->seeInSession('attribute');
$I->seeInSession('attribute', 'value');

seeInSource

  • param string $raw
  • return void

Checks that the current page contains the given string in its raw source code.

<?php
$I->seeInSource('<h1>Green eggs &amp; ham</h1>');

seeInTitle

  • param $title
  • return mixed|void

Checks that the page title contains the given string.

<?php
$I->seeInTitle('Blog - Post #1');
  • param string $text
  • param ?string $url
  • return void

Checks 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>

seeNumRecords

  • param int $expectedNum Expected number of records
  • param string $className A doctrine entity
  • param array $criteria Optional query criteria
  • return void

Checks 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);

seeNumberOfElements

  • param $selector
  • param int|int[] $expected
  • return void

Checks 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

seeOptionIsSelected

  • param $selector
  • param $optionText
  • return mixed|void

Checks that the given option is selected.

<?php
$I->seeOptionIsSelected('#form input[name=payment]', 'Visa');

seeOrphanEvent

  • param string|object|string[] $expected
  • return void

Verifies 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']);

seePageIsAvailable

  • param string|null $url
  • return void

Verifies 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

seePageNotFound

  • return void

Asserts that current page has 404 response status code.

seePageRedirectsTo

  • param string $page
  • param string $redirectsTo
  • return void

Goes to a page and check that it redirects to another.

<?php
$I->seePageRedirectsTo('/admin', '/login');

seeRememberedAuthentication

  • return void

Checks that a user is authenticated with the ‘remember me’ option.

<?php
$I->seeRememberedAuthentication();

seeRenderedTemplate

  • param string $template
  • return void

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');

seeRequestTimeIsLessThan

  • param int|float $expectedMilliseconds The expected time in milliseconds
  • return void

Asserts that the time a request lasted is less than expected.

If the page performed a HTTP redirect, only the time of the last request will be taken into account. You can modify this behavior using stopFollowingRedirects() first.

Also, note that using code coverage can significantly increase the time it takes to resolve a request, which could lead to unreliable results when used together.

It is recommended to set rebootable_client to true (=default), cause otherwise this assertion gives false results if you access multiple pages in a row, or if your app performs a redirect.

seeResponseCodeIs

  • param int $code
  • return void

Checks that response code is equal to value provided.

<?php
$I->seeResponseCodeIs(200);

// recommended \Codeception\Util\HttpCode
$I->seeResponseCodeIs(\Codeception\Util\HttpCode::OK);

seeResponseCodeIsBetween

  • param int $from
  • param int $to
  • return void

Checks that response code is between a certain range. Between actually means [from <= CODE <= to]

seeResponseCodeIsClientError

  • return void

Checks that the response code is 4xx

seeResponseCodeIsRedirection

  • return void

Checks that the response code 3xx

seeResponseCodeIsServerError

  • return void

Checks that the response code is 5xx

seeResponseCodeIsSuccessful

  • return void

Checks that the response code 2xx

seeSessionHasValues

  • param array $bindings
  • return void

Assert that the session has a given list of values.

<?php
$I->seeSessionHasValues(['key1', 'key2']);
$I->seeSessionHasValues(['key1' => 'value1', 'key2' => 'value2']);

seeUserHasRole

  • param string $role
  • return void

Check that the current user has a role

<?php
$I->seeUserHasRole('ROLE_ADMIN');

seeUserHasRoles

  • param string[] $roles
  • return void

Verifies that the current user has multiple roles

<?php
$I->seeUserHasRoles(['ROLE_USER', 'ROLE_ADMIN']);

seeUserPasswordDoesNotNeedRehash

  • param UserInterface|null $user
  • return void

Checks 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);

selectOption

  • param $select
  • param $option
  • return void

Selects 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'

sendAjaxGetRequest

  • param string $uri
  • param array $params
  • return void

Sends an ajax GET request with the passed parameters.

See sendAjaxPostRequest()

sendAjaxPostRequest

  • param string $uri
  • param array $params
  • return void

Sends 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',
]]);

sendAjaxRequest

  • param string $method
  • param string $uri
  • param array $params
  • return void

Sends an ajax request, using the passed HTTP method.

See sendAjaxPostRequest() Example:

<?php
$I->sendAjaxRequest('PUT', '/posts/7', ['title' => 'new title']);

setCookie

  • param $name
  • param $val
  • param $params
  • return mixed|void

Sets 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');

setMaxRedirects

  • param int $maxRedirects
  • return void

Sets the maximum number of redirects that the Client can follow.

<?php
$I->setMaxRedirects(2);

setServerParameters

  • param array $params
  • return void

Sets SERVER parameters valid for all next requests.

this will remove old ones.

$I->setServerParameters([]);

startFollowingRedirects

  • return void

Enables automatic redirects to be followed by the client.

<?php
$I->startFollowingRedirects();

stopFollowingRedirects

  • return void

Prevents automatic redirects to be followed by the client.

<?php
$I->stopFollowingRedirects();

submitForm

  • param $selector
  • param array $params
  • param ?string $button
  • return void

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:

  • Only field names may be used, not CSS/XPath selectors nor field labels
  • If a field is sent to this function that does not exist on the page, it will silently be added to the HTTP request. This is helpful for testing some types of forms, but be aware that you will not get an exception like you would if you called 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 id="userForm">
    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/>
    Subscribe to our newsletter?
    <input type="checkbox" name="user[newsletter]" value="1" checked="checked" /><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.

To uncheck the pre-checked checkbox “newsletter”, call $I->uncheckOption(['name' => 'user[newsletter]']); before, then submit the form as shown here (i.e. without the “newsletter” field in the $params array).

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',
    ]
]);

submitSymfonyForm

  • param string $name The name attribute of the <form> (you cannot use an array as selector here)
  • param string[] $fields
  • return void

Submit 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'
]);

switchToIframe

  • param string $name
  • return void

Switch to iframe or frame on the page.

Example:

<iframe name="another_frame" src="http://example.com">
<?php
# switch to iframe
$I->switchToIframe("another_frame");

uncheckOption

  • param $option
  • return void

Unticks a checkbox.

<?php
$I->uncheckOption('#notify');

unpersistService

  • part services
  • param string $serviceName
  • return void

Remove service $serviceName from the lists of persistent services.

 

Module reference is taken from the source code. Help us to improve documentation. Edit module reference
Don't know how to write tests on your own? We will build or improve them for you. Request a quote for official enterprise support or trainings