MQE-453:[DevOps] Add optional arg for consolidated test run

    - add param for config flag and env to TestManifest Constructor
    - change generate tests signature for new flags

Author: imeron2433

src/Magento/FunctionalTestingFramework/Util/TestGenerator.php

@@ -120,23 +120,33 @@ private function createCestFile($cestPhp, $filename)
      * Assemble ALL PHP strings using the assembleAllCestPhp function. Loop over and pass each array item
      * to the createCestFile function.
      *
+     * @param string $runConfig
+     * @param string $env
      * @return void
      */
-    public function createAllCestFiles()
+    public function createAllCestFiles($runConfig = null, $env = null)
     {
         DirSetupUtil::createGroupDir($this->exportDirectory);
-        $cestPhpArray = $this->assembleAllCestPhp();
+
+        // create our manifest file here
+        $testManifest = new TestManifest($this->exportDirectory, $runConfig, $env);
+        $cestPhpArray = $this->assembleAllCestPhp($testManifest);
 
         foreach ($cestPhpArray as $cestPhpFile) {
             $this->createCestFile($cestPhpFile[1], $cestPhpFile[0]);
         }
+
+        if ($testManifest->getManifestConfig() === TestManifest::SINGLE_RUN_CONFIG) {
+            $testManifest->recordPathToExportDir();
+        }
     }
 
     /**
      * Assemble the entire PHP string for a single Test based on a Cest Object.
      * Create all of the PHP strings for a Test. Concatenate the strings together.
      *
      * @param \Magento\FunctionalTestingFramework\Test\Objects\CestObject $cestObject
+     * @throws TestReferenceException
      * @return string
      */
     private function assembleCestPhp($cestObject)
@@ -168,24 +178,24 @@ private function assembleCestPhp($cestObject)
     /**
      * Load ALL Cest objects. Loop over and pass each to the assembleCestPhp function.
      *
+     * @param TestManifest $testManifest
      * @return array
      */
-    private function assembleAllCestPhp()
+    private function assembleAllCestPhp($testManifest)
     {
         $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());
+            //write to manifest here if config is not single run
+            if ($testManifest->getManifestConfig() != TestManifest::SINGLE_RUN_CONFIG) {
+                $testManifest->recordCest($cest->getName(), $cest->getTests());
+            }
         }
 
         return $cestPhpArray;

src/Magento/FunctionalTestingFramework/Util/TestManifest.php

@@ -10,13 +10,30 @@
 
 class TestManifest
 {
+    const SINGLE_RUN_CONFIG = 'singleRun';
+    const DEFAULT_BROWSER = 'chrome';
+
     /**
      * Test Manifest file path.
      *
      * @var string
      */
     private $filePath;
 
+    /**
+     * Test Manifest environment flag. This is added to each dir or file in order for tests to execute properly.
+     *
+     * @var string $environment
+     */
+    private $environment = self::DEFAULT_BROWSER;
+
+    /**
+     * Type of manifest to generate. (Currently describes whether to path to a dir or for each test).
+     *
+     * @var string
+     */
+    private $runTypeConfig;
+
     /**
      * Relative dir path from functional yml file. For devOps execution flexibility.
      *
@@ -28,14 +45,32 @@ class TestManifest
      * TestManifest constructor.
      *
      * @param string $path
+     * @param string $runConfig
+     * @param string $env
      */
-    public function __construct($path)
+    public function __construct($path, $runConfig, $env)
     {
         $this->relativeDirPath = substr($path, strlen(dirname(dirname(TESTS_BP))) + 1);
         $filePath = $path .  DIRECTORY_SEPARATOR . 'testManifest.txt';
         $this->filePath = $filePath;
         $fileResource = fopen($filePath, 'w');
         fclose($fileResource);
+
+        $this->runTypeConfig = $runConfig;
+
+        if ($env) {
+            $this->environment = $env;
+        }
+    }
+
+    /**
+     * Returns a string indicating the generation config (e.g. singleRun).
+     *
+     * @return string
+     */
+    public function getManifestConfig()
+    {
+        return $this->runTypeConfig;
     }
 
     /**
@@ -51,9 +86,36 @@ public function recordCest($cestName, $tests)
 
         foreach ($tests as $test) {
             $line = $this->relativeDirPath . DIRECTORY_SEPARATOR . $cestName . '.php:' . $test->getName();
-            fwrite($fileResource, $line ."\n");
+            fwrite($fileResource, $this->appendDefaultBrowser($line) ."\n");
         }
 
         fclose($fileResource);
     }
+
+    /**
+     * Function which simple prints the export dir as part of the manifest file rather than an itemized list of
+     * cestFile:testname.
+     *
+     * @return void
+     */
+    public function recordPathToExportDir()
+    {
+        $fileResource = fopen($this->filePath, 'a');
+
+        $line = $this->relativeDirPath . DIRECTORY_SEPARATOR;
+        fwrite($fileResource, $this->appendDefaultBrowser($line) ."\n");
+
+        fclose($fileResource);
+    }
+
+    /**
+     * Function which appends the --env flag to the test. This is needed to properly execute all tests in codeception.
+     *
+     * @param string $line
+     * @return string
+     */
+    private function appendDefaultBrowser($line)
+    {
+        return "${line} --env " . $this->environment;
+    }
 }