codeceptjs 4.0.0-rc.18 → 4.0.0-rc.19

package/docs/helpers/ExpectHelper.md

@@ -0,0 +1,275 @@
+---
+permalink: /helpers/ExpectHelper
+editLink: false
+sidebar: auto
+title: ExpectHelper
+---
+
+<!-- Generated by documentation.js. Update this documentation by updating the source code. -->
+
+## ExpectHelper
+
+This helper allows performing assertions based on Chai.
+
+### Examples
+
+Zero-configuration when paired with other helpers like REST, Playwright:
+
+```js
+// inside codecept.conf.js
+{
+  helpers: {
+    Playwright: {...},
+    ExpectHelper: {},
+  }
+}
+```
+
+## Methods
+
+### expectAbove
+
+#### Parameters
+
+- `targetData` **any**&#x20;
+- `aboveThan` **any**&#x20;
+- `customErrorMsg` **any?**
+
+### expectBelow
+
+#### Parameters
+
+- `targetData` **any**&#x20;
+- `belowThan` **any**&#x20;
+- `customErrorMsg` **any?**
+
+### expectContain
+
+#### Parameters
+
+- `actualValue` **any**&#x20;
+- `expectedValueToContain` **any**&#x20;
+- `customErrorMsg` **any?**
+
+### expectDeepEqual
+
+#### Parameters
+
+- `actualValue` **any**&#x20;
+- `expectedValue` **any**&#x20;
+- `customErrorMsg` **any?**
+
+### expectDeepEqualExcluding
+
+expects members of two JSON objects are deeply equal excluding some properties
+
+#### Parameters
+
+- `actualValue` **any**&#x20;
+- `expectedValue` **any**&#x20;
+- `fieldsToExclude` **any**&#x20;
+- `customErrorMsg` **any?**
+
+### expectDeepIncludeMembers
+
+expects an array to be a superset of another array
+
+#### Parameters
+
+- `superset` **any**&#x20;
+- `set` **any**&#x20;
+- `customErrorMsg` **any?**
+
+### expectDeepMembers
+
+expects members of two arrays are deeply equal
+
+#### Parameters
+
+- `actualValue` **any**&#x20;
+- `expectedValue` **any**&#x20;
+- `customErrorMsg` **any?**
+
+### expectEmpty
+
+#### Parameters
+
+- `targetData` **any**&#x20;
+- `customErrorMsg` **any?**
+
+### expectEndsWith
+
+#### Parameters
+
+- `actualValue` **any**&#x20;
+- `expectedValueToEndWith` **any**&#x20;
+- `customErrorMsg` **any?**
+
+### expectEqual
+
+#### Parameters
+
+- `actualValue` **any**&#x20;
+- `expectedValue` **any**&#x20;
+- `customErrorMsg` **any?**
+
+### expectEqualIgnoreCase
+
+#### Parameters
+
+- `actualValue` **any**&#x20;
+- `expectedValue` **any**&#x20;
+- `customErrorMsg` **any?**
+
+### expectFalse
+
+#### Parameters
+
+- `targetData` **any**&#x20;
+- `customErrorMsg` **any?**
+
+### expectHasAProperty
+
+#### Parameters
+
+- `targetData` **any**&#x20;
+- `propertyName` **any**&#x20;
+- `customErrorMsg` **any?**
+
+### expectHasProperty
+
+#### Parameters
+
+- `targetData` **any**&#x20;
+- `propertyName` **any**&#x20;
+- `customErrorMsg` **any?**
+
+### expectJsonSchema
+
+#### Parameters
+
+- `targetData` **any**&#x20;
+- `jsonSchema` **any**&#x20;
+- `customErrorMsg` **any?**
+
+### expectJsonSchemaUsingAJV
+
+#### Parameters
+
+- `targetData` **any**&#x20;
+- `jsonSchema` **any**&#x20;
+- `customErrorMsg` **any?**
+- `ajvOptions` **any?** Pass AJV options
+
+### expectLengthAboveThan
+
+#### Parameters
+
+- `targetData` **any**&#x20;
+- `lengthAboveThan` **any**&#x20;
+- `customErrorMsg` **any?**
+
+### expectLengthBelowThan
+
+#### Parameters
+
+- `targetData` **any**&#x20;
+- `lengthBelowThan` **any**&#x20;
+- `customErrorMsg` **any?**
+
+### expectLengthOf
+
+#### Parameters
+
+- `targetData` **any**&#x20;
+- `length` **any**&#x20;
+- `customErrorMsg` **any?**
+
+### expectMatchesPattern
+
+expects a JSON object matches a provided pattern
+
+#### Parameters
+
+- `actualValue` **any**&#x20;
+- `expectedPattern` **any**&#x20;
+- `customErrorMsg` **any?**
+
+### expectMatchRegex
+
+#### Parameters
+
+- `targetData` **any**&#x20;
+- `regex` **any**&#x20;
+- `customErrorMsg` **any?**
+
+### expectNotContain
+
+#### Parameters
+
+- `actualValue` **any**&#x20;
+- `expectedValueToNotContain` **any**&#x20;
+- `customErrorMsg` **any?**
+
+### expectNotDeepEqual
+
+#### Parameters
+
+- `actualValue` **any**&#x20;
+- `expectedValue` **any**&#x20;
+- `customErrorMsg` **any?**
+
+### expectNotEndsWith
+
+#### Parameters
+
+- `actualValue` **any**&#x20;
+- `expectedValueToNotEndWith` **any**&#x20;
+- `customErrorMsg` **any?**
+
+### expectNotEqual
+
+#### Parameters
+
+- `actualValue` **any**&#x20;
+- `expectedValue` **any**&#x20;
+- `customErrorMsg` **any?**
+
+### expectNotStartsWith
+
+#### Parameters
+
+- `actualValue` **any**&#x20;
+- `expectedValueToNotStartWith` **any**&#x20;
+- `customErrorMsg` **any?**
+
+### expectStartsWith
+
+#### Parameters
+
+- `actualValue` **any**&#x20;
+- `expectedValueToStartWith` **any**&#x20;
+- `customErrorMsg` **any?**
+
+### expectToBeA
+
+#### Parameters
+
+- `targetData` **any**&#x20;
+- `type` **any**&#x20;
+- `customErrorMsg` **any?**
+
+### expectToBeAn
+
+#### Parameters
+
+- `targetData` **any**&#x20;
+- `type` **any**&#x20;
+- `customErrorMsg` **any?**
+
+### expectTrue
+
+#### Parameters
+
+- `targetData` **any**&#x20;
+- `customErrorMsg` **any?**

