Merge pull request #2020 from magento-pangolin/MFTF2.0.2-2.3-develop

[Pangolin] Added possibility to run Magento CLI from MFTF tests

* [MQE-585](https://jira.corp.magento.com/browse/MQE-585): Implement CLI command action
* [MQE-710](https://jira.corp.magento.com/browse/MQE-710): [2.0.2 - Release] Execute Magento Functional tests on Jenkins
* [MQE-734](https://jira.corp.magento.com/browse/MQE-734): Update dependency for MFTF in magento 2.3-develop branch

Author: okolesnyk

dev/tests/acceptance/.env.example

@@ -9,6 +9,9 @@
 # MAGENTO_ADMIN_USERNAME=admin
 # MAGENTO_ADMIN_PASSWORD=123123q
 #
+# MAGENTO_CLI_COMMAND_PATH=dev/tests/functional/utils/command.php
+# MAGENTO_CLI_COMMAND_PARAMETER=command
+#
 # SELENIUM_HOST=127.0.0.1
 # SELENIUM_PORT=4444
 # SELENIUM_PROTOCOL=http
@@ -35,6 +38,10 @@ MAGENTO_BACKEND_NAME=
 MAGENTO_ADMIN_USERNAME=
 MAGENTO_ADMIN_PASSWORD=
 
+#*** Path to CLI entry point and command parameter name. Uncomment and change if folder structure differs from standard Magento installation
+#MAGENTO_CLI_COMMAND_PATH=dev/tests/acceptance/utils/command.php
+#MAGENTO_CLI_COMMAND_PARAMETER=command
+
 #*** Selenium Server Protocol, Host, Port, and Path, with local defaults. Uncomment and change if not running Selenium locally.
 #SELENIUM_HOST=127.0.0.1
 #SELENIUM_PORT=4444

dev/tests/acceptance/.htaccess.sample

@@ -0,0 +1,11 @@
+##############################################
+## Allow access to command.php
+    <FilesMatch "command.php">
+        <IfVersion < 2.4>
+            order allow,deny
+            allow from all
+        </IfVersion>
+        <IfVersion >= 2.4>
+            Require all granted
+        </IfVersion>
+    </FilesMatch>

dev/tests/acceptance/composer.json

@@ -22,7 +22,7 @@
         "consolidation/robo": "^1.0.0",
         "symfony/process": ">=2.7 <3.4",
         "henrikbjorn/lurker": "^1.2",
-        "magento/magento2-functional-testing-framework": "~2.0.0",
+        "magento/magento2-functional-testing-framework": "~2.0.2",
         "php": "7.0.2|7.0.4|~7.0.6|~7.1.0",
         "vlucas/phpdotenv": "~2.4"
     },

dev/tests/acceptance/composer.lock

@@ -198,6 +198,7 @@
         <waitForLoadingMaskToDisappear stepKey="waitForLoadingMaskToDisappear1"/>
         <scrollToTopOfPage stepKey="scrollToTopOfPage"/>
         <parseFloat userInput="300,000.2325" stepKey="parseFloat1"/>
+        <magentoCLI stepKey="enableMaintenance1" command="maintenance:enable"/>
     </test>
     <test name="AllVariableMethodsTest">
         <annotations>

dev/tests/acceptance/tests/functional/Magento/FunctionalTest/SampleTests/Test/SampleTest.xml

@@ -0,0 +1,69 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+
+if (isset($_POST['command'])) {
+    $command = urldecode($_POST['command']);
+    $php = PHP_BINARY ?: (PHP_BINDIR ? PHP_BINDIR . '/php' : 'php');
+    $valid = validateCommand($command);
+    if ($valid) {
+        exec(escapeCommand($php . ' -f ../../../../bin/magento ' . $command) . " 2>&1", $output, $exitCode);
+        if ($exitCode == 0) {
+            http_response_code(202);
+        } else {
+            http_response_code(500);
+        }
+        echo implode("\n", $output);
+    } else {
+        http_response_code(500);
+        echo "Given command not found valid in Magento CLI Command list.";
+    }
+} else {
+    http_response_code(500);
+    echo("Command parameter is not set.");
+}
+
+/**
+ * Returns escaped command.
+ *
+ * @param string $command
+ * @return string
+ */
+function escapeCommand($command)
+{
+    $escapeExceptions = [
+        '> /dev/null &' => '--dev-null-amp--'
+    ];
+
+    $command = escapeshellcmd(
+        str_replace(array_keys($escapeExceptions), array_values($escapeExceptions), $command)
+    );
+
+    return str_replace(array_values($escapeExceptions), array_keys($escapeExceptions), $command);
+}
+
+/**
+ * Checks magento list of CLI commands for given $command. Does not check command parameters, just base command.
+ * @param string $command
+ * @return bool
+ */
+function validateCommand($command)
+{
+    $php = PHP_BINARY ?: (PHP_BINDIR ? PHP_BINDIR . '/php' : 'php');
+    exec($php . ' -f ../../../../bin/magento list', $commandList);
+    // Trim list of commands after first whitespace
+    $commandList = array_map("trimAfterWhitespace", $commandList);
+    return in_array(trimAfterWhitespace($command), $commandList);
+}
+
+/**
+ * Returns given string trimmed of everything after the first found whitespace.
+ * @param string $string
+ * @return string
+ */
+function trimAfterWhitespace($string)
+{
+    return strtok($string, ' ');
+}