MQE-336: [Generator] Add support for Codeception "Locator" selectors

KevinBKozan · web-flow · commit ff6d257eea1e · 2017-11-10T11:20:19.000-06:00
- Added locatorFunction attribute to elements and ElementObject
- Changed ActionObject to look for selector, then locatorFunction when trying to resolve element references.
- TestGenerator fixes to add double quotes to locatorFunction arguments, necessary for good output.
- Verification test fixes and additions.
diff --git a/dev/tests/verification/Resources/ActionGroupFunctionalCest.txt b/dev/tests/verification/Resources/ActionGroupFunctionalCest.txt
@@ -5,6 +5,7 @@ use Magento\FunctionalTestingFramework\AcceptanceTester;
 use Magento\FunctionalTestingFramework\DataGenerator\Handlers\DataObjectHandler;
 use Magento\FunctionalTestingFramework\DataGenerator\Persist\DataPersistenceHandler;
 use Magento\FunctionalTestingFramework\DataGenerator\Objects\EntityDataObject;
+use \Codeception\Util\Locator;
 use Yandex\Allure\Adapter\Annotation\Features;
 use Yandex\Allure\Adapter\Annotation\Stories;
 use Yandex\Allure\Adapter\Annotation\Title;
diff --git a/dev/tests/verification/Resources/BasicFunctionalCest.txt b/dev/tests/verification/Resources/BasicFunctionalCest.txt
@@ -5,6 +5,7 @@ use Magento\FunctionalTestingFramework\AcceptanceTester;
 use Magento\FunctionalTestingFramework\DataGenerator\Handlers\DataObjectHandler;
 use Magento\FunctionalTestingFramework\DataGenerator\Persist\DataPersistenceHandler;
 use Magento\FunctionalTestingFramework\DataGenerator\Objects\EntityDataObject;
+use \Codeception\Util\Locator;
 use Yandex\Allure\Adapter\Annotation\Features;
 use Yandex\Allure\Adapter\Annotation\Stories;
 use Yandex\Allure\Adapter\Annotation\Title;
diff --git a/dev/tests/verification/Resources/DataReplacementCest.txt b/dev/tests/verification/Resources/DataReplacementCest.txt
@@ -5,6 +5,7 @@ use Magento\FunctionalTestingFramework\AcceptanceTester;
 use Magento\FunctionalTestingFramework\DataGenerator\Handlers\DataObjectHandler;
 use Magento\FunctionalTestingFramework\DataGenerator\Persist\DataPersistenceHandler;
 use Magento\FunctionalTestingFramework\DataGenerator\Objects\EntityDataObject;
+use \Codeception\Util\Locator;
 use Yandex\Allure\Adapter\Annotation\Features;
 use Yandex\Allure\Adapter\Annotation\Stories;
 use Yandex\Allure\Adapter\Annotation\Title;
