Merge branch 'develop' into MQE-3124

jilu1 · web-flow · commit 7111f9db0799 · 2022-01-04T14:05:56.000-06:00
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,13 @@
 Magento Functional Testing Framework Changelog
 ================================================
+3.7.3
+---------
+
+### Updates:
+* Fix encoding issue when secret key contains plus sign
+* Adding pagebuilder file upload spinner to loadingMaskLocators
+
+
 3.7.2
 ---------
 
diff --git a/composer.json b/composer.json
@@ -2,7 +2,7 @@
     "name": "magento/magento2-functional-testing-framework",
     "description": "Magento2 Functional Testing Framework",
     "type": "library",
-    "version": "3.7.2",
+    "version": "3.7.3",
     "license": "AGPL-3.0",
     "keywords": ["magento", "automation", "functional", "testing"],
     "config": {
diff --git a/composer.lock b/composer.lock
diff --git a/dev/tests/functional/tests/MFTF/DevDocs/Helper/CustomHelper.php b/dev/tests/functional/tests/MFTF/DevDocs/Helper/CustomHelper.php
@@ -46,4 +46,15 @@ public function goTo(
         print('$bla = ' . $bla . PHP_EOL);
         print('array $arraysomething = [' . implode(', ', $arraysomething) . ']' . PHP_EOL);
     }
+
+    /**
+     * Returns value of provided param $text
+     *
+     * @param string $text
+     * @return string
+     */
+    public function getText(string $text): string
+    {
+        return $text;
+    }
 }
diff --git a/dev/tests/functional/tests/MFTF/DevDocs/Test/DevDocsTest.xml b/dev/tests/functional/tests/MFTF/DevDocs/Test/DevDocsTest.xml
@@ -42,6 +42,14 @@
             <argument name="int">987</argument>
         </helper>
 
+        <helper class="\MFTF\DevDocs\Helper\CustomHelper" method="getText" stepKey="getText">
+            <argument name="text">some text</argument>
+        </helper>
+        <assertEquals stepKey="assertHelperReturnValue" message="Method getText of CustomHelper should return value which may be used as variable in test">
+            <expectedResult type="string">some text</expectedResult>
+            <actualResult type="variable">getText</actualResult>
+        </assertEquals>
+
         <actionGroup ref="HelperActionGroup" stepKey="actionGroupWithCustomHelper">
             <argument name="test" value="{{HelperData.entityField}}" />
             <argument name="entityTest" value="HelperData" />
