codeceptjs 3.5.11 → 3.5.12-beta.1

package/docs/helpers/ApiDataFactory.md

@@ -1,266 +0,0 @@
----
-permalink: /helpers/ApiDataFactory
-editLink: false
-sidebar: auto
-title: ApiDataFactory
----
-
-<!-- Generated by documentation.js. Update this documentation by updating the source code. -->
-
-## ApiDataFactory
-
-**Extends Helper**
-
-Helper for managing remote data using REST API.
-Uses data generators like [rosie][1] or factory girl to create new record.
-
-By defining a factory you set the rules of how data is generated.
-This data will be saved on server via REST API and deleted in the end of a test.
-
-## Use Case
-
-Acceptance tests interact with a websites using UI and real browser.
-There is no way to create data for a specific test other than from user interface.
-That makes tests slow and fragile. Instead of testing a single feature you need to follow all creation/removal process.
-
-This helper solves this problem.
-Most of web application have API, and it can be used to create and delete test records.
-By combining REST API with Factories you can easily create records for tests:
-
-```js
-I.have('user', { login: 'davert', email: 'davert@mail.com' });
-let id = await I.have('post', { title: 'My first post'});
-I.haveMultiple('comment', 3, {post_id: id});
-```
-
-To make this work you need
-
-1.  REST API endpoint which allows to perform create / delete requests and
-2.  define data generation rules
-
-### Setup
-
-Install [Rosie][1] and [Faker][2] libraries.
-
-```sh
-npm i rosie @faker-js/faker --save-dev
-```
-
-Create a factory file for a resource.
-
-See the example for Posts factories:
-
-```js
-// tests/factories/posts.js
-
-const { Factory } = require('rosie');
-const { faker } = require('@faker-js/faker');
-
-module.exports = new Factory()
-   // no need to set id, it will be set by REST API
-   .attr('author', () => faker.name.findName())
-   .attr('title', () => faker.lorem.sentence())
-   .attr('body', () => faker.lorem.paragraph());
-```
-
-For more options see [rosie documentation][1].
-
-Then configure ApiDataHelper to match factories and REST API:
-
-### Configuration
-
-ApiDataFactory has following config options:
-
--   `endpoint`: base URL for the API to send requests to.
--   `cleanup` (default: true): should inserted records be deleted up after tests
--   `factories`: list of defined factories
--   `returnId` (default: false): return id instead of a complete response when creating items.
--   `headers`: list of headers
--   `REST`: configuration for REST requests
-
-See the example:
-
-```js
- ApiDataFactory: {
-   endpoint: "http://user.com/api",
-   cleanup: true,
-   headers: {
-     'Content-Type': 'application/json',
-     'Accept': 'application/json',
-   },
-   factories: {
-     post: {
-       uri: "/posts",
-       factory: "./factories/post",
-     },
-     comment: {
-       factory: "./factories/comment",
-       create: { post: "/comments/create" },
-       delete: { post: "/comments/delete/{id}" },
-       fetchId: (data) => data.result.id
-     }
-   }
-}
-```
-
-It is required to set REST API `endpoint` which is the baseURL for all API requests.
-Factory file is expected to be passed via `factory` option.
-
-This Helper uses [REST][3] helper and accepts its configuration in "REST" section.
-For instance, to set timeout you should add:
-
-```js
-"ApiDataFactory": {
-   "REST": {
-     "timeout": "100000",
-  }
-}
-```
-
-### Requests
-
-By default to create a record ApiDataFactory will use endpoint and plural factory name:
-
--   create: `POST {endpoint}/{resource} data`
--   delete: `DELETE {endpoint}/{resource}/id`
-
-Example (`endpoint`: `http://app.com/api`):
-
--   create: POST request to `http://app.com/api/users`
--   delete: DELETE request to `http://app.com/api/users/1`
-
-This behavior can be configured with following options:
-
--   `uri`: set different resource uri. Example: `uri: account` => `http://app.com/api/account`.
--   `create`: override create options. Expected format: `{ method: uri }`. Example: `{ "post": "/users/create" }`
--   `delete`: override delete options. Expected format: `{ method: uri }`. Example: `{ "post": "/users/delete/{id}" }`
-
-Requests can also be overridden with a function which returns [axois request config][4].
-
-```js
-create: (data) => ({ method: 'post', url: '/posts', data }),
-delete: (id) => ({ method: 'delete', url: '/posts', data: { id } })
-```
-
-Requests can be updated on the fly by using `onRequest` function. For instance, you can pass in current session from a cookie.
-
-```js
- onRequest: async (request) => {
-    // using global codeceptjs instance
-    let cookie = await codeceptjs.container.helpers('WebDriver').grabCookie('session');
-    request.headers = { Cookie: `session=${cookie.value}` };
-  }
-```
-
-### Responses
-
-By default `I.have()` returns a promise with a created data:
-
-```js
-let client = await I.have('client');
-```
-
-Ids of created records are collected and used in the end of a test for the cleanup.
-If you need to receive `id` instead of full response enable `returnId` in a helper config:
-
-```js
-// returnId: false
-let clientId = await I.have('client');
-// clientId == 1
-
-// returnId: true
-let clientId = await I.have('client');
-// client == { name: 'John', email: 'john@snow.com' }
-```
-
-By default `id` property of response is taken. This behavior can be changed by setting `fetchId` function in a factory config.
-
-```js
-   factories: {
-     post: {
-       uri: "/posts",
-       factory: "./factories/post",
-       fetchId: (data) => data.result.posts[0].id
-     }
-   }
-```
-
-## Methods
-
-### Parameters
-
--   `config`  
-
-### _requestCreate
-
-Executes request to create a record in API.
-Can be replaced from a in custom helper.
-
-#### Parameters
-
--   `factory` **any** 
--   `data` **any** 
-
-### _requestDelete
-
-Executes request to delete a record in API
-Can be replaced from a custom helper.
-
-#### Parameters
-
--   `factory` **any** 
--   `id` **any** 
-
-### have
-
-Generates a new record using factory and saves API request to store it.
-
-```js
-// create a user
-I.have('user');
-// create user with defined email
-// and receive it when inside async function
-const user = await I.have('user', { email: 'user@user.com'});
-// create a user with options that will not be included in the final request
-I.have('user', { }, { age: 33, height: 55 })
-```
-
-#### Parameters
-
--   `factory` **any** factory to use
--   `params` **any?** predefined parameters
--   `options` **any?** options for programmatically generate the attributes
-
-Returns **[Promise][5]&lt;any>** 
-
-### haveMultiple
-
-Generates bunch of records and saves multiple API requests to store them.
-
-```js
-// create 3 posts
-I.haveMultiple('post', 3);
-
-// create 3 posts by one author
-I.haveMultiple('post', 3, { author: 'davert' });
-
-// create 3 posts by one author with options
-I.haveMultiple('post', 3, { author: 'davert' }, { publish_date: '01.01.1997' });
-```
-
-#### Parameters
-
--   `factory` **any** 
--   `times` **any** 
--   `params` **any?** 
--   `options` **any?** 
-
-[1]: https://github.com/rosiejs/rosie
-
-[2]: https://www.npmjs.com/package/faker
-
-[3]: http://codecept.io/helpers/REST/
-
-[4]: https://github.com/axios/axios#request-config
-
-[5]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise