Skip to content

Commit ddf5564

Browse files
soumyausoumyau
authored
MQE-2216: Annual Docs Review Part 3 (#761)
* MQE-2216: Part 3 Docs Annual Review Updated documentation based on 3.0.0 functionality. * MQE-2216: Part 3 Docs Annual Review * MQE-2216: Part 3 Docs Annual Review * MQE-2216: Annual Docs Review Part 3
1 parent 8e42fda commit ddf5564

File tree

6 files changed

+267
-308
lines changed

6 files changed

+267
-308
lines changed

‎docs/commands/codeception.md‎

Lines changed: 40 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# CLI commands: vendor/bin/codecept
22

33
<div class="bs-callout bs-callout-warning" markdown="1">
4-
We do not recommend using Codeception commands directly as they can break the MFTF basic workflow.
4+
We do not recommend using Codeception commands directly as they can break MFTF basic workflow.
55
All the Codeception commands you need are wrapped using the [mftf tool][].
66

77
To run the Codeception testing framework commands directly, change your directory to the `<Magento root>`.
@@ -36,7 +36,7 @@ vendor/bin/codecept run
3636
```
3737

3838
<div class="bs-callout bs-callout-info">
39-
The following documentation corresponds to Codeception 2.3.8.
39+
The following documentation corresponds to Codeception 4.1.4.
4040
</div>
4141

4242
```bash
@@ -47,36 +47,44 @@ Arguments:
4747
test test to be run
4848

4949
Options:
50-
-o, --override=OVERRIDE Override config values (multiple values allowed)
51-
--config (-c) Use custom path for config
52-
--report Show output in compact style
53-
--html Generate html with results (default: "report.html")
54-
--xml Generate JUnit XML Log (default: "report.xml")
55-
--tap Generate Tap Log (default: "report.tap.log")
56-
--json Generate Json Log (default: "report.json")
57-
--colors Use colors in output
58-
--no-colors Force no colors in output (useful to override config file)
59-
--silent Only outputs suite names and final results
60-
--steps Show steps in output
61-
--debug (-d) Show debug and scenario output
62-
--coverage Run with code coverage (default: "coverage.serialized")
63-
--coverage-html Generate CodeCoverage HTML report in path (default: "coverage")
64-
--coverage-xml Generate CodeCoverage XML report in file (default: "coverage.xml")
65-
--coverage-text Generate CodeCoverage text report in file (default: "coverage.txt")
66-
--coverage-phpunit Generate CodeCoverage PHPUnit report in file (default: "coverage-phpunit")
67-
--no-exit Do not finish with exit code
68-
--group (-g) Groups of tests to be executed (multiple values allowed)
69-
--skip (-s) Skip selected suites (multiple values allowed)
70-
--skip-group (-x) Skip selected groups (multiple values allowed)
71-
--env Run tests in selected environments. (multiple values allowed, environments can be merged with ',')
72-
--fail-fast (-f) Stop after first failure
73-
--help (-h) Display this help message.
74-
--quiet (-q) Do not output any message.
75-
--verbose (-v|vv|vvv) Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug
76-
--version (-V) Display this application version.
77-
--ansi Force ANSI output.
78-
--no-ansi Disable ANSI output.
79-
--no-interaction (-n) Do not ask any interactive question.
50+
-o, --override=OVERRIDE Override config values (multiple values allowed)
51+
-e, --ext=EXT Run with extension enabled (multiple values allowed)
52+
--report Show output in compact style
53+
--html[=HTML] Generate html with results [default: "report.html"]
54+
--xml[=XML] Generate JUnit XML Log [default: "report.xml"]
55+
--phpunit-xml[=PHPUNIT-XML] Generate PhpUnit XML Log [default: "phpunit-report.xml"]
56+
--tap[=TAP] Generate Tap Log [default: "report.tap.log"]
57+
--json[=JSON] Generate Json Log [default: "report.json"]
58+
--colors Use colors in output
59+
--no-colors Force no colors in output (useful to override config file)
60+
--silent Only outputs suite names and final results
61+
--steps Show steps in output
62+
-d, --debug Show debug and scenario output
63+
--bootstrap[=BOOTSTRAP] Execute custom PHP script before running tests. Path can be absolute or relative to current working directory [default: false]
64+
--no-redirect Do not redirect to Composer-installed version in vendor/codeception
65+
--coverage[=COVERAGE] Run with code coverage
66+
--coverage-html[=COVERAGE-HTML] Generate CodeCoverage HTML report in path
67+
--coverage-xml[=COVERAGE-XML] Generate CodeCoverage XML report in file
68+
--coverage-text[=COVERAGE-TEXT] Generate CodeCoverage text report in file
69+
--coverage-crap4j[=COVERAGE-CRAP4J] Generate CodeCoverage report in Crap4J XML format
70+
--coverage-phpunit[=COVERAGE-PHPUNIT] Generate CodeCoverage PHPUnit report in path
71+
--no-exit Don't finish with exit code
72+
-g, --group=GROUP Groups of tests to be executed (multiple values allowed)
73+
-s, --skip=SKIP Skip selected suites (multiple values allowed)
74+
-x, --skip-group=SKIP-GROUP Skip selected groups (multiple values allowed)
75+
--env=ENV Run tests in selected environments. (multiple values allowed)
76+
-f, --fail-fast Stop after first failure
77+
--no-rebuild Do not rebuild actor classes on start
78+
--seed=SEED Define random seed for shuffle setting
79+
--no-artifacts Don't report about artifacts
80+
-h, --help Display this help message
81+
-q, --quiet Do not output any message
82+
-V, --version Display this application version
83+
--ansi Force ANSI output
84+
--no-ansi Disable ANSI output
85+
-n, --no-interaction Do not ask any interactive question
86+
-c, --config[=CONFIG] Use custom path for config
87+
-v|vv|vvv, --verbose Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug
8088
```
8189

8290
<!-- Link definitions -->

‎docs/commands/mftf.md‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -39,13 +39,13 @@ vendor/bin/mftf generate:tests
3939
### Generate tests by test name
4040

4141
```bash
42-
vendor/bin/mftf generate:tests AdminLoginTest StorefrontPersistedCustomerLoginTest
42+
vendor/bin/mftf generate:tests AdminLoginSuccessfulTest StorefrontPersistedCustomerLoginTest
4343
```
4444

4545
### Generate test by test and suite name
4646

4747
```bash
48-
vendor/bin/mftf generate:tests LoginSuite:AdminLoginTest
48+
vendor/bin/mftf generate:tests WYSIWYGDisabledSuite:AdminCMSPageCreatePageTest
4949
```
5050

5151
### Generate and run the tests for a specified group
@@ -59,18 +59,18 @@ This command cleans up the previously generated tests; generates and runs tests
5959
### Generate and run particular tests
6060

6161
```bash
62-
vendor/bin/mftf run:test AdminLoginTest StorefrontPersistedCustomerLoginTest -r
62+
vendor/bin/mftf run:test AdminLoginSuccessfulTest StorefrontPersistedCustomerLoginTest -r
6363
```
6464

65-
This command cleans up the previously generated tests; generates and runs the `LoginAsAdminTest` and `LoginAsCustomerTest` tests.
65+
This command cleans up the previously generated tests; generates and runs the `AdminLoginSuccessfulTest` and `StorefrontPersistedCustomerLoginTest` tests.
6666

6767
### Generate and run particular test in a specific suite's context
6868

6969
```bash
70-
vendor/bin/mftf run:test LoginSuite:AdminLoginTest -r
70+
vendor/bin/mftf run:test WYSIWYGDisabledSuite:AdminCMSPageCreatePageTest -r
7171
```
7272

73-
This command cleans up previously generated tests; generates and run `AdminLoginTest` within the context of the `LoginSuite`.
73+
This command cleans up previously generated tests; generates and run `AdminCMSPageCreatePageTest` within the context of the `WYSIWYGDisabledSuite`.
7474

7575
### Generate and run a testManifest.txt file
7676

@@ -362,7 +362,7 @@ vendor/bin/mftf run:manifest path/to/your/testManifest.txt
362362
Each line should contain either: one test path or one group (-g) reference.
363363

364364
```
365-
tests/functional/tests/MFTF/_generated/default/AdminLoginTestCest.php
365+
tests/functional/tests/MFTF/_generated/default/AdminLoginSuccessfulTestCest.php
366366
-g PaypalTestSuite
367367
tests/functional/tests/MFTF/_generated/default/SomeOtherTestCest.php
368368
tests/functional/tests/MFTF/_generated/default/ThirdTestCest.php

0 commit comments

Comments
 (0)