layout	title
doc	Symfony - Codeception - Documentation

Changelog source3.1 2.5 1.8

Symfony

Installation

If you use Codeception installed using composer, install this module with the following command:

{% highlight yaml %} composer require --dev codeception/module-symfony

{% endhighlight %}

Alternatively, you can enable Symfony module in suite configuration file and run

{% highlight yaml %} codecept init upgrade4

{% endhighlight %}

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 Crawler and HttpKernel to emulate requests and test response.

Demo Project

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

Config

Symfony 5.x or 4.x

app_path: 'src' - in Symfony 4 Kernel is located inside src
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
mailer: 'symfony_mailer' - choose the mailer used by your application

Example (`functional.suite.yml`) - Symfony 4 Directory Structure

modules:
   enabled:
      - Symfony:
          app_path: 'src'
          environment: 'test'

Symfony 3.x

app_path: 'app' - specify custom path to your app dir, where the kernel interface is located.
var_path: 'var' - specify custom path to your var dir, where bootstrap cache is located.
environment: 'local' - environment used for load kernel
kernel_class: 'AppKernel' - 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
mailer: 'swiftmailer' - choose the mailer used by your application

Example (`functional.suite.yml`) - Symfony 3 Directory Structure

modules:
   enabled:
      - Symfony:
          app_path: 'app/front'
          var_path: 'var'
          environment: 'local_test'

Public Properties

kernel - HttpKernel instance
client - current Crawler instance

Parts

services: Symfony dependency injection container (DIC)

See WebDriver module for general information on how to load parts of a framework module.

Usage example:

{% highlight yaml %}

actor: AcceptanceTester modules: enabled: - Symfony: part: services - Doctrine2: depends: Symfony - WebDriver: url: http://your-url.com browser: firefox

{% endhighlight %}

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

Locates element using available Codeception locator types:

XPath
CSS
Strict Locator

Use it in Helpers or GroupObject or Extension classes:

{% highlight php %}

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 {% endhighlight %} WebDriver module returns `Facebook\WebDriver\Remote\RemoteWebElement` instances PhpBrowser and Framework modules return `Symfony\Component\DomCrawler\Crawler` instances * `param` $locator * `return` array of interactive elements #### _getResponseContent *hidden 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. {% highlight php %} assertStringContainsString($text, $this->getModule('Symfony')->_getResponseContent(), "response contains"); } ?>

{% endhighlight %}

return string @throws ModuleException

_loadPage

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

{% highlight php %}

getModule('Symfony')->_loadPage('POST', '/checkout/step2', ['order' => $orderId]); } ?>

{% endhighlight %}

param $method
param $uri
param array $parameters
param array $files
param array $server
param null $content

_request

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

{% highlight php %}

getModule('Symfony')->_request('POST', '/api/v1/users', ['name' => $name]); $user = json_decode($userData); return $user->id; } ?>

{% endhighlight %} 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 $method
param $uri
param array $parameters
param array $files
param array $server
param null $content
return mixed|Crawler @throws ExternalUrlException @see _loadPage

_savePageSource

hidden API method, expected to be used from Helper classes

Saves page source of to a file

{% highlight php %}

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

{% endhighlight %}

param $filename

amHttpAuthenticated

Authenticates user for HTTP_AUTH

param $username
param $password

amLoggedInAs

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.

{% highlight php %}

grabEntityFromRepository(User::class, [ 'email' => 'john_doe@gmail.com' ]); $I->amLoggedInAs($user); {% endhighlight %} * `param UserInterface` $user * `param string` $firewallName * `param null` $firewallContext #### amOnAction Opens web page by action name {% highlight php %} amOnAction('PostController::index'); $I->amOnAction('HomeController'); $I->amOnAction('ArticleController', ['slug' => 'lorem-ipsum']); {% endhighlight %} * `param string` $action * `param array` $params #### amOnPage Opens the page for the given relative URI. {% highlight php %} amOnPage('/'); // opens /register page $I->amOnPage('/register'); {% endhighlight %} * `param string` $page #### amOnRoute Opens web page using route name and parameters. {% highlight php %} amOnRoute('posts.create'); $I->amOnRoute('posts.show', array('id' => 34)); {% endhighlight %} * `param string` $routeName * `param array` $params #### attachFile Attaches a file relative to the Codeception `_data` directory to the given file upload field. {% highlight php %} attachFile('input[@type="file"]', 'prices.xls'); ?>

