Skip to content

Commit 90b35d6

Browse files
committed
auto updated documentation
1 parent 12fcbc2 commit 90b35d6

40 files changed

+333
-2592
lines changed

changelog.markdown

Lines changed: 33 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,36 @@ title: Codeception Changelog
77

88
# Changelog
99

10+
#### 2.0.10
11+
12+
* **Console Improvement**: better formatting of test progress. Improved displaying of debug messages and PHP Fatal Errors.
13+
Codeception now uses features of interactive shell to print testing progress.
14+
In case of non-interactive shell (when running from CI like Jenkins) this feature is gracefully degraded to standard mode.
15+
You can turn off interactive printing manually by providing `--no-interaction` option or simply `-n`
16+
* `ExceptionWrapper` messages unpacked into normal and verbose exceptions.
17+
* HTML reports now allow to filter tests by status. Thanks to <strong><a href="https://github.com/raistlin">@raistlin</a></strong>
18+
* Added '_failed' hook for Cest tests. Fixes <a href="https://github.com/Codeception/Codeception/issues/1660">#1660</a> *2015-02-02*
19+
* <strong>[REST]</strong> fixed setting Host header. Issue <a href="https://github.com/Codeception/Codeception/issues/1650">#1650</a> *2015-02-02*
20+
* <strong>[Laravel4]</strong> Disconnecting from database after each test to prevent Too many connections exception <a href="https://github.com/Codeception/Codeception/issues/1665">#1665</a> by <strong><a href="https://github.com/mnabialek">@mnabialek</a></strong> *2015-02-02*
21+
* <strong>[Symfony2]</strong> Fixed kernel reuse in <a href="https://github.com/Codeception/Codeception/issues/1656">#1656</a> by <strong><a href="https://github.com/hacfi">@hacfi</a></strong> *2015-02-01*
22+
* <strong>[REST]</strong> request params are now correctly saved to `$this->params` property. Fixes <a href="https://github.com/Codeception/Codeception/issues/1682">#1682</a> by <strong><a href="https://github.com/gmhenderson">@gmhenderson</a></strong> *2015-02-01*
23+
* Interactive shell updated: deprecated Symfony helpers replaced, printed output cleaned *2015-01-28*
24+
* <strong>[PhpBrowser]</strong><strong>[Frameworks]</strong> Fixed `matchOption` to return the option value in case there is no value attribute by <strong><a href="https://github.com/synchrone">@synchrone</a></strong>. See <a href="https://github.com/Codeception/Codeception/issues/1663">#1663</a> *2015-01-26*
25+
* Fixed remote context options on CodeCoverage by <strong><a href="https://github.com/synchrone">@synchrone</a></strong>. See <a href="https://github.com/Codeception/Codeception/issues/1664">#1664</a> *2015-01-26*
26+
* <strong>[MongoDb]</strong> `seeNumElementsInCollection` method added by <strong><a href="https://github.com/sahanh">@sahanh</a></strong>
27+
* <strong>[MongoDb]</strong> Added new methods: `grabCollectionCount`, `seeElementIsArray`, `seeElementIsObject` by <strong><a href="https://github.com/antoniofrignani">@antoniofrignani</a></strong>
28+
29+
!<strong>[MongoTests]</strong>(https://cloud.githubusercontent.com/assets/802713/5755827/4dcbfd9e-9ca9-11e4-826f-fb262aa2ee8c.png)
30+
* <strong>[WebDriver]</strong> Allow `selectOption()` to select options not inside forms by <strong><a href="https://github.com/n8whnp">@n8whnp</a></strong> See <a href="https://github.com/Codeception/Codeception/issues/1638">#1638</a>
31+
* <strong>[FTP]</strong> Added support for sftp connections with an RSA SSH key by <strong><a href="https://github.com/mattvot">@mattvot</a></strong>.
32+
* <strong>[PhpBrowser]</strong><strong>[WebDriver]</strong> allows to handle domain and path for cookies *2015-01-24*
33+
* <strong>[CLI]</strong> Allow CLI module to handle nonzero response codes without failing by <strong><a href="https://github.com/DevShep">@DevShep</a></strong>
34+
* <strong>[Yii2]</strong> Fix the bug with `session_id()`. See <a href="https://github.com/Codeception/Codeception/issues/1606">#1606</a> by <strong><a href="https://github.com/TriAnMan">@TriAnMan</a></strong>
35+
* <strong>[PhpBrowser]</strong><strong>[Frameworks]</strong> Fix double slashes in certain forms submitted by `submitForm` by <strong><a href="https://github.com/Revisor">@Revisor</a></strong>. See <a href="https://github.com/Codeception/Codeception/issues/1625">#1625</a>
36+
* <strong>[Facebook]</strong> `grabFacebookTestUserId` method added by <strong><a href="https://github.com/ipalaus">@ipalaus</a></strong>
37+
* Always eval error level settings passed from config file.
38+
39+
1040
#### 2.0.9
1141

1242
* **Fixed Symfony 2.6 compatibility in Yaml::parse by <strong><a href="https://github.com/antonioribeiro">@antonioribeiro</a></strong>**
@@ -39,13 +69,13 @@ codecept run unit tests/unit/Codeception/TestLoaderTest:testAddCept
3969
* <strong>[REST]</strong> sendXXX methods now encode objects implementing JsonSerializable interfaces. *2014-12-19*
4070
* <strong>[REST]</strong> added methods to validate JSON structure *2014-12-19*
4171

42-
[seeResponseJsonMatchesJsonPath](http://codeception.com/docs/modules/REST#seeResponseJsonMatchesJsonPath) validates response JSON against [JsonPath](http://goessner.net/articles/JsonPath/).
72+
<strong>[seeResponseJsonMatchesJsonPath]</strong>(http://codeception.com/docs/modules/REST#seeResponseJsonMatchesJsonPath) validates response JSON against <strong>[JsonPath]</strong>(http://goessner.net/articles/JsonPath/).
4373
Usage of JsonPath requires library `flow/jsonpath` to be installed.
4474

45-
[seeResponseJsonMatchesXpath](http://codeception.com/docs/modules/REST#seeResponseJsonMatchesXpath) validates response JSON against XPath.
75+
<strong>[seeResponseJsonMatchesXpath]</strong>(http://codeception.com/docs/modules/REST#seeResponseJsonMatchesXpath) validates response JSON against XPath.
4676
It converts JSON structure into valid XML document and executes XPath for it.
4777

48-
[grabDataFromResponseByJsonPath](http://codeception.com/docs/modules/REST#grabDataFromResponseByJsonPath) method was added as well to grab data JSONPath.
78+
<strong>[grabDataFromResponseByJsonPath]</strong>(http://codeception.com/docs/modules/REST#grabDataFromResponseByJsonPath) method was added as well to grab data JSONPath.
4979

5080
* <strong>[REST]</strong> `grabDataFromJsonResponse` deprecated in favor of `grabDataFromResponseByJsonPath` *2014-12-19*
5181
* <strong>[PhpBrowser]</strong><strong>[Frameworks]</strong> fixed `Unreachable field` error while filling [] fields in input and textarea fields. Issues <a href="https://github.com/Codeception/Codeception/issues/1585">#1585</a> <a href="https://github.com/Codeception/Codeception/issues/1602">#1602</a> *2014-12-18*

docs/03-ModulesAndHelpers.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -51,6 +51,8 @@ Codeception doesn't restrict you to only the modules from the main repository. N
5151

5252
It's a good idea to define missing actions or assertion commands in helpers.
5353

54+
Note: Helpers class names must end with "*Helper.php"
55+
5456
Let's say we are going to extend the FunctionalHelper class. By default it's linked with a FunctionalTester class and functional test suite.
5557

5658
{% highlight php %}

docs/04-AcceptanceTests.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -492,7 +492,7 @@ $I->amOnPage('/messages');
492492
$nick = $I->haveFriend('nick');
493493
$nick->does(function(AcceptanceTester $I) {
494494
$I->amOnPage('/messages/new');
495-
$I->fillFiled('body', 'Hello all!')
495+
$I->fillField('body', 'Hello all!')
496496
$I->click('Send');
497497
$I->see('Hello all!', '.message');
498498
});

docs/06-UnitTests.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -288,7 +288,7 @@ Full reference on Stub util class can be found [here](/docs/reference/Stub).
288288

289289
## Conclusion
290290

291-
PHPUnit tests are first-class citizens in test suites. Whenever you need to write and execute unit tests, you don't need to install PHPUnit, but use a Codeception to execute them. Some nice features can be added to common unit tests by integrating Codeception modules. For the most of unit and integration testing PHPUnit tests are just enough. They are fast and easy to maintain.
291+
PHPUnit tests are first-class citizens in test suites. Whenever you need to write and execute unit tests, you don't need to install PHPUnit, but use Codeception to execute them. Some nice features can be added to common unit tests by integrating Codeception modules. For the most of unit and integration testing PHPUnit tests are just enough. They are fast and easy to maintain.
292292

293293

294294

docs/modules/AMQP.md

Lines changed: 0 additions & 52 deletions
Original file line numberDiff line numberDiff line change
@@ -55,55 +55,6 @@ To use this module with Composer you need <em>"videlalvaro/php-amqplib": "*"</em
5555
@author davert
5656

5757

58-
59-
60-
61-
62-
63-
64-
65-
66-
67-
68-
69-
70-
71-
72-
73-
74-
75-
76-
77-
78-
79-
80-
81-
82-
83-
84-
85-
86-
87-
88-
89-
90-
91-
92-
93-
94-
95-
96-
97-
98-
99-
100-
101-
102-
103-
104-
105-
106-
10758
#### grabMessageFromQueue
10859

10960
Takes last message from queue.
@@ -114,8 +65,6 @@ $message = $I->grabMessageFromQueue('queue.emails');
11465
@return AMQPMessage
11566

11667

117-
118-
11968
#### pushToExchange
12069

12170
Sends message to exchange
@@ -150,7 +99,6 @@ $I->pushToQueue('queue.jobs', new AMQPMessage('create'));
15099
* `param` $message string|AMQPMessage
151100

152101

153-
154102
#### seeMessageInQueueContainsText
155103

156104
Checks if message containing text received.

docs/modules/Asserts.md

Lines changed: 0 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -12,28 +12,6 @@ Special module for using asserts in your tests.
1212

1313

1414

15-
16-
17-
18-
19-
20-
21-
22-
23-
24-
25-
26-
27-
28-
29-
30-
31-
32-
33-
34-
35-
36-
3715
#### assertContains
3816

3917
Checks that haystack contains needle
@@ -115,7 +93,6 @@ Checks that expected is less or equal than actual
11593
* `param string` $message
11694

11795

118-
11996
#### assertNotContains
12097

12198
Checks that haystack doesn't contain needle.
@@ -158,8 +135,6 @@ Checks that variable is NULL
158135
* `param string` $message
159136

160137

161-
162-
163138
#### assertTrue
164139

165140
Checks that condition is positive.
@@ -168,17 +143,10 @@ Checks that condition is positive.
168143
* `param string` $message
169144

170145

171-
172-
173146
#### fail
174147

175148
Fails the test with message.
176149

177150
* `param` $message
178151

179-
180-
181-
182-
183-
184152
<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.0/src/Codeception/Module/Asserts.php">Help us to improve documentation. Edit module reference</a></div>

docs/modules/Cli.md

Lines changed: 11 additions & 49 deletions
Original file line numberDiff line numberDiff line change
@@ -18,50 +18,6 @@ Wrapper for basic shell commands and shell output
1818
*Please review the code of non-stable modules and provide patches if you have issues.*
1919

2020

21-
22-
23-
24-
25-
26-
27-
28-
29-
30-
31-
32-
33-
34-
35-
36-
37-
38-
39-
40-
41-
42-
43-
44-
45-
46-
47-
48-
49-
50-
51-
52-
53-
54-
55-
56-
57-
58-
59-
60-
61-
62-
63-
64-
6521
#### dontSeeInShellOutput
6622

6723
Checks that output from latest command doesn't contain text
@@ -70,17 +26,23 @@ Checks that output from latest command doesn't contain text
7026

7127

7228

29+
#### runShellCommand
30+
31+
Executes a shell command.
32+
Fails If exit code is > 0. You can disable this by setting second parameter to false
7333

34+
{% highlight php %}
7435

36+
<?php
37+
$I->runShellCommand('phpunit');
7538

39+
// do not fail test when command fails
40+
$I->runShellCommand('phpunit', false);
7641

77-
78-
#### runShellCommand
79-
80-
Executes a shell command
42+
{% endhighlight %}
8143

8244
* `param` $command
83-
45+
* `param bool` $failNonZero
8446

8547

8648
#### seeInShellOutput

docs/modules/Db.md

Lines changed: 0 additions & 58 deletions
Original file line numberDiff line numberDiff line change
@@ -75,55 +75,6 @@ Check out drivers if you get problems loading dumps and cleaning databases.
7575

7676

7777

78-
79-
80-
81-
82-
83-
84-
85-
86-
87-
88-
89-
90-
91-
92-
93-
94-
95-
96-
97-
98-
99-
100-
101-
102-
103-
104-
105-
106-
107-
108-
109-
110-
111-
112-
113-
114-
115-
116-
117-
118-
119-
120-
121-
122-
123-
124-
125-
126-
12778
#### dontSeeInDatabase
12879

12980
Effect is opposite to ->seeInDatabase
@@ -153,9 +104,6 @@ Fails if such user was found.
153104
* `param array` $criteria
154105

155106

156-
157-
158-
159107
#### grabFromDatabase
160108

161109
Fetches a single column value from a database.
@@ -179,7 +127,6 @@ $mail = $I->grabFromDatabase('users', 'email', array('name' => 'Davert'));
179127

180128

181129

182-
183130
#### haveInDatabase
184131

185132
Inserts SQL record into database. This record will be erased after the test.
@@ -197,11 +144,6 @@ $I->haveInDatabase('users', array('name' => 'miles', 'email' => 'miles@davis.com
197144
* `return integer` $id
198145

199146

200-
201-
202-
203-
204-
205147
#### seeInDatabase
206148

207149
Checks if a row with given column values exists.

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