Test actions in the Magento Functional Testing Framework

This topic was updated due to the 2.0.2 MFTF release.

This topic contains a reference list of available action type tags available in the MFTF tests.

Overview

Actions in the MFTF allow you to automate different scenarios of Magento user’s actions. They are mostly XML implementations of Codeception actions. Some actions drive browser elements, while others use REST APIs.

Common attributes

All actions contain the following attributes that are useful for merging needs.

stepKey

stepKey is a required attribute that stores a unique identifier of the action.

Example:

<myAction stepKey="conditionalClickStep1"/>

myAction has identifier, which is conditionalClickStep1. This step can be referenced within the test using this identifier.

before and after

before and after are optional attributes that insert the action into the test while merging. The action will be executed before or after the one set in these attributes. The value here is stepKey of reference action.

Example with before:

<myAction before="fillField" stepKey="conditionalClickStep1"/>

myAction will be executed before the action, which has stepKey="fillField".

Example with after:

<myAction after="fillField" stepKey="seeResult"/>

myAction will be executed after the action, which has stepKey="fillField".

Principles

stepKey value format principles:

  • Must be unique within <test>
  • Naming should be as descriptive as possible
    • Should describe the action performed
    • Should briefly describe the purpose
    • May describe which data is in use
  • Should be in camelCase with lowercase first letter
  • Should be the last attribute of an element

Example

The following example contains four actions:

  1. Open the Sign In page for a Customer
  2. Enter customer’s e-mail
  3. Enter customer’s password
  4. Click the Sign In button
<amOnPage url="{{StorefrontCustomerSignInPage}}" stepKey="amOnSignInPage"/>
<fillField  userInput="$$customer.email$$" selector="{{StorefrontCustomerSignInFormSection.emailField}} stepKey="fillEmail"/>
<fillField  userInput="$$customer.password$$" selector="{{StorefrontCustomerSignInFormSection.passwordField}}" stepKey="fillPassword"/>
<click selector="{{StorefrontCustomerSignInFormSection.signInAccountButton}}" stepKey="clickSignInAccountButton"/>

1. Open the Sign In page for a Customer

<amOnPage url="{{StorefrontCustomerSignInPage.url}}" stepKey="amOnSignInPage"/>

The Customer Sign In page is declared in the …/Customer/Page/StorefrontCustomerSignInPage.xml. The given relative URI is declared in StorefrontCustomerSignInPage.url

The StorefrontCustomerSignInPage.xml source code:

<config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
        xsi:noNamespaceSchemaLocation="../../../../../../vendor/magento/magento2-functional-testing-framework/src/Magento/FunctionalTestingFramework/Page/etc/PageObject.xsd">
    <page name="StorefrontCustomerSignInPage" url="/customer/account/login/" module="Magento_Customer">
        <section name="StorefrontCustomerSignInFormSection" />
    </page>
</config>

amOnPage is an action that opens a page for a given URI. It has a key "amOnSignInPage" that will be used as a reference for merging needs in other modules. This action uses value of the url attribute for the given relative URI to open in browser. Here, url contains a pointer to a url attribute of the StorefrontCustomerSignInPage.

2. Enter customer’s e-mail

<fillField  userInput="$$customer.email$$" selector="{{StorefrontCustomerSignInFormSection.emailField}}" stepKey="fillEmail"/>

fillField fills a text field with the given string.

The customer’s e-mail is stored in the email parameter of the customer entity created somewhere earlier it the test using a tag createData. userInput points to that data.

selector points to the field where to enter the data. A required selector is stored in the emailField element of the StorefrontCustomerSignInFormSection section.

This section is declared in …/Customer/Section/StorefrontCustomerSignInFormSection.xml:

<config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
        xsi:noNamespaceSchemaLocation="../../../../../../vendor/magento/magento2-functional-testing-framework/src/Magento/FunctionalTestingFramework/Page/etc/SectionObject.xsd">
    <section name="StorefrontCustomerSignInFormSection">
        <element name="emailField" type="input" selector="#email"/>
        <element name="passwordField" type="input" selector="#pass"/>
        <element name="signInAccountButton" type="button" selector="#send2" timeout="30"/>
    </section>
</config>

3. Enter customer’s password

<fillField  userInput="$$customer.password$$" selector="{{StorefrontCustomerSignInFormSection.passwordField}}" stepKey="fillPassword"/>

