Skip to content

Commit 21ff81c

Browse files
NaktibaldaNaktibalda
committed
auto updated documentation
1 parent b60f1c5 commit 21ff81c

21 files changed

+308
-213
lines changed

‎_includes/extensions.md

Lines changed: 16 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -86,7 +86,7 @@ extensions:
8686

8787
* `delete_successful` (default: true) - delete screenshots for successfully passed tests (i.e. log only failed and errored tests).
8888
* `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.
89-
* `ignore_steps` (default: []) - array of step names that should not be recorded (given the step passed), * wildcards supported.
89+
* `ignore_steps` (default: []) - array of step names that should not be recorded (given the step passed), * wildcards supported. Meta steps can also be ignored.
9090
* `success_color` (default: success) - bootstrap values to be used for color representation for passed tests
9191
* `failure_color` (default: danger) - bootstrap values to be used for color representation for failed tests
9292
* `error_color` (default: dark) - bootstrap values to be used for color representation for scenarios where there's an issue occurred while generating a recording
@@ -102,6 +102,21 @@ extensions:
102102
delete_successful: false # keep screenshots of successful tests
103103
ignore_steps: [have, grab*]
104104
```
105+
#### Skipping recording of steps with annotations
106+
107+
It is also possible to skip recording of steps for specified tests by using the @skipRecoding annotation.
108+
109+
```php
110+
/**
111+
* @skipRecording login
112+
* @skipRecording amOnUrl
113+
*\/
114+
public function testLogin(AcceptanceTester $I)
115+
{
116+
$I->login();
117+
$I->amOnUrl('http://codeception.com');
118+
}
119+
```
105120

106121

107122

‎changelog.markdown

Lines changed: 25 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,30 @@ title: Codeception Changelog
77

88
# Changelog
99

