layout	doc
title	AngularJS - Codeception - Documentation

source master 2.22.1 2.0 1.8

AngularJS

Module for AngularJS testing, based on WebDriver module and Protractor.

Performs synchronization to ensure that page content is fully rendered. Uses Angular's and Protractor internals methods to synchronize with the page.

Configurarion

The same as for WebDriver, but few new options added:

el - element where Angular application is defined (default: body)
script_timeout - for how long in seconds to wait for angular operations to finish (default: 5)

Example (`acceptance.suite.yml`)

modules:
   enabled:
      - AngularJS:
         url: 'http://localhost/'
         browser: firefox
         script_timeout: 10

Additional Features

Can perform matching elements by model. In this case you should provide a strict locator with model set.

Example:

{% highlight php %}

$I->selectOption(['model' => 'customerId'], '3');

{% endhighlight %}

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('AngularJS')->_findElements('.items'); $els = $this->getModule('AngularJS')->_findElements(['name' => 'username']); $editLinks = $this->getModule('AngularJS')->_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 #### _getCurrentUri *hidden API method, expected to be used from Helper classes* Uri of currently opened page. * `return` string * `throws` ModuleException #### _getUrl *hidden API method, expected to be used from Helper classes* Returns URL of a host. * `throws` ModuleConfigException #### _savePageSource *hidden API method, expected to be used from Helper classes* Saves HTML source of a page to a file * `param` $filename #### _saveScreenshot *hidden API method, expected to be used from Helper classes* Saves screenshot of current page to a file {% highlight php %} $this->getModule('AngularJS')->_saveScreenshot(codecept_output_dir().'screenshot_1.png'); {% endhighlight %} * `param` $filename #### acceptPopup Accepts the active JavaScript native popup window, as created by `window.alert`|`window.confirm`|`window.prompt`. Don't confuse popups with modal windows, as created by [various libraries](http://jster.net/category/windows-modals-popups). #### amInsideAngularApp Enables Angular mode (enabled by default). Waits for Angular to finish rendering after each action. #### amOnPage Opens the page for the given relative URI. {% highlight php %} amOnPage('/'); // opens /register page $I->amOnPage('/register'); {% endhighlight %} * `param` $page #### amOnSubdomain Changes the subdomain for the 'url' configuration parameter. Does not open a page; use `amOnPage` for that. {% highlight php %} amOnSubdomain('user'); $I->amOnPage('/'); // moves to http://user.mysite.com/ ?>

{% endhighlight %}

param $subdomain

amOnUrl

Open web page at the given absolute URL and sets its hostname as the base host.

{% highlight php %}

amOnUrl('http://codeception.com'); $I->amOnPage('/quickstart'); // moves to http://codeception.com/quickstart ?>

{% endhighlight %}

amOutsideAngularApp

Disabled Angular mode.

Falls back to original WebDriver, in case web page does not contain Angular app.

appendField

Append the given text to the given element. Can also add a selection to a select box.

{% highlight php %}

appendField('#mySelectbox', 'SelectValue'); $I->appendField('#myTextField', 'appended'); ?>

{% endhighlight %}

param string $field
param string $value
throws \Codeception\Exception\ElementNotFound

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

cancelPopup

Dismisses the active JavaScript popup, as created by window.alert|window.confirm|window.prompt.

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

clickWithRightButton

Performs contextual click with the right mouse button on an element.

param $cssOrXPath
throws \Codeception\Exception\ElementNotFound

debugWebDriverLogs

Print out latest Selenium Logs in debug mode

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

dontSeeElementInDOM

Opposite of seeElementInDOM.

param $selector

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

dontSeeInPageSource

Checks that the page source doesn't contain the given string.

param $text

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

doubleClick

Performs a double-click on an element matched by CSS or XPath.

param $cssOrXPath
throws \Codeception\Exception\ElementNotFound

dragAndDrop

Performs a simple mouse drag-and-drop operation.

{% highlight php %}

dragAndDrop('#drag', '#drop'); ?>

{% endhighlight %}

param string $source (CSS ID or XPath)
param string $target (CSS ID or XPath)

executeInSelenium

Low-level API method. If Codeception commands are not enough, this allows you to use Selenium WebDriver methods directly:

{% highlight php %}

$I->executeInSelenium(function(\Facebook\WebDriver\Remote\RemoteWebDriver $webdriver) { $webdriver->get('http://google.com'); });

{% endhighlight %}

This runs in the context of the RemoteWebDriver class. Try not to use this command on a regular basis. If Codeception lacks a feature you need, please implement it and submit a patch.

param callable $function

executeJS

Executes custom JavaScript.

This example uses jQuery to get a value and assigns that value to a PHP variable:

