codeceptjs 3.4.1 → 3.5.1-2.beta.7

package/docs/build/FileSystem.js

@@ -1,228 +0,0 @@
-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');
-
-/**
- * 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
- */
-class FileSystem extends Helper {
-  constructor() {
-    super();
-    this.dir = global.codecept_dir;
-    this.file = '';
-  }
-
-  _before() {
-    this.debugSection('Dir', this.dir);
-  }
-
-  /**
-   * Enters a directory In local filesystem.
-   * Starts from a current directory
-   * @param {string} openPath
-   */
-  amInPath(openPath) {
-    this.dir = path.join(global.codecept_dir, openPath);
-    this.debugSection('Dir', this.dir);
-  }
-
-  /**
-   * Writes test to file
-   * @param {string} name
-   * @param {string} text
-   */
-  writeToFile(name, text) {
-    fs.writeFileSync(path.join(this.dir, name), text);
-  }
-
-  /**
-   * Checks that file exists
-   * @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}`);
-  }
-
-  /**
-   * 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
-   * ```
-   * @param {string} name
-   * @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);
-    return isFileExists(this.file, waitTimeout).catch(() => {
-      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
-  */
-  seeFileNameMatching(text) {
-    assert.ok(
-      this.grabFileNames().some(file => file.includes(text)),
-      `File name which contains ${text} not found in ${this.dir}`,
-    );
-  }
-
-  /**
-   * Checks that file found by `seeFile` includes a text.
-   * @param {string} text
-   * @param {string} [encoding='utf8']
-   */
-  seeInThisFile(text, encoding = 'utf8') {
-    const content = getFileContents(this.file, encoding);
-    fileIncludes(this.file).assert(text, content);
-  }
-
-  /**
-   * Checks that file found by `seeFile` doesn't include text.
-   * @param {string} text
-   * @param {string} [encoding='utf8']
-   */
-  dontSeeInThisFile(text, encoding = 'utf8') {
-    const content = getFileContents(this.file, encoding);
-    fileIncludes(this.file).negate(text, content);
-  }
-
-  /**
-   * Checks that contents of file found by `seeFile` equal to text.
-   * @param {string} text
-   * @param {string} [encoding='utf8']
-   */
-  seeFileContentsEqual(text, encoding = 'utf8') {
-    const content = getFileContents(this.file, encoding);
-    fileEquals(this.file).assert(text, content);
-  }
-
-  /**
-   * Checks that contents of the file found by `seeFile` equal to contents of the file at `pathToReferenceFile`.
-   * @param {string} pathToReferenceFile
-   * @param {string} [encoding='utf8']
-   * @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);
-  }
-
-  /**
-   * Checks that contents of file found by `seeFile` doesn't equal to text.
-   * @param {string} text
-   * @param {string} [encoding='utf8']
-   */
-  dontSeeFileContentsEqual(text, encoding = 'utf8') {
-    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();
-  * ```
-  */
-  grabFileNames() {
-    return fs.readdirSync(this.dir)
-      .filter(item => !fs.lstatSync(path.join(this.dir, item)).isDirectory());
-  }
-}
-
-module.exports = FileSystem;
-
-/**
- * @param {string} file
- * @param {string} [encoding='utf8']
- * @private
- * @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);
-}
-
-/**
- * @param {string} file
- * @param {number} timeout
- * @private
- * @returns {Promise<any>}
- */
-function isFileExists(file, timeout) {
-  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);
-
-    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();
-      }
-    });
-
-    fs.access(file, fs.constants.R_OK, (err) => {
-      if (!err) {
-        clearTimeout(timer);
-        watcher.close();
-        resolve();
-      }
-    });
-  }));
-}

package/docs/build/GraphQL.js

@@ -1,204 +0,0 @@
-const axios = require('axios').default;
-const Helper = require('@codeceptjs/helper');
-
-/**
- * GraphQL helper allows to send additional requests to a GraphQl endpoint during acceptance tests.
- * [Axios](https://github.com/axios/axios) 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
- */
-class GraphQL extends Helper {
-  constructor(config) {
-    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;
-  }
-
-  static _checkRequirements() {
-    try {
-      require('axios');
-    } catch (e) {
-      return ['axios'];
-    }
-  }
-
-  static _config() {
-    return [
-      { name: 'endpoint', message: 'Endpoint of API you are going to test', default: 'http://localhost:3000/graphql' },
-    ];
-  }
-
-  /**
-   * Executes query via axios call
-   *
-   * @param {object} request
-   */
-  async _executeQuery(request) {
-    this.axios.defaults.timeout = request.timeout || this.options.timeout;
-
-    if (this.headers && this.headers.auth) {
-      request.auth = this.headers.auth;
-    }
-
-    request.headers = Object.assign(request.headers, {
-      'Content-Type': 'application/json',
-    });
-
-    if (this.config.onRequest) {
-      await this.config.onRequest(request);
-    }
-
-    this.debugSection('Request', JSON.stringify(request));
-
-    let response;
-    try {
-      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 (this.config.onResponse) {
-      await this.config.onResponse(response);
-    }
-
-    this.debugSection('Response', JSON.stringify(response.data));
-    return response;
-  }
-
-  /**
-   * Prepares request for axios call
-   *
-   * @param {object} operation
-   * @param {object} headers
-   * @return {object} graphQLRequest
-   */
-  _prepareGraphQLRequest(operation, headers) {
-    return {
-      baseURL: this.options.endpoint,
-      method: 'POST',
-      data: operation,
-      headers,
-    };
-  }
-
-  /**
-   * 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;
-   * ```
-   *
-   * @param {String} query
-   * @param {object} [variables] that may go along with the query
-   * @param {object} [options] are additional query options
-   * @param {object} [headers]
-   * @return Promise<any>
-   */
-  async sendQuery(query, variables, options = {}, headers = {}) {
-    if (typeof query !== 'string') {
-      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);
-  }
-
-  /**
-   * 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'
-   *     }
-   *   },
-   * });
-   * ```
-   *
-   * @param {String} mutation
-   * @param {object} [variables] that may go along with the mutation
-   * @param {object} [options] are additional query options
-   * @param {object} [headers]
-   * @return Promise<any>
-   */
-  async sendMutation(mutation, variables, options = {}, headers = {}) {
-    if (typeof mutation !== 'string') {
-      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);
-  }
-
-  _setRequestTimeout(newTimeout) {
-    this.options.timeout = newTimeout;
-  }
-}
-module.exports = GraphQL;