The action here is very similar to the action in a previous step. The only difference is that different data assigned to the attributes which set a field with password.

4. Click the Sign In button

<click selector="{{StorefrontCustomerSignInFormSection.signInAccountButton}}" stepKey="clickSignInAccountButton"/>

Here, click performs a click on a button that can be found by selector that is stored in the signInAccountButton of the StorefrontCustomerSignInFormSection. See the StorefrontCustomerSignInPage.xml code in step 2

Actions returning a variable

The following test actions return a variable:

Learn more in Using data returned by test actions.

Reference

The following list contains reference documentation about all action elements available in the MFTF. If description of an element does not include a link to Codeception analogue, it means that the action is developed by Magento for specific MFTF needs.

acceptPopup

See acceptPopup docs on codeception.com

Attribute Type Use Description
stepKey string required A unique identifier of the action.
before string optional stepKey of action that must be executed next.
after string optional stepKey of preceding action.

amOnPage

See amOnPage docs on codeception.com

Attribute Type Use Description
url string optional  
stepKey string required A unique identifier of the action.
before string optional stepKey of action that must be executed next.
after string optional stepKey of preceding action.

amOnSubdomain

See amOnSubdomain docs on codeception.com

Attribute Type Use Description
url string optional  
stepKey string required A unique identifier of the action.
before string optional stepKey of action that must be executed next.
after string optional stepKey of preceding action.

amOnUrl

See amOnUrl docs on codeception.com

Attribute Type Use Description
url string optional  
stepKey string required A unique identifier of the action.
before string optional stepKey of action that must be executed next.
after string optional stepKey of preceding action.

appendField

See appendField docs on codeception.com

Attribute Type Use Description
selector string optional  
userInput string optional  
stepKey string required A unique identifier of the action.
before string optional stepKey of action that must be executed next.
after string optional stepKey of preceding action.

attachFile

See attachFile docs on codeception.com

Attribute Type Use Description
selector string optional  
userInput string optional  
stepKey string required A unique identifier of the action.
before string optional stepKey of action that must be executed next.
after string optional stepKey of preceding action.

cancelPopup

See cancelPopup docs on codeception.com

Attribute Type Use Description
stepKey string required A unique identifier of the action.
before string optional stepKey of action that must be executed next.
after string optional stepKey of preceding action.

checkOption

See checkOption docs on codeception.com

Attribute Type Use Description
selector string optional  
stepKey string required A unique identifier of the action.
before string optional stepKey of action that must be executed next.
after string optional stepKey of preceding action.

clearField

Clears a text input field. Equivalent to using fillField with an empty string.

Attribute Type Use Description
selector string required  
stepKey string required A unique identifier of the action.
before string optional stepKey of action that must be executed next.
after string optional stepKey of preceding action.

click

See click docs on codeception.com

Attribute Type Use Description
selector string optional  
selectorArray string optional  
userInput string optional  
stepKey string required A unique identifier of the action.
before string optional stepKey of action that must be executed next.
after string optional stepKey of preceding action.

clickWithLeftButton

See clickWithLeftButton docs on codeception.com

Attribute Type Use Description
selector string optional  
selectorArray string optional  
x string optional  
y string optional  
stepKey string required A unique identifier of the action.
before string optional stepKey of action that must be executed next.
after string optional stepKey of preceding action.

clickWithRightButton

See clickWithRightButton docs on codeception.com

Attribute Type Use Description
selector string optional  
selectorArray string optional  
x string optional  
y string optional  
stepKey string required A unique identifier of the action.
before string optional stepKey of action that must be executed next.
after string optional stepKey of preceding action.

closeAdminNotification

Remove from the DOM all elements with the CSS classes .modal-popup or .modals-overlay

Attribute Type Use Description
stepKey string required A unique identifier of the action.
before string optional stepKey of action that must be executed next.
after string optional stepKey of preceding action.

closeTab

See closeTab docs on codeception.com

Attribute Type Use Description
stepKey string required A unique identifier of the action.
before string optional stepKey of action that must be executed next.
after string optional stepKey of preceding action.

comment

Allows input of a string as a PHP code comment. This tag is not executed. It is intended to aid documentation and clarity of tests.

