Merge pull request #155 from magento/MQE-1060

MQE-1060: Allow magentoCLI Action To Run Without Manipulating Command That Is Sent To CLI

Author: aljcalandra

dev/tests/functional/_bootstrap.php

@@ -29,4 +29,13 @@
     foreach ($_ENV as $key => $var) {
         defined($key) || define($key, $var);
     }
+
+    defined('MAGENTO_CLI_COMMAND_PATH') || define(
+        'MAGENTO_CLI_COMMAND_PATH',
+        'dev/tests/acceptance/utils/command.php'
+    );
+    $env->setEnvironmentVariable('MAGENTO_CLI_COMMAND_PATH', MAGENTO_CLI_COMMAND_PATH);
+
+    defined('MAGENTO_CLI_COMMAND_PARAMETER') || define('MAGENTO_CLI_COMMAND_PARAMETER', 'command');
+    $env->setEnvironmentVariable('MAGENTO_CLI_COMMAND_PARAMETER', MAGENTO_CLI_COMMAND_PARAMETER);
 }

dev/tests/verification/Resources/BasicFunctionalTest.txt

@@ -105,7 +105,7 @@ class BasicFunctionalTestCest
 		$grabMultipleKey1 = $I->grabMultiple(".functionalTestSelector");
 		$grabTextFromKey1 = $I->grabTextFrom(".functionalTestSelector");
 		$grabValueFromKey1 = $I->grabValueFrom(".functionalTestSelector");
-		$magentoCli1 = $I->magentoCLI("maintenance:enable");
+		$magentoCli1 = $I->magentoCLI("maintenance:enable", "\"stuffHere\"");
 		$I->comment($magentoCli1);
 		$I->makeScreenshot("screenShotInput");
 		$I->maximizeWindow();

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

@@ -66,7 +66,7 @@
         <grabMultiple selector=".functionalTestSelector" stepKey="grabMultipleKey1" />
         <grabTextFrom selector=".functionalTestSelector" stepKey="grabTextFromKey1" />
         <grabValueFrom selector=".functionalTestSelector" stepKey="grabValueFromKey1" />
-        <magentoCLI command="maintenance:enable" stepKey="magentoCli1"/>
+        <magentoCLI command="maintenance:enable" arguments="&quot;stuffHere&quot;" stepKey="magentoCli1"/>
         <makeScreenshot userInput="screenShotInput" stepKey="makeScreenshotKey1"/>
         <maximizeWindow stepKey="maximizeWindowKey1"/>
         <moveBack stepKey="moveBackKey1"/>

src/Magento/FunctionalTestingFramework/Module/MagentoWebDriver.php

@@ -457,13 +457,22 @@ public function scrollToTopOfPage()
     /**
      * Takes given $command and executes it against exposed MTF CLI entry point. Returns response from server.
      * @param string $command
+     * @param string $arguments
      * @return string
      */
-    public function magentoCLI($command)
+    public function magentoCLI($command, $arguments = null)
     {
         $apiURL = $this->config['url'] . getenv('MAGENTO_CLI_COMMAND_PATH');
         $executor = new CurlTransport();
-        $executor->write($apiURL, [getenv('MAGENTO_CLI_COMMAND_PARAMETER') => $command], CurlInterface::POST, []);
+        $executor->write(
+            $apiURL,
+            [
+                getenv('MAGENTO_CLI_COMMAND_PARAMETER') => $command,
+                'arguments' => $arguments
+            ],
+            CurlInterface::POST,
+            []
+        );
         $response = $executor->read();
         $executor->close();
         return $response;

src/Magento/FunctionalTestingFramework/Test/etc/Actions/customActions.xsd

@@ -42,6 +42,13 @@
                         </xs:documentation>
                     </xs:annotation>
                 </xs:attribute>
+                <xs:attribute type="xs:string" name="arguments">
+                    <xs:annotation>
+                        <xs:documentation>
+                            Arguments for Magento CLI command, will not be escaped.
+                        </xs:documentation>
+                    </xs:annotation>
+                </xs:attribute>
                 <xs:attributeGroup ref="commonActionAttributes"/>
             </xs:extension>
         </xs:simpleContent>

src/Magento/FunctionalTestingFramework/Util/TestGenerator.php

@@ -488,6 +488,7 @@ public function generateStepsPhp($actionObjects, $hookObject = false, $actor = "
             $dependentSelector = null;
             $visible = null;
             $command = null;
+            $arguments = null;
             $sortOrder = null;
             $storeCode = null;
 
@@ -503,6 +504,9 @@ public function generateStepsPhp($actionObjects, $hookObject = false, $actor = "
             if (isset($customActionAttributes['command'])) {
                 $command = $this->addUniquenessFunctionCall($customActionAttributes['command']);
             }
+            if (isset($customActionAttributes['arguments'])) {
+                $arguments = $this->addUniquenessFunctionCall($customActionAttributes['arguments']);
+            }
 
             if (isset($customActionAttributes['attribute'])) {
                 $attribute = $customActionAttributes['attribute'];
@@ -1218,7 +1222,8 @@ public function generateStepsPhp($actionObjects, $hookObject = false, $actor = "
                         $stepKey,
                         $actor,
                         $actionObject,
-                        $command
+                        $command,
+                        $arguments
                     );
                     $testSteps .= sprintf(
                         "\t\t$%s->comment(\$%s);\n",