layout	title
doc	Yii2 - Codeception - Documentation

source master 2.12.0 1.8

This module provides integration with Yii framework (2.0).

Config

configFile required - the path to the application config file

The entry script must return the application configuration array.

You can use this module by setting params in your functional.suite.yml:

class_name: TestGuy
modules:
    enabled:
        - Yii2:
            configFile: '/path/to/config.php'

Parts

ORM - include only haveRecord/grabRecord/seeRecord/dontSeeRecord actions

Status

Maintainer: qiangxue Stability: stable

_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('Yii2')->_findElements('.items'); $els = $this->getModule('Yii2')->_findElements(['name' => 'username']); $editLinks = $this->getModule('Yii2')->_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 %} assertContains($text, $this->getModule('Yii2')->_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('Yii2')->_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('Yii2')->_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('Yii2')->_savePageSource(codecept_output_dir().'page.html');

{% endhighlight %}

param $filename

amHttpAuthenticated

Authenticates user for HTTP_AUTH

param $username
param $password

amOnPage

Converting $page to valid Yii 2 URL

Allows input like:

{% highlight php %}

$I->amOnPage(['site/view','page'=>'about']); $I->amOnPage('index-test.php?site/index'); $I->amOnPage('http://localhost/index-test.php?site/index');

{% endhighlight %}

param $page string|array parameter for \yii\web\UrlManager::createUrl()

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

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 {% 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` $text * `param null` $selector #### 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 $uri

dontSeeCurrentUrlMatches

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

{% highlight php %}

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

{% endhighlight %}

param $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

dontSeeInCurrentUrl

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

{% highlight php %}

dontSeeInCurrentUrl('/users/'); ?>

{% endhighlight %}

param $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

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 $text
param null $url

dontSeeOptionIsSelected

Checks that the given option is not selected.

{% highlight php %}

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

{% endhighlight %}

param $selector
param $optionText

dontSeeRecord

Checks that record does not exist in database.

{% highlight php %}

$I->dontSeeRecord('app\models\User', array('name' => 'davert'));

{% endhighlight %}

param $model
param array $attributes
[Part] orm

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

getInternalDomains

Returns a list of regex patterns for recognized domain names

return array

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.

param $cookie
param array $params

grabFromCurrentUrl

Executes the given regular expression against the current URI and returns the first match. If no parameters are provided, the full URI is returned.

{% highlight php %}

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

{% endhighlight %}

param null $uri

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[]

grabRecord

Retrieves record from database

{% highlight php %}

$category = $I->grabRecord('app\models\User', array('name' => 'davert'));

{% endhighlight %}

param $model
param array $attributes
[Part] orm

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

haveRecord

Inserts record into the database.

{% highlight php %}

haveRecord('app\models\User', array('name' => 'Davert')); ?>

{% endhighlight %}

param $model
param array $attributes
[Part] orm

moveBack

Moves back in history.

param int $numberOfSteps (default value 1)

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

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 {% 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` $text * `param null` $selector #### 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

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 $uri

seeCurrentUrlMatches

Checks that the current URL matches the given regular expression.

{% highlight php %}

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

{% endhighlight %}

param $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

seeInCurrentUrl

Checks that current URI contains the given string.

{% highlight php %}

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

{% endhighlight %}

param $uri

seeInField

Checks that the given input field or textarea contains the given value. For fuzzy locators, fields are matched by label text, the "name" attribute, CSS, and 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

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 $text
param null $url

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 :

string: strict number
array: range of numbers [0,10]

seeOptionIsSelected

Checks that the given option is selected.

{% highlight php %}

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

{% endhighlight %}

param $selector
param $optionText

seePageNotFound

Asserts that current page has 404 response status code.

seeRecord

Checks that record exists in database.

{% highlight php %}

$I->seeRecord('app\models\User', array('name' => 'davert'));

{% endhighlight %}

param $model
param array $attributes
[Part] orm

seeResponseCodeIs

Checks that response code is equal to value provided.

param $code

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 %}

param $select
param $option

sendAjaxGetRequest

If your page triggers an ajax request, you can perform it manually. This action sends a GET ajax request with specified params.

See ->sendAjaxPostRequest for examples.

param $uri
param $params

sendAjaxPostRequest

If your page triggers an ajax request, you can perform it manually. This action sends a POST ajax request with specified params. Additional params can be passed as array.

Example:

Imagine that by clicking checkbox you trigger ajax request which updates user settings. We emulate that click by running this ajax request manually.

{% highlight php %}

sendAjaxPostRequest('/updateSettings', array('notifications' => true)); // POST $I->sendAjaxGetRequest('/updateSettings', array('notifications' => true)); // GET {% endhighlight %} * `param` $uri * `param` $params #### sendAjaxRequest If your page triggers an ajax request, you can perform it manually. This action sends an ajax request with specified method and params. Example: You need to perform an ajax request specifying the HTTP method. {% highlight php %} sendAjaxRequest('PUT', '/posts/7', array('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

submitForm

Submits the given form on the page, optionally 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 #### 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

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

FilesExpand file tree

Yii2.md

Latest commit

History

Yii2.md

File metadata and controls

Config

Parts

Status

_findElements

_loadPage

_request

_savePageSource

amHttpAuthenticated

amOnPage

attachFile

checkOption

click

dontSee

dontSeeCookie

dontSeeCurrentUrlEquals

dontSeeCurrentUrlMatches

dontSeeElement

dontSeeInCurrentUrl

dontSeeInField

dontSeeInFormFields

dontSeeInSource

Green eggs & ham

dontSeeOptionIsSelected

dontSeeRecord

fillField

getInternalDomains

grabAttributeFrom

grabCookie

grabFromCurrentUrl

grabMultiple

grabRecord

grabTextFrom

grabValueFrom

haveRecord

moveBack

resetCookie

see

seeCookie

seeCurrentUrlEquals

seeCurrentUrlMatches

seeElement

seeInCurrentUrl

seeInField

seeInFormFields

seeInSource

Green eggs & ham

seeLink

seeNumberOfElements

seeOptionIsSelected

seePageNotFound

seeRecord

seeResponseCodeIs

selectOption

sendAjaxGetRequest

sendAjaxPostRequest

submitForm