Skip to content

MQE-1886: Ability to use grab data between ActionGroups #755

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Jul 22, 2020
Merged

MQE-1886: Ability to use grab data between ActionGroups #755

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
8f60fa8
MQE-1886: Ability to use grab data between ActionGroups
soumyau Jul 13, 2020
6a27c3c
Merge remote-tracking branch 'origin/develop' into MQE-1886
soumyau Jul 17, 2020
324bb68
MQE-1886: Ability to use grab data between ActionGroups
soumyau Jul 20, 2020
669f5ee
MQE-1886: Ability to use grab data between ActionGroups
soumyau Jul 20, 2020
e01a26f
MQE-1886: Ability to use grab data between ActionGroups
soumyau Jul 21, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
75 changes: 75 additions & 0 deletions dev/tests/verification/Resources/ActionGroupReturningValueTest.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,75 @@
<?php
namespace Magento\AcceptanceTest\_default\Backend;

use Magento\FunctionalTestingFramework\AcceptanceTester;
use \Codeception\Util\Locator;
use Yandex\Allure\Adapter\Annotation\Features;
use Yandex\Allure\Adapter\Annotation\Stories;
use Yandex\Allure\Adapter\Annotation\Title;
use Yandex\Allure\Adapter\Annotation\Description;
use Yandex\Allure\Adapter\Annotation\Parameter;
use Yandex\Allure\Adapter\Annotation\Severity;
use Yandex\Allure\Adapter\Model\SeverityLevel;
use Yandex\Allure\Adapter\Annotation\TestCaseId;

