codeceptjs 3.6.4 → 3.6.5-beta.1

package/lib/helper/FileSystem.js

@@ -1,11 +1,11 @@
-const assert = require('assert');
-const path = require('path');
-const fs = require('fs');
+const assert = require('assert')
+const path = require('path')
+const fs = require('fs')
 
-const Helper = require('@codeceptjs/helper');
-const { fileExists } = require('../utils');
-const { fileIncludes } = require('../assert/include');
-const { fileEquals } = require('../assert/equal');
+const Helper = require('@codeceptjs/helper')
+const { fileExists } = require('../utils')
+const { fileIncludes } = require('../assert/include')
+const { fileEquals } = require('../assert/equal')
 
 /**
  * Helper for testing filesystem.
@@ -32,13 +32,13 @@ const { fileEquals } = require('../assert/equal');
  */
 class FileSystem extends Helper {
   constructor() {
-    super();
-    this.dir = global.codecept_dir;
-    this.file = '';
+    super()
+    this.dir = global.codecept_dir
+    this.file = ''
   }
 
   _before() {
-    this.debugSection('Dir', this.dir);
+    this.debugSection('Dir', this.dir)
   }
 
   /**
@@ -47,8 +47,8 @@ class FileSystem extends Helper {
    * @param {string} openPath
    */
   amInPath(openPath) {
-    this.dir = path.join(global.codecept_dir, openPath);
-    this.debugSection('Dir', this.dir);
+    this.dir = path.join(global.codecept_dir, openPath)
+    this.debugSection('Dir', this.dir)
   }
 
   /**
@@ -57,7 +57,7 @@ class FileSystem extends Helper {
    * @param {string} text
    */
   writeToFile(name, text) {
-    fs.writeFileSync(path.join(this.dir, name), text);
+    fs.writeFileSync(path.join(this.dir, name), text)
   }
 
   /**
@@ -65,9 +65,9 @@ class FileSystem extends Helper {
    * @param {string} name
    */
   seeFile(name) {
-    this.file = path.join(this.dir, name);
-    this.debugSection('File', this.file);
-    assert.ok(fileExists(this.file), `File ${name} not found in ${this.dir}`);
+    this.file = path.join(this.dir, name)
+    this.debugSection('File', this.file)
+    assert.ok(fileExists(this.file), `File ${name} not found in ${this.dir}`)
   }
 
   /**
@@ -83,31 +83,31 @@ class FileSystem extends Helper {
    * @param {number} [sec=1] seconds to wait
    */
   async waitForFile(name, sec = 1) {
-    if (sec === 0) assert.fail('Use `seeFile` instead of waiting 0 seconds!');
-    const waitTimeout = sec * 1000;
-    this.file = path.join(this.dir, name);
-    this.debugSection('File', this.file);
+    if (sec === 0) assert.fail('Use `seeFile` instead of waiting 0 seconds!')
+    const waitTimeout = sec * 1000
+    this.file = path.join(this.dir, name)
+    this.debugSection('File', this.file)
     return isFileExists(this.file, waitTimeout).catch(() => {
-      throw new Error(`file (${name}) still not present in directory ${this.dir} after ${waitTimeout / 1000} sec`);
-    });
+      throw new Error(`file (${name}) still not present in directory ${this.dir} after ${waitTimeout / 1000} sec`)
+    })
   }
 
   /**
-  * 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');
-  * ```
-  * @param {string} text
-  */
+   * 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');
+   * ```
+   * @param {string} text
+   */
   seeFileNameMatching(text) {
     assert.ok(
-      this.grabFileNames().some(file => file.includes(text)),
+      this.grabFileNames().some((file) => file.includes(text)),
       `File name which contains ${text} not found in ${this.dir}`,
-    );
+    )
   }
 
   /**
@@ -116,8 +116,8 @@ class FileSystem extends Helper {
    * @param {string} [encoding='utf8']
    */
   seeInThisFile(text, encoding = 'utf8') {
-    const content = getFileContents(this.file, encoding);
-    fileIncludes(this.file).assert(text, content);
+    const content = getFileContents(this.file, encoding)
+    fileIncludes(this.file).assert(text, content)
   }
 
   /**
@@ -126,8 +126,8 @@ class FileSystem extends Helper {
    * @param {string} [encoding='utf8']
    */
   dontSeeInThisFile(text, encoding = 'utf8') {
-    const content = getFileContents(this.file, encoding);
-    fileIncludes(this.file).negate(text, content);
+    const content = getFileContents(this.file, encoding)
+    fileIncludes(this.file).negate(text, content)
   }
 
   /**
@@ -136,8 +136,8 @@ class FileSystem extends Helper {
    * @param {string} [encoding='utf8']
    */
   seeFileContentsEqual(text, encoding = 'utf8') {
-    const content = getFileContents(this.file, encoding);
-    fileEquals(this.file).assert(text, content);
+    const content = getFileContents(this.file, encoding)
+    fileEquals(this.file).assert(text, content)
   }
 
   /**
@@ -147,11 +147,11 @@ class FileSystem extends Helper {
    * @param {string} [encodingReference='utf8']
    */
   seeFileContentsEqualReferenceFile(pathToReferenceFile, encoding = 'utf8', encodingReference = '') {
-    const content = getFileContents(this.file, encoding);
-    assert.ok(fileExists(pathToReferenceFile), `Reference file ${pathToReferenceFile} not found.`);
-    encodingReference = encodingReference || encoding;
-    const expectedContent = getFileContents(pathToReferenceFile, encodingReference);
-    fileEquals(this.file).assert(expectedContent, content);
+    const content = getFileContents(this.file, encoding)
+    assert.ok(fileExists(pathToReferenceFile), `Reference file ${pathToReferenceFile} not found.`)
+    encodingReference = encodingReference || encoding
+    const expectedContent = getFileContents(pathToReferenceFile, encodingReference)
+    fileEquals(this.file).assert(expectedContent, content)
   }
 
   /**
@@ -160,27 +160,26 @@ class FileSystem extends Helper {
    * @param {string} [encoding='utf8']
    */
   dontSeeFileContentsEqual(text, encoding = 'utf8') {
-    const content = getFileContents(this.file, encoding);
-    fileEquals(this.file).negate(text, content);
+    const content = getFileContents(this.file, encoding)
+    fileEquals(this.file).negate(text, content)
   }
 
   /**
-  * Returns file names in current directory.
-  *
-  * ```js
-  * I.handleDownloads();
-  * I.click('Download Files');
-  * I.amInPath('output/downloads');
-  * const downloadedFileNames = I.grabFileNames();
-  * ```
-  */
+   * Returns file names in current directory.
+   *
+   * ```js
+   * I.handleDownloads();
+   * I.click('Download Files');
+   * I.amInPath('output/downloads');
+   * const downloadedFileNames = I.grabFileNames();
+   * ```
+   */
   grabFileNames() {
-    return fs.readdirSync(this.dir)
-      .filter(item => !fs.lstatSync(path.join(this.dir, item)).isDirectory());
+    return fs.readdirSync(this.dir).filter((item) => !fs.lstatSync(path.join(this.dir, item)).isDirectory())
   }
 }
 
-module.exports = FileSystem;
+module.exports = FileSystem
 
 /**
  * @param {string} file
@@ -189,9 +188,9 @@ module.exports = FileSystem;
  * @returns {string}
  */
 function getFileContents(file, encoding = 'utf8') {
-  if (!file) assert.fail('No files were opened, please use seeFile action');
-  if (encoding === '') assert.fail('Encoding is an empty string, please set a valid encoding');
-  return fs.readFileSync(file, encoding);
+  if (!file) assert.fail('No files were opened, please use seeFile action')
+  if (encoding === '') assert.fail('Encoding is an empty string, please set a valid encoding')
+  return fs.readFileSync(file, encoding)
 }
 
 /**
@@ -201,28 +200,28 @@ function getFileContents(file, encoding = 'utf8') {
  * @returns {Promise<any>}
  */
 function isFileExists(file, timeout) {
-  return new Promise(((resolve, reject) => {
+  return new Promise((resolve, reject) => {
     const timer = setTimeout(() => {
-      watcher.close();
-      reject(new Error('File did not exists and was not created during the timeout.'));
-    }, timeout);
+      watcher.close()
+      reject(new Error('File did not exists and was not created during the timeout.'))
+    }, timeout)
 
-    const dir = path.dirname(file);
-    const basename = path.basename(file);
+    const dir = path.dirname(file)
+    const basename = path.basename(file)
     const watcher = fs.watch(dir, (eventType, filename) => {
       if (eventType === 'rename' && filename === basename) {
-        clearTimeout(timer);
-        watcher.close();
-        resolve();
+        clearTimeout(timer)
+        watcher.close()
+        resolve()
       }
-    });
+    })
 
     fs.access(file, fs.constants.R_OK, (err) => {
       if (!err) {
-        clearTimeout(timer);
-        watcher.close();
-        resolve();
+        clearTimeout(timer)
+        watcher.close()
+        resolve()
       }
-    });
-  }));
+    })
+  })
 }

package/lib/helper/GraphQL.js

@@ -1,5 +1,5 @@
-const axios = require('axios').default;
-const Helper = require('@codeceptjs/helper');
+const axios = require('axios').default
+const Helper = require('@codeceptjs/helper')
 
 /**
  * GraphQL helper allows to send additional requests to a GraphQl endpoint during acceptance tests.
@@ -38,31 +38,35 @@ 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',
+      },
+    ]
   }
 
   /**
@@ -71,42 +75,39 @@ 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
   }
 
   /**
@@ -122,7 +123,7 @@ class GraphQL extends Helper {
       method: 'POST',
       data: operation,
       headers,
-    };
+    }
   }
 
   /**
@@ -148,15 +149,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)
   }
 
   /**
@@ -188,19 +189,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
   }
 
   /**
@@ -209,7 +210,7 @@ class GraphQL extends Helper {
    * @param {object} headers headers list
    */
   haveRequestHeaders(headers) {
-    this.headers = { ...this.headers, ...headers };
+    this.headers = { ...this.headers, ...headers }
   }
 
   /**
@@ -223,7 +224,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;
+module.exports = GraphQL

package/lib/helper/GraphQLDataFactory.js

@@ -1,7 +1,7 @@
-const path = require('path');
+const path = require('path')
 
-const Helper = require('@codeceptjs/helper');
-const GraphQL = require('./GraphQL');
+const Helper = require('@codeceptjs/helper')
+const GraphQL = require('./GraphQL')
 
 /**
  * Helper for managing remote data using GraphQL queries.
@@ -151,52 +151,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 +214,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 +235,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 +265,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 +277,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,16 +294,15 @@ 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;
+module.exports = GraphQLDataFactory