package/docs/helpers/FileSystem.md

@@ -0,0 +1,152 @@
+---
+permalink: /helpers/FileSystem
+editLink: false
+sidebar: auto
+title: FileSystem
+---
+
+<!-- Generated by documentation.js. Update this documentation by updating the source code. -->
+
+## FileSystem
+
+**Extends Helper**
+
+Helper for testing filesystem.
+Can be easily used to check file structures:
+
+```js
+I.amInPath('test');
+I.seeFile('codecept.js');
+I.seeInThisFile('FileSystem');
+I.dontSeeInThisFile("WebDriver");
+```
+
+## Configuration
+
+Enable helper in config file:
+
+```js
+helpers: {
+    FileSystem: {},
+}
+```
+
+## Methods
+
+### amInPath
+
+Enters a directory In local filesystem.
+Starts from a current directory
+
+#### Parameters
+
+*   `openPath` **[string][1]**&#x20;
+
+### dontSeeFileContentsEqual
+
+Checks that contents of file found by `seeFile` doesn't equal to text.
+
+#### Parameters
+
+*   `text` **[string][1]**&#x20;
+*   `encoding` **[string][1]**  
+
+### dontSeeInThisFile
+
+Checks that file found by `seeFile` doesn't include text.
+
+#### Parameters
+
+*   `text` **[string][1]**&#x20;
+*   `encoding` **[string][1]**  
+
+### grabFileNames
+
+Returns file names in current directory.
+
+```js
+I.handleDownloads();
+I.click('Download Files');
+I.amInPath('output/downloads');
+const downloadedFileNames = I.grabFileNames();
+```
+
+### seeFile
+
+Checks that file exists
+
+#### Parameters
+
+*   `name` **[string][1]**&#x20;
+
+### seeFileContentsEqual
+
+Checks that contents of file found by `seeFile` equal to text.
+
+#### Parameters
+
+*   `text` **[string][1]**&#x20;
+*   `encoding` **[string][1]**  
+
+### seeFileContentsEqualReferenceFile
+
+Checks that contents of the file found by `seeFile` equal to contents of the file at `pathToReferenceFile`.
+
+#### Parameters
+
+*   `pathToReferenceFile` **[string][1]**&#x20;
+*   `encoding` **[string][1]**  
+*   `encodingReference` **[string][1]**  
+
+### seeFileNameMatching
+
+Checks that file with a name including given text exists in the current directory.
+
+```js
+I.handleDownloads();
+I.click('Download as PDF');
+I.amInPath('output/downloads');
+I.seeFileNameMatching('.pdf');
+```
+
+#### Parameters
+
+*   `text` **[string][1]**&#x20;
+
+### seeInThisFile
+
+Checks that file found by `seeFile` includes a text.
+
+#### Parameters
+
+*   `text` **[string][1]**&#x20;
+*   `encoding` **[string][1]**  
+
+### waitForFile
+
+Waits for the file to be present in the current directory.
+
+```js
+I.handleDownloads('downloads/largeFilesName.txt');
+I.click('Download large File');
+I.amInPath('output/downloads');
+I.waitForFile('largeFilesName.txt', 10); // wait 10 seconds for file
+```
+
+#### Parameters
+
+*   `name` **[string][1]**&#x20;
+*   `sec` **[number][2]** seconds to wait 
+
+### writeToFile
+
+Writes text to file
+
+#### Parameters
+
+*   `name` **[string][1]**&#x20;
+*   `text` **[string][1]**&#x20;
+
+[1]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String
+
+[2]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number

