MQE-1541: Add option to generate:tests for XSD validation on 'merged files'

Author: soumyau

dev/tests/_bootstrap.php

@@ -32,8 +32,7 @@
     true,
     \Magento\FunctionalTestingFramework\Config\MftfApplicationConfig::UNIT_TEST_PHASE,
     true,
-    false,
-    false
+    \Magento\FunctionalTestingFramework\Config\MftfApplicationConfig::DISABLE_DEBUG_MODE
 );
 
 // Load needed framework env params

dev/tests/verification/TestModule/ActionGroup/BasicActionGroup.xml

@@ -115,10 +115,6 @@
         <see selector=".selector" userInput="{{sameStepKeyAsArg}}" stepKey="arg1" />
     </actionGroup>
 
-    <actionGroup name="actionGroupWithSkipReadinessActions">
-        <comment userInput="ActionGroupSkipReadiness" stepKey="skip" skipReadiness="true"/>
-    </actionGroup>
-
     <actionGroup name="actionGroupWithSectionAndData">
         <arguments>
             <argument name="content" type="string"/>

dev/tests/verification/TestModule/Test/BasicFunctionalTest.xml

@@ -24,7 +24,6 @@
         </after>
         <comment stepKey="basicCommentWithNoData" userInput="{{emptyData.noData}}"/>
         <comment stepKey="basicCommentWithDefinitelyNoData" userInput="{{emptyData.definitelyNoData}}"/>
-        <comment stepKey="ReadinessCheckSkipped" userInput="skipReadiness" skipReadiness="true"/>
         <grabValueFrom stepKey="someVarDefinition"/>
         <acceptPopup stepKey="acceptPopupKey1"/>
         <amOnPage stepKey="amOnPageKey1" url="/test/url"/>

dev/tests/verification/Tests/ActionGroupGenerationTest.php

@@ -185,17 +185,6 @@ public function testActionGroupWithArgContainingStepKey()
         $this->generateAndCompareTest('ActionGroupContainsStepKeyInArgText');
     }
 
-    /**
-     * Test an action group with an arg containing stepKey text
-     *
-     * @throws \Exception
-     * @throws \Magento\FunctionalTestingFramework\Exceptions\TestReferenceException
-     */
-    public function testActionGroupWithSkipReadiness()
-    {
-        $this->generateAndCompareTest('ActionGroupSkipReadiness');
-    }
-
     /**
      * Test an action group with an arg containing stepKey text
      *

src/Magento/FunctionalTestingFramework/Config/MftfApplicationConfig.php

@@ -15,9 +15,9 @@ class MftfApplicationConfig
     const MFTF_PHASES = [self::GENERATION_PHASE, self::EXECUTION_PHASE, self::UNIT_TEST_PHASE];
 
     const DEFAULT_DEBUG_MODE = "default";
-    const PER_FILE_DEBUG_MODE = "perFile";
+    const DEVELOPER_MODE = "developer";
     const DISABLE_DEBUG_MODE = "ignore";
-    const MFTF_DEBUG_MODES = [self::DEFAULT_DEBUG_MODE, self::PER_FILE_DEBUG_MODE, self::DISABLE_DEBUG_MODE];
+    const MFTF_DEBUG_MODES = [self::DEFAULT_DEBUG_MODE, self::DEVELOPER_MODE, self::DISABLE_DEBUG_MODE];
 
     /**
      * Determines whether the user has specified a force option for generation
@@ -87,7 +87,7 @@ private function __construct(
      * @param boolean $forceGenerate
      * @param string  $phase
      * @param boolean $verboseEnabled
-     * @param string $debug
+     * @param string  $debug
      * @return void
      */
     public static function create($forceGenerate, $phase, $verboseEnabled, $debug)

src/Magento/FunctionalTestingFramework/Config/Reader/Filesystem.php

@@ -157,7 +157,7 @@ protected function readFiles($fileList)
                 } else {
                     $configMerger->merge($content);
                 }