diff --git a/dev/tests/verification/Resources/LocatorFunctionCest.txt b/dev/tests/verification/Resources/LocatorFunctionCest.txt
@@ -0,0 +1,46 @@
+<?php
+namespace Magento\AcceptanceTest\_generated\Backend;
+
+use Magento\FunctionalTestingFramework\AcceptanceTester;
+use Magento\FunctionalTestingFramework\DataGenerator\Handlers\DataObjectHandler;
+use Magento\FunctionalTestingFramework\DataGenerator\Persist\DataPersistenceHandler;
+use Magento\FunctionalTestingFramework\DataGenerator\Objects\EntityDataObject;
+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;
+
+/**
+ */
+class LocatorFunctionCest
+{
+	/**
+	 * @Parameter(name = "AcceptanceTester", value="$I")
+	 * @param AcceptanceTester $I
+	 * @return void
+	 */
+	public function LocatorFuctionTest(AcceptanceTester $I)
+	{
+		$I->amGoingTo("create entity that has the mergeKey: data");
+		$ReplacementPerson = DataObjectHandler::getInstance()->getObject("ReplacementPerson");
+		$data = new DataPersistenceHandler($ReplacementPerson);
+		$data->createEntity();
+		$I->click(Locator::contains("'label'", "'Name'"));
+		$I->click(Locator::contains("'label'", "'Name'"));
+		$I->click(Locator::find("'img'", ['title' => 'diagram']));
+		$I->click(Locator::contains("string", "'Name'"));
+		$I->click(Locator::contains("John", "'Name'"));
+		$I->click(Locator::contains($data->getCreatedDataByName('key') . "", "'Name'"));
+		$I->click(Locator::contains("string1", "string2"));
+		$I->click(Locator::contains("John", "Doe"));
+		$I->click(Locator::contains($data->getCreatedDataByName('key1') . "", "" . $data->getCreatedDataByName('key2')));
+		$I->click(Locator::contains("string1", "John"));
+		$I->click(Locator::contains("string1", "" . $data->getCreatedDataByName('key1')));
+		$I->click(Locator::contains("John", "" . $data->getCreatedDataByName('key1')));
+	}
+}
diff --git a/dev/tests/verification/Resources/MergeFunctionalCest.txt b/dev/tests/verification/Resources/MergeFunctionalCest.txt
@@ -5,6 +5,7 @@ use Magento\FunctionalTestingFramework\AcceptanceTester;
 use Magento\FunctionalTestingFramework\DataGenerator\Handlers\DataObjectHandler;
 use Magento\FunctionalTestingFramework\DataGenerator\Persist\DataPersistenceHandler;
 use Magento\FunctionalTestingFramework\DataGenerator\Objects\EntityDataObject;
+use \Codeception\Util\Locator;
 use Yandex\Allure\Adapter\Annotation\Features;
 use Yandex\Allure\Adapter\Annotation\Stories;
 use Yandex\Allure\Adapter\Annotation\Title;
diff --git a/dev/tests/verification/Resources/PageReplacementCest.txt b/dev/tests/verification/Resources/PageReplacementCest.txt
@@ -5,6 +5,7 @@ use Magento\FunctionalTestingFramework\AcceptanceTester;
 use Magento\FunctionalTestingFramework\DataGenerator\Handlers\DataObjectHandler;
 use Magento\FunctionalTestingFramework\DataGenerator\Persist\DataPersistenceHandler;
 use Magento\FunctionalTestingFramework\DataGenerator\Objects\EntityDataObject;
+use \Codeception\Util\Locator;
 use Yandex\Allure\Adapter\Annotation\Features;
 use Yandex\Allure\Adapter\Annotation\Stories;
 use Yandex\Allure\Adapter\Annotation\Title;
diff --git a/dev/tests/verification/Resources/ParameterArrayCest.txt b/dev/tests/verification/Resources/ParameterArrayCest.txt
@@ -5,6 +5,7 @@ use Magento\FunctionalTestingFramework\AcceptanceTester;
 use Magento\FunctionalTestingFramework\DataGenerator\Handlers\DataObjectHandler;
 use Magento\FunctionalTestingFramework\DataGenerator\Persist\DataPersistenceHandler;
 use Magento\FunctionalTestingFramework\DataGenerator\Objects\EntityDataObject;
+use \Codeception\Util\Locator;
 use Yandex\Allure\Adapter\Annotation\Features;
 use Yandex\Allure\Adapter\Annotation\Stories;
 use Yandex\Allure\Adapter\Annotation\Title;
diff --git a/dev/tests/verification/Resources/PersistedReplacementCest.txt b/dev/tests/verification/Resources/PersistedReplacementCest.txt
@@ -5,6 +5,7 @@ use Magento\FunctionalTestingFramework\AcceptanceTester;
 use Magento\FunctionalTestingFramework\DataGenerator\Handlers\DataObjectHandler;
 use Magento\FunctionalTestingFramework\DataGenerator\Persist\DataPersistenceHandler;
 use Magento\FunctionalTestingFramework\DataGenerator\Objects\EntityDataObject;
+use \Codeception\Util\Locator;
 use Yandex\Allure\Adapter\Annotation\Features;
 use Yandex\Allure\Adapter\Annotation\Stories;
 use Yandex\Allure\Adapter\Annotation\Title;