Attribute Type Use Description
userInput string required PHP comment that will be written in generated test file.
stepKey string required A unique identifier of the action.
before string optional stepKey of action that must be executed next.
after string optional stepKey of preceding action.

conditionalClick

Conditionally click on an element if and only if another element is visible or not.

For example, to click on #foo if #bar is visible:

<conditionalClick selector="#foo" dependentSelector="#bar" visible="true" stepKey="click1"/>
Attribute Type Use Description
selector string optional  
dependentSelector string optional  
visible boolean optional  
stepKey string required A unique identifier of the action.
before string optional stepKey of action that must be executed next.
after string optional stepKey of preceding action.

createData

Create an entity (e.g. a category or product). In other words, make a POST request to the Magento API according to the data and metadata of the entity to be created.

For example, you can create the entity with the name “SampleProduct”:

<createData entity="SampleProduct" stepKey="createSampleProduct"/>
Attribute Type Use Description
entity string required  
stepKey string required  
before string optional stepKey of action that must be executed next.
after string optional stepKey of preceding action.
storeCode string optional  

This action can optionally contain one or more requiredEntity child elements.

requiredEntity

Specify relationships amongst data to be created. For example, a complex Product object may contain within it a pointer (an ID) to a complex Category object.

For example, first we create a category, then we create a product in that category by indicating the relationship.

<createData entity="SampleCategory" stepKey="createCategory"/>

<createData entity="SampleProduct" stepKey="createProduct">
    <requiredEntity createDataKey="createCategory"/>
</createData>
Attribute Type Use Description
createDataKey string required  
before string optional stepKey of action that must be executed next.
after string optional stepKey of preceding action.

deleteData

Delete an entity that was previously created.

It’s important to note that this action is only able to delete entities that were previously created using createData in the scope of the test.

Assuming we created SampleCategory like:

<createData entity="SampleCategory" stepKey="createCategory"/>

We can delete SampleCategory like:

<deleteData createDataKey="createCategory" stepKey="deleteCategory"/>
Attribute Type Use Description
createDataKey string optional  
stepKey string required A unique identifier of the action.
before string optional stepKey of action that must be executed next.
after string optional stepKey of preceding action.
storeCode string optional  

dontSee

See the codeception.com documentation for more information about this action.

Attribute Type Use Description
userInput string optional  
selector string optional  
selectorArray string optional  
stepKey string required A unique identifier of the action.
before string optional stepKey of action that must be executed next.
after string optional stepKey of preceding action.

dontSeeCheckboxIsChecked

See dontSeeCheckboxIsChecked docs on codeception.com

Attribute Type Use Description
selector string optional  
stepKey string required A unique identifier of the action.
before string optional stepKey of action that must be executed next.
after string optional stepKey of preceding action.

dontSeeCookie

See dontSeeCookie docs on codeception.com

Attribute Type Use Description
userInput string optional  
parameterArray string optional  
stepKey string required A unique identifier of the action.
before string optional stepKey of action that must be executed next.
after string optional stepKey of preceding action.

dontSeeCurrentUrlEquals

See dontSeeCurrentUrlEquals docs on codeception.com

Attribute Type Use Description
url string optional  
stepKey string required A unique identifier of the action.
before string optional stepKey of action that must be executed next.
after string optional stepKey of preceding action.

dontSeeCurrentUrlMatches

See dontSeeCurrentUrlMatches docs on codeception.com

Attribute Type Use Description
regex string optional Regular expression against the current URI.
stepKey string required A unique identifier of the action.
before string optional stepKey of action that must be executed next.
after string optional stepKey of preceding action.

dontSeeElement

See dontSeeElement docs on codeception.com

Attribute Type Use Description
selector string optional  
parameterArray string optional  
stepKey string required A unique identifier of the action.
before string optional stepKey of action that must be executed next.
after string optional stepKey of preceding action.

dontSeeElementInDOM

See dontSeeElementInDOM docs on codeception.com

Attribute Type Use Description
selector string optional  
parameterArray string optional  
attributeArray string optional  
stepKey string required A unique identifier of the action.
before string optional stepKey of action that must be executed next.
after string optional stepKey of preceding action.

dontSeeInCurrentUrl

See dontSeeInCurrentUrl docs on codeception.com

Attribute Type Use Description
url string optional  
stepKey string required A unique identifier of the action.
before string optional stepKey of action that must be executed next.
after string optional stepKey of preceding action.

