Merging

Edit on GitHub
Log an Issue

The MFTF allows you to merge test components defined in XML files, such as:

You can create, delete, or update the component. It is useful for supporting rapid test creation for extensions and customizations.

You can specify needed changes to an existing file and merge them to produce a modification of the original that incorporates the specified changes (the “delta”).

Merging operates at the XML tag level, triggered by our parser when there are two (or more) entities with the same name. Your update (XML node with changes) must have the same attribute name as its base node (the target object to be changed).

For example:

  • All tests with <test name="SampleTest> will be merged into one.
  • All pages with <page name="SamplePage> will be merged into one.
  • All sections with <section name="SampleAction"> will be merged into one.
  • All data entities with <entity name="sampleData" type="sample"> will be merged into one.
  • All action groups with <actionGroup name="selectNotLoggedInCustomerGroup"> will be merged into one.

Although a file name does not influence merging, we recommend using the same file names in merging updates. This makes it easier to search later on.

Merging precedence

Magento Functional Testing Framework uses Module’s <sequence> to merge all XML configurations into Codeception instructions. If there’s no Sequence specified, MFTF would use:

  1. Vendor modules (Magento & Vendors) located in vendor/
  2. Tests located in app/code/*/*/Test/Mftf

Usual precedence for merging MFTF Tests and resources

Add a test

You cannot add another [<test>][tests] using merging functionality. To add a <test>, create a new *Test.xml file or add a <test> node to an existing *Test.xml file.

Remove a test

Tests cannot be removed while merging. If a [<test>][tests] must be skipped due to a module completely invalidating a function, you can add the test to the skip group.

Learn more about running tests with different options using mftf or codecept commands.

Example

Skip the AdminLoginTest test in the .../Backend/Test/AdminLoginTest.xml file while merging with the .../Foo/Test/AdminLoginTest.xml file:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20

<tests ...>
    <test name="AdminLoginTest">
        <annotations>
            <features value="Admin Login"/>
            <stories value="Login on the Admin Login page"/>
            <title value="You should be able to log into the Magento Admin backend."/>
            <description value="You should be able to log into the Magento Admin backend."/>
            <severity value="CRITICAL"/>
            <testCaseId value="MAGETWO-71572"/>
            <group value="example"/>
            <group value="login"/>
        </annotations>
        <amOnPage url="{{AdminLoginPage.url}}" stepKey="amOnAdminLoginPage"/>
        <fillField selector="{{AdminLoginFormSection.username}}" userInput="{{_ENV.MAGENTO_ADMIN_USERNAME}}" stepKey="fillUsername"/>
        <fillField selector="{{AdminLoginFormSection.password}}" userInput="{{_ENV.MAGENTO_ADMIN_PASSWORD}}" stepKey="fillPassword"/>
        <click selector="{{AdminLoginFormSection.signIn}}" stepKey="clickOnSignIn"/>
        <closeAdminNotification stepKey="closeAdminNotification"/>
        <seeInCurrentUrl url="{{AdminLoginPage.url}}" stepKey="seeAdminLoginUrl"/>
    </test>
</tests>

Create the .../Foo/Test/AdminLoginTest.xml file:

1
2
3
4
5
6
7
8
9

<tests ...>
    <test name="AdminLoginTest">
       <annotations>
          <skip>
             <issueId value="Issue#"/>
          </skip>
       </annotations>
    </test>
</tests>

The AdminLoginTest result corresponds to:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21

<test name="AdminLoginTest">
    <annotations>
        <features value="Admin Login"/>
        <stories value="Login on the Admin Login page"/>
        <title value="You should be able to log into the Magento Admin backend."/>
        <description value="You should be able to log into the Magento Admin backend."/>
        <severity value="CRITICAL"/>
        <testCaseId value="MAGETWO-71572"/>
        <group value="example"/>
        <group value="login"/>
      <skip>
         <issueId value="Issue#"/>
      </skip>
    </annotations>
    <amOnPage url="{{AdminLoginPage.url}}" stepKey="amOnAdminLoginPage"/>
    <fillField selector="{{AdminLoginFormSection.username}}" userInput="{{_ENV.MAGENTO_ADMIN_USERNAME}}" stepKey="fillUsername"/>
    <fillField selector="{{AdminLoginFormSection.password}}" userInput="{{_ENV.MAGENTO_ADMIN_PASSWORD}}" stepKey="fillPassword"/>
    <click selector="{{AdminLoginFormSection.signIn}}" stepKey="clickOnSignIn"/>
    <closeAdminNotification stepKey="closeAdminNotification"/>
    <seeInCurrentUrl url="{{AdminLoginPage.url}}" stepKey="seeAdminLoginUrl"/>
