Merge pull request #176 from magento-gl/MQE-2903

MQE-2903:Implement rapid times X clicks on UI element in MFTF

Author: KevinBKozan

dev/tests/verification/Resources/DataActionsTest.txt

@@ -58,6 +58,7 @@ class DataActionsTestCest
 		$I->deleteEntity("createdInTest", "test"); // stepKey: deleteInTest
 		$I->updateEntity("createdInBefore", "test", "entity",[]); // stepKey: updatedDataOutOfScope
 		$I->deleteEntity("createdInBefore", "test"); // stepKey: deleteDataOutOfScope
+		$I->rapidClick("#functionalTestSelector", "50"); // stepKey: rapidClickTest
 	}
 
 	public function _passed(AcceptanceTester $I)

dev/tests/verification/TestModule/Test/DataActionsTest.xml

@@ -18,5 +18,6 @@
         <deleteData createDataKey="createdInTest" stepKey="deleteInTest"/>
         <updateData entity="entity" createDataKey="createdInBefore" stepKey="updatedDataOutOfScope"/>
         <deleteData createDataKey="createdInBefore" stepKey="deleteDataOutOfScope"/>
+        <rapidClick selector="#functionalTestSelector" count="50" stepKey="rapidClickTest"/>
     </test>
-</tests>
+</tests>

docs/test/actions.md

@@ -973,6 +973,25 @@ Attribute|Type|Use|Description
 <dragAndDrop selector1="#block1" selector2="#block2" x="50" y="50" stepKey="dragAndDrop"/>
 ```
 
+### rapidClick
+
+See [rapidClick docs on codeception.com](http://codeception.com/docs/modules/WebDriver#rapidClick).
+
+| Attribute  | Type   | Use      | Description                                     |
+|------------|--------|----------|-------------------------------------------------|
+| `selector` | string | optional | A selector for the HTML element to rapid click. |
+| `count`    | string | required | Click count.                                    |
+| `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.                  |
+
+#### Examples
+
+```xml
+<!-- Rapid click the selected element as per given count number -->
+<rapidClick selector="#selector" count="50" stepKey="rapidClick"/>
+```
+
 ### executeJS
 
 See [executeJS docs on codeception.com](http://codeception.com/docs/modules/WebDriver#executeJS).
@@ -1077,7 +1096,7 @@ This action can optionally contain one or more [requiredEntity](#requiredentity)
 ### getOTP
 
 Generate a one-time password (OTP) based on a saved `secret` at path `magento/tfa/OTP_SHARED_SECRET` in a MFTF credential storage.
-The one-time password (OTP) is returned and accessible through the stepkey. 
+The one-time password (OTP) is returned and accessible through the stepkey.
 
 MFTF use TOTP from [Spomky-Labs/otphp](https://github.com/Spomky-Labs/otphp), if you want to learn more about this action.
 

src/Magento/FunctionalTestingFramework/Module/MagentoWebDriver.php

@@ -792,6 +792,21 @@ public function dragAndDrop($source, $target, $xOffset = null, $yOffset = null)
             $action->release($tnodes)->perform();
         }
     }
+    
+    /**
+     * Simple rapid click as per given count number.
+     *
+     * @param string $selector
+     * @param string $count
+     * @return void
+     * @throws \Exception
+     */
+    public function rapidClick($selector, $count)
+    {
+        for ($i = 0; $i < $count; $i++) {
+            $this->click($selector);
+        }
+    }
 
     /**
      * Function used to fill sensitive credentials with user data, data is decrypted immediately prior to fill to avoid

src/Magento/FunctionalTestingFramework/Test/etc/actionTypeTags.xsd

@@ -34,6 +34,7 @@
             <xs:element type="closeTabType" name="closeTab" minOccurs="0" maxOccurs="unbounded"/>
             <xs:element type="commentType" name="comment" minOccurs="0" maxOccurs="unbounded"/>
             <xs:element type="dragAndDropType" name="dragAndDrop" minOccurs="0" maxOccurs="unbounded"/>
+            <xs:element type="rapidClickType" name="rapidClick" minOccurs="0" maxOccurs="unbounded"/>
             <xs:element type="executeJSType" name="executeJS" minOccurs="0" maxOccurs="unbounded"/>
             <xs:element type="fillFieldType" name="fillField" minOccurs="0" maxOccurs="unbounded"/>
             <xs:element type="loadSessionSnapshotType" name="loadSessionSnapshot" minOccurs="0" maxOccurs="unbounded"/>
@@ -253,6 +254,33 @@
         </xs:simpleContent>
     </xs:complexType>
 
+    <xs:complexType name="rapidClickType">
+        <xs:annotation>
+            <xs:documentation>
+                Performs simple mouse rapid click as per given count.
+            </xs:documentation>
+        </xs:annotation>
+        <xs:simpleContent>
+            <xs:extension base="xs:string">
+                <xs:attribute type="xs:string" name="selector" use="required">
+                    <xs:annotation>
+                        <xs:documentation>
+                            Selector for rapid click.
+                        </xs:documentation>
+                    </xs:annotation>
+                </xs:attribute>
+                <xs:attribute type="xs:string" name="count" use="required">
+                    <xs:annotation>
+                        <xs:documentation>
+                            Click count.
+                        </xs:documentation>
+                    </xs:annotation>
+                </xs:attribute>
+                <xs:attributeGroup ref="commonActionAttributes"/>
+            </xs:extension>
+        </xs:simpleContent>
+    </xs:complexType>
+
     <xs:complexType name="dragAndDropType">
         <xs:annotation>
             <xs:documentation>

src/Magento/FunctionalTestingFramework/Util/TestGenerator.php

@@ -774,6 +774,12 @@ public function generateStepsPhp($actionObjects, $generationScope = TestGenerato
                 $selector = $this->resolveLocatorFunctionInAttribute($selector);
             }
 
+            if (isset($customActionAttributes['count'])) {
+                $countClickValue = $customActionAttributes['count'];
+                $countValue = $this->addUniquenessFunctionCall($countClickValue);
+                $countValue = $this->resolveLocatorFunctionInAttribute($countValue);
+            }
+
             if (isset($customActionAttributes['selector1']) || isset($customActionAttributes['filterSelector'])) {
                 $selectorOneValue = $customActionAttributes['selector1'] ?? $customActionAttributes['filterSelector'];
                 $selector1 = $this->addUniquenessFunctionCall($selectorOneValue);
@@ -1159,6 +1165,14 @@ public function generateStepsPhp($actionObjects, $generationScope = TestGenerato
                         $y
                     );
                     break;
+                case "rapidClick":
+                    $testSteps .= $this->wrapFunctionCall(
+                        $actor,
+                        $actionObject,
+                        $selector,
+                        $countValue
+                    );
+                    break;
                 case "selectMultipleOptions":
                     $testSteps .= $this->wrapFunctionCall(
                         $actor,