/**
* @group functional
* @Description("<h3>Test files</h3>verification/TestModule/Test/ActionGroupFunctionalTest/ActionGroupReturningValueTest.xml<br>")
*/
class ActionGroupReturningValueTestCest
{
/**
* @param AcceptanceTester $I
* @throws \Exception
*/
public function _before(AcceptanceTester $I)
{
$I->createEntity("createPersonParam", "hook", "ReplacementPerson", [], []); // stepKey: createPersonParam
$I->comment("Entering Action Group [beforeGroup] FunctionalActionGroup");
$I->fillField("#foo", "myData1"); // stepKey: fillField1BeforeGroup
$I->fillField("#bar", "myData2"); // stepKey: fillField2BeforeGroup
$I->comment("Exiting Action Group [beforeGroup] FunctionalActionGroup");
}

/**
* @param AcceptanceTester $I
* @throws \Exception
*/
public function _after(AcceptanceTester $I)
{
$I->comment("Entering Action Group [afterGroup] FunctionalActionGroup");
$I->fillField("#foo", "myData1"); // stepKey: fillField1AfterGroup
$I->fillField("#bar", "myData2"); // stepKey: fillField2AfterGroup
$I->comment("Exiting Action Group [afterGroup] FunctionalActionGroup");
}

/**
* @param AcceptanceTester $I
* @throws \Exception
*/
public function _failed(AcceptanceTester $I)
{
$I->saveScreenshot(); // stepKey: saveScreenshot
}

/**
* @Severity(level = SeverityLevel::CRITICAL)
* @Features({"TestModule"})
* @Stories({"MQE-433"})
* @Parameter(name = "AcceptanceTester", value="$I")
* @param AcceptanceTester $I
* @return void
* @throws \Exception
*/
public function ActionGroupReturningValueTest(AcceptanceTester $I)
{
$I->amOnPage("/someUrl"); // stepKey: step1
$I->comment("Entering Action Group [actionGroupWithReturnValue1] FunctionalActionGroupWithReturnValueActionGroup");
$grabTextFrom1ActionGroupWithReturnValue1 = $I->grabTextFrom("#foo"); // stepKey: grabTextFrom1ActionGroupWithReturnValue1
$actionGroupWithReturnValue1 = $I->return($grabTextFrom1ActionGroupWithReturnValue1); // stepKey: returnActionGroupWithReturnValue1
$I->comment("Exiting Action Group [actionGroupWithReturnValue1] FunctionalActionGroupWithReturnValueActionGroup");
$I->comment("Entering Action Group [actionGroupWithStringUsage1] actionGroupWithStringUsage");
$I->see($actionGroupWithReturnValue1, "#element .{$actionGroupWithReturnValue1}"); // stepKey: see1ActionGroupWithStringUsage1
$I->comment("Exiting Action Group [actionGroupWithStringUsage1] actionGroupWithStringUsage");
}
}
14 changes: 14 additions & 0 deletions ...ule/ActionGroup/FunctionalActionGroup/FunctionalActionGroupWithReturnValueActionGroup.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
<?xml version="1.0" encoding="UTF-8"?>
<!--
/**
* Copyright © Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/
-->
<actionGroups xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:noNamespaceSchemaLocation="urn:magento:mftf:Test/etc/actionGroupSchema.xsd">
<actionGroup name="FunctionalActionGroupWithReturnValueActionGroup">
<grabTextFrom selector="#foo" stepKey="grabTextFrom1"/>
<return value="{$grabTextFrom1}" stepKey="return"/>
</actionGroup>
</actionGroups>
30 changes: 30 additions & 0 deletions .../verification/TestModule/Test/ActionGroupFunctionalTest/ActionGroupReturningValueTest.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
<?xml version="1.0" encoding="UTF-8"?>
<!--
/**
* Copyright © Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/
-->
<tests xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:noNamespaceSchemaLocation="urn:magento:mftf:Test/etc/testSchema.xsd">
<test name="ActionGroupReturningValueTest">
<annotations>
<severity value="CRITICAL"/>
<group value="functional"/>
<features value="Action Group Functional Cest"/>
<stories value="MQE-433"/>
</annotations>
<before>
<createData entity="ReplacementPerson" stepKey="createPersonParam"/>
<actionGroup ref="FunctionalActionGroup" stepKey="beforeGroup"/>
</before>
<amOnPage url="/someUrl" stepKey="step1"/>
<actionGroup ref="FunctionalActionGroupWithReturnValueActionGroup" stepKey="actionGroupWithReturnValue1"/>
<actionGroup ref="actionGroupWithStringUsage" stepKey="actionGroupWithStringUsage1">
<argument name="someArgument" value="{$actionGroupWithReturnValue1}"/>
</actionGroup>
<after>
<actionGroup ref="FunctionalActionGroup" stepKey="afterGroup"/>
</after>
</test>
</tests>
11 changes: 11 additions & 0 deletions dev/tests/verification/Tests/ActionGroupGenerationTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -228,4 +228,15 @@ public function testActionGroupWithActionStepKeyReferencesInSelectors()
{
$this->generateAndCompareTest('ActionGroupWithParameterizedElementsWithStepKeyReferences');
}

/**
* Test generation of a test referencing an action group that returns a value.
*
* @throws \Exception
* @throws \Magento\FunctionalTestingFramework\Exceptions\TestReferenceException
*/
public function testActionGroupReturningValue()
{
$this->generateAndCompareTest('ActionGroupReturningValueTest');
}
}
28 changes: 28 additions & 0 deletions docs/test/action-groups.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -180,6 +180,34 @@ MFTF resolves `{{myCustomEntity.field1}}` the same as it would in a `selector` o
</actionGroup>
```

## Returning a value

Action groups can return a value using `<return>` action.

```xml
<actionGroup name="GetOrderIdActionGroup">
<seeElement selector="{{CheckoutSuccessMainSection.orderLink}}" stepKey="assertOrderLink"/>
<grabTextFrom selector="{{CheckoutSuccessMainSection.orderLink}}" stepKey="orderId"/>
<return value="{$grabTextFrom1}" stepKey="returnOrderId"/>
</actionGroup>
```

This value can be accessed as below:

1. Reference `GetOrderIdActionGroup` action group:
```xml
<!-- Open Orders Index Page -->
<actionGroup ref="GetOrderIdActionGroup" stepKey="getOrderId"/>
```

1. To use the value returned in another action group, using action group stepKey {getOrderId}:
```xml
<!--Filter the Order using Order ID -->
<actionGroup ref="FilterOrderGridByIdActionGroup" stepKey="filterOrderGridById">
<argument name="orderId" value="{$getOrderId}"/>
</actionGroup>
```

## Optimizing action group structures

Structuring properly an action group increases code reusability and readability.
Expand Down
29 changes: 29 additions & 0 deletions docs/test/actions.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -151,6 +151,7 @@ The following test actions return a variable:
* [grabValueFrom](#grabvaluefrom)
* [executeJS](#executejs)
* [getOTP](#getotp)
* [return](#return)

Learn more in [Using data returned by test actions](../data.md#use-data-returned-by-test-actions).

Expand Down Expand Up @@ -1240,6 +1241,34 @@ To access this value, use `{$grabInputName}` in later actions. -->
<grabValueFrom selector="input#name" stepKey="grabInputName"/>
```

### return

Allows action group to return a value. Value can be then accessed in the test using the action group stepKey.

Attribute|Type|Use|Description
---|---|---|---
`value`|string|required| value returned by actionGroup.
`stepKey`|string|required| A unique identifier of the action.

#### Example