{% highlight php %}

executeJS('return $("#myField").val()'); ?>

{% endhighlight %}

param $script

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

getVisibleText

Grabs all visible text from the current page.

return string

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

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

Finds the value for the given form field. If a fuzzy locator is used, the field is found by field name, CSS, and XPath.

{% highlight php %}

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

{% endhighlight %}

param $field

loadSessionSnapshot

param string $name
return bool

makeScreenshot

Takes a screenshot of the current window and saves it to tests/_output/debug.

{% highlight php %}

amOnPage('/user/edit'); $I->makeScreenshot('edit_page'); // saved to: tests/_output/debug/edit_page.png ?>

{% endhighlight %}

param $name

maximizeWindow

Maximizes the current window.

moveBack

Moves back in history.

moveForward

Moves forward in history.

moveMouseOver

Move mouse over the first element matched by the given locator. If the second and third parameters are given, then the mouse is moved to an offset of the element's top-left corner. Otherwise, the mouse is moved to the center of the element.

{% highlight php %}

moveMouseOver(['css' => '.checkout'], 20, 50); ?>

{% endhighlight %}

param string $cssOrXPath css or xpath of the web element
param int $offsetX
param int $offsetY
throws \Codeception\Exception\ElementNotFound

pauseExecution

Pauses test execution in debug mode. To proceed test press "ENTER" in console.

This method is useful while writing tests, since it allows you to inspect the current page in the middle of a test case.

pressKey

Presses the given key on the given element. To specify a character and modifier (e.g. ctrl, alt, shift, meta), pass an array for $char with the modifier as the first element and the character as the second. For special keys use key constants from WebDriverKeys class.

{% highlight php %}

$I->pressKey('#page','a'); // => olda $I->pressKey('#page',array('ctrl','a'),'new'); //=> new $I->pressKey('#page',array('shift','111'),'1','x'); //=> old!!!1x $I->pressKey('descendant-or-self::*[ * `id='page']','u');` //=> oldu $I->pressKey('#name', array('ctrl', 'a'), \Facebook\WebDriver\WebDriverKeys::DELETE); //=>'' ?>

{% endhighlight %}

param $element
param $char Can be char or array with modifier. You can provide several chars.
throws \Codeception\Exception\ElementNotFound

reloadPage

Reloads the current page.

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

resizeWindow

Resize the current window.

{% highlight php %}

resizeWindow(800, 600); {% endhighlight %} * `param int` $width * `param int` $height #### saveSessionSnapshot * `param string` $name #### scrollTo Move to the middle of the given element matched by the given locator. Extra shift, calculated from the top-left corner of the element, can be set by passing $offsetX and $offsetY parameters. {% highlight php %} scrollTo(['css' => '.checkout'], 20, 50); ?>

{% endhighlight %}

param $selector
param int $offsetX
param int $offsetY

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

seeElementInDOM

Checks that the given element exists on the page, even it is invisible.

{% highlight php %}

seeElementInDOM('//form/input[type=hidden]'); ?>

{% endhighlight %}

param $selector

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

seeInPageSource

Checks that the page source contains the given string.

{% highlight php %}

seeInPageSource('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]

seeNumberOfElementsInDOM

not documented

seeOptionIsSelected

Checks that the given option is selected.

{% highlight php %}

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

{% endhighlight %}

param $selector
param $optionText

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

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. Give the form fields values as an array. Note that hidden fields can't be accessed.

Skipped fields will be filled by their values from the page. You don't need to click the 'Submit' button afterwards. This command itself triggers the request to form's action.

You can optionally specify what 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', 'user[password]' => '123456', 'user[agree]' => true ], 'submitButton' ); {% endhighlight %} Note that "2" will be the submitted value for the "plan" field, as it is the selected option. Also note that this differs from PhpBrowser, in that {% highlight yaml %} 'user' => [ 'login' => 'Davert' ] {% endhighlight %} is not supported at the moment. Named array keys *must* be included in the name as above. Pair this with seeInFormFields 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 %}

Parameter values must be set to arrays for multiple input fields of the same name, or multi-select combo boxes. For checkboxes, either the string value can be used, or boolean values 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 %}

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

// this way both values are submitted $I->submitForm('#my-form', [ 'field' => [ 'value', 'another value', ] ]);

{% endhighlight %}

param $selector
param $params
param $button

switchToIFrame

Switch to another frame on the page.

Example: {% highlight html %}

{% endhighlight %}

{% highlight php %}

switchToIFrame("another_frame"); # switch to parent page $I->switchToIFrame(); {% endhighlight %} * `param string|null` $name #### switchToWindow Switch to another window identified by name. The window can only be identified by name. If the $name parameter is blank, the parent window will be used. Example: {% highlight html %} {% endhighlight %} {% highlight php %} click("Open window"); # switch to another window $I->switchToWindow("another_window"); # switch to parent window $I->switchToWindow(); ?>

