Merge branch 'develop' into MQE-1302

jilu1 · web-flow · commit 6c34dab38693 · 2018-12-11T09:22:48.000-06:00
diff --git a/dev/tests/static/Magento/Sniffs/Commenting/FunctionCommentSniff.php b/dev/tests/static/Magento/Sniffs/Commenting/FunctionCommentSniff.php
@@ -68,7 +68,7 @@ protected function processReturn(File $phpcsFile, $stackPtr, $commentStart)
                 $phpcsFile->addError($error, $return, 'MissingReturnType');
             } else {
                 // Support both a return type and a description.
-                $split = preg_match('`^((?:\|?(?:array\([^\)]*\)|[\\\\a-z0-9\[\]]+))*)( .*)?`i', $content, $returnParts);
+                preg_match('`^((?:\|?(?:array\([^\)]*\)|[\\\\a-z0-9\[\]]+))*)( .*)?`i', $content, $returnParts);
                 if (isset($returnParts[1]) === false) {
                     return;
                 }
@@ -78,7 +78,7 @@ protected function processReturn(File $phpcsFile, $stackPtr, $commentStart)
                 // Check return type (can be multiple, separated by '|').
                 $typeNames      = explode('|', $returnType);
                 $suggestedNames = array();
-                foreach ($typeNames as $i => $typeName) {
+                foreach ($typeNames as $typeName) {
                     $suggestedName = Common::suggestType($typeName);
                     if (in_array($suggestedName, $suggestedNames) === false) {
                         $suggestedNames[] = $suggestedName;
diff --git a/dev/tests/verification/Resources/ActionGroupWithSectionAndDataAsArguments.txt b/dev/tests/verification/Resources/ActionGroupWithSectionAndDataAsArguments.txt
@@ -27,6 +27,6 @@ class ActionGroupWithSectionAndDataAsArgumentsCest
 	 */
 	public function ActionGroupWithSectionAndDataAsArguments(AcceptanceTester $I)
 	{
-		$I->waitForElementVisible("#element .John");
+		$I->waitForElementVisible("#element .John", 10);
 	}
 }
diff --git a/dev/tests/verification/Resources/BasicFunctionalTest.txt b/dev/tests/verification/Resources/BasicFunctionalTest.txt
@@ -126,7 +126,7 @@ class BasicFunctionalTestCest
 		$I->moveMouseOver(".functionalTestSelector");
 		$I->openNewTab();
 		$I->pauseExecution();
-		$I->performOn("#selector", function(\WebDriverElement $el) {return $el->isDisplayed();});
+		$I->performOn("#selector", function(\WebDriverElement $el) {return $el->isDisplayed();}, 10);
 		$I->pressKey("#page", "a");
 		$I->pressKey("#page", ['ctrl', 'a'],'new');
 		$I->pressKey("#page", ['shift', '111'],'1','x');
@@ -165,7 +165,7 @@ class BasicFunctionalTestCest
 		$I->waitForElement(".functionalTestSelector", 30);
 		$I->waitForElementNotVisible(".functionalTestSelector", 30);
 		$I->waitForElementVisible(".functionalTestSelector", 30);
-		$I->waitForElementChange("#selector", function(\WebDriverElement $el) {return $el->isDisplayed();});
+		$I->waitForElementChange("#selector", function(\WebDriverElement $el) {return $el->isDisplayed();}, 10);
 		$I->waitForJS("someJsFunction", 30);
 		$I->waitForText("someInput", 30, ".functionalTestSelector");
 	}
diff --git a/dev/tests/verification/Resources/SectionReplacementTest.txt b/dev/tests/verification/Resources/SectionReplacementTest.txt
@@ -68,5 +68,7 @@ class SectionReplacementTestCest
 		$I->click("#stringLiteral1-" . PersistedObjectHandler::getInstance()->retrieveEntityField('createdData', 'firstname', 'test') . " .Doe" . msq("uniqueData"));
 		$I->click("#element .1#element .2");
 		$I->click("#element .1#element .{$data}");
+		$I->click("(//div[@data-role='slide'])[1]/a[@data-element='link'][contains(@href,'')]");
+		$I->click("(//div[@data-role='slide'])[1]/a[@data-element='link'][contains(@href,' ')]");
 	}
 }