dontSeeInField

See dontSeeInField docs on codeception.com

Attribute Type Use Description
selector string optional  
selectorArray string optional  
userInput string optional  
stepKey string required A unique identifier of the action.
before string optional stepKey of action that must be executed next.
after string optional stepKey of preceding action.

dontSeeInFormFields

See dontSeeInFormFields docs on codeception.com

Attribute Type Use Description
selector string optional  
parameterArray string optional  
stepKey string required A unique identifier of the action.
before string optional stepKey of action that must be executed next.
after string optional stepKey of preceding action.

dontSeeInPageSource

See dontSeeInPageSource docs on codeception.com

Attribute Type Use Description
userInput string optional  
stepKey string required A unique identifier of the action.
before string optional stepKey of action that must be executed next.
after string optional stepKey of preceding action.

dontSeeInSource

See dontSeeInSource docs on codeception.com

Attribute Type Use Description
html string optional  
stepKey string required A unique identifier of the action.
before string optional stepKey of action that must be executed next.
after string optional stepKey of preceding action.

dontSeeInTitle

See dontSeeInTitle docs on codeception.com

Attribute Type Use Description
userInput string optional  
stepKey string required A unique identifier of the action.
before string optional stepKey of action that must be executed next.
after string optional stepKey of preceding action.

dontSeeJsError

Assert that there are no Javascript errors.

Attribute Type Use Description
stepKey string required A unique identifier of the action.
before string optional stepKey of action that must be executed next.
after string optional stepKey of preceding action.

See dontSeeLink docs on codeception.com

Attribute Type Use Description
userInput string optional  
url string optional  
stepKey string required A unique identifier of the action.
before string optional stepKey of action that must be executed next.
after string optional stepKey of preceding action.

dontSeeOptionIsSelected

See dontSeeOptionIsSelected docs on codeception.com

Attribute Type Use Description
selector string optional  
userInput string optional  
stepKey string required A unique identifier of the action.
before string optional stepKey of action that must be executed next.
after string optional stepKey of preceding action.

doubleClick

See doubleClick docs on codeception.com

Attribute Type Use Description
selector string optional  
stepKey string required A unique identifier of the action.
before string optional stepKey of action that must be executed next.
after string optional stepKey of preceding action.

dragAndDrop

See dragAndDrop docs on codeception.com

Attribute Type Use Description
selector1 string optional  
selector2 string optional  
stepKey string required A unique identifier of the action.
before string optional stepKey of action that must be executed next.
after string optional stepKey of preceding action.

executeInSelenium

See executeInSelenium docs on codeception.com

Attribute Type Use Description
function string optional  
stepKey string required A unique identifier of the action.
before string optional stepKey of action that must be executed next.
after string optional stepKey of preceding action.

executeJS

See executeJS docs on codeception.com

Attribute Type Use Description
function string optional  
stepKey string required A unique identifier of the action.
before string optional stepKey of action that must be executed next.
after string optional stepKey of preceding action.

fillField

See fillField docs on codeception.com

Attribute Type Use Description
selector string optional  
selectorArray string optional  
userInput string optional  
stepKey string required A unique identifier of the action.
before string optional stepKey of action that must be executed next.
after string optional stepKey of preceding action.

formatMoney

Attribute Type Use Description
userInput string optional  
locale string optional  
stepKey string required A unique identifier of the action.
before string optional stepKey of action that must be executed next.
after string optional stepKey of preceding action.

getData

Gets an entity (e.g. a category or product). In other words, makes a GET request to the Magento API according to the data and metadata of the entity type that is requested.

For example, using getData in a test looks like this:

<getData entity="ProductAttributeOptionGetter" index="1" stepKey="getAttributeOption1Handle">
    <requiredEntity createDataKey="productAttributeHandle"/>
</getData>

The ProductAttributeOptionGetter entity must be defined in the corresponding data *.xml.

Attribute Type Use Description
storeCode string optional  
stepKey string required A unique identifier of the action.
index integer optional  
entity string required  
before string optional stepKey of action that must be executed next.
after string optional stepKey of preceding action.

This action can optionally contain one or more requiredEntity child elements.

grabAttributeFrom

See grabAttributeFrom docs on codeception.com

