For additional reference, please review the source

New generation Selenium WebDriver module.

Download Selenium Server Launch the daemon: java -jar selenium-server-standalone-2.xx.xxx.jar

PhantomJS is headless alternative to Selenium Server.

• Download PhantomJS
• Run PhantomJS in webdriver mode phantomjs --webdriver=4444

• Maintainer: davert
• Stability: stable
• Contact: davert.codecept@mailican.com
• Based on facebook php-webdriver

• url required - start url for your app
• browser required - browser that would be launched
• host - Selenium server host (127.0.0.1 by default)
• port - Selenium server port (4444 by default)
• restart - set to false (default) to share browser sesssion between tests, or set to true to create a session per test
• window_size - initial window size. Values maximize or dimensions in format 640x480 are accepted.
• clear_cookies - set to false to keep cookies, or set to true (default) to delete all cookies between cases.
• wait - set the implicit wait (0 secs) by default.
• capabilities - sets Selenium2 desired capabilities. Should be a key-value array.

modules:
   enabled: [WebDriver]
   config:
      WebDriver:
         url: 'http://localhost/'
         browser: firefox
         window_size: 1024x768
         wait: 10
         capabilities:
             unexpectedAlertBehaviour: 'accept'

• wait method accepts seconds instead of milliseconds. All waits use second as parameter.

Accepts JavaScript native popup window created by window.alert|window.confirm|window.prompt. Don't confuse it with modal windows, created by various libraries.

Opens the page. Requires relative uri as parameter

Example:

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

• param $page

Sets 'url' configuration parameter to hosts subdomain. It does not open a page on subdomain. Use amOnPage for that

<?php
// If config is: 'http://mysite.com'
// or config is: 'http://www.mysite.com'
// or config is: 'http://company.mysite.com'

$I->amOnSubdomain('user');
$I->amOnPage('/');
// moves to http://user.mysite.com/
?>

• param $subdomain

Append text to an element Can add another selection to a select box

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

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

Attaches file from Codeception data directory to upload field.

Example:

<?php
// file is stored in 'tests/_data/prices.xls'
$I->attachFile('input[@type="file"]', 'prices.xls');
?>

• param $field
• param $filename

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

Ticks a checkbox. For radio buttons use selectOption method.

Example:

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

• param $option

Perform a click on link or button. Link or button are found by their names or CSS selector. Submits a form if button is a submit type.

If link is an image it's found by alt attribute value of image. If button is image button is found by it's value If link or button can't be found by name they are searched by CSS selector.

The second parameter is a context: CSS or XPath locator to narrow the search.

Examples:

<?php
// simple link
$I->click('Logout');
// button of form
$I->click('Submit');
// CSS button
$I->click('#form input[type=submit]');
// XPath
$I->click('//form/*[@type=submit]');
// link in context
$I->click('Logout', '#nav');
// using strict locator
$I->click(['link' => 'Login']);
?>

• param $link
• param $context

Performs contextual click with right mouse button on element matched by CSS or XPath.

• param $cssOrXPath \Codeception\Exception\ElementNotFound

Check if current page doesn't contain the text specified. Specify the css selector to match only specific region.

Examples:

<?php
$I->dontSee('Login'); // I can suppose user is already logged in
$I->dontSee('Sign Up','h1'); // I can suppose it's not a signup page
$I->dontSee('Sign Up','//body/h1'); // with XPath
?>

• param $text
• param null $selector

Assert if the specified checkbox is unchecked. Use css selector or xpath to match.

Example:

<?php
$I->dontSeeCheckboxIsChecked('#agree'); // I suppose user didn't agree to terms
$I->seeCheckboxIsChecked('#signup_form input[type=checkbox]'); // I suppose user didn't check the first checkbox in form.
?>

• param $checkbox

Checks that cookie doesn't exist

• param $cookie

Checks that current url is not equal to value. Unlike dontSeeInCurrentUrl performs a strict check.

<?php
// current url is not root
$I->dontSeeCurrentUrlEquals('/');
?>

• param $uri

Checks that current url does not match a RegEx value

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

• param $uri

Checks that element is invisible or not present on page.

<?php
$I->dontSeeElement('.error');
$I->dontSeeElement('//form/input[1]');
?>

• param $selector
• param array $attributes

Opposite to seeElementInDOM.

• param $selector

Checks that current uri does not contain a value

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

• param $uri

Checks that an input field or textarea doesn't contain value. Field is matched either by label or CSS or Xpath Example:

<?php
$I->dontSeeInField('Body','Type your comment here');
$I->dontSeeInField('form textarea[name=body]','Type your comment here');
$I->dontSeeInField('form input[type=hidden]','hidden_value');
$I->dontSeeInField('#searchform input','Search');
$I->dontSeeInField('//form/*[@name=search]','Search');
$I->seeInField(['name' => 'search'], 'Search');
?>

• param $field
• param $value

Checks that page source does not contain text.

• param $text

Checks that page title does not contain text.

• param $title

Checks if page doesn't contain the link with text specified. Specify url to narrow the results.

Examples:

<?php
$I->dontSeeLink('Logout'); // I suppose user is not logged in
?>

• param $text
• param null $url

Checks if option is not selected in select field.

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

• param $selector
• param $optionText

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

• param $cssOrXPath \Codeception\Exception\ElementNotFound

Performs a simple mouse drag and drop operation.

<?php
$I->dragAndDrop('#drag', '#drop');
?>

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

Low-level API method. If Codeception commands are not enough, use Selenium WebDriver methods directly

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

Use WebDriver Session API Not recommended this command too be used on regular basis. If Codeception lacks important Selenium methods implement then and submit patches.

• param callable $function

Executes custom JavaScript

In this example we will use jQuery to get a value and assign this value to a variable.

<?php
$myVar = $I->executeJS('return $("#myField").val()');
?>

• param $script

Fills a text field or textarea with value.

Example:

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

• param $field
• param $value

@return string

Grabs attribute value from an element. Fails if element is not found.

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

• param $cssOrXpath
• param $attribute
• internal param $element

Grabs a cookie value.

• param $cookie

Takes a parameters from current URI by RegEx. If no url provided returns full URI.

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

• param null $uri

• internal param $url

Finds and returns text contents of element. Element is searched by CSS selector, XPath or matcher by regex.

Example:

<?php
$heading = $I->grabTextFrom('h1');
$heading = $I->grabTextFrom('descendant-or-self::h1');
$value = $I->grabTextFrom('~<input value=(.*?)]~sgi');
?>

• param $cssOrXPathOrRegex

Finds and returns field and returns it's value. Searches by field name, then by CSS, then by XPath

Example:

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

• param $field

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

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

• param $name

Maximizes current window

Moves back in history

Moves forward in history

Move mouse over the first element matched by css or xPath on page

https://code.google.com/p/selenium/wiki/JsonWireProtocol#/session/:sessionId/moveto

• param string $cssOrXPath css or xpath of the web element
• param int $offsetX
• param int $offsetY

\Codeception\Exception\ElementNotFound @return null

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

This method is recommended to use in test development, for additional page analysis, locator searing, etc.

Presses key on element found by css, xpath is focused A char and modifier (ctrl, alt, shift, meta) can be provided. For special keys use key constants from \WebDriverKeys class.

Example:

<?php
// <input id="page" value="old" />
$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'), WebDriverKeys::DELETE); //=>''
?>

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

Reloads current page

Unsets cookie

• param $cookie

Resize current window

Example:

<?php
$I->resizeWindow(800, 600);

• param int $width
• param int $height

Check if current page contains the text specified. Specify the css selector to match only specific region.

Examples:

<?php
$I->see('Logout'); // I can suppose user is logged in
$I->see('Sign Up','h1'); // I can suppose it's a signup page
$I->see('Sign Up','//body/h1'); // with XPath
?>

• param $text
• param null $selector

Assert if the specified checkbox is checked. Use css selector or xpath to match.

Example:

<?php
$I->seeCheckboxIsChecked('#agree'); // I suppose user agreed to terms
$I->seeCheckboxIsChecked('#signup_form input[type=checkbox]'); // I suppose user agreed to terms, If there is only one checkbox in form.
$I->seeCheckboxIsChecked('//form/input[@type=checkbox and @name=agree]');
?>

• param $checkbox

Checks that cookie is set.

• param $cookie

Checks that current url is equal to value. Unlike seeInCurrentUrl performs a strict check.

<?php
// to match root url
$I->seeCurrentUrlEquals('/');
?>

• param $uri

Checks that current url is matches a RegEx value

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

• param $uri

Checks for a visible element on a page, matching it by CSS or XPath

<?php
$I->seeElement('.error');
$I->seeElement('//form/input[1]');
?>

• param $selector
• param array $attributes

Checks if element exists on a page even it is invisible.

<?php
$I->seeElementInDOM('//form/input[type=hidden]');
?>

• param $selector

Checks that current uri contains a value

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

• param $uri

Checks that an input field or textarea contains value. Field is matched either by label or CSS or Xpath

Example:

<?php
$I->seeInField('Body','Type your comment here');
$I->seeInField('form textarea[name=body]','Type your comment here');
$I->seeInField('form input[type=hidden]','hidden_value');
$I->seeInField('#searchform input','Search');
$I->seeInField('//form/*[@name=search]','Search');
$I->seeInField(['name' => 'search'], 'Search');
?>

• param $field
• param $value

Checks that page source contains text.

<?php
$I->seeInPageSource('<link rel="apple-touch-icon"');

• param $text

Checks that active JavaScript popup created by window.alert|window.confirm|window.prompt contain text.

• param $text

Checks that page title contains text.

<?php
$I->seeInTitle('Blog - Post #1');
?>

• param $title

Checks if there is a link with text specified. Specify url to match link with exact this url.

Examples:

<?php
$I->seeLink('Logout'); // matches <a href="#">Logout</a>
$I->seeLink('Logout','/logout'); // matches <a href="https://github.com/logout">Logout</a>
?>

• param $text
• param null $url

Tests number of $elements on page

<?php
$I->seeNumberOfElements('tr', 10);
$I->seeNumberOfElements('tr', [0,10]); //between 0 and 10 elements
?>

• param $selector
• param mixed $expected:

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

Checks if option is selected in select field.

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

• param $selector
• param $optionText

Selects an option in select tag or in radio button group.

Example:

<?php
$I->selectOption('form select[name=account]', 'Premium');
$I->selectOption('form input[name=payment]', 'Monthly');
$I->selectOption('//form/select[@name=account]', 'Monthly');
?>

Can select multiple options if second argument is array:

<?php
$I->selectOption('Which OS do you use?', array('Windows','Linux'));
?>

• param $select
• param $option

Sets a cookie.

• param $cookie
• param $value

Submits a form located on page. Specify the form by it's css or xpath selector. Fill the form fields values as array. Hidden fields can't be accessed.

This command itself triggers the request to form's action.

Examples:

<?php
$I->submitForm('#login', array('login' => 'davert', 'password' => '123456'));

For sample Sign Up form:

<form action="/sign_up">
    Login: <input type="text" name="user[login]" /><br/>
    Password: <input type="password" name="user[password]" /><br/>
    Do you agree to out terms? <input type="checkbox" name="user[agree]" /><br/>
    Select pricing plan <select name="plan"><option value="1">Free</option><option value="2" selected="selected">Paid</option></select>
    <input type="submit" value="Submit" />
</form>

You can write this:

<?php
$I->submitForm('#userForm', array('user' => array('login' => 'Davert', 'password' => '123456', 'agree' => true)));

• param $selector
• param $params \Codeception\Exception\ElementNotFound

Switch to another frame

Example:

<iframe name="another_frame" src="http://example.com">

<?php
# switch to iframe
$I->switchToIFrame("another_frame");
# switch to parent page
$I->switchToIFrame();

• param string|null $name

Switch to another window identified by its name.

The window can only be identified by its name. If the $name parameter is blank it will switch to the parent window.

Example:

<input type="button" value="Open window" onclick="window.open('http://example.com', 'another_window')">

<?php
$I->click("Open window");
# switch to another window
$I->switchToWindow("another_window");
# switch to parent window
$I->switchToWindow();
?>

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

<?php
$I->executeInSelenium(function (\Webdriver $webdriver) {
     $handles=$webdriver->getWindowHandles();
     $last_window = end($handles);
     $webdriver->switchTo()->window($last_window);
});
?>

• param string|null $name

Enters text into native JavaScript prompt popup created by window.prompt.

• param $keys

Unticks a checkbox.

Example:

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

• param $option

not documented

Explicit wait.

• param int $timeout secs \Codeception\Exception\TestRuntime

Waits for element to appear on page for $timeout seconds to pass. If element not appears, timeout exception is thrown.

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

• param $element
• param int $timeout seconds \Exception

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

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

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

Waits for element to not be visible on the page for $timeout seconds to pass. If element stays visible, timeout exception is thrown.

<?php
$I->waitForElementNotVisible('#agree_button', 30); // secs
?>

• param $element
• param int $timeout seconds \Exception

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

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

• param $element
• param int $timeout seconds \Exception

Executes JavaScript and waits for it to return true or for the timeout.

In this example we will wait for all jQuery ajax requests are finished or 60 secs otherwise.

<?php
$I->waitForJS("return $.active == 0;", 60);
?>

• param string $script
• param int $timeout seconds

Waits for text to appear on the page for a specific amount of time. Can also be passed a selector to search in. If text does not appear, timeout exception is thrown.

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

• param string $text
• param int $timeout seconds
• param null $selector \Exception
• internal param string $element