package/docs/helpers/GraphQL.md

@@ -0,0 +1,152 @@
+---
+permalink: /helpers/GraphQL
+editLink: false
+sidebar: auto
+title: GraphQL
+---
+
+<!-- Generated by documentation.js. Update this documentation by updating the source code. -->
+
+## GraphQL
+
+**Extends Helper**
+
+GraphQL helper allows to send additional requests to a GraphQl endpoint during acceptance tests.
+[Axios][1] library is used to perform requests.
+
+## Configuration
+
+*   endpoint: GraphQL base URL
+*   timeout: timeout for requests in milliseconds. 10000ms by default
+*   defaultHeaders: a list of default headers
+*   onRequest: a async function which can update request object.
+
+## Example
+
+```js
+GraphQL: {
+   endpoint: 'http://site.com/graphql/',
+   onRequest: (request) => {
+     request.headers.auth = '123';
+   }
+}
+```
+
+## Access From Helpers
+
+Send GraphQL requests by accessing `_executeQuery` method:
+
+```js
+this.helpers['GraphQL']._executeQuery({
+   url,
+   data,
+});
+```
+
+## Methods
+
+### Parameters
+
+*   `config` &#x20;
+
+### _executeQuery
+
+Executes query via axios call
+
+#### Parameters
+
+*   `request` **[object][2]**&#x20;
+
+### _prepareGraphQLRequest
+
+Prepares request for axios call
+
+#### Parameters
+
+*   `operation` **[object][2]**&#x20;
+*   `headers` **[object][2]**&#x20;
+
+Returns **[object][2]** graphQLRequest
+
+### amBearerAuthenticated
+
+Adds a header for Bearer authentication
+
+```js
+// we use secret function to hide token from logs
+I.amBearerAuthenticated(secret('heregoestoken'))
+```
+
+#### Parameters
+
+*   `accessToken` **([string][3] | CodeceptJS.Secret)** Bearer access token
+
+### haveRequestHeaders
+
+Sets request headers for all requests of this test
+
+#### Parameters
+
+*   `headers` **[object][2]** headers list
+
+### sendMutation
+
+Send query to GraphQL endpoint over http
+
+```js
+I.sendMutation(`
+      mutation createUser($user: UserInput!) {
+         createUser(user: $user) {
+           id
+           name
+           email
+         }
+       }
+   `,
+  { user: {
+      name: 'John Doe',
+      email: 'john@xmail.com'
+    }
+  },
+});
+```
+
+#### Parameters
+
+*   `mutation` **[String][3]**&#x20;
+*   `variables` **[object][2]?** that may go along with the mutation
+*   `options` **[object][2]?** are additional query options 
+*   `headers` **[object][2]?**  
+
+Returns **any** Promise<any>
+
+### sendQuery
+
+Send query to GraphQL endpoint over http.
+Returns a response as a promise.
+
+```js
+
+const response = await I.sendQuery('{ users { name email }}');
+// with variables
+const response = await I.sendQuery(
+ 'query getUser($id: ID) { user(id: $id) { name email }}',
+ { id: 1 },
+)
+const user = response.data.data;
+```
+
+#### Parameters
+
+*   `query` **[String][3]**&#x20;
+*   `variables` **[object][2]?** that may go along with the query
+*   `options` **[object][2]?** are additional query options 
+*   `headers` **[object][2]?**  
+
+Returns **any** Promise<any>
+
+[1]: https://github.com/axios/axios
+
+[2]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object
+
+[3]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String