diff --git a/dev/tests/verification/Resources/SectionReplacementCest.txt b/dev/tests/verification/Resources/SectionReplacementCest.txt
@@ -5,6 +5,7 @@ use Magento\FunctionalTestingFramework\AcceptanceTester;
 use Magento\FunctionalTestingFramework\DataGenerator\Handlers\DataObjectHandler;
 use Magento\FunctionalTestingFramework\DataGenerator\Persist\DataPersistenceHandler;
 use Magento\FunctionalTestingFramework\DataGenerator\Objects\EntityDataObject;
+use \Codeception\Util\Locator;
 use Yandex\Allure\Adapter\Annotation\Features;
 use Yandex\Allure\Adapter\Annotation\Stories;
 use Yandex\Allure\Adapter\Annotation\Title;
diff --git a/dev/tests/verification/TestModule/Cest/LocatorFunctionCest.xml b/dev/tests/verification/TestModule/Cest/LocatorFunctionCest.xml
@@ -0,0 +1,32 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+ /**
+  * Copyright © Magento, Inc. All rights reserved.
+  * See COPYING.txt for license details.
+  */
+-->
+
+<config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+        xsi:noNamespaceSchemaLocation="../../../../../src/Magento/FunctionalTestingFramework/Test/etc/testSchema.xsd">
+    <cest name="LocatorFunctionCest">
+        <test name="LocatorFuctionTest">
+            <createData entity="ReplacementPerson" mergeKey="data"/>
+
+            <click mergeKey="SimpleLocator" selector="{{LocatorFunctionSection.simpleLocator}}"/>
+            <click mergeKey="SimpleLocatorNonShorthand" selector="{{LocatorFunctionSection.simpleLocatorNonShorthand}}"/>
+            <click mergeKey="ArrayLocator" selector="{{LocatorFunctionSection.arrayLocator}}"/>
+
+            <click mergeKey="OneParamLiteral" selector="{{LocatorFunctionSection.simpleLocatorOneParam('string')}}"/>
+            <click mergeKey="OneParamData" selector="{{LocatorFunctionSection.simpleLocatorOneParam(ReplacementPerson.firstname)}}"/>
+            <click mergeKey="OneParamPersisted" selector="{{LocatorFunctionSection.simpleLocatorOneParam($data.key$)}}"/>
+
+            <click mergeKey="TwoParamLiteral" selector="{{LocatorFunctionSection.simpleLocatorTwoParam('string1', 'string2')}}"/>
+            <click mergeKey="TwoParamData" selector="{{LocatorFunctionSection.simpleLocatorTwoParam(ReplacementPerson.firstname, ReplacementPerson.lastname)}}"/>
+            <click mergeKey="TwoParamPersisted" selector="{{LocatorFunctionSection.simpleLocatorTwoParam($data.key1$, $data.key2$)}}"/>
+
+            <click mergeKey="TwoParamMix1" selector="{{LocatorFunctionSection.simpleLocatorTwoParam('string1', ReplacementPerson.firstname)}}"/>
+            <click mergeKey="TwoParamMix2" selector="{{LocatorFunctionSection.simpleLocatorTwoParam('string1', $data.key1$)}}"/>
+            <click mergeKey="TwoParamMix3" selector="{{LocatorFunctionSection.simpleLocatorTwoParam(ReplacementPerson.firstname, $data.key1$)}}"/>
+        </test>
+    </cest>
+</config>
diff --git a/dev/tests/verification/TestModule/Section/LocatorFunctionSection.xml b/dev/tests/verification/TestModule/Section/LocatorFunctionSection.xml
@@ -0,0 +1,19 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+ /**
+  * Copyright © Magento, Inc. All rights reserved.
+  * See COPYING.txt for license details.
+  */
+-->
+
+<config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+        xsi:noNamespaceSchemaLocation="../../../../../src/Magento/FunctionalTestingFramework/Page/etc/SectionObject.xsd">
+    <section name="LocatorFunctionSection">
+        <element name="simpleLocator" type="button" locatorFunction="contains('label', 'Name')"/>
+        <element name="simpleLocatorOneParam" type="button" locatorFunction="contains({{arg1}}, 'Name')" parameterized="true"/>
+        <element name="simpleLocatorTwoParam" type="button" locatorFunction="contains({{arg1}}, {{arg2}})" parameterized="true"/>
+        <element name="simpleLocatorNonShorthand" type="button" locatorFunction="Locator::contains('label', 'Name')"/>
+        <element name="arrayLocator" type="button" locatorFunction="find('img', ['title' => 'diagram'])"/>
+        <element name="arrayLocatorTwoParam" type="button" locatorFunction="find({{arg1}}, {{arg2}})" parameterized="true"/>
+    </section>
+</config>
diff --git a/dev/tests/verification/Tests/LocatorFunctionGenerationTest.php b/dev/tests/verification/Tests/LocatorFunctionGenerationTest.php
@@ -0,0 +1,38 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+namespace tests\verification\Tests;
+
+use Magento\FunctionalTestingFramework\Test\Handlers\CestObjectHandler;
+use Magento\FunctionalTestingFramework\Util\TestGenerator;
+use PHPUnit\Framework\TestCase;
+
+class LocatorFunctionGenerationTest extends TestCase
+{
+    const LOCATOR_FUNCTION_CEST = 'LocatorFunctionCest';
+    const RESOURCES_PATH = __DIR__ . '/../Resources';
+
+    /**
+     * Tests generation of actions using elements that have a LocatorFunction.
+     */
+    public function testLocatorFunctionGeneration()
+    {
+        $cest = CestObjectHandler::getInstance()->getObject(self::LOCATOR_FUNCTION_CEST);
+        $test = TestGenerator::getInstance(null, [$cest]);
+        $test->createAllCestFiles();
+
+        $cestFile = $test->getExportDir() .
+            DIRECTORY_SEPARATOR .
+            self::LOCATOR_FUNCTION_CEST .
+            ".php";
+
+        $this->assertTrue(file_exists($cestFile));
+
+        $this->assertFileEquals(
+            self::RESOURCES_PATH . DIRECTORY_SEPARATOR . self::LOCATOR_FUNCTION_CEST . ".txt",
+            $cestFile
+        );
+    }
+}
diff --git a/src/Magento/FunctionalTestingFramework/Page/Handlers/SectionObjectHandler.php b/src/Magento/FunctionalTestingFramework/Page/Handlers/SectionObjectHandler.php
@@ -21,6 +21,7 @@ class SectionObjectHandler implements ObjectHandlerInterface
     const SUB_TYPE = 'element';
     const ELEMENT_TYPE_ATTR = 'type';
     const ELEMENT_SELECTOR_ATTR = 'selector';
