Skip to content

Symfony2.markdown

Latest commit

 

History

History
508 lines (283 loc) · 8.59 KB

Symfony2.markdown

File metadata and controls

508 lines (283 loc) · 8.59 KB
layout doc
title Codeception - Documentation

Symfony2 Module

This module uses Symfony2 Crawler and HttpKernel to emulate requests and get response.

It implements common Framework interface.

Config

  • app_path: 'app' - specify custom path to your app dir, where bootstrap cache and kernel interface is located.

Public Properties

  • kernel - HttpKernel instance
  • client - current Crawler instance

Actions

amHttpAuthenticated

Authenticates user for HTTP_AUTH

  • param $username
  • param $password

amOnPage

Opens the page. Requires relative uri as parameter

Example:

{% highlight php %}

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

{% endhighlight %}

  • param $page

attachFile

Attaches file from Codeception data directory to upload field.

Example:

{% highlight php %}

attachFile('prices.xls'); ?>

{% endhighlight %}

  • param $field
  • param $filename

checkOption

Ticks a checkbox. For radio buttons use selectOption method.

Example:

{% highlight php %}

checkOption('#agree'); ?>

{% endhighlight %}

  • param $option

click

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.

Examples:

{% highlight php %}

click('Logout'); // button of form $I->click('Submit'); // CSS button $I->click('#form input[type=submit]'); // XPath $I->click('//form/*[@type=submit]') ?>

{% endhighlight %}

  • param $link

dontSee

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

Examples:

{% 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 %} * param $text * param null $selector #### dontSeeCheckboxIsChecked Assert if the specified checkbox is unchecked. Use css selector or xpath to match. Example: {% 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 #### dontSeeInField Checks that an input field or textarea doesn't contain value. Example: {% highlight php %} 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'); ?>

{% endhighlight %}

  • param $field
  • param $value

dontSeeLink

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

Examples:

{% highlight php %}

dontSeeLink('Logout'); // I suppose user is not logged in {% endhighlight %} * param $text * param null $url #### fillField Fills a text field or textarea with value. * param $field * param $value #### formatResponse __not documented__ #### grabServiceFromContainer Grabs a service from Symfony DIC container. Recommended to use for unit testing. {% highlight php %} grabServiceFromContainer('doctrine'); ?>

{% endhighlight %}

  • param $service
  • return mixed

grabTextFrom

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

Example:

{% highlight php %}

grabTextFrom('h1'); $heading = $I->grabTextFrom('descendant-or-self::h1'); $value = $I->grabTextFrom('~

{% endhighlight %}

  • param $cssOrXPathOrRegex
  • return mixed

grabValueFrom

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

Example:

{% highlight php %}

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

{% endhighlight %}

  • param $field
  • return mixed

see

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

Examples:

{% 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 %} * param $text * param null $selector #### seeCheckboxIsChecked Assert if the specified checkbox is checked. Use css selector or xpath to match. Example: {% 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 #### seeEmailIsSent Checks if any email were sent by last request * throws \LogicException #### seeInCurrentUrl Checks that current uri contains value * param $uri #### seeInField Checks that an input field or textarea contains value. Example: {% highlight php %} 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'); ?>

{% endhighlight %}

  • param $field
  • param $value

seeLink

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

Examples:

{% highlight php %}

seeLink('Logout'); // matches Logout $I->seeLink('Logout','/logout'); // matches Logout {% endhighlight %} * param $text * param null $url #### selectOption Selects an option in select tag or in radio button group. Example: {% highlight php %} selectOption('form select[name=account]', 'Premium'); $I->selectOption('form input[name=payment]', 'Monthly'); $I->selectOption('//form/select[@name=account]', 'Monthly'); ?>

{% 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 #### submitForm Submits a form located on page. Specify the form by it's css or xpath selector. Fill the form fields values as array. Skipped fields will be filled by their values from page. You don't need to click the 'Submit' button afterwards. This command itself triggers the request to form's action. Examples: {% highlight php %} submitForm('#login', array('login' => 'davert', 'password' => '123456')); {% endhighlight %} For sample Sign Up form: {% highlight html %} Login:
Password:
Do you agree to out terms?
Select pricing plan FreePaid {% endhighlight %} I can write this: {% highlight php %} submitForm('#userForm', array('user' => array('login' => 'Davert', 'password' => '123456', 'agree' => true))); {% endhighlight %} Note, that pricing plan will be set to Paid, as it's selected on page. * param $selector * param $params #### uncheckOption Unticks a checkbox. Example: {% highlight php %} uncheckOption('#notify'); ?>

{% endhighlight %}

  • param $option