Skip to content

Commit ccfd6e3

Browse files
DavertMikDavertMik
committed
auto updated documentation
1 parent 72850f8 commit ccfd6e3

Some content is hidden

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

43 files changed

+1595
-3092
lines changed

‎_includes/extensions.md‎

Lines changed: 6 additions & 22 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.4/ext/DotReporter.php)
5+
[See Source](https://github.com/Codeception/Codeception/blob/2.3/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,7 +24,6 @@ Time: 2.07 seconds, Memory: 20.00MB
2424
OK (80 tests, 124 assertions)
2525
```
2626

27-
2827
Enable this reporter with `--ext option`
2928

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

37-
38-
3936
## Logger
4037

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

4340
Log suites/tests/steps using Monolog library.
4441
Monolog should be installed additionally by Composer.
@@ -60,12 +57,9 @@ extensions:
6057
6158
* `max_files` (default: 3) - how many log files to keep
6259

63-
64-
65-
6660
## Recorder
6761

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

7064
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))
7165
Activated only for suites with WebDriver module enabled.
@@ -87,7 +81,6 @@ extensions:
8781
* `delete_successful` (default: true) - delete screenshots for successfully passed tests (i.e. log only failed and errored tests).
8882
* `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.
8983

90-
9184
#### Examples:
9285

9386
``` yaml
@@ -98,12 +91,9 @@ extensions:
9891
delete_successful: false # keep screenshots of successful tests
9992
```
10093

101-
102-
103-
10494
## RunFailed
10595

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

10898
Saves failed tests into tests/log/failed in order to rerun failed tests.
10999

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

129119
On each execution failed tests are logged and saved into `tests/_output/failed` file.
130120

131-
132-
133121
## RunProcess
134122

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

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

176164
HINT: you can use different configurations per environment.
177165

178-
179-
180166
## SimpleReporter
181167

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

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

187-
188-

‎changelog.markdown‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,8 +17,9 @@ title: Codeception Changelog
1717
* Cest hooks behavior changed (by **[fffilimonov](https://github.com/fffilimonov)**):
1818
* `_failed` called when test fails
1919
* `_passed` called when tests is successful
20-
* `_after` is called for failing and successful tests
21-
#### 2.3.9
20+
* `_after` is called for failing and successful tests
21+
22+
#### 2.3.9
2223

2324
* Added `Codeception\Step\Argument\PasswordArgument` to pass sensitive data into tests:
2425

‎docs/modules/AMQP.md‎

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

1010
# AMQP
1111

12-
1312
This module interacts with message broker software that implements
1413
the Advanced Message Queuing Protocol (AMQP) standard. For example, RabbitMQ (tested).
1514

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

4948
#### bindQueueToExchange
50-
49+
5150
Binds a queue to an exchange
5251

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

74-
7573
#### declareExchange
76-
74+
7775
Declares an exchange
7876

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

102-
103100
#### declareQueue
104-
101+
105102
Declares queue, creates if needed
106103

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

128-
129125
#### grabMessageFromQueue
130-
126+
131127
Takes last message from queue.
132128

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

144-
145140
#### purgeAllQueues
146-
141+
147142
Purge all queues defined in config.
148143

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

155150
{% endhighlight %}
156151

157-
158152
#### purgeQueue
159-
153+
160154
Purge a specific queue defined in config.
161155

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

170164
* `param string` $queueName
171165

172-
173166
#### pushToExchange
174-
167+
175168
Sends message to exchange by sending exchange name, message
176169
and (optionally) a routing key
177170

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

192-
193185
#### pushToQueue
194-
186+
195187
Sends message to queue
196188

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

209-
210201
#### seeMessageInQueueContainsText
211-
202+
212203
Checks if message containing text received.
213204

214205
**This method drops message from queue**
@@ -226,4 +217,4 @@ $I->seeMessageInQueueContainsText('queue.emails','davert');
226217
* `param string` $queue
227218
* `param string` $text
228219

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>
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>

0 commit comments

Comments
 (0)