MQE-1703: Implicit Suite Generation for Tests

Author: soumyau

src/Magento/FunctionalTestingFramework/Console/BaseGenerateCommand.php

@@ -14,6 +14,7 @@
 use Magento\FunctionalTestingFramework\Util\Filesystem\DirSetupUtil;
 use Magento\FunctionalTestingFramework\Util\TestGenerator;
 use Magento\FunctionalTestingFramework\Config\MftfApplicationConfig;
+use Magento\FunctionalTestingFramework\Suite\Handlers\SuiteObjectHandler;
 
 class BaseGenerateCommand extends Command
 {
@@ -67,4 +68,35 @@ protected function removeGeneratedDirectory(OutputInterface $output, bool $verbo
             }
         }
     }
+
+    /**
+     * Returns a 2D array of tests with their suites references that can be encoded into a json test configuration
+     * @param array $tests
+     * @return false|string
+     * @throws \Magento\FunctionalTestingFramework\Exceptions\XmlException
+     */
+
+    protected function getTestAndSuiteConfiguration(array $tests)
+    {
+        $testConfiguration['tests'] = [];
+        $testConfiguration['suites'] = [];
+        $allSuiteTests = SuiteObjectHandler::getInstance()->getAllTestReferences();
+        $suiteGroup = [];
+
+        foreach($tests as $test) {
+            if (array_key_exists($test, $allSuiteTests)) {
+                $suiteGroup[$test] = $allSuiteTests[$test];
+            }
+            else $testConfiguration['tests'][] = $test;
+        }
+
+        foreach ($suiteGroup as $test => $suites) {
+
+            foreach ($suites as $suite) {
+                $testConfiguration['suites'][$suite][] = $test;
+            }
+
+        }
+        return $testConfiguration;
+    }
 }

src/Magento/FunctionalTestingFramework/Console/GenerateTestsCommand.php

@@ -65,14 +65,19 @@ protected function execute(InputInterface $input, OutputInterface $output)
     {
         $tests = $input->getArgument('name');
         $config = $input->getOption('config');
-        $json = $input->getOption('tests');
+        $json = $input->getOption('tests'); // for backward compatibility
         $force = $input->getOption('force');
         $time = $input->getOption('time') * 60 * 1000; // convert from minutes to milliseconds
         $debug = $input->getOption('debug') ?? MftfApplicationConfig::LEVEL_DEVELOPER; // for backward compatibility
         $remove = $input->getOption('remove');
         $verbose = $output->isVerbose();
         $allowSkipped = $input->getOption('allowSkipped');
 
+        // if test configuration is not specified, set implicitly
+        if ($json === null && !empty($tests)) {
+            $json = json_encode($this->getTestAndSuiteConfiguration($tests));
+        }
+
         if ($json !== null && !json_decode($json)) {
             // stop execution if we have failed to properly parse any json passed in by the user
             throw new TestFrameworkException("JSON could not be parsed: " . json_last_error_msg());
@@ -100,9 +105,7 @@ protected function execute(InputInterface $input, OutputInterface $output)
             $testManifest->createTestGroups($time);
         }
 
-        if (empty($tests)) {
-            SuiteGenerator::getInstance()->generateAllSuites($testManifest);
-        }
+        SuiteGenerator::getInstance()->generateAllSuites($testManifest);
 
         $testManifest->generate();
 

src/Magento/FunctionalTestingFramework/Console/RunTestCommand.php

@@ -64,27 +64,34 @@ protected function execute(InputInterface $input, OutputInterface $output): int
         }
 
         if (!$skipGeneration) {
+            $testConfiguration = $this->getTestAndSuiteConfiguration($tests);
             $command = $this->getApplication()->find('generate:tests');
             $args = [
-                '--tests' => json_encode([
-                    'tests' => $tests,
-                    'suites' => null
-                ]),
+                '--tests' => json_encode($testConfiguration),
                 '--force' => $force,
                 '--remove' => $remove,
                 '--debug' => $debug,
                 '--allowSkipped' => $allowSkipped
             ];
             $command->run(new ArrayInput($args), $output);
         }
-
+        // tests with resolved suite references
+        $resolvedTests = $this->getResolvedTests($testConfiguration);
         $returnCode = 0;
         $codeceptionCommand = realpath(PROJECT_ROOT . '/vendor/bin/codecept') . ' run functional ';
         $testsDirectory = TESTS_MODULE_PATH . DIRECTORY_SEPARATOR . TestGenerator::GENERATED_DIR . DIRECTORY_SEPARATOR;
         //execute only tests specified as arguments in run command
-        foreach ($tests as $test) {
-            $testGroup = TestGenerator::DEFAULT_DIR . DIRECTORY_SEPARATOR;
-            $testName = $test . 'Cest.php';
+        foreach ($resolvedTests as $test){
+            // for tests in suite, set directory as suite name
+            if (strpos($test, ':' )) {
+                list($suite, $testName) = explode(":", $test);
+            }
+            // for standalone tests set directory as "default"
+            else {
+                list($suite, $testName) = [TestGenerator::DEFAULT_DIR, $test];
+            }
+            $testGroup = $suite . DIRECTORY_SEPARATOR;
+            $testName .= 'Cest.php';
             if (!realpath($testsDirectory . $testGroup . $testName)) {
                 throw new TestFrameworkException(
                     $testName . " is not available under " . $testsDirectory . $testGroup
@@ -104,4 +111,25 @@ function ($type, $buffer) use ($output) {
         }
         return $returnCode;
     }
+
+    /** Get an array of tests with resolved suite references from $testConfiguration
+     * eg: if test is referenced in a suite, it'll be stored in format "SuiteName:Testname";
+     * if not it'll be stored as is.
+     * @param $testConfiguration
+     * @return array
+     */
+    private function getResolvedTests($testConfiguration)
+    {
+        $testsArray = $testConfiguration['tests'] ?? [];
+        $suitesArray = $testConfiguration['suites'] ?? [];
+        $testArrayBuilder = [];
+        foreach ($suitesArray as $suite => $tests) {
+            $testArrayBuilder = array_merge($testArrayBuilder,
+                array_map(function($test) use ($suite)
+                { return $suite . ':' . $test ; }, $tests));
+        }
+        return array_merge($testArrayBuilder, $testsArray);
+
+
+    }
 }