{% endhighlight %}

If the window has no name, the only way to access it is via the executeInSelenium() method, like so:

{% highlight php %}

executeInSelenium(function (\Facebook\WebDriver\Remote\RemoteWebDriver $webdriver) { $handles=$webdriver->getWindowHandles(); $last_window = end($handles); $webdriver->switchTo()->window($last_window); }); ?>

{% endhighlight %}

param string|null $name

typeInPopup

Enters text into a native JavaScript prompt popup, as created by window.prompt.

param $keys

uncheckOption

Unticks a checkbox.

{% highlight php %}

uncheckOption('#notify'); ?>

{% endhighlight %}

param $option

unselectOption

not documented

wait

Wait for $timeout seconds.

param int $timeout secs
throws \Codeception\Exception\TestRuntimeException

waitForElement

Waits up to $timeout seconds for an element to appear on the page. If the element doesn't appear, a timeout exception is thrown.

{% highlight php %}

waitForElement('#agree_button', 30); // secs $I->click('#agree_button'); ?>

{% endhighlight %}

param $element
param int $timeout seconds
throws \Exception

waitForElementChange

Waits up to $timeout seconds for the given element to change. Element "change" is determined by a callback function which is called repeatedly until the return value evaluates to true.

{% highlight php %}

waitForElementChange('#menu', function(WebDriverElement $el) { return $el->isDisplayed(); }, 100); ?>

{% endhighlight %}

param $element
param \Closure $callback
param int $timeout seconds
throws \Codeception\Exception\ElementNotFound

waitForElementNotVisible

Waits up to $timeout seconds for the given element to become invisible. If element stays visible, a timeout exception is thrown.

{% highlight php %}

waitForElementNotVisible('#agree_button', 30); // secs ?>

{% endhighlight %}

param $element
param int $timeout seconds
throws \Exception

waitForElementVisible

Waits up to $timeout seconds for the given element to be visible on the page. If element doesn't appear, a timeout exception is thrown.

{% highlight php %}

waitForElementVisible('#agree_button', 30); // secs $I->click('#agree_button'); ?>

{% endhighlight %}

param $element
param int $timeout seconds
throws \Exception

waitForJS

Executes JavaScript and waits up to $timeout seconds for it to return true.

In this example we will wait up to 60 seconds for all jQuery AJAX requests to finish.

{% highlight php %}

waitForJS("return $.active == 0;", 60); ?>

{% endhighlight %}

param string $script
param int $timeout seconds

waitForText

Waits up to $timeout seconds for the given string to appear on the page. Can also be passed a selector to search in. If the given text doesn't appear, a timeout exception is thrown.

{% highlight php %}

waitForText('foo', 30); // secs $I->waitForText('foo', 30, '.title'); // secs ?>

{% endhighlight %}

param string $text
param int $timeout seconds
param null $selector
throws \Exception

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

FilesExpand file tree

AngularJS.md

Latest commit

History

AngularJS.md

File metadata and controls

AngularJS

Configurarion

Example (acceptance.suite.yml)

Additional Features

Actions

_findElements

amOnUrl

amOutsideAngularApp

appendField

attachFile

cancelPopup

checkOption

click

clickWithRightButton

debugWebDriverLogs

dontSee

dontSeeCookie

dontSeeCurrentUrlEquals

dontSeeCurrentUrlMatches

dontSeeElement

dontSeeElementInDOM

dontSeeInCurrentUrl

dontSeeInField

dontSeeInFormFields

dontSeeInPageSource

dontSeeInSource

Green eggs & ham

dontSeeOptionIsSelected

doubleClick

dragAndDrop

executeInSelenium

executeJS

fillField

getVisibleText

grabAttributeFrom

grabCookie

grabFromCurrentUrl

grabMultiple

grabTextFrom

grabValueFrom

loadSessionSnapshot

makeScreenshot

maximizeWindow

moveBack

moveForward

moveMouseOver

pauseExecution

pressKey

reloadPage

resetCookie

resizeWindow

see

seeCookie

seeCurrentUrlEquals

seeCurrentUrlMatches

seeElement

seeElementInDOM

seeInCurrentUrl

seeInField

seeInFormFields

seeInPageSource

Green eggs & ham

seeLink

seeNumberOfElements

seeNumberOfElementsInDOM

seeOptionIsSelected

selectOption

setCookie

submitForm

switchToIFrame

typeInPopup

uncheckOption

unselectOption

wait

Example (`acceptance.suite.yml`)