Merge pull request #164 from magento-gl/MQE-1693

MQE-1693 | Ability To Run MFTF JSON Configuration From File

Author: KevinBKozan

docs/commands/mftf.md

@@ -190,7 +190,7 @@ vendor/bin/mftf generate:tests [option] [<test name>] [<test name>] [--remove]
 | `--force` | Forces test generation, regardless of the module merge order defined in the Magento instance. Example: `generate:tests --force`. |
 | `-i,--time` | Set time in minutes to determine the group size when `--config=parallel` is used. <br/>Example: `generate:tests --config=parallel --time=15` <br/>Option `--time` will be the default and the __default value__ is `10` when neither `--time` nor `--groups` is specified. <br/>Example: `generate:tests --config=parallel`|
 | `-g,--groups` | Set number of groups to be split into when `--config=parallel` is used. <br>Example: `generate:tests --config=parallel --groups=300` <br/>Options `--time` and `--groups` are mutually exclusive and only one should be used.|
-| `--tests` | Defines the test configuration as a JSON string.|
+| `--tests` | Defines the test configuration as a JSON string or JSON file path.|
 | `--allow-skipped` | Allows MFTF to generate and run tests marked with `<skip>.`|
 | `--debug` | Performs schema validations on XML files. <br/> DEFAULT: `generate:tests` implicitly performs schema validation on merged files. It does not indicate the file name where the error is encountered. <br/> DEVELOPER: `--debug` performs per-file validation and returns additional debug information (such as the filename where an error occurred) when test generation fails because of an invalid XML schema. This option takes extra processing time. Use it after test generation has failed once.<br/>|
 | `-r,--remove`| Removes the existing generated suites and tests cleaning up the `_generated` directory before the actual run. For example, `generate:tests SampleTest --remove` cleans up the entire `_generated` directory and generates `SampleTest` only.|
@@ -241,12 +241,20 @@ Complex configuration to generate a few non-suite tests, a single test in a suit
 
 The command that encodes this complex configuration:
 
+Command to generate test by json string:
+
 ```bash
 vendor/bin/mftf generate:tests --tests '{"tests":["general_test1","general_test2","general_test3"],"suites":{"sample":["suite_test1"],"sample2":null}}'
 ```
 
 Note that the strings must be escaped and surrounded in quotes.
 
+Command to generate test by json file:
+
+```bash
+vendor/bin/mftf generate:tests --tests ./foldername/filename.json
+```
+
 ### `generate:suite`
 
 #### Description

src/Magento/FunctionalTestingFramework/Console/GenerateTestsCommand.php

@@ -69,7 +69,7 @@ protected function configure()
                 'tests',
                 't',
                 InputOption::VALUE_REQUIRED,
-                'A parameter accepting a JSON string used to determine the test configuration'
+                'A parameter accepting a JSON string or JSON file path used to determine the test configuration'
             )->addOption(
                 'filter',
                 null,
@@ -138,6 +138,10 @@ protected function execute(InputInterface $input, OutputInterface $output)
             return 1;
         }
 
+        if ($json !== null && is_file($json)) {
+            $json = file_get_contents($json);
+        }
+
         if (!empty($tests)) {
             $json = $this->getTestAndSuiteConfiguration($tests);
         }

src/Magento/FunctionalTestingFramework/Console/RunTestCommand.php

@@ -20,6 +20,9 @@
 use Symfony\Component\Process\Process;
 use Magento\FunctionalTestingFramework\Exceptions\TestFrameworkException;
 
+/**
+ * @SuppressWarnings(PHPMD)
+ */
 class RunTestCommand extends BaseGenerateCommand
 {
     /**
@@ -40,15 +43,19 @@ protected function configure()
             ->setDescription("generation and execution of test(s) defined in xml")
             ->addArgument(
                 'name',
-                InputArgument::REQUIRED | InputArgument::IS_ARRAY,
+                InputArgument::OPTIONAL | InputArgument::IS_ARRAY,
                 "name of tests to generate and execute"
             )->addOption(
                 'skip-generate',
                 'k',
                 InputOption::VALUE_NONE,
                 "skip generation and execute existing test"
+            )->addOption(
+                'tests',
+                't',
+                InputOption::VALUE_REQUIRED,
+                'A parameter accepting a JSON string or JSON file path used to determine the test configuration'
             );
-
         parent::configure();
     }
 
@@ -63,6 +70,7 @@ protected function configure()
     protected function execute(InputInterface $input, OutputInterface $output): int
     {
         $tests = $input->getArgument('name');
+        $json = $input->getOption('tests'); // for backward compatibility
         $skipGeneration = $input->getOption('skip-generate');
         $force = $input->getOption('force');
         $remove = $input->getOption('remove');
@@ -86,7 +94,22 @@ protected function execute(InputInterface $input, OutputInterface $output): int
             $allowSkipped
         );
 
-        $testConfiguration = $this->getTestAndSuiteConfiguration($tests);
+        if ($json !== null) {
+            if (is_file($json)) {
+                $testConfiguration = file_get_contents($json);
+            } else {
+                $testConfiguration = $json;
+            }
+        }
+
+        if (!empty($tests)) {
+            $testConfiguration = $this->getTestAndSuiteConfiguration($tests);
+        }
+
+        if ($testConfiguration !== null && !json_decode($testConfiguration)) {
+            // stop execution if we have failed to properly parse any json passed in by the user
+            throw new TestFrameworkException("JSON could not be parsed: " . json_last_error_msg());
+        }
 
         $generationErrorCode = 0;
 
@@ -98,7 +121,8 @@ protected function execute(InputInterface $input, OutputInterface $output): int
                 '--remove' => $remove,
                 '--debug' => $debug,
                 '--allow-skipped' => $allowSkipped,
-                '-v' => $verbose
+                '-v' => $verbose,
+              ''
             ];
             $command->run(new ArrayInput($args), $output);