```xml
<!-- Returns a value to the action group's step key. -->
<actionGroup name="ActionGroupWithReturnValue">
<grabTextFrom selector="#foo" stepKey="grabTextFrom1"/>
<return value="{$grabTextFrom1}" stepKey="returnValue"/>
</actionGroup>
```
```xml
<!-- To access this value, use `{$actionGroupWithReturnValue}` in later actions or action groups. -->
<test name="ActionGroupReturningValueTest">
<actionGroup ref="ActionGroupWithReturnValue" stepKey="actionGroupWithReturnValue"/>
<actionGroup ref="ActionGroupWithStringUsage" stepKey="actionGroupWithStringUsage">
<argument name="someArgument" value="{$actionGroupWithReturnValue}"/>
</actionGroup>
</test>
```

### loadSessionSnapshot

See [loadSessionSnapshot docs on codeception.com](http://codeception.com/docs/modules/WebDriver#loadSessionSnapshot).
Expand Down
2 changes: 1 addition & 1 deletion etc/di.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@

<!-- Entity value gets replaced in Dom.php before reading $xml -->
<!DOCTYPE config [
<!ENTITY commonTestActions "acceptPopup|actionGroup|amOnPage|amOnUrl|amOnSubdomain|appendField|assertArrayIsSortasserted|assertElementContainsAttribute|attachFile|cancelPopup|checkOption|clearField|click|clickWithLeftButton|clickWithRightButton|closeAdminNotification|closeTab|comment|conditionalClick|createData|deleteData|updateData|getData|dontSee|dontSeeJsError|dontSeeCheckboxIsChecked|dontSeeCookie|dontSeeCurrentUrlEquals|dontSeeCurrentUrlMatches|dontSeeElement|dontSeeElementInDOM|dontSeeInCurrentUrl|dontSeeInField|dontSeeInFormFields|dontSeeInPageSource|dontSeeInSource|dontSeeInTitle|dontSeeLink|dontSeeOptionIsSelected|doubleClick|dragAndDrop|entity|executeJS|fillField|formatCurrency|generateDate|getOTP|grabAttributeFrom|grabCookie|grabFromCurrentUrl|grabMultiple|grabPageSource|grabTextFrom|grabValueFrom|loadSessionSnapshot|loginAsAdmin|magentoCLI|magentoCron|makeScreenshot|maximizeWindow|moveBack|moveForward|moveMouseOver|mSetLocale|mResetLocale|openNewTab|pause|parseFloat|pressKey|reloadPage|resetCookie|submitForm|resizeWindow|saveSessionSnapshot|scrollTo|scrollToTopOfPage|searchAndMultiSelectOption|see|seeCheckboxIsChecked|seeCookie|seeCurrentUrlEquals|seeCurrentUrlMatches|seeElement|seeElementInDOM|seeInCurrentUrl|seeInField|seeInFormFields|seeInPageSource|seeInPopup|seeInSource|seeInTitle|seeLink|seeNumberOfElements|seeOptionIsSelected|selectOption|setCookie|submitForm|switchToIFrame|switchToNextTab|switchToPreviousTab|switchToWindow|typeInPopup|uncheckOption|unselectOption|wait|waitForAjaxLoad|waitForElement|waitForElementChange|waitForElementNotVisible|waitForElementVisible|waitForPwaElementNotVisible|waitForPwaElementVisible|waitForJS|waitForLoadingMaskToDisappear|waitForPageLoad|waitForText|assertArrayHasKey|assertArrayNotHasKey|assertContains|assertStringContainsString|assertStringContainsStringIgnoringCase|assertCount|assertEmpty|assertEquals|assertFalse|assertFileExists|assertFileNotExists|assertGreaterOrEquals|assertGreaterThan|assertGreaterThanOrEqual|assertInstanceOf|assertIsEmpty|assertLessOrEquals|assertLessThan|assertLessThanOrEqual|assertNotContains|assertStringNotContainsString|assertStringNotContainsStringIgnoringCase|assertNotEmpty|assertNotEquals|assertNotInstanceOf|assertNotNull|assertNotRegExp|assertNotSame|assertNull|assertRegExp|assertSame|assertStringStartsNotWith|assertStringStartsWith|assertTrue|expectException|fail|dontSeeFullUrlEquals|dontSee|dontSeeFullUrlMatches|dontSeeInFullUrl|seeFullUrlEquals|seeFullUrlMatches|seeInFullUrl|grabFromFullUrl|helper|assertEqualsWithDelta|assertEqualsCanonicalizing|assertEqualsIgnoringCase|assertNotEqualsWithDelta|assertNotEqualsCanonicalizing|assertNotEqualsIgnoringCase">
<!ENTITY commonTestActions "acceptPopup|actionGroup|amOnPage|amOnUrl|amOnSubdomain|appendField|assertArrayIsSortasserted|assertElementContainsAttribute|attachFile|cancelPopup|checkOption|clearField|click|clickWithLeftButton|clickWithRightButton|closeAdminNotification|closeTab|comment|conditionalClick|createData|deleteData|updateData|getData|dontSee|dontSeeJsError|dontSeeCheckboxIsChecked|dontSeeCookie|dontSeeCurrentUrlEquals|dontSeeCurrentUrlMatches|dontSeeElement|dontSeeElementInDOM|dontSeeInCurrentUrl|dontSeeInField|dontSeeInFormFields|dontSeeInPageSource|dontSeeInSource|dontSeeInTitle|dontSeeLink|dontSeeOptionIsSelected|doubleClick|dragAndDrop|entity|executeJS|fillField|formatCurrency|generateDate|getOTP|grabAttributeFrom|grabCookie|grabFromCurrentUrl|grabMultiple|grabPageSource|grabTextFrom|grabValueFrom|return|loadSessionSnapshot|loginAsAdmin|magentoCLI|magentoCron|makeScreenshot|maximizeWindow|moveBack|moveForward|moveMouseOver|mSetLocale|mResetLocale|openNewTab|pause|parseFloat|pressKey|reloadPage|resetCookie|submitForm|resizeWindow|saveSessionSnapshot|scrollTo|scrollToTopOfPage|searchAndMultiSelectOption|see|seeCheckboxIsChecked|seeCookie|seeCurrentUrlEquals|seeCurrentUrlMatches|seeElement|seeElementInDOM|seeInCurrentUrl|seeInField|seeInFormFields|seeInPageSource|seeInPopup|seeInSource|seeInTitle|seeLink|seeNumberOfElements|seeOptionIsSelected|selectOption|setCookie|submitForm|switchToIFrame|switchToNextTab|switchToPreviousTab|switchToWindow|typeInPopup|uncheckOption|unselectOption|wait|waitForAjaxLoad|waitForElement|waitForElementChange|waitForElementNotVisible|waitForElementVisible|waitForPwaElementNotVisible|waitForPwaElementVisible|waitForJS|waitForLoadingMaskToDisappear|waitForPageLoad|waitForText|assertArrayHasKey|assertArrayNotHasKey|assertContains|assertStringContainsString|assertStringContainsStringIgnoringCase|assertCount|assertEmpty|assertEquals|assertFalse|assertFileExists|assertFileNotExists|assertGreaterOrEquals|assertGreaterThan|assertGreaterThanOrEqual|assertInstanceOf|assertIsEmpty|assertLessOrEquals|assertLessThan|assertLessThanOrEqual|assertNotContains|assertStringNotContainsString|assertStringNotContainsStringIgnoringCase|assertNotEmpty|assertNotEquals|assertNotInstanceOf|assertNotNull|assertNotRegExp|assertNotSame|assertNull|assertRegExp|assertSame|assertStringStartsNotWith|assertStringStartsWith|assertTrue|expectException|fail|dontSeeFullUrlEquals|dontSee|dontSeeFullUrlMatches|dontSeeInFullUrl|seeFullUrlEquals|seeFullUrlMatches|seeInFullUrl|grabFromFullUrl|helper|assertEqualsWithDelta|assertEqualsCanonicalizing|assertEqualsIgnoringCase|assertNotEqualsWithDelta|assertNotEqualsCanonicalizing|assertNotEqualsIgnoringCase">
]>

<config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../src/Magento/FunctionalTestingFramework/ObjectManager/etc/config.xsd">
Expand Down
12 changes: 12 additions & 0 deletions src/Magento/FunctionalTestingFramework/Module/MagentoWebDriver.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1122,4 +1122,16 @@ public function switchToIFrame($locator = null)
$this->webDriver->switchTo()->frame($els[0]);
}
}

