Skip to content

Commit e11a5d0

Browse files
soumyauKevinBKozan
authored andcommitted
MQE-1541: Documentation for debug changes (#353)
- Added documentation
1 parent a779d9b commit e11a5d0

File tree

1 file changed

+12
-2
lines changed

1 file changed

+12
-2
lines changed

docs/commands/mftf.md

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -105,7 +105,7 @@ vendor/bin/mftf build:project --MAGENTO_BASE_URL=http://magento.local/ --MAGENTO
105105

106106
#### Description
107107

108-
Generate PHP code from the tests defined in XML files.
108+
Perform XML schema validation and generate PHP code from the tests defined in XML files.
109109
The path is set in the `TESTS_MODULE_PATH` [configuration] parameter.
110110

111111
#### Usage
@@ -122,9 +122,19 @@ 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` | Returns additional debug information (such as the filename where an error occurred) when test generation fails because of an invalid XML schema. This parameter takes extra processing time. Use it after test generation has failed once. |
125+
| `--debug=[<developer> or <none>]`| Set debug level to `default` when the option is not specified, to `developer` with `--debug developer` or `--debug`, to `none` with `--debug none` | |
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

128+
#### Debugging levels
129+
130+
You can run `generate:tests` with any of the following debug levels. XML schema validation errors will be logged as CRITICAL failures.
131+
132+
| Debug level | Description |
133+
| ---| --- |
134+
|`default` `[generate:tests]` | Perform XML schema validation on merged files. Does not indicate the file name where the error is encountered. Use `developer` level for enhanced debugging. |
135+
|`developer` `[generate:tests --debug or generate:tests --debug developer]` | Returns additional debug information (such as the filename where an error occurred) when test generation fails because of an invalid XML schema. Note: This option takes extra processing time. Use it after test generation has failed once. |
136+
|`none` `[generate:tests --debug none]`| Skip debugging during test generation. Added for backward compatibility, it will be removed with the next MAJOR release.|
137+
128138
#### Examples of the JSON configuration
129139

130140
The configuration to generate a single test with no suites:

0 commit comments

Comments
 (0)