codeceptjs 3.6.4 → 3.6.5-beta.1

package/lib/helper/JSONResponse.js

@@ -1,13 +1,13 @@
-const Helper = require('@codeceptjs/helper');
+const Helper = require('@codeceptjs/helper')
 
-let expect;
+let expect
 
-import('chai').then(chai => {
-  expect = chai.expect;
-  chai.use(require('chai-deep-match'));
-});
+import('chai').then((chai) => {
+  expect = chai.expect
+  chai.use(require('chai-deep-match'))
+})
 
-const joi = require('joi');
+const joi = require('joi')
 
 /**
  * This helper allows performing assertions on JSON responses paired with following helpers:
@@ -67,33 +67,35 @@ 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']
     }
   }
 
@@ -107,8 +109,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')
   }
 
   /**
@@ -121,35 +123,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)
   }
 
   /**
@@ -161,9 +163,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)
   }
 
   /**
@@ -184,19 +186,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)
     }
   }
 
@@ -218,11 +220,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)
     }
   }
 
@@ -246,11 +248,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)
     }
   }
 
@@ -268,10 +270,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]}...`
   }
 
   /**
@@ -285,8 +287,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)
   }
 
   /**
@@ -317,22 +319,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;
+module.exports = JSONResponse

package/lib/helper/Mochawesome.js

@@ -1,71 +1,71 @@
-let addMochawesomeContext;
-let currentTest;
-let currentSuite;
+let addMochawesomeContext
+let currentTest
+let currentSuite
 
-const Helper = require('@codeceptjs/helper');
-const { clearString } = require('../utils');
+const Helper = require('@codeceptjs/helper')
+const { clearString } = require('../utils')
 
 class Mochawesome extends Helper {
   constructor(config) {
-    super(config);
+    super(config)
 
     // set defaults
     this.options = {
       uniqueScreenshotNames: false,
       disableScreenshots: false,
-    };
+    }
 
-    addMochawesomeContext = require('mochawesome/addContext');
-    this._createConfig(config);
+    addMochawesomeContext = require('mochawesome/addContext')
+    this._createConfig(config)
   }
 
   _createConfig(config) {
     // override defaults with config
-    Object.assign(this.options, config);
+    Object.assign(this.options, config)
   }
 
   _beforeSuite(suite) {
-    currentSuite = suite;
-    currentTest = '';
+    currentSuite = suite
+    currentTest = ''
   }
 
   _before() {
     if (currentSuite && currentSuite.ctx) {
-      currentTest = { test: currentSuite.ctx.currentTest };
+      currentTest = { test: currentSuite.ctx.currentTest }
     }
   }
 
   _test(test) {
-    currentTest = { test };
+    currentTest = { test }
   }
 
   _failed(test) {
-    if (this.options.disableScreenshots) return;
-    let fileName;
+    if (this.options.disableScreenshots) return
+    let fileName
     // Get proper name if we are fail on hook
     if (test.ctx.test.type === 'hook') {
-      currentTest = { test: test.ctx.test };
+      currentTest = { test: test.ctx.test }
       // ignore retries if we are in hook
-      test._retries = -1;
-      fileName = clearString(`${test.title}_${currentTest.test.title}`);
+      test._retries = -1
+      fileName = clearString(`${test.title}_${currentTest.test.title}`)
     } else {
-      currentTest = { test };
-      fileName = clearString(test.title);
+      currentTest = { test }
+      fileName = clearString(test.title)
     }
     if (this.options.uniqueScreenshotNames) {
-      const uuid = test.uuid || test.ctx.test.uuid;
-      fileName = `${fileName.substring(0, 10)}_${uuid}`;
+      const uuid = test.uuid || test.ctx.test.uuid
+      fileName = `${fileName.substring(0, 10)}_${uuid}`
     }
     if (test._retries < 1 || test._retries === test.retryNum) {
-      fileName = `${fileName}.failed.png`;
-      return addMochawesomeContext(currentTest, fileName);
+      fileName = `${fileName}.failed.png`
+      return addMochawesomeContext(currentTest, fileName)
     }
   }
 
   addMochawesomeContext(context) {
-    if (currentTest === '') currentTest = { test: currentSuite.ctx.test };
-    return addMochawesomeContext(currentTest, context);
+    if (currentTest === '') currentTest = { test: currentSuite.ctx.test }
+    return addMochawesomeContext(currentTest, context)
   }
 }
 
-module.exports = Mochawesome;
+module.exports = Mochawesome

package/lib/helper/MockServer.js

@@ -1,4 +1,4 @@
-const { mock, settings } = require('pactum');
+const { mock, settings } = require('pactum')
 
 /**
  * ## Configuration
@@ -18,7 +18,7 @@ let config = {
     key: '',
     cert: '',
   },
-};
+}
 
 /**
  * MockServer
@@ -141,10 +141,10 @@ let config = {
  */
 class MockServer {
   constructor(passedConfig) {
-    settings.setLogLevel('SILENT');
-    config = { ...passedConfig };
+    settings.setLogLevel('SILENT')
+    config = { ...passedConfig }
     if (global.debugMode) {
-      settings.setLogLevel('VERBOSE');
+      settings.setLogLevel('VERBOSE')
     }
   }
 
@@ -155,10 +155,10 @@ class MockServer {
    * @returns void
    */
   async startMockServer(port) {
-    const _config = { ...config };
-    if (port) _config.port = port;
-    await mock.setDefaults(_config);
-    await mock.start();
+    const _config = { ...config }
+    if (port) _config.port = port
+    await mock.setDefaults(_config)
+    await mock.start()
   }
 
   /**
@@ -168,7 +168,7 @@ class MockServer {
    *
    */
   async stopMockServer() {
-    await mock.stop();
+    await mock.stop()
   }
 
   /**
@@ -214,8 +214,8 @@ class MockServer {
    *
    */
   async addInteractionToMockServer(interaction) {
-    await mock.addInteraction(interaction);
+    await mock.addInteraction(interaction)
   }
 }
 
-module.exports = MockServer;
+module.exports = MockServer