</test>

Update a test

Any change must include information about where it should be inserted relative to other test steps in the scope of the test.

This is done using the before or after element. See the previous examples.

Add a test step

Use case: Add checkOption before click (stepKey="clickLogin") and add seeInCurrentUrl after the click in the LogInAsAdminTest test (in the .../Backend/Test/LogInAsAdminTest.xml file) while merging with the .../Foo/Test/LogInAsAdminTest.xml file:

1
2
3
4
5
6
7
8
9

<tests ...>
    <test name="LogInAsAdminTest">
        <amOnPage url="{{AdminLoginPage}}" stepKey="navigateToAdmin"/>
        <fillField selector="{{AdminLoginFormSection.username}}" userInput="admin" stepKey="fillUsername"/>
        <fillField selector="{{AdminLoginFormSection.password}}" userInput="password" stepKey="fillPassword"/>
        <click selector="{{AdminLoginFormSection.signIn}}" stepKey="clickLogin"/>
        <see userInput="Lifetime Sales" stepKey="seeLifetimeSales"/>
    </test>
</tests>

Create the .../Foo/Test/LogInAsAdminTest.xml file:

1
2
3
4
5
6

<tests ...>
    <test name="LogInAsAdminTest">
        <checkOption selector="{{AdminLoginFormSection.rememberMe}}" stepKey="checkRememberMe" before="clickLogin"/>
        <seeInCurrentUrl url="admin/admin/dashboard/" stepKey="seeAdminUrl" after="clickLogin"/>
    </test>
</tests>

The LogInAsAdminTest result corresponds to:

1
2
3
4
5
6
7
8
9

<test name="LogInAsAdminTest">
    <amOnPage url="{{AdminLoginPage}}" stepKey="navigateToAdmin"/>
    <fillField selector="{{AdminLoginFormSection.username}}" userInput="admin" stepKey="fillUsername"/>
    <fillField selector="{{AdminLoginFormSection.password}}" userInput="password" stepKey="fillPassword"/>
    <checkOption selector="{{AdminLoginFormSection.rememberMe}}" stepKey="checkRememberMe"/>
    <click selector="{{AdminLoginFormSection.signIn}}" stepKey="clickLogin"/>
    <seeInCurrentUrl url="admin/admin/dashboard/" stepKey="seeAdminUrl"/>
    <see userInput="Lifetime Sales" stepKey="seeLifetimeSales"/>
</test>

Remove a test step

Use case: Remove see (stepKey="seeLifetimeSales") from the LogInAsAdminTest test (in the .../Backend/Test/LogInAsAdminTest.xml file) while merging with the .../Foo/Test/LogInAsAdminTest.xml file:

1
2
3
4
5
6
7
8
9

<tests ...>
    <test name="LogInAsAdminTest">
        <amOnPage url="{{AdminLoginPage}}" stepKey="navigateToAdmin"/>
        <fillField selector="{{AdminLoginFormSection.username}}" userInput="admin" stepKey="fillUsername"/>
        <fillField selector="{{AdminLoginFormSection.password}}" userInput="password" stepKey="fillPassword"/>
        <click selector="{{AdminLoginFormSection.signIn}}" stepKey="clickLogin"/>
        <see userInput="Lifetime Sales" stepKey="seeLifetimeSales"/>
    </test>
</tests>

Create the .../Foo/Test/LogInAsAdminTest.xml file:

1
2
3
4
5

<tests ...>
    <test name="LogInAsAdminTest">
        <remove keyForRemoval="seeLifetimeSales"/>
    </test>
</tests>

The LogInAsAdminTest result corresponds to:

1
2
3
4
5
6

<test name="LogInAsAdminTest">
    <amOnPage url="{{AdminLoginPage}}" stepKey="navigateToAdmin"/>
    <fillField selector="{{AdminLoginFormSection.username}}" userInput="admin" stepKey="fillUsername"/>
    <fillField selector="{{AdminLoginFormSection.password}}" userInput="password" stepKey="fillPassword"/>
    <click selector="{{AdminLoginFormSection.signIn}}" stepKey="clickLogin"/>
