Merge branch 'master' of github.com:Codeception/CodeceptJS

Author: DavertMik

.gitignore

@@ -14,3 +14,4 @@ testpullfilecache*
 .DS_Store
 package-lock.json
 yarn.lock
+/.vs

CHANGELOG.md

@@ -1,3 +1,10 @@
+## 1.3.2
+
+* Interactve Shell improvements for `pause()`
+    * Added `next` command for **step-by-step debug** when using `pause()`.
+    * Use `After(pause);` in a to start interactive console after last step.
+
+
 ## 1.3.1
 
 * BDD-Gherkin: Fixed running async steps.

docs/basics.md

@@ -58,7 +58,17 @@ This also launches interactive console where you can call actions of `I` object.
 
 You can also use `pause()` to check the web application in a browser. Press `ENTER` to resume test execution.
 
-Interactive shell can be started outside test context by running
+To **debug test step-by-step** type `next` and press Enter. The next step will be executed and interactive shell will be shown again.
+
+To see all available commands press TAB two times to see list of all actions included in I.
+
+If a test is failing you can prevent browser from closing by putting `pause()` command into `After()` hook. This is very helpful to debug failing tests. This way you can keep the same session and try different actions on a page to get the idea what went wrong.
+
+```js
+After(pause);
+```
+
+Interactive shell can be started outside the test context by running
 
 ```bash
 codeceptjs shell

docs/configuration.md

@@ -52,7 +52,8 @@ exports.config = {
 
   // don't build monolithic configs
   mocha: require('./mocha.conf.js') || {},
-  includes: {
+  include: {
+    I: './src/steps_file.js',
     loginPage: './src/pages/login_page',
     dashboardPage: new DashboardPage()
   }

docs/helpers/Nightmare.md

@@ -532,7 +532,7 @@ First parameter can be set to `maximize`
 ## saveScreenshot
 
 Saves a screenshot to ouput folder (set in codecept.json).
-Filename is relative to output folder. 
+Filename is relative to output folder.
 Optionally resize the window to the full available page `scrollHeight` and `scrollWidth` to capture the entire page by passing `true` in as the second argument.
 
 ```js
@@ -835,9 +835,14 @@ I.waitForElement('.btn.continue', 5); // wait for 5 secs
 Waits for a function to return true (waits for 1 sec by default).
 Running in browser context.
 
+```js
+I.waitForFunction(fn[, [args[, timeout]])
+```
+
 ```js
 I.waitForFunction(() => window.requests == 0);
 I.waitForFunction(() => window.requests == 0, 5); // waits for 5 sec
+I.waitForFunction((count) => window.requests == count, [3], 5) // pass args and wait for 5 sec
 ```
 
 **Parameters**

docs/helpers/Protractor.md

@@ -775,7 +775,7 @@ Performs right click on an element matched by CSS or XPath.
 ## saveScreenshot
 
 Saves a screenshot to ouput folder (set in codecept.json).
-Filename is relative to output folder. 
+Filename is relative to output folder.
 Optionally resize the window to the full available page `scrollHeight` and `scrollWidth` to capture the entire page by passing `true` in as the second argument.
 
 ```js
@@ -1180,9 +1180,14 @@ Element can be located by CSS or XPath.
 Waits for a function to return true (waits for 1 sec by default).
 Running in browser context.
 
+```js
+I.waitForFunction(fn[, [args[, timeout]])
+```
+
 ```js
 I.waitForFunction(() => window.requests == 0);
 I.waitForFunction(() => window.requests == 0, 5); // waits for 5 sec
+I.waitForFunction((count) => window.requests == count, [3], 5) // pass args and wait for 5 sec
 ```
 
 **Parameters**

docs/helpers/Puppeteer.md

@@ -771,7 +771,7 @@ Performs right click on an element matched by CSS or XPath.
 ## saveScreenshot
 
 Saves a screenshot to ouput folder (set in codecept.json).
-Filename is relative to output folder. 
+Filename is relative to output folder.
 Optionally resize the window to the full available page `scrollHeight` and `scrollWidth` to capture the entire page by passing `true` in as the second argument.
 
 ```js
@@ -1163,9 +1163,14 @@ Element can be located by CSS or XPath.
 Waits for a function to return true (waits for 1 sec by default).
 Running in browser context.
 
+```js
+I.waitForFunction(fn[, [args[, timeout]])
+```
+
 ```js
 I.waitForFunction(() => window.requests == 0);
 I.waitForFunction(() => window.requests == 0, 5); // waits for 5 sec
+I.waitForFunction((count) => window.requests == count, [3], 5) // pass args and wait for 5 sec
 ```
 
 **Parameters**
@@ -1194,7 +1199,7 @@ See [Pupeteer's reference](https://github.com/GoogleChrome/puppeteer/blob/master
 
 **Parameters**
 
--   `opts` **Any** 
+-   `opts` **Any**
 
 ## waitForText
 

docs/helpers/WebDriverIO.md

@@ -878,7 +878,7 @@ placeholder for ~ locator only test case write once run on both Appium and WebDr
 ## saveScreenshot
 
 Saves a screenshot to ouput folder (set in codecept.json).
-Filename is relative to output folder. 
+Filename is relative to output folder.
 Optionally resize the window to the full available page `scrollHeight` and `scrollWidth` to capture the entire page by passing `true` in as the second argument.
 
 ```js
@@ -1301,9 +1301,14 @@ Element can be located by CSS or XPath.
 Waits for a function to return true (waits for 1 sec by default).
 Running in browser context.
 
+```js
+I.waitForFunction(fn[, [args[, timeout]])
+```
+
 ```js
 I.waitForFunction(() => window.requests == 0);
 I.waitForFunction(() => window.requests == 0, 5); // waits for 5 sec
+I.waitForFunction((count) => window.requests == count, [3], 5) // pass args and wait for 5 sec
 ```
 
 **Parameters**

docs/pageobjects.md

@@ -145,6 +145,34 @@ module.exports = {
 }
 ```
 
+To use a Page Fragment within a Test Scenario just inject it into your Scenario:
+
+```js
+Scenario('failed_login', async (I, loginPage, modal) => {
+  loginPage.sendForm('john@doe.com','wrong password');
+  I.waitForVisible(modal.root);
+  within(modal.root, function () {
+    I.see('Login failed');
+  })
+});
+```
+
+To use a Page Fragment within a Page Object, you need to `require` it on top of the Page Object file:
+
+```js
+const I = actor();
+const modal = require('../fragments/modal');
+
+module.exports = { 
+  doStuff() {
+    ...
+    modal.accept();
+    ...
+  }
+}
+
+```
+
 ## StepObjects
 
 StepObjects represent complex actions which involve usage of multiple web pages. For instance, creating users in backend, changing permissions, etc.

docs/webapi/waitForFunction.mustache

@@ -1,10 +1,16 @@
 Waits for a function to return true (waits for 1 sec by default).
 Running in browser context.
 
+```js
+I.waitForFunction(fn[, [args[, timeout]])
+```
+
 ```js
 I.waitForFunction(() => window.requests == 0);
 I.waitForFunction(() => window.requests == 0, 5); // waits for 5 sec
+I.waitForFunction((count) => window.requests == count, [3], 5) // pass args and wait for 5 sec
 ```
 
 @param function to be executed in browser context
-@param sec time seconds to wait, 1 by default
+@param args arguments for function
+@param sec time seconds to wait, 1 by default