Skip to content

Commit 0b02292

Browse files
github-actions[bot]github-actions[bot]
github-actions[bot]
authored and
github-actions[bot]
committed
updated
1 parent 3cec809 commit 0b02292

File tree

4 files changed

+81
-66
lines changed

4 files changed

+81
-66
lines changed

_includes/extensions.md

Lines changed: 15 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
[See Source](https://github.com/Codeception/Codeception/blob/main/ext/DotReporter.php)
66

77
DotReporter provides less verbose output for test execution.
8-
Like PHPUnit printer it prints dots "." for successful testes and "F" for failures.
8+
Like PHPUnit printer it prints dots "." for successful tests and "F" for failures.
99

1010
![](https://cloud.githubusercontent.com/assets/220264/26132800/4d23f336-3aab-11e7-81ba-2896a4c623d2.png)
1111

@@ -68,14 +68,14 @@ extensions:
6868

6969
[See Source](https://github.com/Codeception/Codeception/blob/main/ext/Recorder.php)
7070

71-
Saves a screenshot of each step in acceptance tests and shows them as a slideshow on one HTML page (here's an [example](https://codeception.com/images/recorder.gif))
72-
Activated only for suites with WebDriver module enabled.
71+
Saves a screenshot of each step in acceptance tests and shows them as a slideshow on one HTML page (here's an [example](https://codeception.com/images/recorder.gif)).
72+
Works only for suites with WebDriver module enabled.
7373

7474
The screenshots are saved to `tests/_output/record_*` directories, open `index.html` to see them as a slideshow.
7575

7676
#### Installation
7777

78-
Add this to the list of enabled extensions in `codeception.yml` or `acceptance.suite.yml`:
78+
Add this to the list of enabled extensions in `codeception.yml` or `Acceptance.suite.yml`:
7979

8080
``` yaml
8181
extensions:
@@ -106,7 +106,7 @@ extensions:
106106
```
107107
#### Skipping recording of steps with annotations
108108

109-
It is also possible to skip recording of steps for specified tests by using the @skipRecording annotation.
109+
It is also possible to skip recording of steps for specified tests by using the `@skipRecording` annotation.
110110

111111
```php
112112
/**
@@ -122,7 +122,6 @@ public function testLogin(AcceptanceTester $I)
122122

123123

124124

125-
126125
## RunBefore
127126

128127
[See Source](https://github.com/Codeception/Codeception/blob/main/ext/RunBefore.php)
@@ -158,7 +157,7 @@ HINT: you can use different configurations per environment.
158157

159158
[See Source](https://github.com/Codeception/Codeception/blob/main/ext/RunFailed.php)
160159

161-
Saves failed tests into tests/_output/failed in order to rerun failed tests.
160+
Saves failed tests into `tests/_output/failed` in order to rerun failed tests.
162161

163162
To rerun failed tests just run the `failed` group:
164163

@@ -170,9 +169,9 @@ To change failed group name add:
170169
```
171170
--override "extensions: config: Codeception\Extension\RunFailed: fail-group: another_group1"
172171
```
173-
Remember: if you run tests and they generated custom-named fail group, to run this group, you should add override too
172+
Remember: If you run tests and they generated custom-named fail group, to run this group, you should add override too
174173

175-
Starting from Codeception 2.1 **this extension is enabled by default**.
174+
**This extension is enabled by default.**
176175

177176
``` yaml
178177
extensions:
@@ -188,12 +187,13 @@ On each execution failed tests are logged and saved into `tests/_output/failed`
188187
[See Source](https://github.com/Codeception/Codeception/blob/main/ext/RunProcess.php)
189188

190189
Extension to start and stop processes per suite.
191-
Can be used to start/stop selenium server, chromedriver, mailcatcher, etc.
190+
Can be used to start/stop selenium server, chromedriver, [MailCatcher](https://mailcatcher.me/), etc.
191+
Each command is executed only once, at the beginning of the test suite. To execute a command before each test, see [Before/After Attributes](https://codeception.com/docs/AdvancedUsage#BeforeAfter-Attributes).
192192

193-
Can be configured in suite config:
193+
Can be enabled in suite config:
194194

195195
```yaml
196-
# acceptance.suite.yml
196+
# Acceptance.suite.yml
197197
extensions:
198198
enabled:
199199
- Codeception\Extension\RunProcess:
@@ -203,8 +203,7 @@ extensions:
203203
Multiple parameters can be passed as array:
204204

205205
```yaml
206-
# acceptance.suite.yml
207-
206+
# Acceptance.suite.yml
208207
extensions:
209208
enabled:
210209
- Codeception\Extension\RunProcess:
@@ -214,8 +213,7 @@ extensions:
214213

215214
In the end of a suite all launched processes will be stopped.
216215

217-
To wait for the process to be launched use `sleep` option.
218-
In this case you need configuration to be specified as object:
216+
To wait for the process to be launched use `sleep` option. In this case you need configuration to be specified as object:
219217

220218
```yaml
221219
extensions:
@@ -226,7 +224,7 @@ extensions:
226224
sleep: 5 # wait 5 seconds for processes to boot
227225
```
228226

229-
HINT: you can use different configurations per environment.
227+
HINT: You can use different configurations per environment.
230228

231229

232230

changelog.markdown

Lines changed: 29 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,35 @@ title: Codeception Changelog
99

1010

1111

12+
### Codeception 5.2.0: 5.2.0
13+
14+
Released by [![](https://avatars.githubusercontent.com/u/64917965?v=4&s=16) TavoNiievez](https://github.com/TavoNiievez) on 2025/02/16 20:31:08 / [Repository](https://github.com/Codeception/Codeception) / [Releases](https://github.com/Codeception/Codeception/releases)
15+
16+
17+
18+
## What's Changed
19+
* Fix FAIL message color highlighting by **[antonvolokha](https://github.com/antonvolokha)** in [#6754](https://github.com/Codeception/Codeception/issues/6754)
20+
* Update the codebase to PHP 8.1 by **[TavoNiievez](https://github.com/TavoNiievez)** in [#6747](https://github.com/Codeception/Codeception/issues/6747)
21+
* generate:cest: Adding `declare(strict_types=1);` and return type `void` to generated files by **[ThomasLandauer](https://github.com/ThomasLandauer)** in [#6736](https://github.com/Codeception/Codeception/issues/6736)
22+
* Declare nullable parameter types explicitly by **[W0rma](https://github.com/W0rma)** in [#6774](https://github.com/Codeception/Codeception/issues/6774) , [#6775](https://github.com/Codeception/Codeception/issues/6775)
23+
* chore: Included githubactions in the dependabot config ([#6471](https://github.com/Codeception/Codeception/issues/6471)) by **[SamMousa](https://github.com/SamMousa)** in [#6783](https://github.com/Codeception/Codeception/issues/6783)
24+
* Added new option --disable-coverage-php to skip coverage.serialized report by **[adrenalinkin](https://github.com/adrenalinkin)** in [#6761](https://github.com/Codeception/Codeception/issues/6761)
25+
* chore: add branch alias for main to fix composer install with dev deps by **[SamMousa](https://github.com/SamMousa)** in [#6787](https://github.com/Codeception/Codeception/issues/6787)
26+
* chore(ci): prevent test CI running twice on PR branches by **[SamMousa](https://github.com/SamMousa)** in [#6788](https://github.com/Codeception/Codeception/issues/6788)
27+
* Simplify classes by **[TavoNiievez](https://github.com/TavoNiievez)** in [#6767](https://github.com/Codeception/Codeception/issues/6767) , [#6750](https://github.com/Codeception/Codeception/issues/6750) , [#6764](https://github.com/Codeception/Codeception/issues/6764)
28+
* PHP 8.4: `E_STRICT` deprecation by **[W0rma](https://github.com/W0rma)** in [#6802](https://github.com/Codeception/Codeception/issues/6802)
29+
* Fix PHP 8.4 deprecation. by **[kagg-design](https://github.com/kagg-design)** in [#6811](https://github.com/Codeception/Codeception/issues/6811)
30+
* Fix test suite names in bootstrap command by **[W0rma](https://github.com/W0rma)** in [#6813](https://github.com/Codeception/Codeception/issues/6813)
31+
* Docs (minor) by **[ThomasLandauer](https://github.com/ThomasLandauer)** in [#6804](https://github.com/Codeception/Codeception/issues/6804) , [#6805](https://github.com/Codeception/Codeception/issues/6805) , [#6806](https://github.com/Codeception/Codeception/issues/6806) , 6807 , [#6792](https://github.com/Codeception/Codeception/issues/6792) , [#6810](https://github.com/Codeception/Codeception/issues/6810) , [#6751](https://github.com/Codeception/Codeception/issues/6751) , [#6744](https://github.com/Codeception/Codeception/issues/6744)
32+
33+
## New Contributors
34+
* **[antonvolokha](https://github.com/antonvolokha)** made their first contribution in https://github.com/Codeception/Codeception/pull/6754
35+
* **[adrenalinkin](https://github.com/adrenalinkin)** made their first contribution in https://github.com/Codeception/Codeception/pull/6761
36+
* **[kagg-design](https://github.com/kagg-design)** made their first contribution in https://github.com/Codeception/Codeception/pull/6811
37+
38+
**Full Changelog**: https://github.com/Codeception/Codeception/compare/5.1.2...5.2.0
39+
40+
1241
### module-webdriver 4.0.3: 4.0.3
1342

1443
Released by [![](https://avatars.githubusercontent.com/u/395992?v=4&s=16) Naktibalda](https://github.com/Naktibalda) on 2025/02/14 07:14:37 / [Repository](https://github.com/Codeception/module-webdriver) / [Releases](https://github.com/Codeception/module-webdriver/releases)
@@ -1693,19 +1722,6 @@ Released by [![](https://avatars.githubusercontent.com/u/395992?v=4&s=16) Naktib
16931722
* Uses lib-xml
16941723

16951724

1696-
### Codeception 5.0.0-alpha3: 5.0.0-alpha3
1697-
1698-
Released by [![](https://avatars.githubusercontent.com/u/395992?v=4&s=16) Naktibalda](https://github.com/Naktibalda) on 2022/03/11 11:02:50 / [Repository](https://github.com/Codeception/Codeception) / [Releases](https://github.com/Codeception/Codeception/releases)
1699-
1700-
1701-
1702-
* Support intersection types in actions
1703-
* Introduced PSR-12 code style
1704-
* Extracted some code to modules and shared libs
1705-
* Fixed new incompatibilities with PHPUnit 10
1706-
1707-
1708-
17091725
### module-rest 3.1.0: 3.1.0
17101726

17111727
Released by [![](https://avatars.githubusercontent.com/u/395992?v=4&s=16) Naktibalda](https://github.com/Naktibalda) on 2022/03/11 11:00:56 / [Repository](https://github.com/Codeception/module-rest) / [Releases](https://github.com/Codeception/module-rest/releases)

docs/reference/Commands.md

Lines changed: 36 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -62,39 +62,40 @@ Arguments:
6262

6363
Options:
6464
-o, --override=OVERRIDE Override config values (multiple values allowed)
65-
--config (-c) Use custom path for config
66-
--report Show output in compact style
67-
--html Generate html with results (default: "report.html")
68-
--xml Generate JUnit XML Log (default: "report.xml")
69-
--phpunit-xml Generate PhpUnit XML Log (default: "phpunit-report.xml")
70-
--no-redirect Do not redirect to Composer-installed version in vendor/codeception
71-
--colors Use colors in output
72-
--no-colors Force no colors in output (useful to override config file)
73-
--silent Only outputs suite names and final results. Almost the same as `--quiet`
74-
--steps Show steps in output
75-
--debug (-d) Alias for `-vv`
76-
--bootstrap Execute bootstrap script before the test
77-
--coverage Run with code coverage (default: "coverage.serialized")
78-
--coverage-html Generate CodeCoverage HTML report in path (default: "coverage")
79-
--coverage-xml Generate CodeCoverage XML report in file (default: "coverage.xml")
80-
--coverage-text Generate CodeCoverage text report in file (default: "coverage.txt")
81-
--coverage-phpunit Generate CodeCoverage PHPUnit report in file (default: "coverage-phpunit")
82-
--coverage-cobertura Generate CodeCoverage Cobertura report in file (default: "coverage-cobertura")
83-
--no-exit Don't finish with exit code
84-
--group (-g) Groups of tests to be executed (multiple values allowed)
85-
--skip (-s) Skip selected suites (multiple values allowed)
86-
--skip-group (-x) Skip selected groups (multiple values allowed)
87-
--env Run tests in selected environments. (multiple values allowed, environments can be merged with ',')
88-
--fail-fast (-f) Stop after nth failure (defaults to 1)
89-
--no-rebuild Do not rebuild actor classes on start
90-
--help (-h) Display this help message.
91-
--quiet (-q) Do not output any message. Almost the same as `--silent`
92-
--verbose (-v|vv|vvv) Increase the verbosity of messages: `v` for normal output, `vv` for steps and debug, `vvv` for Codeception-internal debug
93-
--version (-V) Display this application version.
94-
--ansi Force ANSI output.
95-
--no-ansi Disable ANSI output.
96-
--no-interaction (-n) Do not ask any interactive question.
97-
--seed Use the given seed for shuffling tests
65+
--config (-c) Use custom path for config
66+
--report Show output in compact style
67+
--html Generate html with results (default: "report.html")
68+
--xml Generate JUnit XML Log (default: "report.xml")
69+
--phpunit-xml Generate PhpUnit XML Log (default: "phpunit-report.xml")
70+
--no-redirect Do not redirect to Composer-installed version in vendor/codeception
71+
--colors Use colors in output
72+
--no-colors Force no colors in output (useful to override config file)
73+
--silent Only outputs suite names and final results. Almost the same as `--quiet`
74+
--steps Show steps in output
75+
--debug (-d) Alias for `-vv`
76+
--bootstrap Execute bootstrap script before the test
77+
--coverage Run with code coverage (default: "coverage.serialized")
78+
--disable-coverage-php Don't generate CodeCoverage report in raw PHP serialized format
79+
--coverage-html Generate CodeCoverage HTML report in path (default: "coverage")
80+
--coverage-xml Generate CodeCoverage XML report in file (default: "coverage.xml")
81+
--coverage-text Generate CodeCoverage text report in file (default: "coverage.txt")
82+
--coverage-phpunit Generate CodeCoverage PHPUnit report in file (default: "coverage-phpunit")
83+
--coverage-cobertura Generate CodeCoverage Cobertura report in file (default: "coverage-cobertura")
84+
--no-exit Don't finish with exit code
85+
--group (-g) Groups of tests to be executed (multiple values allowed)
86+
--skip (-s) Skip selected suites (multiple values allowed)
87+
--skip-group (-x) Skip selected groups (multiple values allowed)
88+
--env Run tests in selected environments. (multiple values allowed, environments can be merged with ',')
89+
--fail-fast (-f) Stop after nth failure (defaults to 1)
90+
--no-rebuild Do not rebuild actor classes on start
91+
--help (-h) Display this help message.
92+
--quiet (-q) Do not output any message. Almost the same as `--silent`
93+
--verbose (-v|vv|vvv) Increase the verbosity of messages: `v` for normal output, `vv` for steps and debug, `vvv` for Codeception-internal debug
94+
--version (-V) Display this application version.
95+
--ansi Force ANSI output.
96+
--no-ansi Disable ANSI output.
97+
--no-interaction (-n) Do not ask any interactive question.
98+
--seed Use the given seed for shuffling tests
9899

99100
{% endhighlight %}
100101

@@ -157,7 +158,7 @@ Generates Cest (scenario-driven object-oriented test) file:
157158
Creates default config, tests directory and sample suites for current project.
158159
Use this command to start building a test suite.
159160

160-
By default it will create 3 suites **Acceptance**, **Functional**, and **Unit**.
161+
By default, it will create 3 suites **Acceptance**, **Functional**, and **Unit**.
161162

162163
* `codecept bootstrap` - creates `tests` dir and `codeception.yml` in current dir.
163164
* `codecept bootstrap --empty` - creates `tests` dir without suites
@@ -261,7 +262,7 @@ Starting from Codeception 2.0 actor classes are auto-generated. Use this command
261262

262263
## DryRun
263264

264-
Shows step by step execution process for scenario driven tests without actually running them.
265+
Shows step-by-step execution process for scenario driven tests without actually running them.
265266

266267
* `codecept dry-run acceptance`
267268
* `codecept dry-run acceptance MyCest`

docs/reference/Module.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2043,7 +2043,7 @@ HOOK to be executed when config changes with `_reconfigure`.
20432043
* `param array` $array
20442044
* `return array`
20452045

2046-
[See source](https://github.com/Codeception/Codeception/blob/5.1/src/Codeception/Module.php#L312)
2046+
[See source](https://github.com/Codeception/Codeception/blob/5.1/src/Codeception/Module.php#L309)
20472047

20482048
#### shortenMessage()
20492049

0 commit comments

Comments
 (0)