codeceptjs 3.6.7 → 4.0.0-beta.1

package/lib/helper/GraphQL.js

@@ -1,5 +1,5 @@
-const axios = require('axios').default
-const Helper = require('@codeceptjs/helper')
+import { default as axios } from 'axios';
+import Helper from '@codeceptjs/helper';
 
 /**
  * GraphQL helper allows to send additional requests to a GraphQl endpoint during acceptance tests.
@@ -38,35 +38,31 @@ const Helper = require('@codeceptjs/helper')
  */
 class GraphQL extends Helper {
   constructor(config) {
-    super(config)
-    this.axios = axios.create()
-    this.headers = {}
+    super(config);
+    this.axios = axios.create();
+    this.headers = {};
     this.options = {
       timeout: 10000,
       defaultHeaders: {},
       endpoint: '',
-    }
-    this.options = Object.assign(this.options, config)
-    this.headers = { ...this.options.defaultHeaders }
-    this.axios.defaults.headers = this.options.defaultHeaders
+    };
+    this.options = Object.assign(this.options, config);
+    this.headers = { ...this.options.defaultHeaders };
+    this.axios.defaults.headers = this.options.defaultHeaders;
   }
 
   static _checkRequirements() {
     try {
-      require('axios')
+      require('axios');
     } catch (e) {
-      return ['axios']
+      return ['axios'];
     }
   }
 
   static _config() {
     return [
-      {
-        name: 'endpoint',
-        message: 'Endpoint of API you are going to test',
-        default: 'http://localhost:3000/graphql',
-      },
-    ]
+      { name: 'endpoint', message: 'Endpoint of API you are going to test', default: 'http://localhost:3000/graphql' },
+    ];
   }
 
   /**
@@ -75,39 +71,42 @@ class GraphQL extends Helper {
    * @param {object} request
    */
   async _executeQuery(request) {
-    this.axios.defaults.timeout = request.timeout || this.options.timeout
+    this.axios.defaults.timeout = request.timeout || this.options.timeout;
 
     if (this.headers && this.headers.auth) {
-      request.auth = this.headers.auth
+      request.auth = this.headers.auth;
     }
 
     request.headers = Object.assign(request.headers, {
       'Content-Type': 'application/json',
-    })
+    });
 
-    request.headers = { ...this.headers, ...request.headers }
+    request.headers = { ...this.headers, ...request.headers };
 
     if (this.config.onRequest) {
-      await this.config.onRequest(request)
+      await this.config.onRequest(request);
     }
 
-    this.debugSection('Request', JSON.stringify(request))
+    this.debugSection('Request', JSON.stringify(request));
 
-    let response
+    let response;
     try {
-      response = await this.axios(request)
+      response = await this.axios(request);
     } catch (err) {
-      if (!err.response) throw err
-      this.debugSection('Response', `Response error. Status code: ${err.response.status}`)
-      response = err.response
+      if (!err.response) throw err;
+      this.debugSection(
+        'Response',
+        `Response error. Status code: ${err.response.status}`,
+      );
+      response = err.response;
     }
 
     if (this.config.onResponse) {
-      await this.config.onResponse(response)
+      await this.config.onResponse(response);
     }
 
