MQE-893: Add flag to robo generate: tests which accepts a specific set of tests to execute

- refactor config to exclude/include suites and tests based on user pref

Author: imeron2433

dev/tests/acceptance/RoboFile.php

@@ -113,7 +113,6 @@ function buildProject()
      * @param array $opts
      * @return void
      */
-
     function generateTests(array $tests, $opts = [
         'config' => null,
         'force' => false,
@@ -122,48 +121,87 @@ function generateTests(array $tests, $opts = [
         'tests' => null
     ])
     {
-        $GLOBALS['GENERATE_TESTS'] = true;
-        $GLOBALS['FORCE_PHP_GENERATE'] = $opts['force'];
         require 'tests'. DIRECTORY_SEPARATOR . 'functional' . DIRECTORY_SEPARATOR . '_bootstrap.php';
+        $testConfiguration = $this->createTestConfiguration($tests, $opts);
 
-        $testObjects = [];
-        $suitesReferences = [];
+        // maintain backwards compatability for devops
+        $lines = $opts['lines'] ?? $opts ['nodes'];
 
-        if ($opts['tests'] != null) {
-            $testConfigArray = json_decode($opts['tests'],true);
-            $tests = $testConfigArray['tests'] ?? [];
-            $suitesReferences = $testConfigArray['suites'] ?? null;
-        }
+        // create our manifest file here
+        $testManifest = \Magento\FunctionalTestingFramework\Util\Manifest\TestManifestFactory::makeManifest($opts['config'],$testConfiguration['suites']);
+        \Magento\FunctionalTestingFramework\Util\TestGenerator::getInstance(null, $testConfiguration['tests'])->createAllTestFiles($testManifest);
 
-        // stop execution if we have failed to properly parse any json
-        if (json_last_error() != JSON_ERROR_NONE) {
-            $this->say("JSON could not be parsed: " . json_last_error_msg());
-            return;
+        if ($opts['config'] == 'parallel') {
+            $testManifest->createTestGroups($lines);
         }
 
-        if (!empty($tests))
+        \Magento\FunctionalTestingFramework\Suite\SuiteGenerator::getInstance()->generateAllSuites($testManifest);
+        $testManifest->generate();
+
+        $this->say("Generate Tests Command Run");
+    }
+
+
+    /**
+     * Function which builds up a configuration including test and suites for consumption of Magento generation methods.
+     *
+     * @param array $tests
+     * @param array $opts
+     * @return array
+     */
+    private function createTestConfiguration($tests, $opts)
+    {
+        // set these globals as we only run this method during generation.
+        $GLOBALS['GENERATE_TESTS'] = true;
+        $GLOBALS['FORCE_PHP_GENERATE'] = $opts['force'];
+
+        $testConfiguration = [];
+        $testConfiguration['tests'] = $tests;
+        $testConfiguration['suites'] = [];
+
+        $testConfiguration = $this->parseTestsConfigJson($opts['tests'], $testConfiguration);
+
+        // if we have references to specific tests, we resolve the test objects and pass them to the config
+        if (!empty($testConfiguration['tests']))
         {
-            foreach ($tests as $test)
+            $testObjects = [];
+
+            foreach ($testConfiguration['tests'] as $test)
             {
                 $testObjects[$test] = Magento\FunctionalTestingFramework\Test\Handlers\TestObjectHandler::getInstance()->getObject($test);
             }
-        }
 
-        // maintain backwards compatability for devops
-        $lines = $opts['lines'] ?? $opts ['nodes'];
+            $testConfiguration['tests'] = $testObjects;
+        }
 
-        // create our manifest file here
-        $testManifest = \Magento\FunctionalTestingFramework\Util\Manifest\TestManifestFactory::makeManifest($opts['config'],$suitesReferences);
-        \Magento\FunctionalTestingFramework\Util\TestGenerator::getInstance(null, $testObjects)->createAllTestFiles($testManifest);
+        return $testConfiguration;
+    }
 
-        if ($opts['config'] == 'parallel') {
-            $testManifest->createTestGroups($lines);
+    /**
+     * Function which takes a json string of potential custom configuration and parses/validates the resulting json
+     * passed in by the user. The result is a testConfiguration array.
+     *
+     * @param string $json
+     * @param array $testConfiguration
+     * @return array
+     */
+    private function parseTestsConfigJson($json, $testConfiguration) {
+        if ($json == null) {
+            return $testConfiguration;
         }
 
-        \Magento\FunctionalTestingFramework\Suite\SuiteGenerator::getInstance()->generateAllSuites($testManifest);
-        $testManifest->generate();
+        $jsonTestConfiguration = [];
+        $testConfigArray = json_decode($json, true);
 
-        $this->say("Generate Tests Command Run");
+        // stop execution if we have failed to properly parse any json
+        if (json_last_error() != JSON_ERROR_NONE) {
+            $this->say("JSON could not be parsed: " . json_last_error_msg());
+            exit(1);
+        }
+
+        $jsonTestConfiguration['tests'] = $testConfigArray['tests'] ?? null;;
+        $jsonTestConfiguration['suites'] = $testConfigArray['suites'] ?? null;
+        return $jsonTestConfiguration;
     }
 
     /**

dev/tests/acceptance/tests/_bootstrap.php

@@ -57,9 +57,6 @@
 
 $RELATIVE_TESTS_MODULE_PATH = '/Magento/FunctionalTest';
 
-defined('FW_BP') || define('FW_BP', realpath($FW_PATH));
-defined('TESTS_BP') || define('TESTS_BP', realpath($TEST_PATH));
-defined('TESTS_MODULE_PATH') || define('TESTS_MODULE_PATH', realpath($TEST_PATH . $RELATIVE_TESTS_MODULE_PATH));
 defined('MAGENTO_BP') || define('MAGENTO_BP', realpath($MAGENTO_PATH));
 
 //Load constants from .env file
@@ -82,6 +79,10 @@
     $env->setEnvironmentVariable('MAGENTO_CLI_COMMAND_PARAMETER', MAGENTO_CLI_COMMAND_PARAMETER);
 }
 
+defined('FW_BP') || define('FW_BP', realpath($FW_PATH));
+defined('TESTS_BP') || define('TESTS_BP', realpath($TEST_PATH));
+defined('TESTS_MODULE_PATH') || define('TESTS_MODULE_PATH', realpath($TEST_PATH . $RELATIVE_TESTS_MODULE_PATH));
+
 // add the debug flag here
 $debug_mode = $_ENV['MFTF_DEBUG'] ?? false;
 if (!(bool)$debug_mode && extension_loaded('xdebug')) {