diff --git a/dev/tests/verification/Resources/functionalSuiteHooks.txt b/dev/tests/verification/Resources/functionalSuiteHooks.txt
@@ -30,7 +30,7 @@ class functionalSuiteHooks extends \Codeception\GroupObject
 
         if ($this->preconditionFailure != null) {
             //if our preconditions fail, we need to mark all the tests as incomplete.
-            $e->getTest()->getMetadata()->setIncomplete($this->preconditionFailure);
+            $e->getTest()->getMetadata()->setIncomplete("SUITE PRECONDITION FAILED:" . PHP_EOL . $this->preconditionFailure);
         }
     }
 
diff --git a/dev/tests/verification/TestModule/Section/SampleSection.xml b/dev/tests/verification/TestModule/Section/SampleSection.xml
@@ -18,5 +18,6 @@
         <element name="threeOneDuplicateParamElement" type="button" selector="#{{var1}}-{{var2}} .{{var1}} [{{var3}}]" parameterized="true"/>
         <element name="timeoutElement" type="button" selector="#foo" timeout="30"/>
         <element name="mergeElement" type="button" selector="#unMerge"/>
+        <element name="anotherTwoParamsElement" type="button" selector="(//div[@data-role='slide'])[{{arg1}}]/a[@data-element='link'][contains(@href,'{{arg2}}')]" parameterized="true"/>
     </section>
 </sections>
diff --git a/dev/tests/verification/TestModule/Test/SectionReplacementTest.xml b/dev/tests/verification/TestModule/Test/SectionReplacementTest.xml
@@ -50,5 +50,8 @@
 
         <click stepKey="selectorReplaceTwoParamElements" selector="{{SampleSection.oneParamElement('1')}}{{SampleSection.oneParamElement('2')}}"/>
         <click stepKey="selectorReplaceTwoParamMixedTypes" selector="{{SampleSection.oneParamElement('1')}}{{SampleSection.oneParamElement({$data})}}"/>
+
+        <click stepKey="selectorParamWithEmptyString" selector="{{SampleSection.anotherTwoParamsElement('1', '')}}"/>
+        <click stepKey="selectorParamWithASpace" selector="{{SampleSection.anotherTwoParamsElement('1', ' ')}}"/>
     </test>
 </tests>
diff --git a/etc/config/.env.example b/etc/config/.env.example
@@ -4,6 +4,9 @@
 #*** Set the base URL for your Magento instance ***#
 MAGENTO_BASE_URL=http://devdocs.magento.com/
 
+#*** Uncomment if you are running Admin Panel on separate domain (used with MAGENTO_BACKEND_NAME) ***#
+# MAGENTO_BACKEND_BASE_HOST=http://admin.example.com/
+
 #*** Set the Admin Username and Password for your Magento instance ***#
 MAGENTO_BACKEND_NAME=admin
 MAGENTO_ADMIN_USERNAME=admin
@@ -23,8 +26,9 @@ MAGENTO_ADMIN_PASSWORD=123123q
 BROWSER=chrome
 
 #*** Uncomment and set host & port if your dev environment needs different value other than MAGENTO_BASE_URL for Rest API Requests ***#
-#MAGENTO_RESTAPI_SERVER_HOST=
-#MAGENTO_RESTAPI_SERVER_PORT=
+#MAGENTO_RESTAPI_SERVER_HOST=restapi.magento.com
+#MAGENTO_RESTAPI_SERVER_PORT=8080
+#MAGENTO_RESTAPI_SERVER_PROTOCOL=https
 
 #*** Uncomment these properties to set up a dev environment with symlinked projects ***#
 #TESTS_BP=
