Skip to content

Commit 4b42efc

Browse files
DavertMikDavertMik
committed
auto updated documentation
1 parent af99734 commit 4b42efc

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

42 files changed

+3096
-1596
lines changed

‎_includes/extensions.md‎

Lines changed: 22 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
## DotReporter
44

5-
[See Source](https://github.com/Codeception/Codeception/blob/2.3/ext/DotReporter.php)
5+
[See Source](https://github.com/Codeception/Codeception/blob/2.4/ext/DotReporter.php)
66

77
DotReporter provides less verbose output for test execution.
88
Like PHPUnit printer it prints dots "." for successful testes and "F" for failures.
@@ -24,6 +24,7 @@ Time: 2.07 seconds, Memory: 20.00MB
2424
OK (80 tests, 124 assertions)
2525
```
2626

27+
2728
Enable this reporter with `--ext option`
2829

2930
```
@@ -33,9 +34,11 @@ codecept run --ext DotReporter
3334
Failures and Errors are printed by a standard Codeception reporter.
3435
Use this extension as an example for building custom reporters.
3536

37+
38+
3639
## Logger
3740

38-
[See Source](https://github.com/Codeception/Codeception/blob/2.3/ext/Logger.php)
41+
[See Source](https://github.com/Codeception/Codeception/blob/2.4/ext/Logger.php)
3942

4043
Log suites/tests/steps using Monolog library.
4144
Monolog should be installed additionally by Composer.
@@ -57,9 +60,12 @@ extensions:
5760
5861
* `max_files` (default: 3) - how many log files to keep
5962

63+
64+
65+
6066
## Recorder
6167

62-
[See Source](https://github.com/Codeception/Codeception/blob/2.3/ext/Recorder.php)
68+
[See Source](https://github.com/Codeception/Codeception/blob/2.4/ext/Recorder.php)
6369

6470
Saves a screenshot of each step in acceptance tests and shows them as a slideshow on one HTML page (here's an [example](http://codeception.com/images/recorder.gif))
6571
Activated only for suites with WebDriver module enabled.
@@ -81,6 +87,7 @@ extensions:
8187
* `delete_successful` (default: true) - delete screenshots for successfully passed tests (i.e. log only failed and errored tests).
8288
* `module` (default: WebDriver) - which module for screenshots to use. Set `AngularJS` if you want to use it with AngularJS module. Generally, the module should implement `Codeception\Lib\Interfaces\ScreenshotSaver` interface.
8389

90+
8491
#### Examples:
8592

8693
``` yaml
@@ -91,9 +98,12 @@ extensions:
9198
delete_successful: false # keep screenshots of successful tests
9299
```
93100

101+
102+
103+
94104
## RunFailed
95105

96-
[See Source](https://github.com/Codeception/Codeception/blob/2.3/ext/RunFailed.php)
106+
[See Source](https://github.com/Codeception/Codeception/blob/2.4/ext/RunFailed.php)
97107

98108
Saves failed tests into tests/log/failed in order to rerun failed tests.
99109

@@ -118,9 +128,11 @@ extensions:
118128

119129
On each execution failed tests are logged and saved into `tests/_output/failed` file.
120130

131+
132+
121133
## RunProcess
122134

123-
[See Source](https://github.com/Codeception/Codeception/blob/2.3/ext/RunProcess.php)
135+
[See Source](https://github.com/Codeception/Codeception/blob/2.4/ext/RunProcess.php)
124136

125137
Extension to start and stop processes per suite.
126138
Can be used to start/stop selenium server, chromedriver, phantomjs, mailcatcher, etc.
@@ -163,10 +175,14 @@ extensions:
163175

164176
HINT: you can use different configurations per environment.
165177

178+
179+
166180
## SimpleReporter
167181

168-
[See Source](https://github.com/Codeception/Codeception/blob/2.3/ext/SimpleReporter.php)
182+
[See Source](https://github.com/Codeception/Codeception/blob/2.4/ext/SimpleReporter.php)
169183

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

187+
188+

‎docs/modules/AMQP.md‎

Lines changed: 19 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@ title: AMQP - Codeception - Documentation
99

1010
# AMQP
1111

12+
1213
This module interacts with message broker software that implements
1314
the Advanced Message Queuing Protocol (AMQP) standard. For example, RabbitMQ (tested).
1415

@@ -46,7 +47,7 @@ To use this module with Composer you need <em>"php-amqplib/php-amqplib": "~2.4"<
4647
### Actions
4748

4849
#### bindQueueToExchange
49-
50+
5051
Binds a queue to an exchange
5152

5253
This is an alias of method `queue_bind` of `PhpAmqpLib\Channel\AMQPChannel`.
@@ -70,8 +71,9 @@ $I->bindQueueToExchange(
7071
* `param int` $ticket
7172
* `return` mixed|null
7273

73-
#### declareExchange
7474

75+
#### declareExchange
76+
7577
Declares an exchange
7678

7779
This is an alias of method `exchange_declare` of `PhpAmqpLib\Channel\AMQPChannel`.
@@ -97,8 +99,9 @@ $I->declareExchange(
9799
* `param int` $ticket
98100
* `return` mixed|null
99101

100-
#### declareQueue
101102

103+
#### declareQueue
104+
102105
Declares queue, creates if needed
103106

104107
This is an alias of method `queue_declare` of `PhpAmqpLib\Channel\AMQPChannel`.
@@ -122,8 +125,9 @@ $I->declareQueue(
122125
* `param int` $ticket
123126
* `return` mixed|null
124127

125-
#### grabMessageFromQueue
126128

129+
#### grabMessageFromQueue
130+
127131
Takes last message from queue.
128132

129133
{% highlight php %}
@@ -137,8 +141,9 @@ $message = $I->grabMessageFromQueue('queue.emails');
137141
* `param string` $queue
138142
* `return` \PhpAmqpLib\Message\AMQPMessage
139143

140-
#### purgeAllQueues
141144

145+
#### purgeAllQueues
146+
142147
Purge all queues defined in config.
143148

144149
{% highlight php %}
@@ -149,8 +154,9 @@ $I->purgeAllQueues();
149154

150155
{% endhighlight %}
151156

152-
#### purgeQueue
153157

158+
#### purgeQueue
159+
154160
Purge a specific queue defined in config.
155161

156162
{% highlight php %}
@@ -163,8 +169,9 @@ $I->purgeQueue('queue.emails');
163169

164170
* `param string` $queueName
165171

166-
#### pushToExchange
167172

173+
#### pushToExchange
174+
168175
Sends message to exchange by sending exchange name, message
169176
and (optionally) a routing key
170177

@@ -182,8 +189,9 @@ $I->pushToExchange('exchange.emails', new AMQPMessage('Thanks!'), 'severity');
182189
* `param string|\PhpAmqpLib\Message\AMQPMessage` $message
183190
* `param string` $routing_key
184191

185-
#### pushToQueue
186192

193+
#### pushToQueue
194+
187195
Sends message to queue
188196

189197
{% highlight php %}
@@ -198,8 +206,9 @@ $I->pushToQueue('queue.jobs', new AMQPMessage('create'));
198206
* `param string` $queue
199207
* `param string|\PhpAmqpLib\Message\AMQPMessage` $message
200208

201-
#### seeMessageInQueueContainsText
202209

210+
#### seeMessageInQueueContainsText
211+
203212
Checks if message containing text received.
204213

205214
**This method drops message from queue**
@@ -217,4 +226,4 @@ $I->seeMessageInQueueContainsText('queue.emails','davert');
217226
* `param string` $queue
218227
* `param string` $text
219228

220-
<p>&nbsp;</p><div class="alert alert-warning">Module reference is taken from the source code. <a href="https://github.com/Codeception/Codeception/tree/2.3/src/Codeception/Module/AMQP.php">Help us to improve documentation. Edit module reference</a></div>
229+
<p>&nbsp;</p><div class="alert alert-warning">Module reference is taken from the source code. <a href="https://github.com/Codeception/Codeception/tree/2.4/src/Codeception/Module/AMQP.php">Help us to improve documentation. Edit module reference</a></div>

0 commit comments

Comments
 (0)