codeceptjs 3.0.6 → 3.1.2

package/docs/configuration.md

@@ -11,7 +11,7 @@ After running `codeceptjs init` it should be saved in test root.
 
 Here is an overview of available options with their defaults:
 
-* **tests**: `"./*_test.js"` - pattern to locate tests. Allows to enter [glob pattern](https://github.com/isaacs/node-glob).
+* **tests**: `"./*_test.js"` - pattern to locate tests. Allows to enter [glob pattern](https://github.com/isaacs/node-glob), Can either be a pattern to locate tests or an array of patterns to locate tests / test file names.
 * **grep**: - pattern to filter tests by name
 * **include**: `{}` - actors and page objects to be registered in DI container and included in tests. Accepts objects and module `require` paths
 * **timeout**: `10000` - default tests timeout
@@ -47,7 +47,20 @@ exports.config = {
   require: ["ts-node/register", "should"]
 }
 ```
-
+For array of test pattern
+```js
+exports.config = {
+  tests: ['./*_test.js','./sampleTest.js'],
+  timeout: 10000,
+  output: '',
+  helpers: {},
+  include: {},
+  bootstrap: false,
+  mocha: {},
+  // require modules
+  require: ["ts-node/register", "should"]
+}
+```
 ## Dynamic Configuration
 
  By default `codecept.json` is used for configuration. You can override its values in runtime by using `--override` or `-o` option in command line, passing valid JSON as a value:

package/docs/email.md

@@ -6,10 +6,10 @@ title: Email Testing
 # Email Testing
 
 In End 2 End testing we need to interact with emails.
-Email delivery can't tested locally or mocked while testing.
-That's why for an end to end test you need to use a real emails to be sent and real email address to receive that emails.
+Email delivery can't be tested locally or mocked while testing.
+That's why for an end to end test you need real emails to be sent and real email address to receive that emails.
 
-Setting up an email server can be hard. So we recommend to use a [MailSlurp](https://mailslurp.com/) - a service designed for testing emails. It creates disposable mailboxes and provides you an access to those mailboxes via REST API.
+Setting up an email server can be hard. So we recommend to use [MailSlurp](https://mailslurp.com/) - a service designed for testing emails. It creates disposable mailboxes and provides you an access to those mailboxes via REST API.
 
 > You no longer need to open your gmail account in a browser to check for an email!
 
@@ -41,7 +41,7 @@ npx codeceptjs def
 
 ## Creating Mailbox
 
-MailSlurp allows you to create disposable mailboxes. It means that an email address is created for a one test only and is deleted afterwards. So you can be confident that no other emails are received at that address.
+MailSlurp allows you to create disposable mailboxes. It means that an email address is created for one test only and is deleted afterwards. So you can be confident that no other emails are received at that address.
 
 To create a mailbox use `I.haveNewMailbox()` command:
 
@@ -57,7 +57,7 @@ mailbox object contains:
 
 > See [MailSlurp's guide](https://www.mailslurp.com/guides/getting-started/#create-email-addresses) for details.
 
-Mailbox is opened on creation. If you need more than one mailboxes and you want to switch between them use `openMailbox` method:
+Mailbox is opened on creation. If you need more than one mailbox and you want to switch between them use `openMailbox` method:
 
 ```js
 const mailbox1 = await I.haveNewMailbox();
@@ -71,7 +71,7 @@ I.openMailbox(mailbox1);
 
 A last created mailbox will be activated. It means that it will be used by default to check for emails.
 
-After an action that triggers sending an email is performed on a website you should wait for this email to be received.
+After an action that triggers sending an email is performed on a website, you should wait for this email to be received.
 A timeout for waiting an email can be set globally for a helper or for a one call.
 
 Use `waitForLatestEmail` function to return the first email from a mailbox:
@@ -109,7 +109,7 @@ const email = await I.waitForLatestEmail();
 ```
 > Please note, that we use `await` to assign email. This should be declared inside async function
 
-An `email` object contains following fields:
+An `email` object contains the following fields:
 
 * `subject`
 * `for`
@@ -130,7 +130,7 @@ I.amOnPage(url);
 
 ## Assertions
 
-Assertions are performed on the currently opened email.Email is opened on `waitFor` email call, however, you can open an exact email by using `openEmail` function.
+Assertions are performed on the currently opened email. Email is opened on `waitFor` email call, however, you can open an exact email by using `openEmail` function.
 
 ```js
 const email1 = await I.waitForLatestEmail();

package/docs/examples.md

@@ -8,9 +8,9 @@ editLink: false
 
 # Examples
 > Add your own examples to our [Wiki Page](https://github.com/codeceptjs/CodeceptJS/wiki/Examples)
-## [TodoMVC Examples](https://github.com/codeceptjs/examples)
+## [TodoMVC Examples](https://github.com/codecept-js/examples)
 
-![](https://github.com/codeceptjs/examples/raw/master/todo.png)
+![](https://github.com/codecept-js/examples/raw/master/todo.png)
 
 Playground repository where you can run tests in different helpers on a basic single-page website.
 
@@ -155,4 +155,4 @@ Suggestions and improvements are welcome , please raise a ticket in Issue tab.
 * Step by step setup in README
 * Two helpers are added. UI - Puppeteer , API - REST and chai-codeceptJS for assetion
 * ESLint for code check
-* Upcoming : API generic functions , Adaptor design pattern , More utilities
+* Upcoming : API generic functions , Adaptor design pattern , More utilities

package/docs/helpers/Appium.md

@@ -945,6 +945,57 @@ If multiple elements found returns first element.
 
 Returns **[Promise][13]<[string][4]>** attribute value
 
+### grabNumberOfVisibleElements
+
+Grab number of visible elements by locator.
+Resumes test execution, so **should be used inside async function with `await`** operator.
+
+```js
+let numOfElements = await I.grabNumberOfVisibleElements('p');
+```
+
+#### Parameters
+
+-   `locator` **([string][4] \| [object][6])** located by CSS|XPath|strict locator.
+
+Returns **[Promise][13]<[number][8]>** number of visible elements
+
+### grabAttributeFrom
+
+Can be used for apps only with several values ("contentDescription", "text", "className", "resourceId")
+
+Retrieves an attribute from an element located by CSS or XPath and returns it to test.
+Resumes test execution, so **should be used inside async with `await`** operator.
+If more than one element is found - attribute of first element is returned.
+
+```js
+let hint = await I.grabAttributeFrom('#tooltip', 'title');
+```
+
+#### Parameters
+
+-   `locator` **([string][4] \| [object][6])** element located by CSS|XPath|strict locator.
+-   `attr` **[string][4]** attribute name.
+
+Returns **[Promise][13]<[string][4]>** attribute value
+
+### grabAttributeFromAll
+
+Can be used for apps only with several values ("contentDescription", "text", "className", "resourceId")
+Retrieves an array of attributes from elements located by CSS or XPath and returns it to test.
+Resumes test execution, so **should be used inside async with `await`** operator.
+
+```js
+let hints = await I.grabAttributeFromAll('.tooltip', 'title');
+```
+
+#### Parameters
+
+-   `locator` **([string][4] \| [object][6])** element located by CSS|XPath|strict locator.
+-   `attr` **[string][4]** attribute name.
+
+Returns **[Promise][13]<[Array][14]<[string][4]>>** attribute value
+
 ### grabValueFromAll
 
 Retrieves an array of value from a form located by CSS or XPath and returns it to test.
@@ -976,6 +1027,19 @@ let email = await I.grabValueFrom('input[name=email]');
 
 Returns **[Promise][13]<[string][4]>** attribute value
 
+### saveScreenshot
+
+Saves a screenshot to ouput folder (set in codecept.json or codecept.conf.js).
+Filename is relative to output folder.
+
+```js
+I.saveScreenshot('debug.png');
+```
+
+#### Parameters
+
+-   `fileName` **[string][4]** file name to save.
+
 ### scrollIntoView
 
 Scroll element into viewport.
@@ -1437,39 +1501,6 @@ let postHTML = await I.grabHTMLFrom('#post');
 
 Returns **[Promise][13]<[string][4]>** HTML code for an element
 
-### grabAttributeFromAll
-
-Retrieves an array of attributes from elements located by CSS or XPath and returns it to test.
-Resumes test execution, so **should be used inside async with `await`** operator.
-
-```js
-let hints = await I.grabAttributeFromAll('.tooltip', 'title');
-```
-
-#### Parameters
-
--   `locator` **([string][4] \| [object][6])** element located by CSS|XPath|strict locator.
--   `attr` **[string][4]** attribute name.
-
-Returns **[Promise][13]<[Array][14]<[string][4]>>** attribute valueAppium: can be used for apps only with several values ("contentDescription", "text", "className", "resourceId")
-
-### grabAttributeFrom
-
-Retrieves an attribute from an element located by CSS or XPath and returns it to test.
-Resumes test execution, so **should be used inside async with `await`** operator.
-If more than one element is found - attribute of first element is returned.
-
-```js
-let hint = await I.grabAttributeFrom('#tooltip', 'title');
-```
-
-#### Parameters
-
--   `locator` **([string][4] \| [object][6])** element located by CSS|XPath|strict locator.
--   `attr` **[string][4]** attribute name.
-
-Returns **[Promise][13]<[string][4]>** attribute valueAppium: can be used for apps only with several values ("contentDescription", "text", "className", "resourceId")
-
 ### seeTextEquals
 
 Checks that text is equal to provided one.
@@ -1597,21 +1628,6 @@ I.seeAttributesOnElements('//form', { method: "post"});
 -   `locator` **([string][4] \| [object][6])** located by CSS|XPath|strict locator.
 -   `attributes` **[object][6]** attributes and their values to check.
 
-### grabNumberOfVisibleElements
-
-Grab number of visible elements by locator.
-Resumes test execution, so **should be used inside async function with `await`** operator.
-
-```js
-let numOfElements = await I.grabNumberOfVisibleElements('p');
-```
-
-#### Parameters
-
--   `locator` **([string][4] \| [object][6])** located by CSS|XPath|strict locator.
-
-Returns **[Promise][13]<[number][8]>** number of visible elements
-
 ### scrollTo
 
 Scrolls to element matched by locator.
@@ -1660,27 +1676,11 @@ I.saveElementScreenshot(`#submit`,'debug.png');
 -   `locator` **([string][4] \| [object][6])** element located by CSS|XPath|strict locator.
 -   `fileName` **[string][4]** file name to save.
 
-### saveScreenshot
-
-Saves a screenshot to ouput folder (set in codecept.json or codecept.conf.js).
-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
-I.saveScreenshot('debug.png');
-I.saveScreenshot('debug.png', true) //resizes to available scrollHeight and scrollWidth before taking screenshot
-```
-
-#### Parameters
-
--   `fileName` **[string][4]** file name to save.
--   `fullPage` **[boolean][20]** (optional, `false` by default) flag to enable fullscreen screenshot mode. (optional, default `false`)
-
 ### type
 
 Types out the given text into an active field.
 To slow down typing use a second parameter, to set interval between key presses.
-_Note:_ Should be used when [`fillField`][21] is not an option.
+_Note:_ Should be used when [`fillField`][20] is not an option.
 
 ```js
 // passing in a string
@@ -1918,6 +1918,4 @@ Returns **([Promise][13]<DOMRect> | [Promise][13]<[number][8]>)** Element
 
 [19]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/undefined
 
-[20]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean
-
-[21]: #fillfield
+[20]: #fillfield

package/docs/helpers/MockRequest.md

@@ -56,7 +56,7 @@ helpers: {
    Puppeteer: {
      // regular Puppeteer config here
    },
-   MockRequest: {
+   MockRequestHelper: {
      require: '@codeceptjs/mock-request',
    }
 }
@@ -67,7 +67,7 @@ helpers: {
 ```js
 // sample options
 helpers: {
-  MockRequest: {
+  MockRequestHelper: {
      require: '@codeceptjs/mock-request',
      mode: record,
      recordIfMissing: true,
@@ -115,7 +115,7 @@ helpers: {
    WebDriver: {
      // regular WebDriver config here
    },
-   MockRequest: {
+   MockRequestHelper: {
      require: '@codeceptjs/mock-request',
    }
 }