MQE-351:Single test run for running tests in parallel mode

    - add Test Manifest Class
    - invoke new class during TestGenerator runs
    - change hardcoded slash to PHP constant
    - add directory clear between generate calls

Author: imeron2433

src/Magento/FunctionalTestingFramework/Util/TestGenerator.php

@@ -6,13 +6,24 @@
 
 namespace Magento\FunctionalTestingFramework\Util;
 
+use FilesystemIterator;
 use Magento\FunctionalTestingFramework\DataGenerator\Objects\EntityDataObject;
 use Magento\FunctionalTestingFramework\Test\Handlers\CestObjectHandler;
 use Magento\FunctionalTestingFramework\Test\Objects\ActionObject;
 use Magento\FunctionalTestingFramework\DataGenerator\Handlers\DataObjectHandler;
+use Magento\FunctionalTestingFramework\Test\Objects\CestObject;
+use RecursiveDirectoryIterator;
 
 class TestGenerator
 {
+
+    /**
+     * Path to the export dir.
+     *
+     * @var string
+     */
+    private $exportDirectory;
+
     /**
      * Test generator.
      *
@@ -23,9 +34,47 @@ class TestGenerator
     /**
      * TestGenerator constructor.
      */
-    private function __construct()
+    private function __construct($exportDir)
     {
         // private constructor for singleton
+        $this->exportDirectory = $exportDir;
+    }
+
+    /**
+     * Method used to clean export dir if needed and create new empty export dir.
+     *
+     * @return void
+     */
+    private function setupExportDir()
+    {
+        if (file_exists($this->exportDirectory)) {
+            $this->rmDirRecursive($this->exportDirectory);
+        }
+
+        mkdir($this->exportDirectory, 0777, true);
+    }
+
+    /**
+     * Takes a directory path and recursively deletes all files and folders.
+     *
+     * @param string $directory
+     */
+    private function rmdirRecursive($directory)
+    {
+        $it = new RecursiveDirectoryIterator($directory, FilesystemIterator::SKIP_DOTS);
+
+        while($it->valid()) {
+            $path = $directory . DIRECTORY_SEPARATOR . $it->getFilename();
+            if ($it->isDir()) {
+                $this->rmDirRecursive($path);
+            } else {
+                unlink($path);
+            }
+
+            $it->next();
+        }
+
+        rmdir($directory);
     }
 
     /**
@@ -36,7 +85,7 @@ private function __construct()
     public static function getInstance()
     {
         if (!self::$testGenerator) {
-            self::$testGenerator = new TestGenerator();
+            self::$testGenerator = new TestGenerator(TESTS_MODULE_PATH .  DIRECTORY_SEPARATOR . "_generated");
         }
 
         return self::$testGenerator;
@@ -63,13 +112,7 @@ private function loadAllCestObjects()
      */
     private function createCestFile($cestPhp, $filename)
     {
-        $exportDirectory = TESTS_MODULE_PATH . "/_generated";
-        $exportFilePath = sprintf("%s/%s.php", $exportDirectory, $filename);
-
-        if (!is_dir($exportDirectory)) {
-            mkdir($exportDirectory, 0777, true);
-        }
-
+        $exportFilePath = $this->exportDirectory . DIRECTORY_SEPARATOR . $filename . ".php";
         $file = fopen($exportFilePath, 'w');
 
         if (!$file) {
@@ -88,6 +131,7 @@ private function createCestFile($cestPhp, $filename)
      */
     public function createAllCestFiles()
     {
+        $this->setupExportDir();
         $cestPhpArray = $this->assembleAllCestPhp();
 
         foreach ($cestPhpArray as $cestPhpFile) {
@@ -134,11 +178,17 @@ private function assembleAllCestPhp()
         $cestObjects = $this->loadAllCestObjects();
         $cestPhpArray = [];
 
+        // create our manifest file here
+        $testManifest = new TestManifest($this->exportDirectory);
+
         foreach ($cestObjects as $cest) {
             $name = $cest->getName();
             $name = $string = str_replace(' ', '', $name);
             $php = $this->assembleCestPhp($cest);
             $cestPhpArray[] = [$name, $php];
+
+            //write to manifest here
+            $testManifest->recordCest($cest->getName(), $cest->getTests());
         }
 
         return $cestPhpArray;

src/Magento/FunctionalTestingFramework/Util/TestManifest.php

@@ -0,0 +1,52 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+
+namespace Magento\FunctionalTestingFramework\Util;
+
+use Magento\FunctionalTestingFramework\Test\Objects\TestObject;
+
+class TestManifest
+{
+    /**
+     * Test Manifest file path.
+     *
+     * @var string
+     */
+    private $filePath;
+
+    /**
+     * TestManifest constructor.
+     *
+     * @param string $path
+     */
+    public function __construct($path)
+    {
+        $filePath = $path .  DIRECTORY_SEPARATOR . 'testManifest.txt';
+        $this->filePath = $filePath;
+        $fileResource = fopen($filePath, 'w');
+        fclose($fileResource);
+    }
+
+    /**
+     * Takes a cest name and set of tests, records the names in a file for codeception to consume.
+     *
+     * @param string $cestName
+     * @param TestObject $tests
+     * @return void
+     */
+    public function recordCest($cestName, $tests)
+    {
+        $fileResource = fopen($this->filePath, 'a');
+
+        foreach ($tests as $test)
+        {
+            $line = $cestName . ':' . $test->getName();
+            fwrite($fileResource, $line ."\n");
+        }
+
+        fclose($fileResource);
+    }
+}