Update changelog and module docs

Naktibalda · Naktibalda · commit e76da31becab · 2021-08-06T20:54:08.000+03:00
diff --git a/changelog.markdown b/changelog.markdown
@@ -8,6 +8,13 @@ title: Codeception Changelog
 # Changelog
 
 
+#### 4.1.22
+
+* Security fix: Disable deserialization of RunProcess class ([#6241](https://github.com/Codeception/Codeception/issues/6241))
+* Reduce memory consumption of very large tests ([#6230](https://github.com/Codeception/Codeception/issues/6230)) by **[esnelubov](https://github.com/esnelubov)**
+* Support guzzlehttp/psr7 v2 by **[W0rma](https://github.com/W0rma)**
+* Fix W3C warning in reports generated by Recorder extension ([#6224](https://github.com/Codeception/Codeception/issues/6224)) by RickR2H
+
 #### 4.1.21
 
 * Fix `dry-run` compatibility with symfony/console 5.3
diff --git a/docs/modules/Symfony.md b/docs/modules/Symfony.md
@@ -302,6 +302,139 @@ $I->amOnRoute('posts.show', ['id' => 34]);
  * `param array` $params
 
 
+#### assertEmailAddressContains
+ 
+Verify that an email contains addresses with a [header](https://datatracker.ietf.org/doc/html/rfc4021)
+`$headerName` and its expected value `$expectedValue`.
+If the Email object is not specified, the last email sent is used instead.
+
+{% highlight php %}
+
+<?php
+$I->assertEmailAddressContains('To', 'jane_doe@example.com');
+
+{% endhighlight %}
+
+
+#### assertEmailAttachmentCount
+ 
+Verify that an email has sent the specified number `$count` of attachments.
+If the Email object is not specified, the last email sent is used instead.
+
+{% highlight php %}
+
+<?php
+$I->assertEmailAttachmentCount(1);
+
+{% endhighlight %}
+
+
+#### assertEmailHasHeader
+ 
+Verify that an email has a [header](https://datatracker.ietf.org/doc/html/rfc4021) `$headerName`.
+If the Email object is not specified, the last email sent is used instead.
+
+{% highlight php %}
+
+<?php
+$I->assertEmailHasHeader('Bcc');
+
+{% endhighlight %}
+
+
+#### assertEmailHeaderNotSame
+ 
+Verify that the [header](https://datatracker.ietf.org/doc/html/rfc4021)
+`$headerName` of an email is not the expected one `$expectedValue`.
+If the Email object is not specified, the last email sent is used instead.
+
+{% highlight php %}
+
+<?php
+$I->assertEmailHeaderNotSame('To', 'john_doe@gmail.com');
+
+{% endhighlight %}
+
+
+#### assertEmailHeaderSame
+ 
+Verify that the [header](https://datatracker.ietf.org/doc/html/rfc4021)
+`$headerName` of an email is the same as expected `$expectedValue`.
+If the Email object is not specified, the last email sent is used instead.
+
+{% highlight php %}
+
+<?php
+$I->assertEmailHeaderSame('To', 'jane_doe@gmail.com');
+
+{% endhighlight %}
+
+
+#### assertEmailHtmlBodyContains
+ 
+Verify that the HTML body of an email contains `$text`.
+If the Email object is not specified, the last email sent is used instead.
+
+{% highlight php %}
+
+<?php
+$I->assertEmailHtmlBodyContains('Successful registration');
+
+{% endhighlight %}
+
+
+#### assertEmailHtmlBodyNotContains
+ 
+Verify that the HTML body of an email does not contain a text `$text`.
+If the Email object is not specified, the last email sent is used instead.
+
+{% highlight php %}
+
+<?php
+$I->assertEmailHtmlBodyNotContains('userpassword');
+
+{% endhighlight %}
+
+
+#### assertEmailNotHasHeader
+ 
+Verify that an email does not have a [header](https://datatracker.ietf.org/doc/html/rfc4021) `$headerName`.
+If the Email object is not specified, the last email sent is used instead.
+
+{% highlight php %}
+
+<?php
+$I->assertEmailNotHasHeader('Bcc');
+
+{% endhighlight %}
+
+
+#### assertEmailTextBodyContains
+ 
+Verify the text body of an email contains a `$text`.
+If the Email object is not specified, the last email sent is used instead.
+
+{% highlight php %}
+
+<?php
+$I->assertEmailTextBodyContains('Example text body');
+
+{% endhighlight %}
+
+
+#### assertEmailTextBodyNotContains
+ 
+Verify that the text body of an email does not contain a `$text`.
+If the Email object is not specified, the last email sent is used instead.
+
+{% highlight php %}
+
+<?php
+$I->assertEmailTextBodyNotContains('My secret text body');
+
+{% endhighlight %}
+
+
 #### attachFile
  
 Attaches a file relative to the Codeception `_data` directory to the given file upload field.
@@ -802,6 +935,14 @@ $I->followRedirect();
 
 
 
+#### goToLogoutPath
+ 
+Go to the configured logout url (by default: `/logout`).
+This method includes redirection to the destination page configured after logout.
+
+See the Symfony documentation on ['Logging Out'](https://symfony.com/doc/current/security.html#logging-out).
+
+
 #### grabAttributeFrom
  
 Grabs the value of the given attribute value from the given element.
@@ -1073,7 +1214,7 @@ Invalidate previously cached routes.
 
 #### logout
  
-Invalidate the current session.
+Alias method for [`logoutProgrammatically()`](https://codeception.com/docs/modules/Symfony#logoutProgrammatically)
 
 {% highlight php %}
 
@@ -1083,6 +1224,19 @@ $I->logout();
 {% endhighlight %}
 
 
+#### logoutProgrammatically
+ 
+Invalidates the current user's session and expires the session cookies.
+This method does not include any redirects after logging out.
+
+{% highlight php %}
+
+<?php
+$I->logoutProgrammatically();
+
+{% endhighlight %}
+
+
 #### makeHtmlSnapshot
  
 Use this method within an [interactive pause](https://codeception.com/docs/02-GettingStarted#Interactive-Pause) to save the HTML source code of the current page.
@@ -1797,6 +1951,22 @@ $I->seeRenderedTemplate('layout.html.twig');
  * `param string` $template
 
 
+#### seeRequestTimeIsLessThan
+ 
+Asserts that the time a request lasted is less than expected.
+
+If the page performed a HTTP redirect, only the time of the last request will be taken into account.
+You can modify this behavior using [stopFollowingRedirects()](https://codeception.com/docs/modules/Symfony#stopFollowingRedirects) first.
+
+Also, note that using code coverage can significantly increase the time it takes to resolve a request,
+which could lead to unreliable results when used together.
+
+It is recommended to set [`rebootable_client`](https://codeception.com/docs/modules/Symfony#Config) to `true` (=default),
+cause otherwise this assertion gives false results if you access multiple pages in a row, or if your app performs a redirect.
+
+ * `param int|float` $expectedMilliseconds The expected time in milliseconds
+
+
 #### seeResponseCodeIs
  
 Checks that response code is equal to value provided.