</test>

Update a test step

Use case: Change selector in fillField (stepKey="fillPassword") of the LogInAsAdminTest test (in the .../Backend/Test/LogInAsAdminTest.xml file) while merging with the .../Foo/Test/LogInAsAdminTest.xml file:

1
2
3
4
5
6
7
8
9

<tests ...>
    <test name="LogInAsAdminTest">
        <amOnPage url="{{AdminLoginPage}}" stepKey="navigateToAdmin"/>
        <fillField selector="{{AdminLoginFormSection.username}}" userInput="admin" stepKey="fillUsername"/>
        <fillField selector="{{AdminLoginFormSection.password}}" userInput="password" stepKey="fillPassword"/>
        <click selector="{{AdminLoginFormSection.signIn}}" stepKey="clickLogin"/>
        <see userInput="Lifetime Sales" stepKey="seeLifetimeSales"/>
    </test>
</tests>

Create the .../Foo/Test/LogInAsAdminTest.xml file:

1
2
3
4
5

<tests ...>
    <test name="LogInAsAdminTest">
        <fillField selector="{{AdminLoginFormSection.wrong-password}}" userInput="password" stepKey="fillPassword"/>
    </test>
</tests>

The LogInAsAdminTest result corresponds to:

1
2
3
4
5
6
7

<test name="LogInAsAdminTest">
    <amOnPage url="{{AdminLoginPage}}" stepKey="navigateToAdmin"/>
    <fillField selector="{{AdminLoginFormSection.username}}" userInput="admin" stepKey="fillUsername"/>
    <fillField selector="{{AdminLoginFormSection.wrong-password}}" userInput="password" stepKey="fillPassword"/>
    <click selector="{{AdminLoginFormSection.signIn}}" stepKey="clickLogin"/>
    <see userInput="Lifetime Sales" stepKey="seeLifetimeSales"/>
</test>

Add several test steps

Use case: Add several actions after the click (stepKey="clickLogin") in the LogInAsAdminTest test (in the .../Backend/Test/LogInAsAdminTest.xml file) while merging with the .../Foo/Test/LogInAsAdminTest.xml file:

1
2
3
4
5
6
7
8
9

<tests ...>
    <test name="LogInAsAdminTest">
        <amOnPage url="{{AdminLoginPage}}" stepKey="navigateToAdmin"/>
        <fillField selector="{{AdminLoginFormSection.username}}" userInput="admin" stepKey="fillUsername"/>
        <fillField selector="{{AdminLoginFormSection.password}}" userInput="password" stepKey="fillPassword"/>
        <click selector="{{AdminLoginFormSection.signIn}}" stepKey="clickLogin"/>
        <see userInput="Lifetime Sales" stepKey="seeLifetimeSales"/>
    </test>
</tests>

Create the .../Foo/Test/LogInAsAdminTest.xml file:

1
2
3
4
5
6

<tests ...>
    <test name="LogInAsAdminTest" insertAfter="clickLogin">
        <checkOption selector="{{AdminLoginFormSection.rememberMe}}" stepKey="checkRememberMe"/>
        <seeInCurrentUrl url="admin/admin/dashboard/" stepKey="seeAdminUrl"/>
    </test>
</tests>

The LogInAsAdminTest result corresponds to:

1
2
3
4
5
6
7
8
9

<test name="LogInAsAdminTest">
   <amOnPage url="{{AdminLoginPage}}" stepKey="navigateToAdmin"/>
   <fillField selector="{{AdminLoginFormSection.username}}" userInput="admin" stepKey="fillUsername"/>
   <fillField selector="{{AdminLoginFormSection.password}}" userInput="password" stepKey="fillPassword"/>
   <click selector="{{AdminLoginFormSection.signIn}}" stepKey="clickLogin"/>
   <checkOption selector="{{AdminLoginFormSection.rememberMe}}" stepKey="checkRememberMe"/>
   <seeInCurrentUrl url="admin/admin/dashboard/" stepKey="seeAdminUrl"/>
   <see userInput="Lifetime Sales" stepKey="seeLifetimeSales"/>
</test>

Merge action groups

Merging action groups allows you to extend existing tests by reusing existing action groups, while customizing them for your specific needs.

Use case

