Updated changelog and module documentation

Naktibalda · Naktibalda · commit 66987d3e9c98 · 2020-10-11T22:16:27.000+03:00
diff --git a/.gitignore b/.gitignore
@@ -3,6 +3,7 @@ _site/
 .jekyll-metadata
 /build
 /composer.lock
+/docs/modules/AbstractAsserts.md
 /package/composer.lock
 /package/vendor
 /vendor
diff --git a/_includes/extensions.md b/_includes/extensions.md
@@ -47,7 +47,8 @@ Monolog should be installed additionally by Composer.
 composer require monolog/monolog
 ```
 
-Steps are logged into `tests/_output/codeception.log`
+Codeception's core/internal stuff is logged into `tests/_output/codeception.log`.
+Test suites' steps are logged into `tests/_output/<test_full_name>-<rotation_date>.log`.
 
 To enable this module add to your `codeception.yml`:
 
@@ -157,7 +158,7 @@ HINT: you can use different configurations per environment.
 
 [See Source](https://github.com/Codeception/Codeception/blob/4.1/ext/RunFailed.php)
 
-Saves failed tests into tests/log/failed in order to rerun failed tests.
+Saves failed tests into tests/_output/failed in order to rerun failed tests.
 
 To rerun failed tests just run the `failed` group:
 
diff --git a/changelog.markdown b/changelog.markdown
@@ -8,6 +8,17 @@ title: Codeception Changelog
 # Changelog
 
 
+#### 4.1.8
+
+* Support Covertura code coverage format [#5994](https://github.com/Codeception/Codeception/issues/5994) by **[zachkknowbe4](https://github.com/zachkknowbe4)**
+* Compatibility with vlucas/phpdotenv v5 [#5975](https://github.com/Codeception/Codeception/issues/5975) by **[johanzandstra](https://github.com/johanzandstra)**
+* Support absolute output dir path on Windows [#5966](https://github.com/Codeception/Codeception/issues/5966) by **[Naktibalda](https://github.com/Naktibalda)**
+* Fix --no-redirect option for run command [#5967](https://github.com/Codeception/Codeception/issues/5967) by **[convenient](https://github.com/convenient)**
+* Code coverage: Don't make request to c3.php if remote=false [#5991](https://github.com/Codeception/Codeception/issues/5991) by **[dereuromark](https://github.com/dereuromark)**
+* Gherkin: Fail on ambiguous step definition [#5866](https://github.com/Codeception/Codeception/issues/5866) by **[matthiasnoback](https://github.com/matthiasnoback)**
+* Removed complicated merge logic for environment configurations [#5948](https://github.com/Codeception/Codeception/issues/5948) by **[Sasti](https://github.com/Sasti)**
+* Logger extension: add .log to suite log files [#5982](https://github.com/Codeception/Codeception/issues/5982) by **[varp](https://github.com/varp)**
+
 #### 4.1.7
 
 * Compatibility with PhpCodeCoverage 9 and PHPUnit 9.3
diff --git a/docs/modules/Cli.md b/docs/modules/Cli.md
@@ -54,7 +54,7 @@ Checks that output from latest command doesn't contain text
 #### runShellCommand
  
 Executes a shell command.
-Fails If exit code is > 0. You can disable this by setting second parameter to false
+Fails if exit code is > 0. You can disable this by passing `false` as second argument
 
 {% highlight php %}
 
@@ -79,7 +79,7 @@ Checks that output from last executed command contains text
 
 #### seeResultCodeIs
  
-Checks result code
+Checks result code. To verify a result code > 0, you need to pass `false` as second argument to `runShellCommand()`
 
 {% highlight php %}
 
diff --git a/docs/modules/Laravel5.md b/docs/modules/Laravel5.md
@@ -894,6 +894,7 @@ $I->grabAttributeFrom('#tooltip', 'title');
  
 Grabs a cookie value.
 You can set additional cookie params like `domain`, `path` in array passed as last argument.
+If the cookie is set by an ajax request (XMLHttpRequest), there might be some delay caused by the browser, so try `$I->wait(0.1)`.
 
  * `param` $cookie
 
diff --git a/docs/modules/Lumen.md b/docs/modules/Lumen.md
@@ -688,6 +688,7 @@ $I->grabAttributeFrom('#tooltip', 'title');
  
 Grabs a cookie value.
 You can set additional cookie params like `domain`, `path` in array passed as last argument.
+If the cookie is set by an ajax request (XMLHttpRequest), there might be some delay caused by the browser, so try `$I->wait(0.1)`.
 
  * `param` $cookie
 
diff --git a/docs/modules/Mezzio.md b/docs/modules/Mezzio.md
@@ -607,6 +607,7 @@ $I->grabAttributeFrom('#tooltip', 'title');
  
 Grabs a cookie value.
 You can set additional cookie params like `domain`, `path` in array passed as last argument.
+If the cookie is set by an ajax request (XMLHttpRequest), there might be some delay caused by the browser, so try `$I->wait(0.1)`.
 
  * `param` $cookie
 
diff --git a/docs/modules/Phalcon.md b/docs/modules/Phalcon.md
@@ -718,6 +718,7 @@ $I->grabAttributeFrom('#tooltip', 'title');
  
 Grabs a cookie value.
 You can set additional cookie params like `domain`, `path` in array passed as last argument.
+If the cookie is set by an ajax request (XMLHttpRequest), there might be some delay caused by the browser, so try `$I->wait(0.1)`.
 
  * `param` $cookie
 
diff --git a/docs/modules/Phalcon4.md b/docs/modules/Phalcon4.md
@@ -714,6 +714,7 @@ $I->grabAttributeFrom('#tooltip', 'title');
  
 Grabs a cookie value.
 You can set additional cookie params like `domain`, `path` in array passed as last argument.
+If the cookie is set by an ajax request (XMLHttpRequest), there might be some delay caused by the browser, so try `$I->wait(0.1)`.
 
  * `param` $cookie
 
diff --git a/docs/modules/PhpBrowser.md b/docs/modules/PhpBrowser.md
@@ -708,6 +708,7 @@ $I->grabAttributeFrom('#tooltip', 'title');
  
 Grabs a cookie value.
 You can set additional cookie params like `domain`, `path` in array passed as last argument.
+If the cookie is set by an ajax request (XMLHttpRequest), there might be some delay caused by the browser, so try `$I->wait(0.1)`.
 
  * `param` $cookie
 
diff --git a/docs/modules/REST.md b/docs/modules/REST.md
@@ -163,8 +163,7 @@ $I->amNTLMAuthenticated('jon_snow', 'targaryen');
 
 #### deleteHeader
  
-Deletes the header with the passed name.  Subsequent requests
-will not have the deleted header in its request.
+Deletes a HTTP header, so that subsequent requests will not send it anymore.
 
 Example:
 {% highlight php %}
@@ -396,7 +395,7 @@ Element is matched by either CSS or XPath
 
 #### haveHttpHeader
  
-Sets HTTP header valid for all next requests. Use `deleteHeader` to unset it
+Sets a HTTP header to be used for all subsequent requests. Use [`deleteHeader`](#deleteHeader) to unset it.
 
 {% highlight php %}
 
diff --git a/docs/modules/Symfony.md b/docs/modules/Symfony.md
@@ -707,6 +707,7 @@ $I->grabAttributeFrom('#tooltip', 'title');
  
 Grabs a cookie value.
 You can set additional cookie params like `domain`, `path` in array passed as last argument.
+If the cookie is set by an ajax request (XMLHttpRequest), there might be some delay caused by the browser, so try `$I->wait(0.1)`.
 
  * `param` $cookie
 
diff --git a/docs/modules/WebDriver.md b/docs/modules/WebDriver.md
@@ -1157,6 +1157,7 @@ $I->grabAttributeFrom('#tooltip', 'title');
  
 Grabs a cookie value.
 You can set additional cookie params like `domain`, `path` in array passed as last argument.
+If the cookie is set by an ajax request (XMLHttpRequest), there might be some delay caused by the browser, so try `$I->wait(0.1)`.
 
  * `param` $cookie
 
@@ -1348,19 +1349,18 @@ $I->moveMouseOver(['css' => '.checkout'], 20, 50);
 
 #### openNewTab
  
-Opens a new browser tab (wherever it is possible) and switches to it.
+Opens a new browser tab and switches to it.
 
 {% highlight php %}
 
 <?php
 $I->openNewTab();
 
 {% endhighlight %}
-Tab is opened by using `window.open` javascript in a browser.
-Please note, that adblock can restrict creating such tabs.
-
-Can't be used with PhantomJS
-
+The tab is opened with JavaScript's `window.open()`, which means:
+* Some adblockers might restrict it.
+* The sessionStorage is copied to the new tab (contrary to a tab that was manually opened by the user)
+* It is not possible in PhantomJS.
 
 
 #### performOn
diff --git a/docs/modules/Yii2.md b/docs/modules/Yii2.md
@@ -848,6 +848,7 @@ $mailer = $I->grabComponent('mailer');
  
 Grabs a cookie value.
 You can set additional cookie params like `domain`, `path` in array passed as last argument.
+If the cookie is set by an ajax request (XMLHttpRequest), there might be some delay caused by the browser, so try `$I->wait(0.1)`.
 
  * `param` $cookie
 
diff --git a/docs/modules/ZF2.md b/docs/modules/ZF2.md
@@ -654,6 +654,7 @@ $I->grabAttributeFrom('#tooltip', 'title');
  
 Grabs a cookie value.
 You can set additional cookie params like `domain`, `path` in array passed as last argument.
+If the cookie is set by an ajax request (XMLHttpRequest), there might be some delay caused by the browser, so try `$I->wait(0.1)`.
 
  * `param` $cookie
 
diff --git a/docs/reference/Commands.md b/docs/reference/Commands.md
@@ -312,6 +312,7 @@ Options:
  --coverage-xml        Generate CodeCoverage XML report in file (default: "coverage.xml")
  --coverage-text       Generate CodeCoverage text report in file (default: "coverage.txt")
  --coverage-phpunit    Generate CodeCoverage PHPUnit report in file (default: "coverage-phpunit")
+ --coverage-cobertura  Generate CodeCoverage Cobertura report in file (default: "coverage-cobertura")
  --no-exit             Don't finish with exit code
  --group (-g)          Groups of tests to be executed (multiple values allowed)
  --skip (-s)           Skip selected suites (multiple values allowed)