Attribute Type Use Description
selector string optional  
userInput string optional  
stepKey string required A unique identifier of the action.
before string optional stepKey of action that must be executed next.
after string optional stepKey of preceding action.

grabCookie

See grabCookie docs on codeception.com

Attribute Type Use Description
userInput string optional  
parameterArray string optional  
stepKey string required A unique identifier of the action.
before string optional stepKey of action that must be executed next.
after string optional stepKey of preceding action.

grabFromCurrentUrl

See grabFromCurrentUrl docs on codeception.com

Attribute Type Use Description
regex string optional Regular expression against the current URI.
stepKey string required A unique identifier of the action.
before string optional stepKey of action that must be executed next.
after string optional stepKey of preceding action.

grabMultiple

See grabMultiple docs on codeception.com

Attribute Type Use Description
selector string optional  
userInput string optional  
stepKey string required A unique identifier of the action.
before string optional stepKey of action that must be executed next.
after string optional stepKey of preceding action.

grabPageSource

See grabPageSource docs on codeception.com

Attribute Type Use Description
stepKey string required A unique identifier of the action.
before string optional stepKey of action that must be executed next.
after string optional stepKey of preceding action.

grabTextFrom

See grabTextFrom docs on codeception.com

Attribute Type Use Description
selector string optional  
stepKey string required A unique identifier of the action.
before string optional stepKey of action that must be executed next.
after string optional stepKey of preceding action.

grabValueFrom

See grabValueFrom docs on codeception.com

Attribute Type Use Description
selector string optional  
selectorArray string optional  
stepKey string required A unique identifier of the action.
before string optional stepKey of action that must be executed next.
after string optional stepKey of preceding action.

loadSessionSnapshot

See loadSessionSnapshot docs on codeception.com

Attribute Type Use Description
userInput string optional  
stepKey string required A unique identifier of the action.
before string optional stepKey of action that must be executed next.
after string optional stepKey of preceding action.

magentoCLI

Passes CLI command for execution in Magento environment.

Attribute Type Use Description
command string optional CLI command to be executed in Magento environment.
stepKey string required A unique identifier of the action.
before string optional stepKey of action that must be executed next.
after string optional stepKey of preceding action.

makeScreenshot

See makeScreenshot docs on codeception.com

Attribute Type Use Description
userInput string optional  
stepKey string required A unique identifier of the action.
before string optional stepKey of action that must be executed next.
after string optional stepKey of preceding action.

maximizeWindow

See maximizeWindow docs on codeception.com

Attribute Type Use Description
stepKey string required A unique identifier of the action.
before string optional stepKey of action that must be executed next.
after string optional stepKey of preceding action.

moveBack

See moveBack docs on codeception.com

Attribute Type Use Description
stepKey string required A unique identifier of the action.
before string optional stepKey of action that must be executed next.
after string optional stepKey of preceding action.

moveForward

See moveForward docs on codeception.com

Attribute Type Use Description
stepKey string required A unique identifier of the action.
before string optional stepKey of action that must be executed next.
after string optional stepKey of preceding action.

moveMouseOver

See moveMouseOver docs on codeception.com

Attribute Type Use Description
selector string optional  
selectorArray string optional  
x string optional  
y string optional  
stepKey string required A unique identifier of the action.
before string optional stepKey of action that must be executed next.
after string optional stepKey of preceding action.

mSetLocale

Attribute Type Use Description
userInput string optional  
locale string optional  
stepKey string required A unique identifier of the action.
before string optional stepKey of action that must be executed next.
after string optional stepKey of preceding action.

mResetLocale

Attribute Type Use Description
stepKey string required A unique identifier of the action.
before string optional stepKey of action that must be executed next.
after string optional stepKey of preceding action.

openNewTab

See openNewTab docs on codeception.com

Attribute Type Use Description
stepKey string required A unique identifier of the action.
before string optional stepKey of action that must be executed next.
after string optional stepKey of preceding action.

parseFloat

Parse float number with thousands seperator.

Attribute Type Use Description
userInput string optional  
stepKey string required A unique identifier of the action.
before string optional stepKey of action that must be executed next.
after string optional stepKey of preceding action.

pauseExecution

See pauseExecution docs on codeception.com

Attribute Type Use Description
stepKey string required A unique identifier of the action.
before string optional stepKey of action that must be executed next.
after string optional stepKey of preceding action.

