Skip to content

Commit 83c00a9

Browse files
committed
auto updated documentation
1 parent ef21029 commit 83c00a9

File tree

5 files changed

+217
-177
lines changed

5 files changed

+217
-177
lines changed

changelog.markdown

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,23 @@ title: Codeception Changelog
77

88
# Changelog
99

10+
#### 3.0.2
11+
* **[weshooper](https://github.com/weshooper)** reduced size of exported package.
12+
* --no-redirect option disables the redirect to a Composer-installed version, by **[DanielRuf](https://github.com/DanielRuf)**
13+
* PhpUnit 8.2 support by **[Naktibalda](https://github.com/Naktibalda)**
14+
* Retry: double wait interval after each execution by **[Naktibalda](https://github.com/Naktibalda)**
15+
* **[FTP]** Bugfix: Make sure _directory will return its directory by **[bbatsche](https://github.com/bbatsche)**
16+
* **[Doctrine2]** Fixed recursive building of association queries by **[alexkunin](https://github.com/alexkunin)**
17+
* **[PhpBrowser]** Pass file type option to Guzzle if specified [#5548](https://github.com/Codeception/Codeception/issues/5548) by **[Naktibalda](https://github.com/Naktibalda)**
18+
* [PhpBrowser][Frameworks] InnerBrowser: selectOption can match by text when option has no value attribute [#5547](https://github.com/Codeception/Codeception/issues/5547) by **[Naktibalda](https://github.com/Naktibalda)**
19+
* **[REST]** Updated url construction logic, so it does not produce double slashes, by **[nicholascus](https://github.com/nicholascus)**
20+
* **[ZF2]** Add check for console class before calling it by **[carnage](https://github.com/carnage)**
21+
* **[Gherkin]** Fixed Gherkin setup for single run from group file by **[bnpatel1990](https://github.com/bnpatel1990)**
22+
* **[CodeCoverage]** Ability to use a custom cookie domain for code coverage by **[maksimovic](https://github.com/maksimovic)**
23+
* **[Docs]** **[EspadaV8](https://github.com/EspadaV8)** fixed env substitution in DB module example
24+
* **[Docs]** **[splinter89](https://github.com/splinter89)** mentioned phpdbg and pcov for code coverage
25+
* **[el7cosmos](https://github.com/el7cosmos)**, **[KartaviK](https://github.com/KartaviK)** and **[davertMik](https://github.com/davertMik)** fixed various deprecation messages
26+
1027
#### 3.0.1
1128

1229
* Fixed code duplication when building actors. Fixes [#5506](https://github.com/Codeception/Codeception/issues/5506) [#5500](https://github.com/Codeception/Codeception/issues/5500)

docs/06-ModulesAndHelpers.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -509,7 +509,7 @@ module:
509509
- Db:
510510
dsn: "mysql:host=%DB_HOST%;dbname=%DB_DATABASE%"
511511
user: "%DB_USERNAME%"
512-
password: "DB_PASSWORD"
512+
password: "%DB_PASSWORD%"
513513

514514
{% endhighlight %}
515515

@@ -586,5 +586,6 @@ Helpers also can be used to extend the functionality of the original modules.
586586

587587

588588

589+
589590
* **Next Chapter: [ReusingTestCode >](/docs/06-ReusingTestCode)**
590591
* **Previous Chapter: [< UnitTests](/docs/05-UnitTests)**

docs/11-Codecoverage.md

Lines changed: 22 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,13 @@ Just for this case the [CodeCoverage](http://en.wikipedia.org/wiki/Code_coverage
1010
you will receive statistics of all classes, methods, and lines triggered by these tests.
1111
The ratio between all lines in script and all touched lines is a main coverage criterion. In the ideal world you should get 100% code coverage, but in reality 80% is really enough. Because even 100% code coverage rate doesn't save you from fatal errors and crashes.
1212

13-
*To collect coverage information `xdebug` is required**.
13+
The required information is provided by [SebastianBergmann\CodeCoverage](https://github.com/sebastianbergmann/php-code-coverage), and you can use any of the supported drivers.
14+
15+
| Driver | Description |
16+
| --- | --- |
17+
| [Xdebug](https://github.com/xdebug/xdebug) | Great for debugging, but too slow when collecting coverage |
18+
| [phpdbg](https://www.php.net/manual/en/book.phpdbg.php) | Faster than `Xdebug` but inaccurate |
19+
| [pcov](https://github.com/krakjoe/pcov) | Fast and accurate, but no debug functionality &mdash; perfect for CI |
1420

1521
![Code Coverage Example](http://codeception.com/images/coverage.png)
1622

@@ -132,6 +138,21 @@ In case you execute your application locally there is nothing to be changed in c
132138
All codecoverage reports will be collected as usual and merged afterwards.
133139
Think of it: Codeception runs remote coverage in the same way as local.
134140

141+
#### Custom cookie domain
142+
143+
It's possible to override the cookie domain set by Codeception during code coverage. Typical case for that is when you
144+
have several subdomains that your acceptance tests are visiting, e.g. `mysite.com` and `admin.mysite.com`. By default,
145+
Codeception will run code coverage only for the domain set in the url of the `WebDriver/url` (or `c3_url` if defined),
146+
thus leaving out other subdomains from code coverage. To avoid that and to include all relevant subdomains in code
147+
covereage, it's advised to set `.mysite.com` as the cookie domain option:
148+
149+
{% highlight yaml %}
150+
151+
coverage:
152+
cookie_domain: ".mysite.com"
153+
154+
{% endhighlight %}
155+
135156
### Remote Server
136157

137158
But if you run tests on different server (or your webserver doesn't use code from current directory) a single option `remote` should be added to config.

0 commit comments

Comments
 (0)