Here is an action group for selecting customerGroup in the Cart Price Rules section. The controls change drastically in the B2B version, so it was abstracted to an action group so that it may be easily changed if B2B is enabled.

Action group for selecting customerGroup in the Cart Price Rules section:

1
2
3

<actionGroup name="selectNotLoggedInCustomerGroup">
    <selectOption selector="{{AdminCartPriceRulesFormSection.customerGroups}}" userInput="NOT LOGGED IN" stepKey="selectCustomerGroup"/>
</actionGroup>

B2B Merge file

1
2
3
4
5
6
7
8
9
10

<!-- name matches -->
<actionGroup name="selectNotLoggedInCustomerGroup">
    <!-- removes the original action -->
    <remove keyForRemoval="selectCustomerGroup"/>
    <!-- adds in sequence of actions to be performed instead-->
    <click selector="{{AdminCartPriceRulesFormSection.customerGroups}}" stepKey="expandCustomerGroups"/>
    <fillField selector="{{AdminCartPriceRulesFormSection.customerGroupsInput}}" userInput="NOT LOGGED IN" stepKey="fillCustomerGroups"/>
    <click selector="{{AdminCartPriceRulesFormSection.customerGroupsFirstResult}}" stepKey="selectNotLoggedInGroup"/>
    <click selector="{{AdminCartPriceRulesFormSection.customerGroupsDoneBtn}}" stepKey="closeMultiSelect"/>
</actionGroup>

Merge pages

Use [page] merging to add or remove [sections] in your module.

To merge [pages][page], the page name must be the same as in the base module. page name is set in the module attribute.

Add a section

Use case: The FooBackend module extends the Backend module and requires use of two new sections that must be covered with tests. Add BaseBackendSection and AnotherBackendSection to the BaseBackendPage (.../Backend/Page/BaseBackendPage.xml file):

1
2
3
4
5
6

<pages ...>
    <page name="BaseBackendPage" url="admin" area="admin" module="Magento_Backend">
        <section name="BaseBackendSection"/>
        <section name="AnotherBackendSection"/>
    </page>
</pages>

Create the .../FooBackend/Page/BaseBackendPage.xml file:

1
2
3
4
5

<pages ...>
   <page name="BaseBackendPage" url="admin" area="admin" module="Magento_Backend">
      <section name="NewExtensionSection"/>
   </page>
</pages>

The BaseBackendPage result corresponds to:

1
2
3
4
5
6

<page name="BaseBackendPage" url="admin" area="admin" module="Magento_Backend">

    <section name="BaseBackendSection"/>
    <section name="AnotherBackendSection"/>
    <section name="NewExtensionSection"/>
</page>

Remove a section

Use case: The FooBackend module extends the Backend module and requires deletion of the AnotherBackendSection section (the .../Backend/Page/BaseBackendPage.xml file):

1
2
3
4

<page name="BaseBackendPage" url="admin" area="admin" module="Magento_Backend">
    <section name="BaseBackendSection"/>
    <section name="AnotherBackendSection"/>
</page>

Create the .../FooBackend/Page/BaseBackendPage.xml file:

1
2
3

<page name="BaseBackendPage" url="admin" area="admin" module="Magento_Backend">
   <section name="AnotherBackendSection" remove="true"/>
</page>

The BaseBackendPage result corresponds to:

1
2
3

<page name="BaseBackendPage" url="admin" area="admin" module="Magento_Backend">
   <section name="BaseBackendSection"/>
</page>

Merge sections

Use merging to add, remove, or update elements in sections.

All sections with the same file name, section name, and element name are merged during test generation.

Add an element

Use case: The FooBackend module extends the Backend module and requires a new mergeElement element in the AdminLoginFormSection. Add mergeElement to the AdminLoginFormSection:

1
2
3
4
5
6
7

<sections ...>
   <section name="AdminLoginFormSection">
      <element name="username" type="input" selector="#username"/>
      <element name="password" type="input" selector="#login"/>
      <element name="signIn" type="button" selector=".actions .action-primary" timeout="30"/>
   </section>
</sections>

Create the .../FooBackend/Section/AdminLoginFormSection.xml file:

1
2
3
4
5

<sections ...>
   <section name="AdminLoginFormSection">
      <element name="mergeElement" type="input" selector="#selector"/>
   </section>
</sections>