performOn

See performOn docs on codeception.com

Attribute Type Use Description
selector string optional  
function string optional  
stepKey string required A unique identifier of the action.
before string optional stepKey of action that must be executed next.
after string optional stepKey of preceding action.

pressKey

See pressKey docs on codeception.com

Attribute Type Use Description
selector string optional  
userInput string optional  
parameterArray string optional  
stepKey string required A unique identifier of the action.
before string optional stepKey of action that must be executed next.
after string optional stepKey of preceding action.

reloadPage

See reloadPage docs on codeception.com

Attribute Type Use Description
stepKey string required A unique identifier of the action.
before string optional stepKey of action that must be executed next.
after string optional stepKey of preceding action.

remove

Removes action by its stepKey.

Attribute Type Use Description
keyForRemoval string required Set stepKey of the action you want to remove.

resetCookie

See resetCookie docs on codeception.com

Attribute Type Use Description
userInput string optional  
parameterArray string optional  
stepKey string required A unique identifier of the action.
before string optional stepKey of action that must be executed next.
after string optional stepKey of preceding action.

resizeWindow

See resizeWindow docs on codeception.com

Attribute Type Use Description
width string optional  
height string optional  
stepKey string required A unique identifier of the action.
before string optional stepKey of action that must be executed next.
after string optional stepKey of preceding action.

saveSessionSnapshot

See saveSessionSnapshot docs on codeception.com

Attribute Type Use Description
userInput string optional  
stepKey string required A unique identifier of the action.
before string optional stepKey of action that must be executed next.
after string optional stepKey of preceding action.

scrollTo

See scrollTo docs on codeception.com

Attribute Type Use Description
selector string optional  
selectorArray string optional  
x string optional  
y string optional  
stepKey string required A unique identifier of the action.
before string optional stepKey of action that must be executed next.
after string optional stepKey of preceding action.

scrollToTopOfPage

A convenience function that executes window.scrollTo(0,0) as JavaScript thus returning to the top of the page.

Attribute Type Use Description
stepKey string required A unique identifier of the action.
before string optional stepKey of action that must be executed next.
after string optional stepKey of preceding action.

searchAndMultiSelectOption

Search for and select options from a Magento multi-select drop down menu. For example, the drop down menu you use to assign Products to Categories.

Attribute Type Use Description
selector string optional  
userInput string optional  
parameterArray string optional  
requiredAction string optional  
stepKey string required A unique identifier of the action.
before string optional stepKey of action that must be executed next.
after string optional stepKey of preceding action.

see

See see docs on codeception.com

Attribute Type Use Description
userInput string optional  
selector string optional  
selectorArray string optional  
stepKey string required A unique identifier of the action.
before string optional stepKey of action that must be executed next.
after string optional stepKey of preceding action.

seeCheckboxIsChecked

See seeCheckboxIsChecked docs on codeception.com

Attribute Type Use Description
selector string optional  
stepKey string required A unique identifier of the action.
before string optional stepKey of action that must be executed next.
after string optional stepKey of preceding action.

seeCookie

See seeCookie docs on codeception.com

Attribute Type Use Description
userInput string optional  
parameterArray string optional  
stepKey string required A unique identifier of the action.
before string optional stepKey of action that must be executed next.
after string optional stepKey of preceding action.

seeCurrentUrlEquals

See seeCurrentUrlEquals docs on codeception.com

Attribute Type Use Description
url string optional  
stepKey string required A unique identifier of the action.
before string optional stepKey of action that must be executed next.
after string optional stepKey of preceding action.

seeCurrentUrlMatches

See seeCurrentUrlMatches docs on codeception.com

Attribute Type Use Description
regex string optional Regular expression against the current URI.
stepKey string required A unique identifier of the action.
before string optional stepKey of action that must be executed next.
after string optional stepKey of preceding action.

seeElement

See seeElement docs on codeception.com

Attribute Type Use Description
selector string optional  
selectorArray string optional  
parameterArray string optional  
stepKey string required A unique identifier of the action.
before string optional stepKey of action that must be executed next.
after string optional stepKey of preceding action.

seeElementInDOM

See seeElementInDOM docs on codeception.com

Attribute Type Use Description
selector string optional  
parameterArray string optional  
stepKey string required A unique identifier of the action.
before string optional stepKey of action that must be executed next.
after string optional stepKey of preceding action.

