codeceptjs 2.3.4 → 2.4.1

package/docs/build/FileSystem.js

@@ -1,10 +1,11 @@
+const assert = require('assert');
+const path = require('path');
+const fs = require('fs');
+
 const Helper = require('../helper');
 const fileExists = require('../utils').fileExists;
 const fileIncludes = require('../assert/include').fileIncludes;
 const fileEquals = require('../assert/equal').fileEquals;
-const assert = require('assert');
-const path = require('path');
-const fs = require('fs');
 
 /**
  * Helper for testing filesystem.
@@ -33,6 +34,7 @@ class FileSystem extends Helper {
   /**
    * Enters a directory In local filesystem.
    * Starts from a current directory
+   * @param {string} openPath
    */
   amInPath(openPath) {
     this.dir = path.join(global.codecept_dir, openPath);
@@ -41,6 +43,8 @@ class FileSystem extends Helper {
 
   /**
    * Writes test to file
+   * @param {string} name
+   * @param {string} text
    */
   writeToFile(name, text) {
     fs.writeFileSync(path.join(this.dir, name), text);
@@ -48,6 +52,7 @@ class FileSystem extends Helper {
 
   /**
    * Checks that file exists
+   * @param {string} name
    */
   seeFile(name) {
     this.file = path.join(this.dir, name);
@@ -55,8 +60,27 @@ class FileSystem extends Helper {
     assert.ok(fileExists(this.file), `File ${name} not found in ${this.dir}`);
   }
 
+  /**
+  * 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');
+  * ```
+  */
+  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
    */
   seeInThisFile(text, encoding) {
     const content = getFileContents(this.file, encoding);
@@ -65,6 +89,8 @@ class FileSystem extends Helper {
 
   /**
    * Checks that file found by `seeFile` doesn't include text.
+   * @param {string} text
+   * @param {string} encoding
    */
   dontSeeInThisFile(text, encoding) {
     const content = getFileContents(this.file, encoding);
@@ -73,6 +99,8 @@ class FileSystem extends Helper {
 
   /**
    * Checks that contents of file found by `seeFile` equal to text.
+   * @param {string} text
+   * @param {string} encoding
    */
   seeFileContentsEqual(text, encoding) {
     const content = getFileContents(this.file, encoding);
@@ -81,11 +109,28 @@ class FileSystem extends Helper {
 
   /**
    * Checks that contents of file found by `seeFile` doesn't equal to text.
+   * @param {string} text
+   * @param {string} encoding
    */
   dontSeeFileContentsEqual(text, encoding) {
     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());
+  }
 }
 
 function getFileContents(file, encoding) {

package/docs/build/GraphQL.js

@@ -1,6 +1,7 @@
-const Helper = require('../helper');
 const requireg = require('requireg');
 
+const Helper = require('../helper');
+
 let axios = requireg('axios');
 let headers = {};
 
@@ -49,7 +50,7 @@ class GraphQL extends Helper {
       endpoint: '',
     };
     this.options = Object.assign(this.options, config);
-    headers = Object.assign({}, this.options.defaultHeaders);
+    headers = { ...this.options.defaultHeaders };
     axios.defaults.headers = this.options.defaultHeaders;
   }
 

package/docs/build/GraphQLDataFactory.js

@@ -1,5 +1,6 @@
 const path = require('path');
 const requireg = require('requireg');
+
 const Helper = require('../helper');
 const GraphQL = require('./GraphQL');
 

package/docs/build/Mochawesome.js

@@ -1,10 +1,11 @@
 let addMochawesomeContext;
 let currentTest;
 let currentSuite;
+
+const requireg = require('requireg');
+
 const Helper = require('../helper');
 const clearString = require('../utils').clearString;
-const requireg = require('requireg');
-const path = require('path');
 
 
 class Mochawesome extends Helper {

package/docs/build/MockRequest.js

@@ -1,5 +1,6 @@
-const Helper = require('../helper');
 const requireg = require('requireg');
+
+const Helper = require('../helper');
 const { appendBaseUrl } = require('../utils');
 const pollyWebDriver = require('./clientscripts/PollyWebDriverExt');
 
@@ -32,7 +33,22 @@ let PollyJS;
  *    MockRequest: {}
  * }
  * ```
- * The same can be done when using WebDriver helper..
+ *
+ * > Partially works with WebDriver helper
+ *
+ * [Polly config options](https://netflix.github.io/pollyjs/#/configuration?id=configuration) can be passed as well:
+ *
+ * ```js
+ * // enable replay mode
+ * helpers: {
+ *  Puppeteer: {
+ *    // regular Puppeteer config here
+ *  },
+ *  MockRequest: {
+ *     mode: 'replay',
+ *  },
+ * }
+ * ```
  *
  * ### Usage
  *
@@ -101,13 +117,15 @@ class MockRequest extends Helper {
     }
     await page.setRequestInterception(true);
 
-    this.polly = new PollyJS(title, {
+    const defaultConfig = {
       mode: 'passthrough',
       adapters: ['puppeteer'],
       adapterOptions: {
         puppeteer: { page },
       },
-    });
+    };
+
+    this.polly = new PollyJS(title, { ...defaultConfig, ...this.options });
   }
 
   /**
@@ -140,7 +158,7 @@ class MockRequest extends Helper {
    * I.mockRequest('GET', ['/secrets', '/v2/secrets'], 403);
    * ```
    * @param {string} method request method. Can be `GET`, `POST`, `PUT`, etc or `ANY`.
-   * @param {string|array} oneOrMoreUrls url(s) to mock. Can be exact URL, a pattern, or an array of URLs.
+   * @param {string|string[]} oneOrMoreUrls url(s) to mock. Can be exact URL, a pattern, or an array of URLs.
    * @param {number|string|object} dataOrStatusCode status code when number provided. A response body otherwise
    * @param {string|object} additionalData response body when a status code is set by previous parameter.
    *