{% endhighlight %}

param $field
param $filename

checkOption

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

{% highlight php %}

checkOption('#agree'); ?>

{% endhighlight %}

param $option

click

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.

{% highlight php %}

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

{% endhighlight %}

param $link
param $context

deleteHeader

Deletes the header with the passed name. Subsequent requests will not have the deleted header in its request.

Example: {% highlight php %}

haveHttpHeader('X-Requested-With', 'Codeception'); $I->amOnPage('test-headers.php'); // ... $I->deleteHeader('X-Requested-With'); $I->amOnPage('some-other-page.php'); ?>

{% endhighlight %}

param string $name the name of the header to delete.

dontSee

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.

{% highlight php %}

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 {% endhighlight %} Note that the search is done after stripping all HTML tags from the body, so `$I->dontSee('strong')` will fail on strings like: - `

I am Stronger than thou

` - `<script>document.createElement('strong');</script>` But will ignore strings like: - `Home` - `

Home` - `` For checking the raw source code, use `seeInSource()`. * `param string` $text * `param array|string` $selector optional #### dontSeeAuthentication Check that user is not authenticated. {% highlight php %} dontSeeAuthentication(); {% endhighlight %} #### dontSeeCheckboxIsChecked Check that the specified checkbox is unchecked. {% highlight php %} 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. ?>

{% endhighlight %}

param $checkbox

dontSeeCookie

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.

param $cookie
param array $params

dontSeeCurrentUrlEquals

Checks that the current URL doesn't equal the given string. Unlike dontSeeInCurrentUrl, this only matches the full URL.

{% highlight php %}

dontSeeCurrentUrlEquals('/'); ?>

{% endhighlight %}

param string $uri

dontSeeCurrentUrlMatches

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

{% highlight php %}

dontSeeCurrentUrlMatches('~^/users/(\d+)~'); ?>

{% endhighlight %}

param string $uri

dontSeeElement

Checks that the given element is invisible or not present on the page. You can also specify expected attributes of this element.

{% highlight php %}

dontSeeElement('.error'); $I->dontSeeElement('//form/input[1]'); $I->dontSeeElement('input', ['name' => 'login']); $I->dontSeeElement('input', ['value' => '123456']); ?>

{% endhighlight %}

param $selector
param array $attributes

dontSeeEmailIsSent

Checks that no email was sent. This is an alias for seeEmailIsSent(0).

[Part] email

dontSeeEventTriggered

Make sure events did not fire during the test.

{% highlight php %}

dontSeeEventTriggered('App\MyEvent'); $I->dontSeeEventTriggered(new App\Events\MyEvent()); $I->dontSeeEventTriggered(['App\MyEvent', 'App\MyOtherEvent']); {% endhighlight %} * `param string|object|string[]` $expected #### dontSeeFormErrors Verifies that there are no errors bound to the submitted form. {% highlight php %} dontSeeFormErrors(); {% endhighlight %} #### dontSeeInCurrentUrl Checks that the current URI doesn't contain the given string. {% highlight php %} dontSeeInCurrentUrl('/users/'); ?>

{% endhighlight %}

param string $uri

dontSeeInField

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.

{% highlight php %}

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

{% endhighlight %}

param $field
param $value

dontSeeInFormFields

Checks if the array of form parameters (name => value) are not set on the form matched with the passed selector.

{% highlight php %}

dontSeeInFormFields('form[name=myform]', [ 'input1' => 'non-existent value', 'input2' => 'other non-existent value', ]); ?>

{% endhighlight %}

To check that an element hasn't been assigned any one of many values, an array can be passed as the value:

{% highlight php %}

dontSeeInFormFields('.form-class', [ 'fieldName' => [ 'This value shouldn\'t be set', 'And this value shouldn\'t be set', ], ]); ?>

{% endhighlight %}

Additionally, checkbox values can be checked with a boolean.

{% highlight php %}