seeInCurrentUrl

See seeInCurrentUrl docs on codeception.com

Attribute Type Use Description
url string optional  
stepKey string required A unique identifier of the action.
before string optional stepKey of action that must be executed next.
after string optional stepKey of preceding action.

seeInField

See seeInField docs on codeception.com

Attribute Type Use Description
selector string optional  
selectorArray string optional  
userInput string optional  
stepKey string required A unique identifier of the action.
before string optional stepKey of action that must be executed next.
after string optional stepKey of preceding action.

seeInFormFields

See seeInFormFields docs on codeception.com

Attribute Type Use Description
selector string optional  
parameterArray string optional  
stepKey string required A unique identifier of the action.
before string optional stepKey of action that must be executed next.
after string optional stepKey of preceding action.

seeInPageSource

See seeInPageSource docs on codeception.com

Attribute Type Use Description
html string optional  
stepKey string required A unique identifier of the action.
before string optional stepKey of action that must be executed next.
after string optional stepKey of preceding action.

seeInPopup

See seeInPopup docs on codeception.com

Attribute Type Use Description
userInput string optional  
stepKey string required A unique identifier of the action.
before string optional stepKey of action that must be executed next.
after string optional stepKey of preceding action.

seeInSource

See seeInSource docs on codeception.com

Attribute Type Use Description
html string optional  
stepKey string required A unique identifier of the action.
before string optional stepKey of action that must be executed next.
after string optional stepKey of preceding action.

seeInTitle

See seeInTitle docs on codeception.com

Attribute Type Use Description
userInput string optional  
stepKey string required A unique identifier of the action.
before string optional stepKey of action that must be executed next.
after string optional stepKey of preceding action.

See seeLink docs on codeception.com

Attribute Type Use Description
userInput string optional  
url string optional  
stepKey string required A unique identifier of the action.
before string optional stepKey of action that must be executed next.
after string optional stepKey of preceding action.

seeNumberOfElements

See seeNumberOfElements docs on codeception.com

Attribute Type Use Description
selector string optional  
userInput string optional  
parameterArray string optional  
stepKey string required A unique identifier of the action.
before string optional stepKey of action that must be executed next.
after string optional stepKey of preceding action.

seeOptionIsSelected

See seeOptionIsSelected docs on codeception.com

Attribute Type Use Description
selector string optional  
userInput string optional  
stepKey string required A unique identifier of the action.
before string optional stepKey of action that must be executed next.
after string optional stepKey of preceding action.

selectOption

See selectOption docs on codeception.com

Attribute Type Use Description
selector string optional  
userInput string optional  
parameterArray string optional  
stepKey string required A unique identifier of the action.
before string optional stepKey of action that must be executed next.
after string optional stepKey of preceding action.

setCookie

See setCookie docs on codeception.com

Attribute Type Use Description
userInput string optional  
parameterArray string optional  
value string optional  
stepKey string required A unique identifier of the action.
before string optional stepKey of action that must be executed next.
after string optional stepKey of preceding action.

submitForm

See submitForm docs on codeception.com

Attribute Type Use Description
selector string optional  
parameterArray string optional  
button string optional  
stepKey string required A unique identifier of the action.
before string optional stepKey of action that must be executed next.
after string optional stepKey of preceding action.

switchToIFrame

See switchToIFrame docs on codeception.com

Attribute Type Use Description
selector string optional  
userInput string optional  
stepKey string required A unique identifier of the action.
before string optional stepKey of action that must be executed next.
after string optional stepKey of preceding action.

switchToNextTab

See switchToNextTab docs on codeception.com

Attribute Type Use Description
userInput string optional  
stepKey string required A unique identifier of the action.
before string optional stepKey of action that must be executed next.
after string optional stepKey of preceding action.

switchToPreviousTab

See switchToPreviousTab docs on codeception.com

Attribute Type Use Description
userInput string optional  
stepKey string required A unique identifier of the action.
before string optional stepKey of action that must be executed next.
after string optional stepKey of preceding action.

switchToWindow

See switchToWindow docs on codeception.com

Attribute Type Use Description
userInput string optional  
stepKey string required A unique identifier of the action.
before string optional stepKey of action that must be executed next.
after string optional stepKey of preceding action.