-                if (MftfApplicationConfig::getConfig()->getDebugMode() == MftfApplicationConfig::PER_FILE_DEBUG_MODE) {
+                if (MftfApplicationConfig::getConfig()->getDebugMode() === MftfApplicationConfig::DEVELOPER_MODE) {
                     $this->validateSchema($configMerger, $fileList->getFilename());
                 }
             } catch (\Magento\FunctionalTestingFramework\Config\Dom\ValidationException $e) {
@@ -231,7 +231,7 @@ protected function validateSchema($configMerger, $filename = null)
         if ($this->validationState->isValidationRequired()) {
             $errors = [];
             if ($configMerger && !$configMerger->validate($this->schemaFile, $errors)) {
-                foreach ($errors as $error){
+                foreach ($errors as $error) {
                     $error = str_replace("\n", "", $error);
                     LoggingUtil::getInstance()->getLogger(Filesystem::class)->criticalFailure(
                         "Schema validation error. ",

src/Magento/FunctionalTestingFramework/Config/Reader/MftfFilesystem.php

@@ -41,9 +41,9 @@ public function readFiles($fileList)
                 } else {
                     $configMerger->merge($content, $fileList->getFilename(), $exceptionCollector);
                 }
-                // run per file validation with generate:tests -d
+                 // run per file validation with generate:tests -d
                 if (!in_array($debugMode, MftfApplicationConfig::MFTF_DEBUG_MODES) ||
-                    $debugMode == MftfApplicationConfig::PER_FILE_DEBUG_MODE) {
+                    $debugMode === MftfApplicationConfig::DEVELOPER_MODE) {
                     $this->validateSchema($configMerger, $fileList->getFilename());
                 }
             } catch (\Magento\FunctionalTestingFramework\Config\Dom\ValidationException $e) {
@@ -55,9 +55,9 @@ public function readFiles($fileList)
             $this->validateSchema($configMerger, $fileList->getFilename());
         }
 
-        // run validation on merged file with generate:tests
-        if ($debugMode == MftfApplicationConfig::DEFAULT_DEBUG_MODE) {
-            $this->validateSchema($configMerger);
+         //run validation on merged file with generate:tests
+        if ($debugMode === MftfApplicationConfig::DEFAULT_DEBUG_MODE) {
+            $this->validateSchema($configMerger, $debugMode);
         }
 
         $output = [];

src/Magento/FunctionalTestingFramework/Console/GenerateTestsCommand.php

@@ -29,7 +29,7 @@ class GenerateTestsCommand extends BaseGenerateCommand
     protected function configure()
     {
         $this->setName('generate:tests')
-            ->setDescription('This command runs validation and generates all test files and suites based on xml declarations')
+            ->setDescription('Run validation and generate all test files and suites based on xml declarations')
             ->addArgument(
                 'name',
                 InputArgument::OPTIONAL | InputArgument::IS_ARRAY,
@@ -39,7 +39,7 @@ protected function configure()
                 "force",
                 'f',
                 InputOption::VALUE_NONE,
-                'force generation of tests regardless of Magento Instance Configuration'
+                'Force generation of tests regardless of Magento Instance Configuration'
             )->addOption(
                 'time',
                 'i',
@@ -55,7 +55,8 @@ protected function configure()
                 'debug',
                 'd',
                 InputOption::VALUE_OPTIONAL,
-                'run per file validation while running tests. Use option \'ignore\' to skip debugging',
+                'Run per file validation while running tests. Use option \'ignore\' to skip debugging -- 
+                 added for backward compatibility, will be removed in the next MAJOR release',
                 'default'
             );
 
@@ -79,7 +80,7 @@ protected function execute(InputInterface $input, OutputInterface $output)
         $json = $input->getOption('tests');
         $force = $input->getOption('force');
         $time = $input->getOption('time') * 60 * 1000; // convert from minutes to milliseconds
-        $debug = $input->getOption('debug')?? MftfApplicationConfig::PER_FILE_DEBUG_MODE; // set to per file if no option specified
+        $debug = $input->getOption('debug')?? MftfApplicationConfig::DEVELOPER_MODE;
         $remove = $input->getOption('remove');
         $verbose = $output->isVerbose();
 
@@ -125,7 +126,7 @@ protected function execute(InputInterface $input, OutputInterface $output)
      * @param string  $json
      * @param array   $tests
      * @param boolean $force
-     * @param string $debug
+     * @param string  $debug
      * @param boolean $verbose
      * @return array
      * @throws \Magento\FunctionalTestingFramework\Exceptions\TestReferenceException