Skip to content

Commit 430ea3f

Browse files
committed
Updated module docs and changelog
1 parent a031f59 commit 430ea3f

22 files changed

+1799
-672
lines changed

_includes/extensions.md

Lines changed: 8 additions & 8 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/4.1/ext/DotReporter.php)
5+
[See Source](https://github.com/Codeception/Codeception/blob/4.2/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.
@@ -38,7 +38,7 @@ Use this extension as an example for building custom reporters.
3838

3939
## Logger
4040

41-
[See Source](https://github.com/Codeception/Codeception/blob/4.1/ext/Logger.php)
41+
[See Source](https://github.com/Codeception/Codeception/blob/4.2/ext/Logger.php)
4242

4343
Log suites/tests/steps using Monolog library.
4444
Monolog should be installed additionally by Composer.
@@ -66,9 +66,9 @@ extensions:
6666

6767
## Recorder
6868

69-
[See Source](https://github.com/Codeception/Codeception/blob/4.1/ext/Recorder.php)
69+
[See Source](https://github.com/Codeception/Codeception/blob/4.2/ext/Recorder.php)
7070

71-
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))
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))
7272
Activated only for suites with WebDriver module enabled.
7373

7474
The screenshots are saved to `tests/_output/record_*` directories, open `index.html` to see them as a slideshow.
@@ -125,7 +125,7 @@ public function testLogin(AcceptanceTester $I)
125125

126126
## RunBefore
127127

128-
[See Source](https://github.com/Codeception/Codeception/blob/4.1/ext/RunBefore.php)
128+
[See Source](https://github.com/Codeception/Codeception/blob/4.2/ext/RunBefore.php)
129129

130130
Extension for execution of some processes before running tests.
131131

@@ -156,7 +156,7 @@ HINT: you can use different configurations per environment.
156156

157157
## RunFailed
158158

159-
[See Source](https://github.com/Codeception/Codeception/blob/4.1/ext/RunFailed.php)
159+
[See Source](https://github.com/Codeception/Codeception/blob/4.2/ext/RunFailed.php)
160160

161161
Saves failed tests into tests/_output/failed in order to rerun failed tests.
162162

@@ -185,7 +185,7 @@ On each execution failed tests are logged and saved into `tests/_output/failed`
185185

186186
## RunProcess
187187

188-
[See Source](https://github.com/Codeception/Codeception/blob/4.1/ext/RunProcess.php)
188+
[See Source](https://github.com/Codeception/Codeception/blob/4.2/ext/RunProcess.php)
189189

190190
Extension to start and stop processes per suite.
191191
Can be used to start/stop selenium server, chromedriver, mailcatcher, etc.
@@ -232,7 +232,7 @@ HINT: you can use different configurations per environment.
232232

233233
## SimpleReporter
234234

235-
[See Source](https://github.com/Codeception/Codeception/blob/4.1/ext/SimpleReporter.php)
235+
[See Source](https://github.com/Codeception/Codeception/blob/4.2/ext/SimpleReporter.php)
236236

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

changelog.markdown

Lines changed: 1401 additions & 276 deletions
Large diffs are not rendered by default.

docs/modules/Apc.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ Warning. Using PHAR file and composer in the same project can cause unexpected e
3232

3333

3434

35-
This module interacts with the [Alternative PHP Cache (APC)](https://php.net/manual/en/intro.apcu.php)
35+
This module interacts with the [Alternative PHP Cache (APC)](http://php.net/manual/en/intro.apcu.php)
3636
using either _APCu_ or _APC_ extension.
3737

3838
Performs a cleanup by flushing all values after each test run.

docs/modules/Db.md

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ Warning. Using PHAR file and composer in the same project can cause unexpected e
3535
Access a database.
3636

3737
The most important function of this module is to clean a database before each test.
38-
This module also provides actions to perform checks in a database, e.g. [seeInDatabase()](https://codeception.com/docs/modules/Db#seeInDatabase)
38+
This module also provides actions to perform checks in a database, e.g. [seeInDatabase()](http://codeception.com/docs/modules/Db#seeInDatabase)
3939

4040
In order to have your database populated with data you need a raw SQL dump.
4141
Simply put the dump in the `tests/_data` directory (by default) and specify the path in the config.
@@ -67,14 +67,14 @@ if you run into problems loading dumps and cleaning databases.
6767
* cleanup: false - whether the dump should be reloaded before each test
6868
* reconnect: false - whether the module should reconnect to the database before each test
6969
* waitlock: 0 - wait lock (in seconds) that the database session should use for DDL statements
70-
* ssl_key - path to the SSL key (MySQL specific, @see https://php.net/manual/de/ref.pdo-mysql.php#pdo.constants.mysql-attr-key)
71-
* ssl_cert - path to the SSL certificate (MySQL specific, @see https://php.net/manual/de/ref.pdo-mysql.php#pdo.constants.mysql-attr-ssl-cert)
72-
* ssl_ca - path to the SSL certificate authority (MySQL specific, @see https://php.net/manual/de/ref.pdo-mysql.php#pdo.constants.mysql-attr-ssl-ca)
73-
* ssl_verify_server_cert - disables certificate CN verification (MySQL specific, @see https://php.net/manual/de/ref.pdo-mysql.php)
74-
* ssl_cipher - list of one or more permissible ciphers to use for SSL encryption (MySQL specific, @see https://php.net/manual/de/ref.pdo-mysql.php#pdo.constants.mysql-attr-cipher)
70+
* ssl_key - path to the SSL key (MySQL specific, @see http://php.net/manual/de/ref.pdo-mysql.php#pdo.constants.mysql-attr-key)
71+
* ssl_cert - path to the SSL certificate (MySQL specific, @see http://php.net/manual/de/ref.pdo-mysql.php#pdo.constants.mysql-attr-ssl-cert)
72+
* ssl_ca - path to the SSL certificate authority (MySQL specific, @see http://php.net/manual/de/ref.pdo-mysql.php#pdo.constants.mysql-attr-ssl-ca)
73+
* ssl_verify_server_cert - disables certificate CN verification (MySQL specific, @see http://php.net/manual/de/ref.pdo-mysql.php)
74+
* ssl_cipher - list of one or more permissible ciphers to use for SSL encryption (MySQL specific, @see http://php.net/manual/de/ref.pdo-mysql.php#pdo.constants.mysql-attr-cipher)
7575
* databases - include more database configs and switch between them in tests.
7676
* initial_queries - list of queries to be executed right after connection to the database has been initiated, i.e. creating the database if it does not exist or preparing the database collation
77-
77+
* skip_cleanup_if_failed - Do not perform the cleanup if the tests failed. If this is used, manual cleanup might be required when re-running
7878
### Example
7979

8080
modules:
@@ -88,6 +88,7 @@ if you run into problems loading dumps and cleaning databases.
8888
cleanup: true
8989
reconnect: true
9090
waitlock: 10
91+
skip_cleanup_if_failed: true
9192
ssl_key: '/path/to/client-key.pem'
9293
ssl_cert: '/path/to/client-cert.pem'
9394
ssl_ca: '/path/to/ca-cert.pem'
@@ -390,7 +391,8 @@ Returns the number of rows in a database
390391

391392
#### haveInDatabase
392393

393-
Inserts an SQL record into a database. This record will be erased after the test.
394+
Inserts an SQL record into a database. This record will be erased after the test,
395+
unless you've configured "skip_cleanup_if_failed", and the test fails.
394396

395397
{% highlight php %}
396398

docs/modules/Doctrine2.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ Warning. Using PHAR file and composer in the same project can cause unexpected e
3232

3333

3434

35-
Access the database using [Doctrine2 ORM](https://docs.doctrine-project.org/projects/doctrine-orm/en/latest/).
35+
Access the database using [Doctrine2 ORM](http://docs.doctrine-project.org/projects/doctrine-orm/en/latest/).
3636

3737
When used with Symfony or Zend Framework 2, Doctrine's Entity Manager is automatically retrieved from Service Locator.
3838
Set up your `functional.suite.yml` like this:

docs/modules/FTP.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -50,9 +50,9 @@ Supported and tested FTP types are:
5050
* SFTP
5151

5252
Connection uses php build in FTP client for FTP,
53-
connection to SFTP uses [phpseclib](https://phpseclib.sourceforge.net/) pulled in using composer.
53+
connection to SFTP uses [phpseclib](http://phpseclib.sourceforge.net/) pulled in using composer.
5454

55-
For SFTP, add [phpseclib](https://phpseclib.sourceforge.net/) to require list.
55+
For SFTP, add [phpseclib](http://phpseclib.sourceforge.net/) to require list.
5656
{% highlight yaml %}
5757
"require": {
5858
"phpseclib/phpseclib": "^2.0.14"

docs/modules/Memcache.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ Warning. Using PHAR file and composer in the same project can cause unexpected e
3232

3333

3434

35-
Connects to [memcached](https://www.memcached.org/) using either _Memcache_ or _Memcached_ extension.
35+
Connects to [memcached](http://www.memcached.org/) using either _Memcache_ or _Memcached_ extension.
3636

3737
Performs a cleanup by flushing all values after each test run.
3838

docs/modules/Phalcon.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ Warning. Using PHAR file and composer in the same project can cause unexpected e
3232

3333

3434

35-
This module provides integration with [Phalcon framework](https://www.phalcon.io/) (3.x).
35+
This module provides integration with [Phalcon framework](http://www.phalcon.io/) (3.x).
3636
Please try it and leave your feedback.
3737

3838
### Demo Project

docs/modules/Phalcon4.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ Warning. Using PHAR file and composer in the same project can cause unexpected e
3232

3333

3434

35-
This module provides integration with [Phalcon framework](https://www.phalcon.io/) (4.x).
35+
This module provides integration with [Phalcon framework](http://www.phalcon.io/) (4.x).
3636
Please try it and leave your feedback.
3737

3838
### Status

docs/modules/PhpBrowser.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ Warning. Using PHAR file and composer in the same project can cause unexpected e
3232

3333

3434

35-
Uses [Guzzle](https://guzzlephp.org/) to interact with your application over CURL.
35+
Uses [Guzzle](http://guzzlephp.org/) to interact with your application over CURL.
3636
Module works over CURL and requires **PHP CURL extension** to be enabled.
3737

3838
Use to perform web acceptance tests with non-javascript browser.
@@ -50,13 +50,13 @@ If test fails stores last shown page in 'output' dir.
5050

5151
* url *required* - start url of your app
5252
* headers - default headers are set before each test.
53-
* handler (default: curl) - Guzzle handler to use. By default curl is used, also possible to pass `stream`, or any valid class name as [Handler](https://docs.guzzlephp.org/en/latest/handlers-and-middleware.html#handlers).
53+
* handler (default: curl) - Guzzle handler to use. By default curl is used, also possible to pass `stream`, or any valid class name as [Handler](http://docs.guzzlephp.org/en/latest/handlers-and-middleware.html#handlers).
5454
* middleware - Guzzle middlewares to add. An array of valid callables is required.
5555
* curl - curl options
5656
* cookies - ...
5757
* auth - ...
5858
* verify - ...
59-
* .. those and other [Guzzle Request options](https://docs.guzzlephp.org/en/latest/request-options.html)
59+
* .. those and other [Guzzle Request options](http://docs.guzzlephp.org/en/latest/request-options.html)
6060

6161

6262
#### Example (`acceptance.suite.yml`)
@@ -91,7 +91,7 @@ Those properties and methods are expected to be used in Helper classes:
9191

9292
Properties:
9393

94-
* `guzzle` - contains [Guzzle](https://guzzlephp.org/) client instance: `\GuzzleHttp\Client`
94+
* `guzzle` - contains [Guzzle](http://guzzlephp.org/) client instance: `\GuzzleHttp\Client`
9595
* `client` - Symfony BrowserKit instance.
9696

9797

@@ -639,7 +639,7 @@ $I->dontSeeResponseCodeIs(\Codeception\Util\HttpCode::OK);
639639
#### executeInGuzzle
640640

641641
Low-level API method.
642-
If Codeception commands are not enough, use [Guzzle HTTP Client](https://guzzlephp.org/) methods directly
642+
If Codeception commands are not enough, use [Guzzle HTTP Client](http://guzzlephp.org/) methods directly
643643

644644
Example:
645645

0 commit comments

Comments
 (0)