typeInPopup

See typeInPopup docs on codeception.com

Attribute Type Use Description
userInput string optional  
stepKey string required A unique identifier of the action.
before string optional stepKey of action that must be executed next.
after string optional stepKey of preceding action.

uncheckOption

See uncheckOption docs on codeception.com

Attribute Type Use Description
selector string optional  
stepKey string required A unique identifier of the action.
before string optional stepKey of action that must be executed next.
after string optional stepKey of preceding action.

unselectOption

See unselectOption docs on codeception.com

Attribute Type Use Description
selector string optional  
userInput string optional  
parameterArray string optional  
stepKey string required A unique identifier of the action.
before string optional stepKey of action that must be executed next.
after string optional stepKey of preceding action.

updateData

When you create a data entity using createData, you may need to update it later in the test. The updateData action allows this.

For example, to change the price of a product:

<updateData entity="AdjustPriceProduct" createDataKey="productHandle" stepKey="updateProduct"/>

where AdjustPriceProduct simply looks like this:

<entity name="AdjustPriceProduct" type="product">
    <data key="price">321.00</data>
</entity>

Notice only the fields that you wish to update are set.

Attribute Type Use Description
storeCode string optional  
stepKey string required A unique identifier of the action.
entity string required  
createDataKey string required  
before string optional stepKey of action that must be executed next.
after string optional stepKey of preceding action.

This action can optionally contain one or more requiredEntity child elements.

wait

See wait docs on codeception.com

Attribute Type Use Description
time string optional  
stepKey string required A unique identifier of the action.
before string optional stepKey of action that must be executed next.
after string optional stepKey of preceding action.

waitForAjaxLoad

Wait for all AJAX calls to finish.

Attribute Type Use Description
time string optional  
stepKey string required A unique identifier of the action.
before string optional stepKey of action that must be executed next.
after string optional stepKey of preceding action.

waitForElementChange

See waitForElementChange docs on codeception.com

Attribute Type Use Description
selector string optional  
function string optional  
time string optional  
stepKey string required A unique identifier of the action.
before string optional stepKey of action that must be executed next.
after string optional stepKey of preceding action.

waitForElement

See waitForElement docs on codeception.com

Attribute Type Use Description
selector string optional  
time string optional  
stepKey string required A unique identifier of the action.
before string optional stepKey of action that must be executed next.
after string optional stepKey of preceding action.

waitForElementNotVisible

See waitForElementNotVisible docs on codeception.com

Attribute Type Use Description
selector string optional  
time string optional  
stepKey string required A unique identifier of the action.
before string optional stepKey of action that must be executed next.
after string optional stepKey of preceding action.

waitForElementVisible

See waitForElementVisible docs on codeception.com

Attribute Type Use Description
selector string optional  
time string optional  
stepKey string required A unique identifier of the action.
before string optional stepKey of action that must be executed next.
after string optional stepKey of preceding action.

waitForJS

See waitForJS docs on codeception.com

Attribute Type Use Description
function string optional  
time string optional  
stepKey string required A unique identifier of the action.
before string optional stepKey of action that must be executed next.
after string optional stepKey of preceding action.

waitForLoadingMaskToDisappear

Wait for all Magento loading overlays to go away.

The CSS class for loading masks is not used consistently throughout Magento. Therefore, this convenience function tries to wait for various specific selectors.

# Wait for these classes to not be visible

//div[contains(@class, "loading-mask")]
//div[contains(@class, "admin_data-grid-loading-mask")]
//div[contains(@class, "admin__data-grid-loading-mask")]
//div[contains(@class, "admin__form-loading-mask")]
//div[@data-role="spinner"]
Attribute Type Use Description
stepKey string required A unique identifier of the action.
before string optional stepKey of action that must be executed next.
after string optional stepKey of preceding action.

waitForPageLoad

Wait for AJAX, Magento loading overlays, and document.readyState == "complete".

Attribute Type Use Description
time string optional  
stepKey string required A unique identifier of the action.
before string optional stepKey of action that must be executed next.
after string optional stepKey of preceding action.

waitForText

See waitForText docs on codeception.com

Attribute Type Use Description
userInput string optional  
time string optional  
selector string optional  
stepKey string required A unique identifier of the action.
before string optional stepKey of action that must be executed next.
after string optional stepKey of preceding action.