/**
* Returns a value to origin of the action.
* TODO: move this function to MagentoActionProxies after MQE-1904
*
* @param mixed $value
* @return mixed
*/
public function return($value)
{
return $value;
}
}
26 changes: 26 additions & 0 deletions src/Magento/FunctionalTestingFramework/Test/etc/Actions/customActions.xsd
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,12 @@
</xs:choice>
</xs:group>

<xs:group name="returnTags">
<xs:choice>
<xs:element type="returnType" name="return" minOccurs="0" maxOccurs="1"/>
</xs:choice>
</xs:group>

<!-- Complex Types -->

<xs:complexType name="helperType">
Expand Down Expand Up @@ -346,6 +352,26 @@
</xs:simpleContent>
</xs:complexType>

<xs:complexType name="returnType">
<xs:annotation>
<xs:documentation>
Used in an action group to return a value. Must be used only once in action group. Do not use in tests or suites.
</xs:documentation>
</xs:annotation>
<xs:simpleContent>
<xs:extension base="xs:string">
<xs:attribute name="value" use="required" type="xs:string">
<xs:annotation>
<xs:documentation>
Value to be returned.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attributeGroup ref="commonActionAttributes"/>
</xs:extension>
</xs:simpleContent>
</xs:complexType>

<xs:simpleType name="sortEnum" final="restriction">
<xs:annotation>
<xs:documentation>
Expand Down
6 changes: 6 additions & 0 deletions src/Magento/FunctionalTestingFramework/Test/etc/actionTypeTags.xsd
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,6 +68,12 @@
</xs:choice>
</xs:group>