-    this.debugSection('Response', JSON.stringify(response.data))
-    return response
+    this.debugSection('Response', JSON.stringify(response.data));
+    return response;
   }
 
   /**
@@ -123,7 +122,7 @@ class GraphQL extends Helper {
       method: 'POST',
       data: operation,
       headers,
-    }
+    };
   }
 
   /**
@@ -149,15 +148,15 @@ class GraphQL extends Helper {
    */
   async sendQuery(query, variables, options = {}, headers = {}) {
     if (typeof query !== 'string') {
-      throw new Error(`query expected to be a String, instead received ${typeof query}`)
+      throw new Error(`query expected to be a String, instead received ${typeof query}`);
     }
     const operation = {
       query,
       variables,
       ...options,
-    }
-    const request = this._prepareGraphQLRequest(operation, headers)
-    return this._executeQuery(request)
+    };
+    const request = this._prepareGraphQLRequest(operation, headers);
+    return this._executeQuery(request);
   }
 
   /**
@@ -189,19 +188,19 @@ class GraphQL extends Helper {
    */
   async sendMutation(mutation, variables, options = {}, headers = {}) {
     if (typeof mutation !== 'string') {
-      throw new Error(`mutation expected to be a String, instead received ${typeof mutation}`)
+      throw new Error(`mutation expected to be a String, instead received ${typeof mutation}`);
     }
     const operation = {
       query: mutation,
       variables,
       ...options,
-    }
-    const request = this._prepareGraphQLRequest(operation, headers)
-    return this._executeQuery(request)
+    };
+    const request = this._prepareGraphQLRequest(operation, headers);
+    return this._executeQuery(request);
   }
 
   _setRequestTimeout(newTimeout) {
-    this.options.timeout = newTimeout
+    this.options.timeout = newTimeout;
   }
 
   /**
@@ -210,7 +209,7 @@ class GraphQL extends Helper {
    * @param {object} headers headers list
    */
   haveRequestHeaders(headers) {
-    this.headers = { ...this.headers, ...headers }
+    this.headers = { ...this.headers, ...headers };
   }
 
   /**
@@ -224,7 +223,7 @@ class GraphQL extends Helper {
    * @param {string | CodeceptJS.Secret} accessToken  Bearer access token
    */
   amBearerAuthenticated(accessToken) {
-    this.haveRequestHeaders({ Authorization: `Bearer ${accessToken}` })
+    this.haveRequestHeaders({ Authorization: `Bearer ${accessToken}` });
   }
 }
-module.exports = GraphQL
+export default GraphQL;

package/lib/helper/GraphQLDataFactory.js