10+
#### 2.5.2
11+
12+
* **[ZendExppressive]** Support for Zend Expressive v3 by **[Naktibalda](https://github.com/Naktibalda)**
13+
* **[ZendExppressive]** Added options to reload application between tests and between requests by **[Naktibalda](https://github.com/Naktibalda)**
14+
* **[Symfony]** Fix "already initialized service", "reboot kernel issue" [#5262](https://github.com/Codeception/Codeception/issues/5262) by **[gdmfx](https://github.com/gdmfx)**
15+
* {Yii2] Prevent NPE [#5259](https://github.com/Codeception/Codeception/issues/5259) by **[SilverFire](https://github.com/SilverFire)**
16+
* **[Db]** isPopulated method was hidden by renaming to _isPopulated by **[Naktibalda](https://github.com/Naktibalda)**
17+
* **[Db]** don't clear database for empty dump by **[Slamdunk](https://github.com/Slamdunk)**
18+
* **[AMQP]** added methods `seeQueueIsEmpty`, `dontSeeQueueIsEmpty`, `seeNumberOfMessagesInQueue`, `scheduleQueueCleanup` method by **[kardagan](https://github.com/kardagan)**
19+
* [REST][PhpBrowser][Frameworks] Save page source as .fail.json or .fail.xml depending on content type, by **[freiondrej](https://github.com/freiondrej)**
20+
* **[Doctrine2]** Cleanup property works after on reconfigure [#5250](https://github.com/Codeception/Codeception/issues/5250) by **[joelmedeiros](https://github.com/joelmedeiros)**
21+
* **[JsonType]** Allow to use : in regex filter ([#5273](https://github.com/Codeception/Codeception/issues/5273)) by **[ellisgl](https://github.com/ellisgl)**
22+
* **[WebDriver]** Print curl error to debug output if WebDriver failed to connect [#5315](https://github.com/Codeception/Codeception/issues/5315) by **[Naktibalda](https://github.com/Naktibalda)**
23+
* **[Logger]** Ignores empty context and extra fields, by **[siad007](https://github.com/siad007)**
24+
* **[Recorder]** Improved steps ignoring in Recorder extension with meta steps and annotations support [#5210](https://github.com/Codeception/Codeception/issues/5210) by **[sspat](https://github.com/sspat)**.
25+
* `@dataProvider` works with yield/generators [#5271](https://github.com/Codeception/Codeception/issues/5271) by **[burned42](https://github.com/burned42)**
26+
* Fixed issue ArrayContainsComparator do not Intersect correctly Empty expected nested array [#5303](https://github.com/Codeception/Codeception/issues/5303) by **[malinink](https://github.com/malinink)**
27+
* Fixed issue of steps with mocked objects [#5163](https://github.com/Codeception/Codeception/issues/5163) by **[dh9325](https://github.com/dh9325)**
28+
* Added Environment Name To Descriptor Unique Signatures [#5294](https://github.com/Codeception/Codeception/issues/5294) by **[Tenzian](https://github.com/Tenzian)**
29+
* Run command: Added `--phpunit-xml` option, which produces xml report having the same structure as PhpUnit's [#5004](https://github.com/Codeception/Codeception/issues/5004) by **[Naktibalda](https://github.com/Naktibalda)**
30+
* Bootstrap command: Changed namespace shortcut to `-s` [#5275](https://github.com/Codeception/Codeception/issues/5275) by **[Naktibalda](https://github.com/Naktibalda)**
31+
* Improved the docs; by **[h311ion](https://github.com/h311ion)**, **[gimler](https://github.com/gimler)**, **[picass0](https://github.com/picass0)**, **[josephzidell](https://github.com/josephzidell)**
32+
33+
1034
#### 2.5.1
1135

1236
* Recorder extension improvements by **[OneEyedSpaceFish](https://github.com/OneEyedSpaceFish)**. See [#5177](https://github.com/Codeception/Codeception/issues/5177):
@@ -19,7 +43,7 @@ title: Codeception Changelog
1943
* the ability not to display any Unicode characters if ANSI only output is requested
2044
* the ability not to display any colors in output if no-colors is requested
2145
* the ability to change colors in the generated list based on configuration
22-
* **[Db]** Made `_loadDump` unconditional like it was in 2.4. Fixed [#5195](https://github.com/Codeception/Codeception/issues/5195) by **[Naktibala](https://github.com/Naktibala)**
46+
* **[Db]** Made `_loadDump` unconditional like it was in 2.4. Fixed [#5195](https://github.com/Codeception/Codeception/issues/5195) by **[Naktibalda](https://github.com/Naktibalda)**
2347
* **[Db]** Allows to specify more than one dump file. See [#5220](https://github.com/Codeception/Codeception/issues/5220) by **[Fenikkusu](https://github.com/Fenikkusu)**
2448
* **[WebDriver]** Added `waitForElementClickable` by **[FatBoyXPC](https://github.com/FatBoyXPC)**
2549
* Code coverage: added `work_dir` config option to map remote paths to local. See [#5225](https://github.com/Codeception/Codeception/issues/5225) by **[Fenikkusu](https://github.com/Fenikkusu)**

‎docs/06-ModulesAndHelpers.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ modules:
4444

4545
The FunctionalTester class has its methods defined in modules. Actually, it doesn't contain any of them,
4646
but rather acts as a proxy. It knows which module executes this action and passes parameters into it.
47-
To make your IDE see all of the FunctionalTester methods, you should run use the `codecept build` command.
47+
To make your IDE see all of the FunctionalTester methods, you should run the `codecept build` command.
4848
It generates method signatures from enabled modules and saves them into a trait which is included in an actor.
4949
In the current example, the `tests/support/_generated/FunctionalTesterActions.php` file will be generated.
5050
By default, Codeception automatically rebuilds the Actions trait on each change of the suite configuration.

‎docs/modules/AMQP.md

Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -126,6 +126,22 @@ $I->declareQueue(
126126
* `return` mixed|null
127127

128128

129+
#### dontSeeQueueIsEmpty
130+
131+
Checks if queue is not empty.
132+
133+
{% highlight php %}
134+
135+
<?php
136+
$I->pushToQueue('queue.emails', 'Hello, davert');
137+
$I->dontSeeQueueIsEmpty('queue.emails');
138+
?>
139+
140+
{% endhighlight %}
141+
142+
* `param string` $queue
143+
144+
129145
#### grabMessageFromQueue
130146

131147
Takes last message from queue.
@@ -207,6 +223,13 @@ $I->pushToQueue('queue.jobs', new AMQPMessage('create'));
207223
* `param string|\PhpAmqpLib\Message\AMQPMessage` $message
208224

209225

226+
#### scheduleQueueCleanup
227+
228+
Add a queue to purge list
229+
230+
* `param string` $queue
231+
232+
210233
#### seeMessageInQueueContainsText
211234

212235
Checks if message containing text received.
@@ -226,4 +249,39 @@ $I->seeMessageInQueueContainsText('queue.emails','davert');
226249
* `param string` $queue
227250
* `param string` $text
228251

252+
253+
#### seeNumberOfMessagesInQueue
254+
255+
Checks that queue have expected number of message
256+
257+
{% highlight php %}
258+
259+
<?php
260+
$I->pushToQueue('queue.emails', 'Hello, davert');
261+
$I->seeNumberOfMessagesInQueue('queue.emails',1);
262+
?>
263+
264+
{% endhighlight %}
265+
266+
* `param string` $queue
267+
* `param int` $expected
268+
269+
270+
#### seeQueueIsEmpty
271+
272+
Checks that queue is empty
273+
274+
{% highlight php %}
275+
276+
<?php
277+
$I->pushToQueue('queue.emails', 'Hello, davert');
278+
$I->purgeQueue('queue.emails');
279+
$I->seeQueueIsEmpty('queue.emails');
280+
?>
281+
282+
{% endhighlight %}
283+
284+
* `param string` $queue
285+
* `param int` $expected
286+
229287
<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.5/src/Codeception/Module/AMQP.php">Help us to improve documentation. Edit module reference</a></div>

‎docs/modules/AngularJS.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -558,7 +558,7 @@ But will ignore strings like:
558558
For checking the raw source code, use `seeInSource()`.
559559

560560
* `param string` $text
561-
* `param string` $selector optional
561+
* `param array|string` $selector optional
562562

563563

564564
#### dontSeeCheckboxIsChecked
@@ -1323,7 +1323,7 @@ But will *not* be true for strings like:
13231323
For checking the raw source code, use `seeInSource()`.
13241324

13251325
* `param string` $text
1326-
* `param string` $selector optional
1326+
* `param array|string` $selector optional
13271327

13281328

13291329
#### seeCheckboxIsChecked

‎docs/modules/Db.md

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -343,10 +343,6 @@ $I->haveInDatabase('users', array('name' => 'miles', 'email' => 'miles@davis.com
343343
* `return integer` $id
344344

345345

346-
#### isPopulated
347-
__not documented__
348-
349-
350346
#### performInDatabase
351347

352348
Can be used with a callback if you don't want to change the current database in your test.

‎docs/modules/Laravel5.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -513,7 +513,7 @@ But will ignore strings like:
513513
For checking the raw source code, use `seeInSource()`.
514514

515515
* `param string` $text
516-
* `param string` $selector optional
516+
* `param array|string` $selector optional
517517

518518

519519
#### dontSeeAuthentication
@@ -1274,7 +1274,7 @@ But will *not* be true for strings like:
12741274
For checking the raw source code, use `seeInSource()`.
12751275

12761276
* `param string` $text
1277-
* `param string` $selector optional
1277+
* `param array|string` $selector optional
12781278

12791279

12801280
#### seeAuthentication

‎docs/modules/Lumen.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -359,7 +359,7 @@ But will ignore strings like:
359359
For checking the raw source code, use `seeInSource()`.
360360

361361
* `param string` $text
362-
* `param string` $selector optional
362+
* `param array|string` $selector optional
363363

364364

365365
#### dontSeeAuthentication
@@ -1047,7 +1047,7 @@ But will *not* be true for strings like:
10471047
For checking the raw source code, use `seeInSource()`.
10481048

10491049
* `param string` $text
1050-
* `param string` $selector optional
1050+
* `param array|string` $selector optional
10511051

10521052

10531053
#### seeAuthentication

‎docs/modules/Phalcon.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -390,7 +390,7 @@ But will ignore strings like:
390390
For checking the raw source code, use `seeInSource()`.
391391

392392
* `param string` $text
393-
* `param string` $selector optional
393+
* `param array|string` $selector optional
394394

395395

396396
#### dontSeeCheckboxIsChecked
@@ -945,7 +945,7 @@ But will *not* be true for strings like:
945945
For checking the raw source code, use `seeInSource()`.
946946

947947
* `param string` $text
948-
* `param string` $selector optional
948+
* `param array|string` $selector optional
949949

950950

951951
#### seeCheckboxIsChecked

‎docs/modules/PhpBrowser.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -382,7 +382,7 @@ But will ignore strings like:
382382
For checking the raw source code, use `seeInSource()`.
383383

384384
* `param string` $text
385-
* `param string` $selector optional
385+
* `param array|string` $selector optional
386386

387387

388388
#### dontSeeCheckboxIsChecked
@@ -858,7 +858,7 @@ But will *not* be true for strings like:
858858
For checking the raw source code, use `seeInSource()`.
859859

860860
* `param string` $text
861-
* `param string` $selector optional
861+
* `param array|string` $selector optional
862862

863863

864864
#### seeCheckboxIsChecked

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