+    const ELEMENT_LOCATOR_FUNC_ATTR = 'locatorFunction';
     const ELEMENT_TIMEOUT_ATTR = 'timeout';
     const ELEMENT_PARAMETERIZED = 'parameterized';
 
@@ -109,14 +110,16 @@ private function initSectionObjects()
             $elements = [];
             foreach ($sectionData[SectionObjectHandler::SUB_TYPE] as $elementName => $elementData) {
                 $elementType = $elementData[SectionObjectHandler::ELEMENT_TYPE_ATTR];
-                $elementSelector = $elementData[SectionObjectHandler::ELEMENT_SELECTOR_ATTR];
+                $elementSelector = $elementData[SectionObjectHandler::ELEMENT_SELECTOR_ATTR] ?? null;
+                $elementLocatorFunc = $elementData[SectionObjectHandler::ELEMENT_LOCATOR_FUNC_ATTR] ?? null;
                 $elementTimeout = $elementData[SectionObjectHandler::ELEMENT_TIMEOUT_ATTR] ?? null;
                 $elementParameterized = $elementData[SectionObjectHandler::ELEMENT_PARAMETERIZED] ?? false;
 
                 $elements[$elementName] = new ElementObject(
                     $elementName,
                     $elementType,
                     $elementSelector,
+                    $elementLocatorFunc,
                     $elementTimeout,
                     $elementParameterized
                 );
diff --git a/src/Magento/FunctionalTestingFramework/Page/Objects/ElementObject.php b/src/Magento/FunctionalTestingFramework/Page/Objects/ElementObject.php
@@ -5,6 +5,8 @@
  */
 namespace Magento\FunctionalTestingFramework\Page\Objects;
 
+use Magento\FunctionalTestingFramework\Exceptions\XmlException;
+
 /**
  * Class ElementObject
  */
@@ -33,6 +35,13 @@ class ElementObject
      */
     private $selector;
 
+    /**
+     * Section element locatorFunction
+     *
+     * @var string
+     */
+    private $locatorFunction;
+
     /**
      * Section element timeout
      *
@@ -52,14 +61,25 @@ class ElementObject
      * @param string $name
      * @param string $type
      * @param string $selector
+     * @param string $locatorFunction
      * @param string $timeout
      * @param bool $parameterized
+     * @throws XmlException
      */
-    public function __construct($name, $type, $selector, $timeout, $parameterized)
+    public function __construct($name, $type, $selector, $locatorFunction, $timeout, $parameterized)
     {
+        //Elements cannot have both a selector and a locatorFunction defined
+        if ($selector != null && $locatorFunction != null) {
+            throw new XmlException("Element '{$name}' cannot have both a selector and a locatorFunction.");
+        }
+
         $this->name = $name;
         $this->type = $type;
         $this->selector = $selector;
+        $this->locatorFunction = $locatorFunction;
+        if (strpos($locatorFunction, "Locator::") === false) {
+            $this->locatorFunction = "Locator::" . $locatorFunction;
+        }
         $this->timeout = $timeout;
         $this->parameterized = $parameterized;
     }
@@ -94,6 +114,16 @@ public function getSelector()
         return $this->selector;
     }
 
