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

- fix generation error during non custom generation
- fix multidimensional references issue

Author: imeron2433

src/Magento/FunctionalTestingFramework/Util/Manifest/ParallelTestManifest.php

@@ -14,6 +14,8 @@
 use Magento\FunctionalTestingFramework\Test\Objects\TestObject;
 use Magento\FunctionalTestingFramework\Util\Filesystem\DirSetupUtil;
 use Magento\FunctionalTestingFramework\Util\Sorter\ParallelGroupSorter;
+use RecursiveArrayIterator;
+use RecursiveIteratorIterator;
 
 class ParallelTestManifest extends BaseTestManifest
 {
@@ -97,9 +99,10 @@ public function createTestGroups($lines)
     public function generate()
     {
         DirSetupUtil::createGroupDir($this->dirPath);
+        $suites = $this->getFlattenedSuiteConfiguration($this->parallelGroupSorter->getResultingSuiteConfig());
 
         foreach ($this->testGroups as $groupNumber => $groupContents) {
-            $this->generateGroupFile($groupContents, $groupNumber);
+            $this->generateGroupFile($groupContents, $groupNumber, $suites);
         }
     }
 
@@ -115,15 +118,16 @@ public function getSorter()
 
     /**
      * Function which takes an array containing entries representing the test execution as well as the associated group
-     * for the entry in order to generate a txt file used by devops for parllel execution in Jenkins.
+     * for the entry in order to generate a txt file used by devops for parllel execution in Jenkins. The results
+     * are checked against a flattened list of suites in order to generate proper entries.
      *
      * @param array $testGroup
      * @param int $nodeNumber
+     * @param array $suites
      * @return void
      */
-    private function generateGroupFile($testGroup, $nodeNumber)
+    private function generateGroupFile($testGroup, $nodeNumber, $suites)
     {
-        $suites = $this->parallelGroupSorter->getResultingSuiteConfig();
         foreach ($testGroup as $entryName => $testValue) {
             $fileResource = fopen($this->dirPath . DIRECTORY_SEPARATOR . "group{$nodeNumber}.txt", 'a');
 
@@ -137,4 +141,27 @@ private function generateGroupFile($testGroup, $nodeNumber)
             fclose($fileResource);
         }
     }
+
+    /**
+     * Function which recusrively parses a given potentially multidimensional array of suites containing their split
+     * groups. The result is a flattened array of suite names to relevant tests for generation of the manifest.
+     *
+     * @param array $multiDimensionalSuites
+     * @return array
+     */
+    private function getFlattenedSuiteConfiguration($multiDimensionalSuites)
+    {
+        $suites = [];
+        foreach ($multiDimensionalSuites as $suiteName => $suiteContent) {
+            $value = array_values($suiteContent)[0];
+            if (is_array($value)) {
+                $suites = array_merge($suites, $this->getFlattenedSuiteConfiguration($suiteContent));
+                continue;
+            }
+
+            $suites[$suiteName] = $suiteContent;
+        }
+
+        return $suites;
+    }
 }

src/Magento/FunctionalTestingFramework/Util/TestGenerator.php

@@ -113,14 +113,28 @@ public function getExportDir()
     }
 
     /**
-     * Load all Test files as Objects using the Test Object Handler.
+     * Load all Test files as Objects using the Test Object Handler, additionally validates test references being loaded
+     * for validity.
      *
+     * @param array $testsToIgnore
      * @return array
      */
-    private function loadAllTestObjects()
+    private function loadAllTestObjects($testsToIgnore)
     {
         if ($this->tests === null || empty($this->tests)) {
-            return TestObjectHandler::getInstance()->getAllObjects();
+            $testObjects = TestObjectHandler::getInstance()->getAllObjects();
+            return array_diff_key($testObjects, $testsToIgnore);
+        }
+
+        // If we have a custom configuration, we need to check the tests passed in to insure that we can generate
+        // them in the current context.
+        $invalidTestObjects = array_intersect_key($this->tests, $testsToIgnore);
+        if (!empty($invalidTestObjects)) {
+            $errorMsg = "Cannot reference the following tests for generation without accompanying suite:\n";
+            array_walk($invalidTestObjects, function ($value, $key) use (&$errorMsg) {
+                $errorMsg.= "\t{$key}\n";
+            });
+            throw new TestReferenceException($errorMsg);
         }
 
         return $this->tests;
@@ -216,19 +230,7 @@ private function assembleTestPhp($testObject)
     private function assembleAllTestPhp($testManifest, array $testsToIgnore)
     {
         /** @var TestObject[] $testObjects */
-        $testObjects = $this->loadAllTestObjects();
-
-        // We need to check the tests passed in to insure that we can generate them in the current context.
-        $invalidTestObjects = array_intersect_key($testObjects, $testsToIgnore);
-        if (!empty($invalidTestObjects)) {
-            $errorMsg = "Cannot reference the following tests for generation without accompanying suite:\n";
-            array_walk($invalidTestObjects, function ($value, $key) use (&$errorMsg) {
-                $errorMsg.= "\t{$key}\n";
-            });
-            throw new TestReferenceException($errorMsg);
-        }
-
-        $testObjects = array_diff_key($testObjects, $testsToIgnore);
+        $testObjects = $this->loadAllTestObjects($testsToIgnore);
         $cestPhpArray = [];
 
         foreach ($testObjects as $test) {