MQE-349:[PageObjects] Need to add customized function for conditional click

    - add supporting logic for conditional click behavior
    - add conditionalClick schema to test xsd

Author: imeron2433

src/Magento/FunctionalTestingFramework/Module/MagentoWebDriver.php

@@ -99,17 +99,6 @@ public function _getCurrentUri()
         return Uri::retrieveUri($url);
     }
 
-    /**
-     * Returns an array of Elements.
-     *
-     * @param string $locator
-     * @return array
-     */
-    public function findElement($locator)
-    {
-        return $this->_findElements($locator);
-    }
-
     /**
      * Login Magento Admin with given username and password.
      *
@@ -285,6 +274,32 @@ public function scrollToTopOfPage()
         $this->executeJS('window.scrollTo(0,0);');
     }
 
+    /**
+     * Conditional click for an area that should be visible
+     *
+     * @param string $selector
+     * @param string dependentSelector
+     * @param bool $visible
+     */
+    public function conditionalClick($selector, $dependentSelector, $visible)
+    {
+        $el = $this->_findElements($dependentSelector);
+        if (sizeof($el) > 1) {
+            throw new \Exception("more than one element matches selector " . $selector);
+        }
+
+        $clickCondition = null;
+        if ($visible) {
+            $clickCondition = !empty($el) && $el[0]->isDisplayed();
+        } else {
+            $clickCondition = empty($el) || !$el[0]->isDisplayed();
+        }
+
+        if ($clickCondition) {
+            $this->click($selector);
+        }
+    }
+
     /**
      * Override for _failed method in Codeception method. Adds png and html attachments to allure report
      * following parent execution of test failure processing.

src/Magento/FunctionalTestingFramework/Test/Objects/ActionObject.php

@@ -20,6 +20,7 @@
 class ActionObject
 {
     const DATA_ENABLED_ATTRIBUTES = ["userInput", "parameterArray"];
+    const SELECTOR_ENABLED_ATTRIBUTES = ['selector', 'dependentSelector'];
     const MERGE_ACTION_ORDER_AFTER = 'after';
     const ACTION_ATTRIBUTE_URL = 'url';
     const ACTION_ATTRIBUTE_SELECTOR = 'selector';
@@ -189,15 +190,20 @@ public function resolveReferences()
      */
     private function resolveSelectorReferenceAndTimeout()
     {
-        if (!array_key_exists(ActionObject::ACTION_ATTRIBUTE_SELECTOR, $this->actionAttributes)) {
+        $actionAttributeKeys = array_keys($this->actionAttributes);
+        $relevantSelectorAttributes = array_intersect($actionAttributeKeys, ActionObject::SELECTOR_ENABLED_ATTRIBUTES);
+
+        if (empty($relevantSelectorAttributes)) {
             return;
         }
 
-        $selector = $this->actionAttributes[ActionObject::ACTION_ATTRIBUTE_SELECTOR];
+        foreach ($relevantSelectorAttributes as $selectorAttribute) {
+            $selector = $this->actionAttributes[$selectorAttribute];
 
-        $replacement = $this->findAndReplaceReferences(SectionObjectHandler::getInstance(), $selector);
-        if ($replacement) {
-            $this->resolvedCustomAttributes[ActionObject::ACTION_ATTRIBUTE_SELECTOR] = $replacement;
+            $replacement = $this->findAndReplaceReferences(SectionObjectHandler::getInstance(), $selector);
+            if ($replacement) {
+                $this->resolvedCustomAttributes[$selectorAttribute] = $replacement;
+            }
         }
     }
 

src/Magento/FunctionalTestingFramework/Test/etc/sampleCest.xml

@@ -21,6 +21,7 @@
             <click selector="" mergeKey=""/>
             <clickWithLeftButton selector="" mergeKey=""/>
             <clickWithRightButton selector="" mergeKey=""/>
+            <conditionalClick mergeKey="" selector="" dependentSelector="" visible="true" />
             <closeTab mergeKey=""/>
             <dontSee userInput="" selector="" mergeKey=""/>
             <dontSeeCheckboxIsChecked selector="" mergeKey=""/>

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

@@ -84,6 +84,7 @@
             <xs:element type="clickWithRightButtonType" name="clickWithRightButton" minOccurs="0" maxOccurs="unbounded"/>
             <xs:element type="closeAdminNotificationType" name="closeAdminNotification" minOccurs="0" maxOccurs="unbounded"/>
             <xs:element type="closeTabType" name="closeTab" minOccurs="0" maxOccurs="unbounded"/>
+            <xs:element type="conditionalClickType" name="conditionalClick" minOccurs="0" maxOccurs="unbounded"/>
             <xs:element type="createDataType" name="createData" minOccurs="0" maxOccurs="unbounded"/>
             <xs:element type="deleteDataType" name="deleteData" minOccurs="0" maxOccurs="unbounded"/>
             <xs:element type="dontSeeType" name="dontSee" minOccurs="0" maxOccurs="unbounded"/>
@@ -352,6 +353,19 @@
             </xs:extension>
         </xs:simpleContent>
     </xs:complexType>
+    <xs:complexType name="conditionalClickType">
+        <xs:simpleContent>
+            <xs:extension base="xs:string">
+                <xs:attribute type="xs:string" name="selector"/>
+                <xs:attribute type="xs:string" name="dependentSelector" />
+                <xs:attribute type="xs:boolean" name="visible"/>
+                <xs:attribute type="xs:string" name="mergeKey" use="required"/>
+                <xs:attribute type="xs:boolean" name="remove" default="false"/>
+                <xs:attribute type="xs:string" name="before"/>
+                <xs:attribute type="xs:string" name="after"/>
+            </xs:extension>
+        </xs:simpleContent>
+    </xs:complexType>
     <xs:complexType name="createDataType">
         <xs:choice minOccurs="0" maxOccurs="unbounded">
             <xs:element type="requiredEntityType" name="required-entity" minOccurs="0" maxOccurs="unbounded"/>

src/Magento/FunctionalTestingFramework/Util/TestGenerator.php

@@ -348,6 +348,8 @@ private function generateStepsPhp($stepsObject, $stepsData, $hookObject = false)
             $value = null;
             $button = null;
             $parameter = null;
+            $dependentSelector = null;
+            $visible = null;
 
             if (isset($customActionAttributes['returnVariable'])) {
                 $returnVariable = $customActionAttributes['returnVariable'];
@@ -450,6 +452,15 @@ private function generateStepsPhp($stepsObject, $stepsData, $hookObject = false)
                 $parameter = $this->wrapWithDoubleQuotes($customActionAttributes['parameter']);
             }
 
+
+            if (isset($customActionAttributes['dependentSelector'])) {
+                $dependentSelector = $this->wrapWithDoubleQuotes($customActionAttributes['dependentSelector']);
+            }
+
+            if (isset($customActionAttributes['visible'])) {
+                $visible = $customActionAttributes['visible'];
+            }
+
             switch ($actionName) {
                 case "createData":
                     $entity = $customActionAttributes['entity'];
@@ -757,6 +768,9 @@ private function generateStepsPhp($stepsObject, $stepsData, $hookObject = false)
                     // TODO: Need to fix xml parser to allow parsing html.
                     $testSteps .= $this->wrapFunctionCall($actor, $actionName, $html);
                     break;
+                case "conditionalClick":
+                    $testSteps .= $this->wrapFunctionCall($actor, $actionName, $selector, $dependentSelector, $visible);
+                    break;
                 default:
                     if ($returnVariable) {
                         $testSteps .= $this->wrapFunctionCallWithReturnValue(