@@ -40,4 +44,7 @@ MODULE_WHITELIST=Magento_Framework,Magento_ConfigurableProductWishlist,Magento_C
 
 #*** Bool property which allows the user to toggle debug output during test execution
 #MFTF_DEBUG=
+
+#*** Default timeout for wait actions
+#WAIT_TIMEOUT=10
 #*** End of .env ***#
diff --git a/etc/config/codeception.dist.yml b/etc/config/codeception.dist.yml
@@ -12,7 +12,6 @@ settings:
     memory_limit: 1024M
 extensions:
     enabled:
-        - Codeception\Extension\RunFailed
         - Magento\FunctionalTestingFramework\Extension\TestContextExtension
         - Magento\FunctionalTestingFramework\Allure\Adapter\MagentoAllureAdapter
     config:
diff --git a/etc/config/functional.suite.dist.yml b/etc/config/functional.suite.dist.yml
@@ -20,6 +20,7 @@ modules:
     config:
         \Magento\FunctionalTestingFramework\Module\MagentoWebDriver:
             url: "%MAGENTO_BASE_URL%"
+            backend_url: "%MAGENTO_BACKEND_BASE_URL%"
             backend_name: "%MAGENTO_BACKEND_NAME%"
             browser: 'chrome'
             restart: true
diff --git a/src/Magento/FunctionalTestingFramework/Allure/Adapter/MagentoAllureAdapter.php b/src/Magento/FunctionalTestingFramework/Allure/Adapter/MagentoAllureAdapter.php
@@ -10,6 +10,8 @@
 use Yandex\Allure\Adapter\Event\StepStartedEvent;
 use Yandex\Allure\Adapter\Event\StepFinishedEvent;
 use Yandex\Allure\Adapter\Event\StepFailedEvent;
+use Yandex\Allure\Adapter\Event\TestCaseFailedEvent;
+use Codeception\Event\FailEvent;
 use Codeception\Event\SuiteEvent;
 use Codeception\Event\StepEvent;
 
@@ -132,4 +134,18 @@ public function stepAfter(StepEvent $stepEvent = null)
         }
         $this->getLifecycle()->fire(new StepFinishedEvent());
     }
+
+    /**
+     * Override of parent method, fires a TestCaseFailedEvent if a test is marked as incomplete.
+     *
+     * @param FailEvent $failEvent
+     * @return void
+     */
+    public function testIncomplete(FailEvent $failEvent)
+    {
+        $event = new TestCaseFailedEvent();
+        $e = $failEvent->getFail();
+        $message = $e->getMessage();
+        $this->getLifecycle()->fire($event->withException($e)->withMessage($message));
+    }
 }
diff --git a/src/Magento/FunctionalTestingFramework/DataGenerator/Persist/Curl/AbstractExecutor.php b/src/Magento/FunctionalTestingFramework/DataGenerator/Persist/Curl/AbstractExecutor.php
@@ -14,32 +14,18 @@
 abstract class AbstractExecutor implements CurlInterface
 {
     /**
-     * Base url.
+     * Returns Magento base URL. Used as a fallback for other services (eg. WebApi, Backend)
      *
      * @var string
      */
     protected static $baseUrl = null;
 
     /**
-     * Resolve base url.
-     *
-     * @return void
+     * Returns base URL for Magento instance
+     * @return string
      */
-    protected static function resolveBaseUrl()
+    public function getBaseUrl(): string
     {
-
-        if ((getenv('MAGENTO_RESTAPI_SERVER_HOST') !== false)
-            && (getenv('MAGENTO_RESTAPI_SERVER_HOST') !== '') ) {
-            self::$baseUrl = getenv('MAGENTO_RESTAPI_SERVER_HOST');
-        } else {
-            self::$baseUrl = getenv('MAGENTO_BASE_URL');
-        }
-
-        if ((getenv('MAGENTO_RESTAPI_SERVER_PORT') !== false)
-            && (getenv('MAGENTO_RESTAPI_SERVER_PORT') !== '')) {
-            self::$baseUrl .= ':' . getenv('MAGENTO_RESTAPI_SERVER_PORT');
-        }
-
-        self::$baseUrl = rtrim(self::$baseUrl, '/') . '/';
+        return getenv('MAGENTO_BASE_URL');
     }
 }