dontSeeInFormFields('#form-id', [ 'checkbox1' => true, // fails if checked 'checkbox2' => false, // fails if unchecked ]); ?>

{% endhighlight %}

param $formSelector
param $params

dontSeeInSession

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

{% highlight php %}

dontSeeInSession('attribute'); $I->dontSeeInSession('attribute', 'value'); {% endhighlight %} * `param string` $attribute * `param mixed|null` $value #### dontSeeInSource Checks that the current page contains the given string in its raw source code. {% highlight php %} dontSeeInSource('

Green eggs & ham

'); {% endhighlight %} * `param` $raw #### dontSeeInTitle Checks that the page title does not contain the given string. * `param` $title #### dontSeeLink 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. {% highlight php %} dontSeeLink('Logout'); // I suppose user is not logged in $I->dontSeeLink('Checkout now', '/store/cart.php'); ?>

{% endhighlight %}

param string $text
param string $url optional

dontSeeOptionIsSelected

Checks that the given option is not selected.

{% highlight php %}

dontSeeOptionIsSelected('#form input[name=payment]', 'Visa'); ?>

{% endhighlight %}

param $selector
param $optionText

dontSeeRememberedAuthentication

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

{% highlight php %}

dontSeeRememberedAuthentication(); {% endhighlight %} #### dontSeeResponseCodeIs Checks that response code is equal to value provided. {% highlight php %} dontSeeResponseCodeIs(200); // recommended \Codeception\Util\HttpCode $I->dontSeeResponseCodeIs(\Codeception\Util\HttpCode::OK); {% endhighlight %} * `param` $code #### fillField Fills a text field or textarea with the given string. {% highlight php %} fillField("//input[@type='text']", "Hello World!"); $I->fillField(['name' => 'email'], 'jon@mail.com'); ?>

{% endhighlight %}

param $field
param $value

grabAttributeFrom

Grabs the value of the given attribute value from the given element. Fails if element is not found.

{% highlight php %}

grabAttributeFrom('#tooltip', 'title'); ?>

{% endhighlight %}

param $cssOrXpath
param $attribute

grabCookie

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

param $cookie
param array $params

grabFromCurrentUrl

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.

{% highlight php %}

grabFromCurrentUrl('~^/user/(\d+)/~'); $uri = $I->grabFromCurrentUrl(); ?>

{% endhighlight %}

param string $uri optional

grabMultiple

Grabs either the text content, or attribute values, of nodes matched by $cssOrXpath and returns them as an array.

{% highlight html %}

First Second Third

{% endhighlight %}

{% highlight php %}

grabMultiple('a'); // would return ['#first', '#second', '#third'] $aLinks = $I->grabMultiple('a', 'href'); ?>

{% endhighlight %}

param $cssOrXpath
param $attribute
return string[]

grabNumRecords

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

{% highlight php %}

grabNumRecords('User::class', ['name' => 'davert']); {% endhighlight %} * `param string` $entityClass The entity class * `param array` $criteria Optional query criteria * `return` int #### grabPageSource Grabs current page source code. @throws ModuleException if no page was opened. * `return` string Current page source code. #### grabParameter Grabs a Symfony parameter {% highlight php %} grabParameter('app.business_name'); {% endhighlight %} * `param string` $name * `return` mixed|null #### grabRepository Grab a Doctrine entity repository. Works with objects, entities, repositories, and repository interfaces. {% highlight php %} grabRepository($user); $I->grabRepository(User::class); $I->grabRepository(UserRepository::class); $I->grabRepository(UserRepositoryInterface::class); {% endhighlight %} * `param object|string` $mixed * `return` \Doctrine\ORM\EntityRepository|null #### grabService Grabs a service from the Symfony dependency injection container (DIC). In "test" environment, Symfony uses a special `test.service_container`, see https://symfony.com/doc/current/testing.html#accessing-the-container Services that aren't injected somewhere into your app, need to be defined as `public` to be accessible by Codeception. {% highlight php %} grabService('doctrine'); {% endhighlight %} * `param string` $service * `[Part]` services #### grabTextFrom 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. {% highlight php %} grabTextFrom('h1'); $heading = $I->grabTextFrom('descendant-or-self::h1'); $value = $I->grabTextFrom('~

{% endhighlight %}

param $cssOrXPathOrRegex

grabValueFrom

param $field
return array|mixed|null|string

haveHttpHeader

Sets the HTTP header to the passed value - which is used on subsequent HTTP requests through PhpBrowser.

Example: {% highlight php %}

haveHttpHeader('X-Requested-With', 'Codeception'); $I->amOnPage('test-headers.php'); ?>

{% endhighlight %}

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'

{% highlight php %}

haveHttpHeader('Client_Id', 'Codeception'); ?>

{% endhighlight %}

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

haveServerParameter

Sets SERVER parameter valid for all next requests.

{% highlight php %}

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

{% endhighlight %}

param $name
param $value

invalidateCachedRouter

Invalidate previously cached routes.

logout

Invalidate the current session. {% highlight php %}

logout(); {% endhighlight %} #### makeHtmlSnapshot Use this method within an [interactive pause](https://codeception.com/docs/02-GettingStarted#Interactive-Pause) to save the HTML source code of the current page. {% highlight php %} 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 {% endhighlight %} * `param null` $name #### moveBack Moves back in history. * `param int` $numberOfSteps (default value 1) #### persistPermanentService Get service $serviceName and add it to the lists of persistent services, making that service persistent between tests. * `param string` $serviceName #### persistService Get service $serviceName and add it to the lists of persistent services. * `param string` $serviceName #### rebootClientKernel Reboot client's kernel. Can be used to manually reboot kernel when 'rebootable_client' => false {% highlight php %} rebootClientKernel(); // Perform other requests {% endhighlight %} #### resetCookie 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 #### runSymfonyConsoleCommand Run Symfony console command, grab response and return as string. Recommended to use for integration or functional testing. {% highlight php %} runSymfonyConsoleCommand('hello:world', ['arg' => 'argValue', 'opt1' => 'optValue'], ['input']); {% endhighlight %} * `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 #### see 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. {% highlight php %} 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 {% endhighlight %} Note that the search is done after stripping all HTML tags from the body, so `$I->see('strong')` will return true for strings like: - `

I am Stronger than thou

` - `<script>document.createElement('strong');</script>` But will *not* be true for strings like: - `Home` - `

Home` - `` For checking the raw source code, use `seeInSource()`. * `param string` $text * `param array|string` $selector optional #### seeAuthentication Checks that a user is authenticated. {% highlight php %} seeAuthentication(); {% endhighlight %} #### seeCheckboxIsChecked Checks that the specified checkbox is checked. {% highlight php %} 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]'); ?>

{% endhighlight %}

param $checkbox

seeCookie

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.

{% highlight php %}

seeCookie('PHPSESSID'); ?>

{% endhighlight %}

param $cookie
param array $params

seeCurrentActionIs

Checks that current page matches action

{% highlight php %}

seeCurrentActionIs('PostController::index'); $I->seeCurrentActionIs('HomeController'); {% endhighlight %} * `param string` $action #### seeCurrentRouteIs Checks that current url matches route. {% highlight php %} seeCurrentRouteIs('posts.index'); $I->seeCurrentRouteIs('posts.show', array('id' => 8)); {% endhighlight %} * `param string` $routeName * `param array` $params #### seeCurrentUrlEquals Checks that the current URL is equal to the given string. Unlike `seeInCurrentUrl`, this only matches the full URL. {% highlight php %} seeCurrentUrlEquals('/'); ?>

{% endhighlight %}

param string $uri

seeCurrentUrlMatches

Checks that the current URL matches the given regular expression.

{% highlight php %}

seeCurrentUrlMatches('~^/users/(\d+)~'); ?>

{% endhighlight %}

param string $uri

seeElement

Checks that the given element exists on the page and is visible. You can also specify expected attributes of this element.

{% highlight php %}

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

{% endhighlight %}

param $selector
param array $attributes @return

seeEmailIsSent

Checks if the desired number of emails was sent. If no argument is provided then at least one email must be sent to satisfy the check. The email is checked using Symfony's profiler, which means:

If your app performs a redirect after sending the email, you need to suppress this using REST Module's stopFollowingRedirects
If the email is sent by a Symfony Console Command, Codeception cannot detect it yet.

{% highlight php %}

seeEmailIsSent(2); {% endhighlight %} * `param int|null` $expectedCount #### seeEventTriggered Make sure events fired during the test. {% highlight php %} seeEventTriggered('App\MyEvent'); $I->seeEventTriggered(new App\Events\MyEvent()); $I->seeEventTriggered(['App\MyEvent', 'App\MyOtherEvent']); {% endhighlight %} * `param string|object|string[]` $expected #### seeFormErrorMessage Verifies that a form field has an error. You can specify the expected error message as second parameter. {% highlight php %} seeFormErrorMessage('username'); $I->seeFormErrorMessage('username', 'Username is empty'); {% endhighlight %} * `param string` $field * `param string|null` $message #### seeFormErrorMessages 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: {% highlight php %} seeFormErrorMessages(['telephone', 'address']); {% endhighlight %} 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: {% highlight php %} seeFormErrorMessages([ 'address' => 'The address is too long' 'telephone' => 'too short', // the full error message is 'The telephone is too short' ]); {% endhighlight %} 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: {% highlight php %} seeFormErrorMessages([ 'telephone' => 'too short', 'address' => null, 'postal code', ]); {% endhighlight %} * `param string[]` $expectedErrors #### seeFormHasErrors Verifies that there are one or more errors bound to the submitted form. {% highlight php %} seeFormHasErrors(); {% endhighlight %} #### seeInCurrentRoute Checks that current url matches route. Unlike seeCurrentRouteIs, this can matches without exact route parameters {% highlight php %} seeInCurrentRoute('my_blog_pages'); {% endhighlight %} * `param string` $routeName #### seeInCurrentUrl Checks that current URI contains the given string. {% highlight php %} seeInCurrentUrl('home'); // to match: /users/1 $I->seeInCurrentUrl('/users/'); ?>

{% endhighlight %}

param string $uri

seeInField

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.

{% highlight php %}

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

{% endhighlight %}

param $field
param $value

seeInFormFields

Checks if the array of form parameters (name => value) are set on the form matched with the passed selector.

{% highlight php %}

seeInFormFields('form[name=myform]', [ 'input1' => 'value', 'input2' => 'other value', ]); ?>

{% endhighlight %}

For multi-select elements, or to check values of multiple elements with the same name, an array may be passed:

{% highlight php %}

seeInFormFields('.form-class', [ 'multiselect' => [ 'value1', 'value2', ], 'checkbox[]' => [ 'a checked value', 'another checked value', ], ]); ?>

{% endhighlight %}

Additionally, checkbox values can be checked with a boolean.

{% highlight php %}

seeInFormFields('#form-id', [ 'checkbox1' => true, // passes if checked 'checkbox2' => false, // passes if unchecked ]); ?>

{% endhighlight %}

Pair this with submitForm for quick testing magic.

{% highlight php %}

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

{% endhighlight %}

param $formSelector
param $params

seeInSession

Assert that a session attribute exists.

{% highlight php %}

seeInSession('attribute'); $I->seeInSession('attribute', 'value'); {% endhighlight %} * `param string` $attribute * `param mixed|null` $value #### seeInSource Checks that the current page contains the given string in its raw source code. {% highlight php %} seeInSource('

Green eggs & ham

'); {% endhighlight %} * `param` $raw #### seeInTitle Checks that the page title contains the given string. {% highlight php %} seeInTitle('Blog - Post #1'); ?>

{% endhighlight %}

param $title

seeLink

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.

{% highlight php %}

seeLink('Logout'); // matches Logout $I->seeLink('Logout','/logout'); // matches Logout ?>

{% endhighlight %}

param string $text
param string $url optional

seeNumRecords

Checks that number of given records were found in database. 'id' is the default search parameter.

{% highlight php %}

seeNumRecords(1, User::class, ['name' => 'davert']); $I->seeNumRecords(80, User::class); {% endhighlight %} * `param int` $expectedNum Expected number of records * `param string` $className A doctrine entity * `param array` $criteria Optional query criteria #### seeNumberOfElements Checks that there are a certain number of elements matched by the given locator on the page. {% highlight php %} seeNumberOfElements('tr', 10); $I->seeNumberOfElements('tr', [0,10]); // between 0 and 10 elements ?>

{% endhighlight %}

param $selector
param mixed $expected int or int[]

seeOptionIsSelected

Checks that the given option is selected.

{% highlight php %}

seeOptionIsSelected('#form input[name=payment]', 'Visa'); ?>

{% endhighlight %}

param $selector
param $optionText

seePageIsAvailable

Goes to a page and check that it can be accessed.

{% highlight php %}

seePageIsAvailable('/dashboard'); {% endhighlight %} * `param string` $url #### seePageNotFound Asserts that current page has 404 response status code. #### seePageRedirectsTo Goes to a page and check that it redirects to another. {% highlight php %} seePageRedirectsTo('/admin', '/login'); {% endhighlight %} * `param string` $page * `param string` $redirectsTo #### seeRememberedAuthentication Checks that a user is authenticated with the 'remember me' option. {% highlight php %} seeRememberedAuthentication(); {% endhighlight %} #### seeResponseCodeIs Checks that response code is equal to value provided. {% highlight php %} seeResponseCodeIs(200); // recommended \Codeception\Util\HttpCode $I->seeResponseCodeIs(\Codeception\Util\HttpCode::OK); {% endhighlight %} * `param` $code #### seeResponseCodeIsBetween Checks that response code is between a certain range. Between actually means [from <= CODE <= to] * `param` $from * `param` $to #### seeResponseCodeIsClientError Checks that the response code is 4xx #### seeResponseCodeIsRedirection Checks that the response code 3xx #### seeResponseCodeIsServerError Checks that the response code is 5xx #### seeResponseCodeIsSuccessful Checks that the response code 2xx #### seeSessionHasValues Assert that the session has a given list of values. {% highlight php %} seeSessionHasValues(['key1', 'key2']); $I->seeSessionHasValues(['key1' => 'value1', 'key2' => 'value2']); {% endhighlight %} * `param` array $bindings #### seeUserHasRole Check that the current user has a role {% highlight php %} seeUserHasRole('ROLE_ADMIN'); {% endhighlight %} * `param string` $role #### seeUserHasRoles Verifies that the current user has multiple roles {% highlight php %} seeUserHasRoles(['ROLE_USER', 'ROLE_ADMIN']); {% endhighlight %} * `param string[]` $roles #### seeUserPasswordDoesNotNeedRehash 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. {% highlight php %} seeUserPasswordDoesNotNeedRehash(); $I->seeUserPasswordDoesNotNeedRehash($user); {% endhighlight %} * `param UserInterface|null` $user #### selectOption Selects an option in a select tag or in radio button group. {% highlight php %} selectOption('form select[name=account]', 'Premium'); $I->selectOption('form input[name=payment]', 'Monthly'); $I->selectOption('//form/select[@name=account]', 'Monthly'); ?>

{% endhighlight %}

Provide an array for the second argument to select multiple options:

{% highlight php %}

selectOption('Which OS do you use?', array('Windows','Linux')); ?>

{% endhighlight %}

Or provide an associative array for the second argument to specifically define which selection method should be used:

{% highlight php %}

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

{% endhighlight %}

param $select
param $option

sendAjaxGetRequest

Sends an ajax GET request with the passed parameters. See sendAjaxPostRequest()

param $uri
param $params

sendAjaxPostRequest

Sends an ajax POST request with the passed parameters. The appropriate HTTP header is added automatically: X-Requested-With: XMLHttpRequest Example: {% highlight php %}

sendAjaxPostRequest('/add-task', ['task' => 'lorem ipsum']); {% endhighlight %} Some frameworks (e.g. Symfony) create field names in the form of an "array": `` In this case you need to pass the fields like this: {% highlight php %} sendAjaxPostRequest('/add-task', ['form' => [ 'task' => 'lorem ipsum', 'category' => 'miscellaneous', ]]); {% endhighlight %} * `param string` $uri * `param array` $params #### sendAjaxRequest Sends an ajax request, using the passed HTTP method. See `sendAjaxPostRequest()` Example: {% highlight php %} sendAjaxRequest('PUT', '/posts/7', ['title' => 'new title']); {% endhighlight %} * `param` $method * `param` $uri * `param` $params #### setCookie 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. {% highlight php %} setCookie('PHPSESSID', 'el4ukv0kqbvoirg7nkp4dncpk3'); ?>

{% endhighlight %}

param $name
param $val
param array $params

setServerParameters

Sets SERVER parameters valid for all next requests. this will remove old ones.

{% highlight php %}

$I->setServerParameters([]);

{% endhighlight %}

param array $params

submitForm

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:

{% highlight php %}

submitForm('#login', [ 'login' => 'davert', 'password' => '123456' ]); // or $I->submitForm('#login', [ 'login' => 'davert', 'password' => '123456' ], 'submitButtonName'); {% endhighlight %} For example, given this sample "Sign Up" form: {% highlight html %} Login:
Password:
Do you agree to our terms?
Select pricing plan: Free Paid {% endhighlight %} You could write the following to submit it: {% highlight php %} submitForm( '#userForm', [ 'user' => [ 'login' => 'Davert', 'password' => '123456', 'agree' => true ] ], 'submitButton' ); {% endhighlight %} 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. {% highlight php %} submitForm( '#userForm', [ 'user' => [ 'login' => 'Davert', 'password' => '123456', 'agree' => true ] ] ); {% endhighlight %} This function works well when paired with `seeInFormFields()` for quickly testing CRUD interfaces and form validation logic. {% highlight php %} '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); {% endhighlight %} 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. {% highlight php %} 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' ] ]); {% endhighlight %} 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: {% highlight php %} submitForm('#my-form', [ 'field[]' => 'value', 'field[]' => 'another value', // 'field[]' is already a defined key ]); {% endhighlight %} The solution is to pass an array value: {% highlight php %} submitForm('#my-form', [ 'field' => [ 'value', 'another value', ] ]); {% endhighlight %} * `param` $selector * `param` $params * `param` $button #### submitSymfonyForm 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. {% highlight php %} submitSymfonyForm('login_form', [ '[email]' => 'john_doe@gmail.com', '[password]' => 'secretForest' ]); {% endhighlight %} * `param string` $name * `param string[]` $fields #### switchToIframe Switch to iframe or frame on the page. Example: {% highlight html %} <iframe name="another_frame" src="http://example.com"> {% endhighlight %} {% highlight php %} switchToIframe("another_frame"); {% endhighlight %} * `param string` $name #### uncheckOption Unticks a checkbox. {% highlight php %} uncheckOption('#notify'); ?>

{% endhighlight %}

param $option

unpersistService

Remove service $serviceName from the lists of persistent services.

param string $serviceName

Module reference is taken from the source code. Help us to improve documentation. Edit module reference

FilesExpand file tree

Symfony.md

Latest commit

History

Symfony.md

File metadata and controls

Symfony

Installation

Description

Demo Project

Config

Symfony 5.x or 4.x

Example (functional.suite.yml) - Symfony 4 Directory Structure

Symfony 3.x

Example (functional.suite.yml) - Symfony 3 Directory Structure

Public Properties

Parts

Actions

_findElements

_loadPage

_request

_savePageSource

amHttpAuthenticated

amLoggedInAs

checkOption

click

deleteHeader

dontSee

dontSeeCookie

dontSeeCurrentUrlEquals

dontSeeCurrentUrlMatches

dontSeeElement

dontSeeEmailIsSent

dontSeeEventTriggered

dontSeeInField

dontSeeInFormFields

dontSeeInSession

Green eggs & ham

dontSeeOptionIsSelected

dontSeeRememberedAuthentication

grabAttributeFrom

grabCookie

grabFromCurrentUrl

grabMultiple

grabNumRecords

grabValueFrom

haveHttpHeader

haveServerParameter

invalidateCachedRouter

logout

seeCookie

seeCurrentActionIs

seeCurrentUrlMatches

seeElement

seeEmailIsSent

seeInField

seeInFormFields

seeInSession

Green eggs & ham

seeLink

seeNumRecords

seeOptionIsSelected

seePageIsAvailable

sendAjaxGetRequest

sendAjaxPostRequest

setServerParameters

submitForm

unpersistService

Example (`functional.suite.yml`) - Symfony 4 Directory Structure

Example (`functional.suite.yml`) - Symfony 3 Directory Structure