diff --git a/dev/tests/verification/Resources/DataActionsTest.txt b/dev/tests/verification/Resources/DataActionsTest.txt
@@ -53,6 +53,7 @@ class DataActionsTestCest
 	 */
 	public function DataActionsTest(AcceptanceTester $I)
 	{
+		$I->waitForElementClickable(".functionalTestSelector"); // stepKey: waitForElementClickable
 		$I->createEntity("createdInTest", "test", "entity", [], []); // stepKey: createdInTest
 		$I->updateEntity("createdInTest", "test", "entity",[]); // stepKey: updateInTest
 		$I->deleteEntity("createdInTest", "test"); // stepKey: deleteInTest
diff --git a/dev/tests/verification/TestModule/Test/DataActionsTest.xml b/dev/tests/verification/TestModule/Test/DataActionsTest.xml
@@ -13,8 +13,9 @@
             <createData entity="entity" stepKey="createdInBefore"/>
             <updateData entity="entity" createDataKey="createdInBefore" stepKey="updateInBefore"/>
             <deleteData createDataKey="createdInBefore" stepKey="deleteInBefore"/>
-        </before>
 
+        </before>
+        <waitForElementClickable selector=".functionalTestSelector" time="30" stepKey="waitForElementClickable" />
         <createData entity="entity" stepKey="createdInTest"/>
         <updateData entity="entity" createDataKey="createdInTest" stepKey="updateInTest"/>
         <deleteData createDataKey="createdInTest" stepKey="deleteInTest"/>
diff --git a/docs/test/actions.md b/docs/test/actions.md
@@ -2374,10 +2374,28 @@ Attribute|Type|Use|Description
 #### Example
 
 ```xml
-<!-- Wait up to 30 seconds for `<div id="changedElement" ... >...</div>` to become visible on the page before continuing. -->
 <waitForElementVisible selector="#changedElement" stepKey="waitForElementVisible"/>
 ```
 
+### waitForElementClickable
+
+See [waitForElementClickable docs on codeception.com](http://codeception.com/docs/modules/WebDriver#waitForElementClickable).
+
+Attribute|Type|Use|Description
+---|---|---|---
+`selector`|string|optional| The selector identifying the corresponding HTML element.
+`time`|string|optional| The number of seconds to wait for the element to appear.
+`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.
+
+#### Example
+
+```xml
+<!-- Waits up to $timeout seconds for the given element to be clickable. If element doesn’t become clickable, a timeout exception is thrown. -->
+<waitForElementClickable selector="#changedElement" stepKey="waitForElementClickable"/>
+```
+
 ### waitForJS
 
 See [waitForJS docs on codeception.com](http://codeception.com/docs/modules/WebDriver#waitForJS).
diff --git a/src/Magento/FunctionalTestingFramework/Module/MagentoWebDriver.php b/src/Magento/FunctionalTestingFramework/Module/MagentoWebDriver.php
@@ -72,6 +72,9 @@ class MagentoWebDriver extends WebDriver
         '//div[contains(@class, "admin__data-grid-loading-mask")]',
         '//div[contains(@class, "admin__form-loading-mask")]',
         '//div[@data-role="spinner"]',
+        '//div[contains(@class,"file-uploader-spinner")]',
+        '//div[contains(@class,"image-uploader-spinner")]',
+        '//div[contains(@class,"uploader")]//div[@class="file-row"]',
     ];
 
     /**
diff --git a/src/Magento/FunctionalTestingFramework/Test/etc/Actions/waitActions.xsd b/src/Magento/FunctionalTestingFramework/Test/etc/Actions/waitActions.xsd
@@ -23,6 +23,8 @@
             <xs:element type="waitForPwaElementNotVisibleType" name="waitForPwaElementNotVisible" minOccurs="0" maxOccurs="unbounded"/>
             <xs:element type="waitForPwaElementVisibleType" name="waitForPwaElementVisible" minOccurs="0" maxOccurs="unbounded"/>
             <xs:element type="waitForTextType" name="waitForText" minOccurs="0" maxOccurs="unbounded"/>
+            <xs:element type="waitForElementClickableType" name="waitForElementClickable" minOccurs="0" maxOccurs="unbounded"/>
+
         </xs:choice>
     </xs:group>
 
@@ -224,4 +226,19 @@
             </xs:extension>
         </xs:simpleContent>
     </xs:complexType>
+    <xs:complexType name="waitForElementClickableType">
+        <xs:annotation>
+            <xs:documentation>
+                Waits up to $timeout seconds for the given element to be clickable.
+                If element doesn’t become clickable, a timeout exception is thrown.
+            </xs:documentation>
+        </xs:annotation>
+        <xs:simpleContent>
+            <xs:extension base="xs:string">
+                <xs:attribute ref="selector" use="required"/>
+                <xs:attribute ref="time"/>
+                <xs:attributeGroup ref="commonActionAttributes"/>
+            </xs:extension>
+        </xs:simpleContent>
+    </xs:complexType>
 </xs:schema>
diff --git a/src/Magento/FunctionalTestingFramework/Util/TestGenerator.php b/src/Magento/FunctionalTestingFramework/Util/TestGenerator.php
@@ -898,7 +898,12 @@ public function generateStepsPhp($actionObjects, $generationScope = TestGenerato
                         $stepKey,
                         $customActionAttributes['class'] . '::' . $customActionAttributes['method']
                     );
-                    $testSteps .= $this->wrapFunctionCall($actor, $actionObject, $arguments);
+                    $testSteps .= $this->wrapFunctionCallWithReturnValue(
+                        $stepKey,
+                        $actor,
+                        $actionObject,
+                        $arguments
+                    );
                     break;
                 case "createData":
                     $entity = $customActionAttributes['entity'];
@@ -2016,16 +2021,7 @@ private function addDollarSign($input)
      */
     private function wrapFunctionCall($actor, $action, ...$args)
     {
-        $isFirst = true;
-        $isActionHelper = $action->getType() === 'helper';
-        $actionType = $action->getType();
-        if ($isActionHelper) {
-            $actor = "this->helperContainer->get('" . $action->getCustomActionAttributes()['class'] . "')";
-            $args = $args[0];
-            $actionType = $action->getCustomActionAttributes()['method'];
-        }
-
-        $output = sprintf("\t\t$%s->%s(", $actor, $actionType);
+        $output = sprintf("\t\t$%s->%s(", $actor, $action->getType());
         for ($i = 0; $i < count($args); $i++) {
             if (null === $args[$i]) {
                 continue;
@@ -2046,17 +2042,22 @@ private function wrapFunctionCall($actor, $action, ...$args)
     /**
      * Wrap parameters into a function call with a return value.
      *
-     * @param string $returnVariable
-     * @param string $actor
-     * @param string $action
-     * @param array  ...$args
+     * @param string       $returnVariable
+     * @param string       $actor
+     * @param actionObject $action
+     * @param array        ...$args
      * @return string
      * @throws \Exception
      */
     private function wrapFunctionCallWithReturnValue($returnVariable, $actor, $action, ...$args)
     {
-        $isFirst = true;
-        $output = sprintf("\t\t$%s = $%s->%s(", $returnVariable, $actor, $action->getType());
+        $actionType = $action->getType();
+        if ($actionType === 'helper') {
+            $actor = "this->helperContainer->get('" . $action->getCustomActionAttributes()['class'] . "')";
+            $args = $args[0];
+            $actionType = $action->getCustomActionAttributes()['method'];
+        }
+        $output = sprintf("\t\t$%s = $%s->%s(", $returnVariable, $actor, $actionType);
         for ($i = 0; $i < count($args); $i++) {
             if (null === $args[$i]) {
                 continue;

Original file line number	Diff line number	Diff line change
`@@ -53,6 +53,7 @@ class DataActionsTestCest`
`53`	`53`	`*/`
`54`	`54`	`public function DataActionsTest(AcceptanceTester $I)`
`55`	`55`	`{`
	`56`	`+ $I->waitForElementClickable(".functionalTestSelector"); // stepKey: waitForElementClickable`
`56`	`57`	`$I->createEntity("createdInTest", "test", "entity", [], []); // stepKey: createdInTest`
`57`	`58`	`$I->updateEntity("createdInTest", "test", "entity",[]); // stepKey: updateInTest`
`58`	`59`	`$I->deleteEntity("createdInTest", "test"); // stepKey: deleteInTest`