auto updated documentation

DavertMik · DavertMik · commit 980abf3c8bb2 · 2017-02-04T04:09:05.000+02:00
diff --git a/changelog.markdown b/changelog.markdown
@@ -7,16 +7,33 @@ title: Codeception Changelog
 
 # Changelog
 
+#### 2.2.9
+
+* **[Laravel5]** **Laravel 5.4 support** by **[janhenkgerritsen](https://github.com/janhenkgerritsen)**
+* **[WebDriver]** Added `performOn` to wait for element, and run actions inside it. See [complete reference](http://codeception.com/docs/modules/WebDriver#performOn). [#3986](https://github.com/Codeception/Codeception/issues/3986)
+* **[WebDriver]** Improved error messages for `wait*` methods by **[disc](https://github.com/disc)**. See [#3983](https://github.com/Codeception/Codeception/issues/3983)
+* **[REST]** Binary responses support by **[spikyjt](https://github.com/spikyjt)** [#3993](https://github.com/Codeception/Codeception/issues/3993) [#3985](https://github.com/Codeception/Codeception/issues/3985)
+  * `seeBinaryResponseEquals` assert that binary response matches a hash
+  * `seeBinaryResponseEquals` assert that binary response doesn't match a hash
+  * hide binary response on debug
+* **[Laravel5]** module fix error for applications that do not use a database. See [#3954](https://github.com/Codeception/Codeception/issues/3954) by **[janhenkgerritsen](https://github.com/janhenkgerritsen)**. Fixed [#3942](https://github.com/Codeception/Codeception/issues/3942)  
+* **[Laravel5]** database seeders to be executed inside a transaction. See [#3954](https://github.com/Codeception/Codeception/issues/3954) by **[janhenkgerritsen](https://github.com/janhenkgerritsen)**. Fixed [#3948](https://github.com/Codeception/Codeception/issues/3948) by **[janhenkgerritsen](https://github.com/janhenkgerritsen)**
+* **[Yii2]** reverted [#3834](https://github.com/Codeception/Codeception/issues/3834), closing transaction after each request. [#3973](https://github.com/Codeception/Codeception/issues/3973) by **[iRipVanWinkle](https://github.com/iRipVanWinkle)**. Fixes [#3961](https://github.com/Codeception/Codeception/issues/3961)
+* Added crap4j report support. Use `--coverage-crap4j` option and `codeception/c3` 2.0.10 
+* [PhpBrowser][Frameworks] If form has no id, use action attribute as identifier by **[Naktibalda](https://github.com/Naktibalda)**. Fixes [#3953](https://github.com/Codeception/Codeception/issues/3953)
+* Fixed test coloring output when a Feature title has some special chars in it like `/` or `-`
+* **[REST]** Added missing **[part](https://github.com/part)** `json` and `xml` to `deleteHeader` by **[freezy](https://github.com/freezy)**-sk 
+
 #### 2.2.8
 
 * **[WebDriver]** Added tab actions (not supported in PhantomJS):
-  * [openNewTab](http://codeception.com/docs/modules/WebDriver#openNewTab) opens a new tab and switches to it
-  * [closeTab](http://codeception.com/docs/modules/WebDriver#closeTab) closes a tab and switches to previous
-  * [switchToNextTab](http://codeception.com/docs/modules/WebDriver#switchToNextTab) switches to next tab 
-  * [switchToPreviousTab](http://codeception.com/docs/modules/WebDriver#switchToPreviousTab) switches to previous tab
+  * `openNewTab` opens a new tab and switches to it
+  * `closeTab` closes a tab and switches to previous
+  * `switchToNextTab` switches to next tab 
+  * `switchToPreviousTab` switches to previous tab
 * **[WebDriver]** Added actions to click element by coordinates. Via **[gimler](https://github.com/gimler)**
-  * [clickWithLeftButton](http://codeception.com/docs/modules/WebDriver#clickWithLeftButton) clicks element with offset
-  * [clickWithRightButton](http://codeception.com/docs/modules/WebDriver#clickWithRightButton) right clicks on element with offset 
+  * `clickWithLeftButton` clicks element with offset
+  * `clickWithRightButton` right clicks on element with offset 
 * **[WebDriver]** Added `js_error_logging` option to print JS logs in console and in HTML report by **[ngraf](https://github.com/ngraf)**. See [#3821](https://github.com/Codeception/Codeception/issues/3821)
 * **[WebDriver]** Improvements to `seeInField` by **[gimler](https://github.com/gimler)**. See [#3905](https://github.com/Codeception/Codeception/issues/3905)
   * support option text in seeInField not only value
diff --git a/docs/03-AcceptanceTests.md b/docs/03-AcceptanceTests.md
@@ -399,8 +399,8 @@ $I->seeElement('#modal');
 #### Wait
 
 While testing web application, you may need to wait for JavaScript events to occur. Due to its asynchronous nature,
-complex JavaScript interactions are hard to test. That's why you may need to use `wait` actions,
-which can be used to specify what event you expect to occur on a page, before continuing the test.
+complex JavaScript interactions are hard to test. That's why you may need to use waiters, actions with *wait* prefix. 
+They can be used to specify what event you expect to occur on a page, before continuing the test.
 
 For example:
 
@@ -413,9 +413,47 @@ $I->click('#agree_button');
 {% endhighlight %}
 
 In this case we are waiting for the 'agree' button to appear and then clicking it. If it didn't appear after 30 seconds,
-the test will fail. There are other `wait` methods you may use.
+the test will fail. There are other `wait` methods you may use, like [waitForText](http://codeception.com/docs/modules/WebDriver#waitForText), 
+[waitForElementVisible](http://codeception.com/docs/modules/WebDriver#waitForElementVisible) and others.
 
-See Codeception's [WebDriver module documentation](http://codeception.com/docs/modules/WebDriver) for the full reference.
+If you don't know what exact element you need to wait for, you can simply pause execution with using `$I->wait()`
+
+{% highlight php %}
+
+<?php
+$I->wait(3); // wait for 3 secs
+
+{% endhighlight %}
+
+#### Wait and Act
+
+To combine `waitForElement` with actions inside that element you can use [performOn](http://codeception.com/docs/modules/WebDriver#performOn) method. 
+Let's see how can you perform some actions inside an HTML popup:
+
+{% highlight php %}
+
+<?php
+$I->performOn('.confirm', \Codeception\Util\ActionSequence::build()
+    ->see('Warning')
+    ->see('Are you sure you want to delete this?')
+    ->click('Yes')
+);
+
+{% endhighlight %}
+Alternatively, this can be executed using callback, in this case WebDriver module instance is passed as argument
+
+{% highlight php %}
+
+<?php
+$I->performOn('.confirm', function(\Codeception\Module\WebDriver $I) {
+    $I->see('Warning');
+    $I->see('Are you sure you want to delete this?');
+    $I->click('Yes');
+});
+
+{% endhighlight %}
+
+For more options see [`performOn` reference]([performOn](http://codeception.com/docs/modules/WebDriver#performOn) ).
 
 ### Multi Session Testing
 
diff --git a/docs/modules/AMQP.md b/docs/modules/AMQP.md
@@ -58,6 +58,60 @@ To use this module with Composer you need <em>"videlalvaro/php-amqplib": "*"</em
 
 ### Actions
 
+#### bindQueueToExchange
+ 
+Binds a queue to an exchange
+
+This is an alias of method `queue_bind` of `PhpAmqpLib\Channel\AMQPChannel`.
+
+{% highlight php %}
+
+<?php
+$I->bindQueueToExchange(
+    'nameOfMyQueueToBind', // name of the queue
+    'transactionTracking.transaction', // exchange name to bind to
+    'your.routing.key' // Optionally, provide a binding key
+    //.. see the original method for more options
+)
+
+{% endhighlight %}
+
+
+#### declareExchange
+ 
+Declares an exchange
+
+This is an alias of method `exchange_declare` of `PhpAmqpLib\Channel\AMQPChannel`.
+
+{% highlight php %}
+
+<?php
+$I->declareExchange(
+    'nameOfMyExchange', // exchange name
+    'topic' // exchange type
+    //.. see the original method for more options
+)
+
+{% endhighlight %}
+
+
+#### declareQueue
+ 
+Declares a queue
+
+This is an alias of method `queue_declare` of `PhpAmqpLib\Channel\AMQPChannel`.
+
+{% highlight php %}
+
+<?php
+$I->declareQueue(
+    'nameOfMyQueue', // exchange name
+    //.. see the original method for more options
+)
+
+{% endhighlight %}
+
+
 #### grabMessageFromQueue
  
 Takes last message from queue.
diff --git a/docs/modules/AngularJS.md b/docs/modules/AngularJS.md
@@ -702,13 +702,6 @@ $I->fillField(['name' => 'email'], 'jon@mail.com');
  * `param` $value
 
 
-#### getVisibleText
- 
-Grabs all visible text from the current page.
-
- * `return` string
-
-
 #### grabAttributeFrom
  
 Grabs the value of the given attribute value from the given element.
@@ -915,6 +908,57 @@ This method is useful while writing tests,
 since it allows you to inspect the current page in the middle of a test case.
 
 
+#### performOn
+ 
+Waits for element and runs a sequence of actions inside its context.
+Actions can be defined with array, callback, or `Codeception\Util\ActionSequence` instance.
+
+Actions as array are recommended for simple to combine "waitForElement" with assertions;
+`waitForElement($el)` and `see('text', $el)` can be simplified to:
+
+{% highlight php %}
+
+<?php
+$I->performOn($el, ['see' => 'text']);
+
+{% endhighlight %}
+
+List of actions can be pragmatically build using `Codeception\Util\ActionSequence`:
+
+{% highlight php %}
+
+<?php
+$I->performOn('.model', ActionSequence::build()
+    ->see('Warning')
+    ->see('Are you sure you want to delete this?')
+    ->click('Yes')
+);
+
+{% endhighlight %}
+
+Actions executed from array or ActionSequence will print debug output for actions, and adds an action name to
+exception on failure.
+
+Whenever you need to define more actions a callback can be used. A WebDriver module is passed for argument:
+
+{% highlight php %}
+
+<?php
+$I->performOn('.rememberMe', function (WebDriver $I) {
+     $I->see('Remember me next time');
+     $I->seeElement('#LoginForm_rememberMe');
+     $I->dontSee('Login');
+});
+
+{% endhighlight %}
+
+In 3rd argument you can set number a seconds to wait for element to appear
+
+ * `param` $element
+ * `param` $actions
+ * `param int` $timeout
+
+
 #### pressKey
  
 Presses the given key on the given element.
@@ -1652,9 +1696,9 @@ An offset can be specified.
 
 <?php
 // switch to previous tab
-$I->switchToPreviousTab();
+$I->switchToNextTab();
 // switch to 2nd previous tab
-$I->switchToPreviousTab(2);
+$I->switchToNextTab(-2);
 
 {% endhighlight %}
 
diff --git a/docs/modules/REST.md b/docs/modules/REST.md
@@ -97,6 +97,27 @@ $I->sendPOST('some-other-page.php');
 {% endhighlight %}
 
  * `param string` $name the name of the header to delete.
+ * `[Part]` json
+ * `[Part]` xml
+
+
+#### dontSeeBinaryResponseEquals
+ 
+Checks if the hash of a binary response is not the same as provided.
+
+{% highlight php %}
+
+<?php
+$I->dontSeeBinaryResponseEquals("8c90748342f19b195b9c6b4eff742ded");
+?>
+
+{% endhighlight %}
+Opposite to `seeBinaryResponseEquals`
+
+ * `param` $hash the hashed data response expected
+ * `param` $algo the hash algorithm to use. Default md5.
+ * `[Part]` json
+ * `[Part]` xml
 
 
 #### dontSeeHttpHeader
@@ -318,6 +339,49 @@ $I->haveHttpHeader('Content-Type', 'application/json');
  * `[Part]` xml
 
 
+#### seeBinaryResponseEquals
+ 
+Checks if the hash of a binary response is exactly the same as provided.
+Parameter can be passed as any hash string supported by hash(), with an
+optional second parameter to specify the hash type, which defaults to md5.
+
+Example: Using md5 hash key
+
+{% highlight php %}
+
+<?php
+$I->seeBinaryResponseEquals("8c90748342f19b195b9c6b4eff742ded");
+?>
+
+{% endhighlight %}
+
+Example: Using md5 for a file contents
+
+{% highlight php %}
+
+<?php
+$fileData = file_get_contents("test_file.jpg");
+$I->seeBinaryResponseEquals(md5($fileData));
+?>
+
+{% endhighlight %}
+Example: Using sha256 hsah
+
+{% highlight php %}
+
+<?php
+$fileData = '/9j/2wBDAAMCAgICAgMCAgIDAwMDBAYEBAQEBAgGBgUGCQgKCgkICQkKDA8MCgsOCwkJDRENDg8QEBEQCgwSExIQEw8QEBD/yQALCAABAAEBAREA/8wABgAQEAX/2gAIAQEAAD8A0s8g/9k='; // very small jpeg
+$I->seeBinaryResponseEquals(hash("sha256", base64_decode($fileData)), 'sha256');
+?>
+
+{% endhighlight %}
+
+ * `param` $hash the hashed data response expected
+ * `param` $algo the hash algorithm to use. Default md5.
+ * `[Part]` json
+ * `[Part]` xml
+
+
 #### seeHttpHeader
  
 Checks over the given HTTP header and (optionally)
diff --git a/docs/modules/WebDriver.md b/docs/modules/WebDriver.md
