Skip to content

Commit f3f53c5

Browse files
committed
MQE-1541: Add option to generate:tests for XSD validation on 'merged files'
updated documentation for --debug
1 parent e445902 commit f3f53c5

File tree

1 file changed

+4
-7
lines changed

1 file changed

+4
-7
lines changed

docs/commands/mftf.md

Lines changed: 4 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -122,7 +122,7 @@ vendor/bin/mftf generate:tests [option] [<test name>] [<test name>] [--remove]
122122
| `--force` | Forces test generation, regardless of the module merge order defined in the Magento instance. Example: `generate:tests --force`. |
123123
| `-i,--time` | Set time in minutes to determine the group size when `--config=parallel` is used. The __default value__ is `10`. Example: `generate:tests --config=parallel --time=15`|
124124
| `--tests` | Defines the test configuration as a JSON string.|
125-
| `--debug or --debug=[<none>]`| Performs schema validations on XML files </br> <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> <br/> NONE: `--debug=none` skips debugging during test generation. Added for backward compatibility, it will be removed in the next MAJOR release.</br>|
125+
| `--debug or --debug=[<none>]`| Performs schema validations on XML files. </br> <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> <br/> NONE: `--debug=none` skips debugging during test generation. Added for backward compatibility, it will be removed in the next MAJOR release.</br>|
126126
| `-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.|
127127

128128
#### Examples of the JSON configuration
@@ -295,9 +295,7 @@ vendor/bin/mftf run:group [--skip-generate|--remove] [--] <group1> [<group2>]
295295
| --------------------- | --------------------------------------------------------------------------------------------------------- |
296296
| `-k, --skip-generate` | Skips generating from the source XML. Instead, the command executes previously-generated groups of tests. |
297297
| `-r, --remove` | Removes previously generated suites and tests before the actual generation and run. |
298-
| `--debug or --debug=[<none>]`| <br/>Performs schema validations on XML files </br> <br/> DEFAULT: `run:group` 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 run fails because of an invalid XML schema. This option takes extra processing time. Use it after test run has failed once.</br> <br/> NONE: `--debug=none` skips debugging during test run. Added for backward compatibility, it will be removed in the next MAJOR release.</br>|
299-
300-
298+
| `--debug or --debug=[<none>]`| Performs schema validations on XML files. `run:group` implicitly performs schema validation on merged files. It does not indicate the file name where the error is encountered. `--debug` performs per-file validation and returns additional debug information (such as the filename where an error occurred). `--debug=none` skips debugging during test run. Added for backward compatibility, it will be removed in the next MAJOR release.|
301299

302300
#### Examples
303301

@@ -329,7 +327,7 @@ vendor/bin/mftf run:test [--skip-generate|--remove] [--] <name1> [<name2>]
329327
|-----------------------|-----------------------------------------------------------------------------------------------------------|
330328
| `-k, --skip-generate` | Skips generating from the source XML. Instead, the command executes previously-generated groups of tests. |
331329
| `-r, --remove` | Remove previously generated suites and tests. |
332-
| `--debug or --debug=[<none>]`| <br/>Performs schema validations on XML files </br> <br/> DEFAULT: `run:test` 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 run fails because of an invalid XML schema. This option takes extra processing time. Use it after test run has failed once.</br> <br/> NONE: `--debug=none` skips debugging during test run. Added for backward compatibility, it will be removed in the next MAJOR release.</br>|
330+
| `--debug or --debug=[<none>]`| Performs schema validations on XML files. `run:test` implicitly performs schema validation on merged files. It does not indicate the file name where the error is encountered. `--debug` performs per-file validation and returns additional debug information (such as the filename where an error occurred). `--debug=none` skips debugging during test run. Added for backward compatibility, it will be removed in the next MAJOR release.
333331

334332
#### Examples
335333

@@ -355,8 +353,7 @@ vendor/bin/mftf run:failed
355353

356354
| Option | Description |
357355
|-----------------------|-----------------------------------------------------------------------------------------------------------|
358-
| `--debug or --debug=[<none>]`| <br/>Performs schema validations on XML files </br> <br/> DEFAULT: `run:failed` 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 run fails because of an invalid XML schema. This option takes extra processing time. Use it after test run has failed once.</br> <br/> NONE: `--debug=none` skips debugging during test run. Added for backward compatibility, it will be removed in the next MAJOR release.</br>|
359-
356+
| `--debug or --debug=[<none>]`| Performs schema validations on XML files. `run:failed` implicitly performs schema validation on merged files. It does not indicate the file name where the error is encountered. `--debug` performs per-file validation and returns additional debug information (such as the filename where an error occurred). Use it after test run has failed once. `--debug=none` skips debugging during test run. Added for backward compatibility, it will be removed in the next MAJOR release.|
360357

361358
#### Examples
362359

0 commit comments

Comments
 (0)