|
1 | 1 | # Interactive Pause
|
2 | 2 |
|
3 |
| -It’s hard to write a complete test at once. You will need to try different commands with different arguments before you find a correct path. |
| 3 | +It can be difficut to write a successful test on the first attempt. You will need to try different commands, with different arguments, before you find the correct path. |
4 | 4 |
|
5 |
| -Since Codeception 3.0 you can pause execution in any point and enter interactive shell where you will be able to try commands in action. |
| 5 | +Since Codeception 3.0, you can pause execution in any point and enter an interactive shell where you will be able to try commands in action. |
6 | 6 |
|
7 |
| -Now this `Interactive Pause` feature is available in MFTF and all you need to do is to set `ENABLE_PAUSE=true` in `.env`. |
| 7 | +Now this `Interactive Pause` feature is available in MFTF. All you need to do is to set `ENABLE_PAUSE=true` in `.env`. |
8 | 8 |
|
9 | 9 | Check [pause on codeception.com][] for documentation and a video to see `Interactive Pause` in action.
|
10 | 10 |
|
11 |
| -In short, when a test gets to `$I->pause()` step, it stops and shows a console where you can try all available commands with auto-completion, stash commands, and save screenshot, etc. |
| 11 | +In short, when a test gets to `$I->pause()` step, it stops and shows a console where you can try all available commands with auto-completion, stash commands, save screenshots, etc. |
12 | 12 |
|
13 | 13 | ## Generation Time
|
14 | 14 |
|
15 | 15 | A `<pause>` action in xml will always be generated into php regardless if `ENABLE_PAUSE=true` is set or not.
|
16 | 16 | However, when `ENABLE_PAUSE=true` is set, an additional`pause()` action will be generated in `_failed()` hook for a test,
|
17 |
| -so that the test could pause on failure at run time. |
| 17 | +so that the test may pause on failure at run time. |
18 | 18 |
|
19 | 19 | ## Execution Time
|
20 | 20 |
|
21 |
| -To use `Interactive Pause` at run time, there are two types of MFTF commands to use. |
| 21 | +To use `Interactive Pause` at run time, there are two types of MFTF commands to use: |
22 | 22 |
|
23 | 23 | ### MFTF Run Commands
|
24 | 24 |
|
@@ -47,17 +47,16 @@ Note: MFTF run command's `--debug` option is different from Codeception `--debug
|
47 | 47 | ### MFTF Codecept Run Command
|
48 | 48 |
|
49 | 49 | You can also use MFTF's wrapper command to run Codeception directly and activate `Interactive Pause` by passing `--debug` option.
|
50 |
| -You don't need to set `ENABLE_PAUSE=true` for this command. |
| 50 | +You do not need to set `ENABLE_PAUSE=true` for this command. |
51 | 51 |
|
52 | 52 | ```bash
|
53 | 53 | vendor/bin/mftf codecept:run --debug
|
54 | 54 | ```
|
55 | 55 |
|
56 | 56 | <div class="bs-callout-warning">
|
57 |
| -Note: You may want to limit the usage of this Codeception command with arguments and options for `acceptance` only |
58 |
| -since it's what is supported by MFTF. You should also replace `acceptance` to `functional` when using this command when referring to Codeception documentation. |
| 57 | +You may want to limit the usage of this Codeception command with arguments and options for `acceptance` only, since it is what is supported by MFTF. You should also change `acceptance` to `functional` when using this command when referring to Codeception documentation. |
59 | 58 | </div>
|
60 | 59 |
|
61 | 60 | ## References
|
62 | 61 |
|
63 |
| -[pause on codeception.com](https://codeception.com/docs/02-GettingStarted#Interactive-Pause) |
| 62 | +[pause on codeception.com](https://codeception.com/docs/02-GettingStarted#Interactive-Pause) |
0 commit comments