#57: Debug flag exists in robo generate:tests to print action sequence of test steps

Author: StasKozar

RoboFile.php

@@ -3,6 +3,7 @@
  * Copyright © Magento, Inc. All rights reserved.
  * See COPYING.txt for license details.
  */
+use Magento\FunctionalTestingFramework\Test\Parsers\TestDataParser;
 
 /** This is project's console commands configuration for Robo task runner.
  *
@@ -43,17 +44,20 @@ function buildProject()
      * @param array $opts
      * @return void
      */
-    function generateTests($opts = ['config' => null, 'force' => true, 'nodes' => null])
+    function generateTests($opts = ['config' => null, 'force' => true, 'nodes' => null, 'debug' => false])
     {
         $GLOBALS['GENERATE_TESTS'] = true;
 
         if ($opts['force'])
         {
             $GLOBALS['FORCE_PHP_GENERATE'] = true;
         }
+        
+        $output = $this->getOutput() ?? null;
 
         require 'dev' . DIRECTORY_SEPARATOR . 'tests'. DIRECTORY_SEPARATOR . 'functional' . DIRECTORY_SEPARATOR . '_bootstrap.php';
-        \Magento\FunctionalTestingFramework\Util\TestGenerator::getInstance()->createAllTestFiles($opts['config'], $opts['nodes']);
+        \Magento\FunctionalTestingFramework\Util\TestGenerator::getInstance()
+            ->createAllTestFiles($opts['config'], $opts['nodes'], $opts['debug'], $output);
         $this->say("Generate Tests Command Run");
     }
 

src/Magento/FunctionalTestingFramework/Test/Objects/TestObject.php

@@ -159,4 +159,22 @@ public function getOrderedActions()
         $mergeUtil = new ActionMergeUtil($this->getName(), "Test");
         return $mergeUtil->resolveActionSteps($this->parsedSteps);
     }
+
+    /**
+     * Get information about actions and steps in test.
+     *
+     * @return array
+     */
+    public function getDebugInformation()
+    {
+        $debugInformation = [];
+        $mergeUtil = new ActionMergeUtil($this->getName(), "Test");
+        $orderList  = $mergeUtil->resolveActionSteps($this->parsedSteps);
+
+        foreach ($orderList as $action) {
+            $debugInformation[] = "\t" . $action->getType() . ' ' . $action->getStepKey();
+        }
+
+        return $debugInformation;
+    }
 }

src/Magento/FunctionalTestingFramework/Util/TestGenerator.php

@@ -20,13 +20,17 @@
 use Magento\FunctionalTestingFramework\Test\Util\ActionObjectExtractor;
 use Magento\FunctionalTestingFramework\Test\Util\TestObjectExtractor;
 use Magento\FunctionalTestingFramework\Util\Filesystem\DirSetupUtil;
+use Robo\Common\IO;
+use Symfony\Component\Console\Output\OutputInterface;
 
 /**
  * Class TestGenerator
  * @SuppressWarnings(PHPMD.ExcessiveClassComplexity)
  */
 class TestGenerator
 {
+    use IO;
+
     const REQUIRED_ENTITY_REFERENCE = 'createDataKey';
     const GENERATED_DIR = '_generated';
 
@@ -132,17 +136,22 @@ private function createCestFile($testPhp, $filename)
      *
      * @param string $runConfig
      * @param int $nodes
+     * @param bool $debug
+     * @param OutputInterface|null $output
      * @return void
      * @throws TestReferenceException
      * @throws \Exception
      */
-    public function createAllTestFiles($runConfig = null, $nodes = null)
+    public function createAllTestFiles($runConfig = null, $nodes = null, $debug = false, $output = null)
     {
         DirSetupUtil::createGroupDir($this->exportDirectory);
+        if ($output !== null) {
+            $this->setOutput($output);
+        }
 
         // create our manifest file here
         $testManifest = TestManifestFactory::makeManifest($this->exportDirectory, $runConfig);
-        $testPhpArray = $this->assembleAllTestPhp($testManifest, $nodes);
+        $testPhpArray = $this->assembleAllTestPhp($testManifest, $nodes, $debug);
 
         foreach ($testPhpArray as $testPhpFile) {
             $this->createCestFile($testPhpFile[1], $testPhpFile[0]);
@@ -189,29 +198,52 @@ private function assembleTestPhp($testObject)
      *
      * @param BaseTestManifest $testManifest
      * @param int $nodes
+     * @param bool $debug
      * @return array
      * @throws TestReferenceException
      * @throws \Exception
      */
-    private function assembleAllTestPhp($testManifest, $nodes)
+    private function assembleAllTestPhp($testManifest, $nodes, $debug = false)
     {
         /** @var TestObject[] $testObjects */
         $testObjects = $this->loadAllTestObjects();
         $cestPhpArray = [];
 
         foreach ($testObjects as $test) {
+            $this->debug('Start creating test: ' . $test->getCodeceptionName(), $debug);
             $php = $this->assembleTestPhp($test);
             $cestPhpArray[] = [$test->getCodeceptionName(), $php];
 
             //write to manifest here if config is not single run
             $testManifest->addTest($test);
+            $debugInformation = $test->getDebugInformation();
+
+            $this->debug($debugInformation, $debug);
+            $this->debug('Finish creating test ' . $test->getCodeceptionName(), $debug);
         }
 
         $testManifest->generate($nodes);
 
         return $cestPhpArray;
     }
 
+    /**
+     * Output information in console when debug flag is enabled.
+     *
+     * @param array|string $messages
+     * @param bool $debug
+     * @return void
+     */
+    private function debug($messages, $debug = false)
+    {
+        if ($debug && $messages) {
+            $messages = (array) $messages;
+            foreach ($messages as $message) {
+                $this->say($message);
+            }
+        }
+    }
+
     /**
      * Creates a PHP string for the necessary Allure and AcceptanceTester use statements.
      * Since we don't support other dependencies at this time, this function takes no parameter.