Skip to content

Commit f7e36d7

Browse files
Update extensions.md: Fixing links to sourcecodes
1 parent e784907 commit f7e36d7

File tree

1 file changed

+23
-37
lines changed

1 file changed

+23
-37
lines changed

_includes/extensions.md

Lines changed: 23 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,10 @@
22

33
## DotReporter
44

5-
[See Source](https://github.com/Codeception/Codeception/blob/5.1/ext/DotReporter.php)
5+
[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

@@ -34,11 +34,9 @@ codecept run --ext DotReporter
3434
Failures and Errors are printed by a standard Codeception reporter.
3535
Use this extension as an example for building custom reporters.
3636

37-
38-
3937
## Logger
4038

41-
[See Source](https://github.com/Codeception/Codeception/blob/5.1/ext/Logger.php)
39+
[See Source](https://github.com/Codeception/Codeception/blob/main/ext/Logger.php)
4240

4341
Log suites/tests/steps using Monolog library.
4442
Monolog should be installed additionally by Composer.
@@ -62,20 +60,18 @@ extensions:
6260
* `max_files` (default: 3) - how many log files to keep
6361

6462

65-
66-
6763
## Recorder
6864

69-
[See Source](https://github.com/Codeception/Codeception/blob/5.1/ext/Recorder.php)
65+
[See Source](https://github.com/Codeception/Codeception/blob/main/ext/Recorder.php)
7066

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.
67+
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)).
68+
Works only for suites with WebDriver module enabled.
7369

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

7672
#### Installation
7773

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

8076
``` yaml
8177
extensions:
@@ -106,26 +102,23 @@ extensions:
106102
```
107103
#### Skipping recording of steps with annotations
108104

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

111107
```php
112108
/**
113109
* @skipRecording login
114110
* @skipRecording amOnUrl
115-
*\/
111+
*/
116112
public function testLogin(AcceptanceTester $I)
117113
{
118114
$I->login();
119115
$I->amOnUrl('https://codeception.com');
120116
}
121117
```
122118

123-
124-
125-
126119
## RunBefore
127120

128-
[See Source](https://github.com/Codeception/Codeception/blob/5.1/ext/RunBefore.php)
121+
[See Source](https://github.com/Codeception/Codeception/blob/main/ext/RunBefore.php)
129122

130123
Extension for execution of some processes before running tests.
131124

@@ -150,15 +143,13 @@ extensions:
150143
- dependent_process_2_2
151144
```
152145

153-
HINT: you can use different configurations per environment.
154-
155-
146+
HINT: You can use different configurations per environment.
156147

157148
## RunFailed
158149

159-
[See Source](https://github.com/Codeception/Codeception/blob/5.1/ext/RunFailed.php)
150+
[See Source](https://github.com/Codeception/Codeception/blob/main/ext/RunFailed.php)
160151

161-
Saves failed tests into tests/_output/failed in order to rerun failed tests.
152+
Saves failed tests into `tests/_output/failed` in order to rerun failed tests.
162153

163154
To rerun failed tests just run the `failed` group:
164155

@@ -170,30 +161,26 @@ To change failed group name add:
170161
```
171162
--override "extensions: config: Codeception\Extension\RunFailed: fail-group: another_group1"
172163
```
173-
Remember: if you run tests and they generated custom-named fail group, to run this group, you should add override too
164+
Remember: If you run tests and they generated custom-named fail group, to run this group, you should add override too.
174165

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

177168
``` yaml
178169
extensions:
179170
enabled: [Codeception\Extension\RunFailed]
180171
```
181172

182-
On each execution failed tests are logged and saved into `tests/_output/failed` file.
183-
184-
185-
186173
## RunProcess
187174

188-
[See Source](https://github.com/Codeception/Codeception/blob/5.1/ext/RunProcess.php)
175+
[See Source](https://github.com/Codeception/Codeception/blob/main/ext/RunProcess.php)
189176

190177
Extension to start and stop processes per suite.
191-
Can be used to start/stop selenium server, chromedriver, mailcatcher, etc.
178+
Can be used to start/stop chromedriver, MailCatcher, etc.
192179

193-
Can be configured in suite config:
180+
Can be enabled in suite config:
194181

195182
```yaml
196-
# acceptance.suite.yml
183+
# Acceptance.suite.yml
197184
extensions:
198185
enabled:
199186
- Codeception\Extension\RunProcess:
@@ -203,7 +190,7 @@ extensions:
203190
Multiple parameters can be passed as array:
204191

205192
```yaml
206-
# acceptance.suite.yml
193+
# Acceptance.suite.yml
207194
208195
extensions:
209196
enabled:
@@ -214,8 +201,7 @@ extensions:
214201

215202
In the end of a suite all launched processes will be stopped.
216203

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

220206
```yaml
221207
extensions:
@@ -226,13 +212,13 @@ extensions:
226212
sleep: 5 # wait 5 seconds for processes to boot
227213
```
228214

229-
HINT: you can use different configurations per environment.
215+
HINT: You can use different configurations per environment.
230216

231217

232218

233219
## SimpleReporter
234220

235-
[See Source](https://github.com/Codeception/Codeception/blob/5.1/ext/SimpleReporter.php)
221+
[See Source](https://github.com/Codeception/Codeception/blob/main/ext/SimpleReporter.php)
236222

237223
This extension demonstrates how you can implement console output of your own.
238224
Recommended to be used for development purposes only.

0 commit comments

Comments
 (0)
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy