Section structure in the Magento Functional Testing Framework

This topic was updated due to the 1.0.0 MFTF release.

Overview

A section is a reusable part of a page. It is the standard file for defining UI elements on a page used under test.

You are able to define:

• explicit element that has a selector equal to constant string. Example: selector="#add_root_category_button"
• parameterized element that contains substitutable values in selector. Example: selector="#element .{{var1}} .{{var2}}".

Substitutable values

Substitutable values in the test can be of the following formats:

• String Literals: stringLiteral
• Reference to data entity (XML data from the corresponding …/Data/*.xml): entityName.Field
• Persisted Data
  • $persistedCreateDataKey.field$ for data created in scope of a test using createData action with stepKey="persistedCreateDataKey"
  • $$persistedCreateDataKey.field$$ or data created in before and that is why used in scope of a cest using createData action with stepKey="persistedCreateDataKey"

The following diagram demonstrates XML structure of a section in the MFTF:

Format

<?xml version="1.0" encoding="UTF-8"?>

<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="">
        <element name="" type="" selector="" />
        <element name="" type="" selector="" parameterized="true"/>
        <element name="" type="" selector="" timeout=""/>
    </section>
</config>

Principles

• <section> name is the same as the file name
• *Section.xml is stored in the Section directory of a module
• a name format is {Admin|Storefront}{SectionDescription}Section.xml
• Elements in sections are given camel case with first letter lowercase name. They describe the function of the element rather than attempting to describe the selector used.

Example

…/Catalog/Section/AdminCategorySidebarActionSection.xml:

<?xml version="1.0" encoding="utf-8"?>

<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="AdminCategorySidebarActionSection">
        <element name="addRootCategoryButton" type="button" selector="#add_root_category_button" timeout="30"/>
        <element name="addSubcategoryButton" type="button" selector="#add_subcategory_button" timeout="30"/>
    </section>
</config>

The example demonstrates a section AdminCategorySidebarActionSection. All sections with same name will be merged during tests generation.

The section declares two buttons:

• addRootCategoryButton is a button with a locator #add_root_category_button on the parent web page.
• addSubcategoryButton is a button with a locator #add_subcategory_button on the parent web page.

Example of a call in test:

<!-- Click on the button with locator "#add_subcategory_button" on the web page-->
<click selector="{{AdminCategorySidebarActionSection.addSubcategoryButton}}" stepKey="clickOnAddSubCategory"/>

Reference

section

Contains sequence of UI elements in a section of a page.

element

A UI element used in an action.