diff --git a/src/Magento/FunctionalTestingFramework/DataGenerator/Persist/Curl/AdminExecutor.php b/src/Magento/FunctionalTestingFramework/DataGenerator/Persist/Curl/AdminExecutor.php
@@ -37,18 +37,11 @@ class AdminExecutor extends AbstractExecutor implements CurlInterface
     private $response;
 
     /**
-     * Should executor remove backend_name from api url
+     * Flag describes whether the request is to Magento Base URL, removes backend_name from api url
      * @var boolean
      */
     private $removeBackend;
 
-    /**
-     * Backend url.
-     *
-     * @var string
-     */
-    private static $adminUrl;
-
     /**
      * Constructor.
      * @param boolean $removeBackend
@@ -58,15 +51,21 @@ class AdminExecutor extends AbstractExecutor implements CurlInterface
      */
     public function __construct($removeBackend)
     {
-        if (!isset(parent::$baseUrl)) {
-            parent::resolveBaseUrl();
-        }
-        self::$adminUrl = parent::$baseUrl . getenv('MAGENTO_BACKEND_NAME') . '/';
         $this->removeBackend = $removeBackend;
         $this->transport = new CurlTransport();
         $this->authorize();
     }
 
+    /**
+     * Returns base URL for Magento backend instance
+     * @return string
+     */
+    public function getBaseUrl(): string
+    {
+        $backendHost = getenv('MAGENTO_BACKEND_BASE_URL') ?: parent::getBaseUrl();
+        return $backendHost . getenv('MAGENTO_BACKEND_NAME') . '/';
+    }
+
     /**
      * Authorize admin on backend.
      *
@@ -76,11 +75,11 @@ public function __construct($removeBackend)
     private function authorize()
     {
         // Perform GET to backend url so form_key is set
-        $this->transport->write(self::$adminUrl, [], CurlInterface::GET);
+        $this->transport->write($this->getBaseUrl(), [], CurlInterface::GET);
         $this->read();
 
         // Authenticate admin user
-        $authUrl = self::$adminUrl . 'admin/auth/login/';
+        $authUrl = $this->getBaseUrl() . 'admin/auth/login/';
         $data = [
             'login[username]' => getenv('MAGENTO_ADMIN_USERNAME'),
             'login[password]' => getenv('MAGENTO_ADMIN_PASSWORD'),
@@ -119,10 +118,10 @@ private function setFormKey()
     public function write($url, $data = [], $method = CurlInterface::POST, $headers = [])
     {
         $url = ltrim($url, "/");
-        $apiUrl = self::$adminUrl . $url;
+        $apiUrl = $this->getBaseUrl() . $url;
 
         if ($this->removeBackend) {
-            $apiUrl = parent::$baseUrl . $url;
+            $apiUrl = parent::getBaseUrl() . $url;
         }
 
         if ($this->formKey) {
diff --git a/src/Magento/FunctionalTestingFramework/DataGenerator/Persist/Curl/FrontendExecutor.php b/src/Magento/FunctionalTestingFramework/DataGenerator/Persist/Curl/FrontendExecutor.php
@@ -67,9 +67,6 @@ class FrontendExecutor extends AbstractExecutor implements CurlInterface
      */
     public function __construct($customerEmail, $customerPassWord)
     {
-        if (!isset(parent::$baseUrl)) {
-            parent::resolveBaseUrl();
-        }
         $this->transport = new CurlTransport();
         $this->customerEmail = $customerEmail;
         $this->customerPassword = $customerPassWord;
@@ -84,11 +81,11 @@ public function __construct($customerEmail, $customerPassWord)
      */
     private function authorize()
     {
-        $url = parent::$baseUrl . 'customer/account/login/';
+        $url = $this->getBaseUrl() . 'customer/account/login/';
         $this->transport->write($url);
         $this->read();
 
-        $url = parent::$baseUrl  . 'customer/account/loginPost/';
+        $url = $this->getBaseUrl() . 'customer/account/loginPost/';
         $data = [
             'login[username]' => $this->customerEmail,
             'login[password]' => $this->customerPassword,
@@ -146,7 +143,7 @@ public function write($url, $data = [], $method = CurlInterface::POST, $headers
         if (isset($data['customer_password'])) {
             unset($data['customer_password']);
         }
-        $apiUrl = parent::$baseUrl . $url;
+        $apiUrl = $this->getBaseUrl() . $url;
         if ($this->formKey) {
             $data['form_key'] = $this->formKey;
         } else {
diff --git a/src/Magento/FunctionalTestingFramework/DataGenerator/Persist/Curl/WebapiExecutor.php b/src/Magento/FunctionalTestingFramework/DataGenerator/Persist/Curl/WebapiExecutor.php
@@ -59,15 +59,34 @@ class WebapiExecutor extends AbstractExecutor implements CurlInterface
      */
     public function __construct($storeCode = null)
     {
-        if (!isset(parent::$baseUrl)) {
-            parent::resolveBaseUrl();
-        }
-
         $this->storeCode = $storeCode;
         $this->transport = new CurlTransport();
         $this->authorize();
     }
 
+    /**
+     * Returns base URL for Magento Web API instance
+     * @return string
+     */
+    public function getBaseUrl(): string
+    {
+        $baseUrl = parent::getBaseUrl();
+
+        $webapiHost = getenv('MAGENTO_RESTAPI_SERVER_HOST');
+        $webapiPort = getenv("MAGENTO_RESTAPI_SERVER_PORT");
+        $webapiProtocol = getenv("MAGENTO_RESTAPI_SERVER_PROTOCOL");
+
+        if ($webapiHost) {
+            $baseUrl = sprintf('%s://%s/', $webapiProtocol, $webapiHost);
+        }
+
+        if ($webapiPort) {
+            $baseUrl = rtrim($baseUrl, '/') . ':' . $webapiPort . '/';
+        }
+
+        return $baseUrl;
+    }
+
     /**
      * Returns the authorization token needed for some requests via REST call.
      *
@@ -152,11 +171,11 @@ public function close()
      */
     public function getFormattedUrl($resource)
     {
-        $urlResult = parent::$baseUrl . 'rest/';
+        $urlResult = $this->getBaseUrl() . 'rest/';
         if ($this->storeCode != null) {
             $urlResult .= $this->storeCode . "/";
         }
-        $urlResult.= trim($resource, "/");
+        $urlResult .= trim($resource, "/");
         return $urlResult;
     }
 }
diff --git a/src/Magento/FunctionalTestingFramework/DataGenerator/Persist/CurlHandler.php b/src/Magento/FunctionalTestingFramework/DataGenerator/Persist/CurlHandler.php
@@ -197,15 +197,33 @@ private function resolveUrlReference($urlIn, $entityObjects)
     {
         $urlOut = $urlIn;
         $matchedParams = [];
+        // Find all the params ({}) references
         preg_match_all("/[{](.+?)[}]/", $urlIn, $matchedParams);
 
         if (!empty($matchedParams)) {
             foreach ($matchedParams[0] as $paramKey => $paramValue) {
+                $paramEntityParent = "";
+                $matchedParent = [];
+                $dataItem = $matchedParams[1][$paramKey];
+                // Find all the parent property (Type.key) references, assuming there will be only one
+                // parent property reference within one param
+                preg_match_all("/(.+?)\./", $dataItem, $matchedParent);
+
+                if (!empty($matchedParent) && !empty($matchedParent[0])) {
+                    $paramEntityParent = $matchedParent[1][0];
+                    $dataItem = preg_replace('/^'.$matchedParent[0][0].'/', '', $dataItem);
+                }
+
                 foreach ($entityObjects as $entityObject) {
-                    $param = $entityObject->getDataByName(
-                        $matchedParams[1][$paramKey],
-                        EntityDataObject::CEST_UNIQUE_VALUE
-                    );
+                    $param = null;
+
+                    if ($paramEntityParent === "" || $entityObject->getType() == $paramEntityParent) {
+                        $param = $entityObject->getDataByName(
+                            $dataItem,
+                            EntityDataObject::CEST_UNIQUE_VALUE
+                        );
+                    }
+
                     if (null !== $param) {
                         $urlOut = str_replace($paramValue, $param, $urlOut);
                         continue;
diff --git a/src/Magento/FunctionalTestingFramework/DataGenerator/Persist/OperationDataArrayResolver.php b/src/Magento/FunctionalTestingFramework/DataGenerator/Persist/OperationDataArrayResolver.php
diff --git a/src/Magento/FunctionalTestingFramework/Extension/TestContextExtension.php b/src/Magento/FunctionalTestingFramework/Extension/TestContextExtension.php
diff --git a/src/Magento/FunctionalTestingFramework/Suite/views/SuiteClass.mustache b/src/Magento/FunctionalTestingFramework/Suite/views/SuiteClass.mustache
diff --git a/src/Magento/FunctionalTestingFramework/Test/Objects/ActionObject.php b/src/Magento/FunctionalTestingFramework/Test/Objects/ActionObject.php
diff --git a/src/Magento/FunctionalTestingFramework/Util/ModuleResolver.php b/src/Magento/FunctionalTestingFramework/Util/ModuleResolver.php
diff --git a/src/Magento/FunctionalTestingFramework/Util/TestGenerator.php b/src/Magento/FunctionalTestingFramework/Util/TestGenerator.php

Original file line number	Diff line number	Diff line change
`@@ -27,6 +27,6 @@ class ActionGroupWithSectionAndDataAsArgumentsCest`
`27`	`27`	`*/`
`28`	`28`	`public function ActionGroupWithSectionAndDataAsArguments(AcceptanceTester $I)`
`29`	`29`	`{`
`30`		`- $I->waitForElementVisible("#element .John");`
	`30`	`+ $I->waitForElementVisible("#element .John", 10);`
`31`	`31`	`}`
`32`	`32`	`}`
Original file line number	Diff line number	Diff line change
`@@ -68,5 +68,7 @@ class SectionReplacementTestCest`
`68`	`68`	`$I->click("#stringLiteral1-" . PersistedObjectHandler::getInstance()->retrieveEntityField('createdData', 'firstname', 'test') . " .Doe" . msq("uniqueData"));`
`69`	`69`	`$I->click("#element .1#element .2");`
`70`	`70`	`$I->click("#element .1#element .{$data}");`
	`71`	`+ $I->click("(//div[@data-role='slide'])[1]/a[@data-element='link'][contains(@href,'')]");`
	`72`	`+ $I->click("(//div[@data-role='slide'])[1]/a[@data-element='link'][contains(@href,' ')]");`
`71`	`73`	`}`
`72`	`74`	`}`
Original file line number	Diff line number	Diff line change
`@@ -30,7 +30,7 @@ class functionalSuiteHooks extends \Codeception\GroupObject`
`30`	`30`
`31`	`31`	`if ($this->preconditionFailure != null) {`
`32`	`32`	`//if our preconditions fail, we need to mark all the tests as incomplete.`
`33`		`- $e->getTest()->getMetadata()->setIncomplete($this->preconditionFailure);`
	`33`	`+ $e->getTest()->getMetadata()->setIncomplete("SUITE PRECONDITION FAILED:" . PHP_EOL . $this->preconditionFailure);`
`34`	`34`	`}`
`35`	`35`	`}`
`36`	`36`