@@ -1,7 +1,6 @@
-const path = require('path')
-
-const Helper = require('@codeceptjs/helper')
-const GraphQL = require('./GraphQL')
+import path from 'path';
+import Helper from '@codeceptjs/helper';
+import GraphQL from './GraphQL';
 
 /**
  * Helper for managing remote data using GraphQL queries.
@@ -151,52 +150,52 @@ const GraphQL = require('./GraphQL')
  */
 class GraphQLDataFactory extends Helper {
   constructor(config) {
-    super(config)
+    super(config);
 
     const defaultConfig = {
       cleanup: true,
       GraphQL: {},
       factories: {},
-    }
-    this.config = Object.assign(defaultConfig, this.config)
+    };
+    this.config = Object.assign(defaultConfig, this.config);
 
     if (this.config.headers) {
-      this.config.GraphQL.defaultHeaders = this.config.headers
+      this.config.GraphQL.defaultHeaders = this.config.headers;
     }
     if (this.config.onRequest) {
-      this.config.GraphQL.onRequest = this.config.onRequest
+      this.config.GraphQL.onRequest = this.config.onRequest;
     }
-    this.graphqlHelper = new GraphQL(Object.assign(this.config.GraphQL, { endpoint: this.config.endpoint }))
-    this.factories = this.config.factories
+    this.graphqlHelper = new GraphQL(Object.assign(this.config.GraphQL, { endpoint: this.config.endpoint }));
+    this.factories = this.config.factories;
 
-    this.created = {}
-    Object.keys(this.factories).forEach((f) => (this.created[f] = []))
+    this.created = {};
+    Object.keys(this.factories).forEach(f => (this.created[f] = []));
   }
 
   static _checkRequirements() {
     try {
-      require('axios')
-      require('rosie')
+      require('axios');
+      require('rosie');
     } catch (e) {
-      return ['axios', 'rosie']
+      return ['axios', 'rosie'];
     }
   }
 
   _after() {
     if (!this.config.cleanup) {
-      return Promise.resolve()
+      return Promise.resolve();
     }
-    const promises = []
+    const promises = [];
     // clean up all created items
     for (const mutationName in this.created) {
-      const createdItems = this.created[mutationName]
-      if (!createdItems.length) continue
-      this.debug(`Deleting ${createdItems.length} ${mutationName}(s)`)
+      const createdItems = this.created[mutationName];
+      if (!createdItems.length) continue;
+      this.debug(`Deleting ${createdItems.length} ${mutationName}(s)`);
       for (const itemData of createdItems) {
-        promises.push(this._requestDelete(mutationName, itemData))
+        promises.push(this._requestDelete(mutationName, itemData));
       }
     }
-    return Promise.all(promises)
+    return Promise.all(promises);
   }
 
   /**
@@ -214,9 +213,9 @@ class GraphQLDataFactory extends Helper {
    * @param {*} params predefined parameters
    */
   mutateData(operation, params) {
-    const variables = this._createItem(operation, params)
-    this.debug(`Creating ${operation} ${JSON.stringify(variables)}`)
-    return this._requestCreate(operation, variables)
+    const variables = this._createItem(operation, params);
+    this.debug(`Creating ${operation} ${JSON.stringify(variables)}`);
+    return this._requestCreate(operation, variables);
   }
 
   /**
@@ -235,26 +234,26 @@ class GraphQLDataFactory extends Helper {
    * @param {*} params
    */
   mutateMultiple(operation, times, params) {
-    const promises = []
+    const promises = [];
     for (let i = 0; i < times; i++) {
-      promises.push(this.mutateData(operation, params))
+      promises.push(this.mutateData(operation, params));
     }
-    return Promise.all(promises)
+    return Promise.all(promises);
   }
 
   _createItem(operation, data) {
     if (!this.factories[operation]) {
-      throw new Error(`Mutation ${operation} is not defined in config.factories`)
+      throw new Error(`Mutation ${operation} is not defined in config.factories`);
     }
-    let modulePath = this.factories[operation].factory
+    let modulePath = this.factories[operation].factory;
     try {
       try {
-        require.resolve(modulePath)
+        require.resolve(modulePath);
       } catch (e) {
-        modulePath = path.join(global.codecept_dir, modulePath)
+        modulePath = path.join(global.codecept_dir, modulePath);
       }
-      const builder = require(modulePath)
-      return builder.build(data)
+      const builder = require(modulePath);
+      return builder.build(data);
     } catch (err) {
       throw new Error(`Couldn't load factory file from ${modulePath}, check that
 
@@ -265,7 +264,7 @@ class GraphQLDataFactory extends Helper {
         points to valid factory file.
         Factory file should export an object with build method.
 
-        Current file error: ${err.message}`)
+        Current file error: ${err.message}`);
     }
   }
 
@@ -277,13 +276,13 @@ class GraphQLDataFactory extends Helper {
    * @param {*} variables to be sent along with the query
    */
   _requestCreate(operation, variables) {
-    const { query } = this.factories[operation]
+    const { query } = this.factories[operation];
     return this.graphqlHelper.sendMutation(query, variables).then((response) => {
-      const data = response.data.data[operation]
-      this.created[operation].push(data)
-      this.debugSection('Created', `record: ${data}`)
-      return data
-    })
+      const data = response.data.data[operation];
+      this.created[operation].push(data);
+      this.debugSection('Created', `record: ${data}`);
+      return data;
+    });
   }
 
   /**
@@ -294,15 +293,16 @@ class GraphQLDataFactory extends Helper {
    * @param {*} data of the record to be deleted.
    */
   _requestDelete(operation, data) {
-    const deleteOperation = this.factories[operation].revert(data)
-    const { query, variables } = deleteOperation
+    const deleteOperation = this.factories[operation].revert(data);
+    const { query, variables } = deleteOperation;
 
-    return this.graphqlHelper.sendMutation(query, variables).then((response) => {
-      const idx = this.created[operation].indexOf(data)
-      this.debugSection('Deleted', `record: ${response.data.data}`)
-      this.created[operation].splice(idx, 1)
-    })
+    return this.graphqlHelper.sendMutation(query, variables)
+      .then((response) => {
+        const idx = this.created[operation].indexOf(data);
+        this.debugSection('Deleted', `record: ${response.data.data}`);
+        this.created[operation].splice(idx, 1);
+      });
   }
 }
 
-module.exports = GraphQLDataFactory
+export default GraphQLDataFactory;

package/lib/helper/JSONResponse.js

@@ -1,13 +1,12 @@
-const Helper = require('@codeceptjs/helper')
+import joi from 'joi';
+import Helper from '../helper.js';
 
-let expect
+let expect;
 
-import('chai').then((chai) => {
-  expect = chai.expect
-  chai.use(require('chai-deep-match'))
-})
-
-const joi = require('joi')
+import('chai').then(chai => {
+  expect = chai.expect;
+  chai.use(require('chai-deep-match'));
+});
 
 /**
  * This helper allows performing assertions on JSON responses paired with following helpers:
@@ -67,35 +66,33 @@ const joi = require('joi')
  */
 class JSONResponse extends Helper {
   constructor(config = {}) {
-    super(config)
+    super(config);
     this.options = {
       requestHelper: 'REST',
-    }
-    this.options = { ...this.options, ...config }
+    };
+    this.options = { ...this.options, ...config };
   }
 
   _beforeSuite() {
-    this.response = null
+    this.response = null;
     if (!this.helpers[this.options.requestHelper]) {
-      throw new Error(
-        `Error setting JSONResponse, helper ${this.options.requestHelper} is not enabled in config, helpers: ${Object.keys(this.helpers)}`,
-      )
+      throw new Error(`Error setting JSONResponse, helper ${this.options.requestHelper} is not enabled in config, helpers: ${Object.keys(this.helpers)}`);
     }
     // connect to REST helper
     this.helpers[this.options.requestHelper].config.onResponse = (response) => {
-      this.response = response
-    }
+      this.response = response;
+    };
   }
 
   _before() {
-    this.response = null
+    this.response = null;
   }
 
   static _checkRequirements() {
     try {
-      require('joi')
+      require('joi');
     } catch (e) {
-      return ['joi']
+      return ['joi'];
     }
   }
 
@@ -109,8 +106,8 @@ class JSONResponse extends Helper {
    * @param {number} code
    */
   seeResponseCodeIs(code) {
-    this._checkResponseReady()
-    expect(this.response.status).to.eql(code, 'Response code is not the same as expected')
+    this._checkResponseReady();
+    expect(this.response.status).to.eql(code, 'Response code is not the same as expected');
   }
 
   /**
@@ -123,35 +120,35 @@ class JSONResponse extends Helper {
    * @param {number} code
    */
   dontSeeResponseCodeIs(code) {
-    this._checkResponseReady()
-    expect(this.response.status).not.to.eql(code)
+    this._checkResponseReady();
+    expect(this.response.status).not.to.eql(code);
   }
 
   /**
    * Checks that the response code is 4xx
    */
   seeResponseCodeIsClientError() {
-    this._checkResponseReady()
-    expect(this.response.status).to.be.gte(400)
-    expect(this.response.status).to.be.lt(500)
+    this._checkResponseReady();
+    expect(this.response.status).to.be.gte(400);
+    expect(this.response.status).to.be.lt(500);
   }
 
   /**
    * Checks that the response code is 3xx
    */
   seeResponseCodeIsRedirection() {
-    this._checkResponseReady()
-    expect(this.response.status).to.be.gte(300)
-    expect(this.response.status).to.be.lt(400)
+    this._checkResponseReady();
+    expect(this.response.status).to.be.gte(300);
+    expect(this.response.status).to.be.lt(400);
   }
 
   /**
    * Checks that the response code is 5xx
    */
   seeResponseCodeIsServerError() {
-    this._checkResponseReady()
-    expect(this.response.status).to.be.gte(500)
-    expect(this.response.status).to.be.lt(600)
+    this._checkResponseReady();
+    expect(this.response.status).to.be.gte(500);
+    expect(this.response.status).to.be.lt(600);
   }
 
   /**
@@ -163,9 +160,9 @@ class JSONResponse extends Helper {
    * ```
    */
   seeResponseCodeIsSuccessful() {
-    this._checkResponseReady()
-    expect(this.response.status).to.be.gte(200)
-    expect(this.response.status).to.be.lt(300)
+    this._checkResponseReady();
+    expect(this.response.status).to.be.gte(200);
+    expect(this.response.status).to.be.lt(300);
   }
 
   /**
@@ -186,19 +183,19 @@ class JSONResponse extends Helper {
    * @param {object} json
    */
   seeResponseContainsJson(json = {}) {
-    this._checkResponseReady()
+    this._checkResponseReady();
     if (Array.isArray(this.response.data)) {
-      let fails = 0
+      let fails = 0;
       for (const el of this.response.data) {
         try {
-          expect(el).to.deep.match(json)
+          expect(el).to.deep.match(json);
         } catch (err) {
-          fails++
+          fails++;
         }
       }
-      expect(fails < this.response.data.length, `No elements in array matched ${JSON.stringify(json)}`).to.be.true
+      expect(fails < this.response.data.length, `No elements in array matched ${JSON.stringify(json)}`).to.be.true;
     } else {
-      expect(this.response.data).to.deep.match(json)
+      expect(this.response.data).to.deep.match(json);
     }
   }
 
@@ -220,11 +217,11 @@ class JSONResponse extends Helper {
    * @param {object} json
    */
   dontSeeResponseContainsJson(json = {}) {
-    this._checkResponseReady()
+    this._checkResponseReady();
     if (Array.isArray(this.response.data)) {
-      this.response.data.forEach((data) => expect(data).not.to.deep.match(json))
+      this.response.data.forEach(data => expect(data).not.to.deep.match(json));
     } else {
-      expect(this.response.data).not.to.deep.match(json)
+      expect(this.response.data).not.to.deep.match(json);
     }
   }
 
@@ -248,11 +245,11 @@ class JSONResponse extends Helper {
    * @param {array} keys
    */
   seeResponseContainsKeys(keys = []) {
-    this._checkResponseReady()
+    this._checkResponseReady();
     if (Array.isArray(this.response.data)) {
-      this.response.data.forEach((data) => expect(data).to.include.keys(keys))
+      this.response.data.forEach(data => expect(data).to.include.keys(keys));
     } else {
-      expect(this.response.data).to.include.keys(keys)
+      expect(this.response.data).to.include.keys(keys);
     }
   }
 
@@ -270,10 +267,10 @@ class JSONResponse extends Helper {
    * @param {function} fn
    */
   seeResponseValidByCallback(fn) {
-    this._checkResponseReady()
-    fn({ ...this.response, expect })
-    const body = fn.toString()
-    fn.toString = () => `${body.split('\n')[1]}...`
+    this._checkResponseReady();
+    fn({ ...this.response, expect });
+    const body = fn.toString();
+    fn.toString = () => `${body.split('\n')[1]}...`;
   }
 
   /**
@@ -287,8 +284,8 @@ class JSONResponse extends Helper {
    * @param {object} resp
    */
   seeResponseEquals(resp) {
-    this._checkResponseReady()
-    expect(this.response.data).to.deep.equal(resp)
+    this._checkResponseReady();
+    expect(this.response.data).to.deep.equal(resp);
   }
 
   /**
@@ -319,22 +316,22 @@ class JSONResponse extends Helper {
    * @param {any} fnOrSchema
    */
   seeResponseMatchesJsonSchema(fnOrSchema) {
-    this._checkResponseReady()
-    let schema = fnOrSchema
+    this._checkResponseReady();
+    let schema = fnOrSchema;
     if (typeof fnOrSchema === 'function') {
-      schema = fnOrSchema(joi)
-      const body = fnOrSchema.toString()
-      fnOrSchema.toString = () => `${body.split('\n')[1]}...`
+      schema = fnOrSchema(joi);
+      const body = fnOrSchema.toString();
+      fnOrSchema.toString = () => `${body.split('\n')[1]}...`;
     }
-    if (!schema) throw new Error('Empty Joi schema provided, see https://joi.dev/ for details')
-    if (!joi.isSchema(schema)) throw new Error('Invalid Joi schema provided, see https://joi.dev/ for details')
-    schema.toString = () => schema.describe()
-    joi.assert(this.response.data, schema)
+    if (!schema) throw new Error('Empty Joi schema provided, see https://joi.dev/ for details');
+    if (!joi.isSchema(schema)) throw new Error('Invalid Joi schema provided, see https://joi.dev/ for details');
+    schema.toString = () => schema.describe();
+    joi.assert(this.response.data, schema);
   }
 
   _checkResponseReady() {
-    if (!this.response) throw new Error('Response is not available')
+    if (!this.response) throw new Error('Response is not available');
   }
 }
 
-module.exports = JSONResponse
+export default JSONResponse;