+    /**
+     * Getter for the locatorFunction of an element
+     *
+     * @return string
+     */
+    public function getLocatorFunction()
+    {
+        return $this->locatorFunction;
+    }
+
     /**
      * Returns an integer representing an element's timeout
      *
diff --git a/src/Magento/FunctionalTestingFramework/Page/etc/SectionObject.xsd b/src/Magento/FunctionalTestingFramework/Page/etc/SectionObject.xsd
@@ -64,10 +64,17 @@
                     </xs:documentation>
                 </xs:annotation>
             </xs:attribute>
-            <xs:attribute type="notEmptyType" name="selector" use="required">
+            <xs:attribute type="notEmptyType" name="selector" use="optional">
                 <xs:annotation>
                     <xs:documentation>
-                        Selector of the element.
+                        Selector of the element. Optional due to being able to use either this or locatorFunction.
+                    </xs:documentation>
+                </xs:annotation>
+            </xs:attribute>
+            <xs:attribute type="notEmptyType" name="locatorFunction" use="optional">
+                <xs:annotation>
+                    <xs:documentation>
+                        LocatorFunction of an element, substitute for a selector.
                     </xs:documentation>
                 </xs:annotation>
             </xs:attribute>
diff --git a/src/Magento/FunctionalTestingFramework/Test/Objects/ActionObject.php b/src/Magento/FunctionalTestingFramework/Test/Objects/ActionObject.php
@@ -323,7 +323,9 @@ private function findAndReplaceReferences($objectHandler, $inputString)
                         throw new TestReferenceException("Could not resolve entity reference " . $inputString);
                     }
                     $parameterized = $obj->getElement($objField)->isParameterized();
-                    $replacement = $obj->getElement($objField)->getSelector();
+                    // If no Selector is defined, assume element has LocatorFunction
+                    $replacement = $obj->getElement($objField)->getSelector() ?:
+                        $obj->getElement($objField)->getLocatorFunction();
                     $this->timeout = $obj->getElement($objField)->getTimeout();
                     break;
                 case (get_class($obj) == EntityDataObject::class):
diff --git a/src/Magento/FunctionalTestingFramework/Util/TestGenerator.php b/src/Magento/FunctionalTestingFramework/Util/TestGenerator.php