The AdminLoginFormSection result corresponds to:

1
2
3
4
5
6

<section name="AdminLoginFormSection">
   <element name="username" type="input" selector="#username"/>
   <element name="password" type="input" selector="#login"/>
   <element name="signIn" type="button" selector=".actions .action-primary" timeout="30"/>
   <element name="mergeElement" type="input" selector="#selector"/>
</section>

Remove an element

Use case: The FooBackend module extends the Backend module and requires deletion of username in the AdminLoginFormSection. Remove username from the AdminLoginFormSection:

1
2
3
4
5
6
7

<sections ...>
   <section name="AdminLoginFormSection">
      <element name="username" type="input" selector="#username"/>
      <element name="password" type="input" selector="#login"/>
      <element name="signIn" type="button" selector=".actions .action-primary" timeout="30"/>
   </section>
</sections>

Create the .../FooBackend/Section/AdminLoginFormSection.xml file:

1
2
3
4
5

<sections ...>
   <section name="AdminLoginFormSection">
      <element name="username" type="input" remove="true"/>
   </section>
</sections>

The AdminLoginFormSection result corresponds to:

1
2
3
4

<section name="AdminLoginFormSection">
   <element name="password" type="input" selector="#login"/>
   <element name="signIn" type="button" selector=".actions .action-primary" timeout="30"/>
</section>

Update an element

Use case: The FooBackend module extends the Backend module and requires change of a selector in username in the AdminLoginFormSection. Update username in the AdminLoginFormSection (the .../Backend/Section/AdminLoginFormSection.xml file):

1
2
3
4
5
6
7

<sections ...>
   <section name="AdminLoginFormSection">
      <element name="username" type="input" selector="#username"/>
      <element name="password" type="input" selector="#login"/>
      <element name="signIn" type="button" selector=".actions .action-primary" timeout="30"/>
   </section>
</sections>

Create the .../FooBackend/Section/AdminLoginFormSection.xml file:

1
2
3
4
5

<sections ...>
   <section name="AdminLoginFormSection">
      <element name="username" type="input" selector="#newSelector"/>
   </section>
</sections>

The AdminLoginFormSection result corresponds to:

1
2
3
4
5

<section name="AdminLoginFormSection">
   <element name="username" type="input" selector="#newSelector"/>
   <element name="password" type="input" selector="#login"/>
   <element name="signIn" type="button" selector=".actions .action-primary" timeout="30"/>
</section>

Merge data

You can add or update <data> elements within an <entity>. Removal of individual <data> tags is not supported.

Entities and data with the same file name, entity name and type, and data key are merged during test generation.

Add data

Use case: The FooSample module extends the Sample module and requires a new data item thirdField in the _defaultSample entity. Add <data key="thirdField">field3</data> to the _defaultSample (the .../Sample/Data/SampleData.xml file):

1
2
3
4
5
6

<entities ...>
   <entity name="_defaultSample" type="testData">
      <data key="firstField">field1</data>
      <data key="secondField">field2</data>
   </entity>
</entities>

Create the .../FooSample/Data/SampleData.xml file:

1
2
3
4
5

<entities ...>
   <entity name="sampleData" type="testData">
      <data key="thirdField">field3</data>
   </entity>
</entities>

The _defaultSample result corresponds to:

1
2
3
4
5

<entity name="_defaultSample" type="testData">
   <data key="firstField">field1</data>
   <data key="secondField">field2</data>
   <data key="thirdField">field3</data>
</entity>

Update data

Use case: The FooSample module extends the Sample module and requires changing the firstField data item in the _defaultSample entity. Change firstField to <data key="firstField">overrideField</data> in the _defaultSample (the .../Sample/Data/SampleData.xml file):

1
2
3
4
5
6

<entities ...>
   <entity name="_defaultSample" type="testData">
      <data key="firstField">field1</data>
      <data key="secondField">field2</data>
   </entity>
</entity>

Create the .../FooSample/Data/SampleData.xml file:

1
2
3
4
5

<entities ...>
   <entity name="_defaultSample" type="testData">
      <data key="firstField">overrideField</data>
   </entity>
</entity>

The _defaultSample results corresponds to:

1
2
3
4

<entity name="_defaultSample" type="testData">
   <data key="firstField">overrideField</data>
   <data key="secondField">field2</data>
</entity>
© 2020 Magento. All rights reserved.