<xs:group name="returnTypeTags">
<xs:choice>
<xs:group ref="returnTags"/>
</xs:choice>
</xs:group>

<!-- Complex Types -->

<xs:complexType name="failType">
Expand Down
62 changes: 39 additions & 23 deletions src/Magento/FunctionalTestingFramework/Test/etc/mergedActionGroupSchema.xsd
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,29 +15,21 @@
</xs:choice>
</xs:complexType>
<xs:complexType name="actionsRefType">
<xs:choice minOccurs="0" maxOccurs="unbounded">
<xs:group ref="actionTypeTags"/>
<xs:element name="arguments">
<xs:complexType>
<xs:sequence>
<xs:element name="argument" maxOccurs="unbounded" minOccurs="0">
<xs:complexType>
<xs:attribute type="xs:string" name="name" use="required"/>
<xs:attribute type="xs:string" name="defaultValue"/>
<xs:attribute type="dataTypeEnum" name="type" default="entity"/>
</xs:complexType>
</xs:element>
</xs:sequence>
</xs:complexType>
</xs:element>
<xs:element name="annotations">
<xs:complexType>
<xs:sequence>
<xs:element name="description"/>
</xs:sequence>
</xs:complexType>
</xs:element>
</xs:choice>
<xs:sequence>
<xs:choice minOccurs="0" maxOccurs="unbounded">
<xs:group ref="actionTypeTags"/>
<xs:element ref="arguments"/>
<xs:element ref="annotations"/>
</xs:choice>
<xs:sequence minOccurs="0">
<xs:group ref="returnTags"/>
<xs:choice minOccurs="0" maxOccurs="unbounded">
<xs:group ref="actionTypeTags"/>
<xs:element ref="arguments"/>
<xs:element ref="annotations"/>
</xs:choice>
</xs:sequence>
</xs:sequence>
<xs:attribute type="xs:string" name="name" use="required"/>
<xs:attribute type="xs:string" name="filename"/>
<xs:attribute type="xs:string" name="insertBefore"/>
Expand All @@ -57,4 +49,28 @@
<xs:enumeration value="entity"/>
</xs:restriction>
</xs:simpleType>

<!-- elements -->

<xs:element name="arguments">
<xs:complexType>
<xs:sequence>
<xs:element name="argument" maxOccurs="unbounded" minOccurs="0">
<xs:complexType>
<xs:attribute type="xs:string" name="name" use="required"/>
<xs:attribute type="xs:string" name="defaultValue"/>
<xs:attribute type="dataTypeEnum" name="type" default="entity"/>
</xs:complexType>
</xs:element>
</xs:sequence>
</xs:complexType>
</xs:element>

<xs:element name="annotations">
<xs:complexType>
<xs:sequence>
<xs:element name="description"/>
</xs:sequence>
</xs:complexType>
</xs:element>
</xs:schema>
10 changes: 10 additions & 0 deletions src/Magento/FunctionalTestingFramework/Util/TestGenerator.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1172,6 +1172,16 @@ public function generateStepsPhp($actionObjects, $generationScope = TestGenerato
$selector
);
break;
case "return":
$actionOrigin = $actionObject->getActionOrigin();
$actionOriginStepKey = $actionOrigin[ActionGroupObject::ACTION_GROUP_ORIGIN_TEST_REF];
$testSteps .= $this->wrapFunctionCallWithReturnValue(
$actionOriginStepKey,
$actor,
$actionObject,
$value
);
break;
case "formatCurrency":
$testSteps .= $this->wrapFunctionCallWithReturnValue(
$stepKey,
Expand Down