codeceptjs 3.0.6 → 3.1.2

package/lib/mochaFactory.js

@@ -17,12 +17,6 @@ class MochaFactory {
     output.process(opts.child);
     mocha.ui(scenarioUi);
 
-    // process.on('unhandledRejection', (reason) => {
-    //   output.error('Unhandled rejection');
-    //   console.log(Error.captureStackTrace(reason));
-    //   output.error(reason);
-    // });
-
     Mocha.Runner.prototype.uncaught = function (err) {
       if (err) {
         if (err.toString().indexOf('ECONNREFUSED') >= 0) {
@@ -51,19 +45,30 @@ class MochaFactory {
 
         // add ids for each test and check uniqueness
         const dupes = [];
+        let missingFeatureInFile = [];
         const seenTests = [];
         mocha.suite.eachTest(test => {
           test.id = genTestId(test);
+
           const name = test.fullTitle();
           if (seenTests.includes(test.id)) {
             dupes.push(name);
           }
           seenTests.push(test.id);
+
+          if (name.slice(0, name.indexOf(':')) === '') {
+            missingFeatureInFile.push(test.file);
+          }
         });
         if (dupes.length) {
           // ideally this should be no-op and throw (breaking change)...
           output.error(`Duplicate test names detected - Feature + Scenario name should be unique:\n${dupes.join('\n')}`);
         }
+
+        if (missingFeatureInFile.length) {
+          missingFeatureInFile = [...new Set(missingFeatureInFile)];
+          output.error(`Missing Feature section in:\n${missingFeatureInFile.join('\n')}`);
+        }
       }
     };
 

package/lib/output.js

@@ -190,6 +190,9 @@ module.exports = {
    * @param {string} [color]
    */
   say(message, color = 'cyan') {
+    if (colors[color] === undefined) {
+      color = 'cyan';
+    }
     if (outputLevel >= 1) print(`   ${colors[color].bold(message)}`);
   },
 
@@ -232,8 +235,8 @@ function print(...msg) {
 }
 
 function truncate(msg, gap = 0) {
-  if (msg.indexOf('\n') > 0) {
-    return msg; // don't cut multi line steps
+  if (msg.indexOf('\n') > 0 || outputLevel >= 3) {
+    return msg; // don't cut multi line steps or on verbose log level
   }
   const width = (process.stdout.columns || 200) - gap - 4;
   if (msg.length > width) {

package/lib/plugin/allure.js

@@ -83,7 +83,6 @@ module.exports = (config) => {
 
   let currentMetaStep = [];
   let currentStep;
-  let isHookSteps = false;
 
   reporter.pendingCase = function (testName, timestamp, opts = {}) {
     reporter.startCase(testName, timestamp);
@@ -191,14 +190,6 @@ module.exports = (config) => {
     }
   });
 
-  event.dispatcher.on(event.hook.started, () => {
-    isHookSteps = true;
-  });
-
-  event.dispatcher.on(event.hook.passed, () => {
-    isHookSteps = false;
-  });
-
   event.dispatcher.on(event.suite.after, () => {
     reporter.endSuite();
   });
@@ -258,15 +249,13 @@ module.exports = (config) => {
   });
 
   event.dispatcher.on(event.step.started, (step) => {
-    if (isHookSteps === false) {
-      startMetaStep(step.metaStep);
-      if (currentStep !== step) {
-        // In multi-session scenarios, actors' names will be highlighted with ANSI
-        // escape sequences which are invalid XML values
-        step.actor = step.actor.replace(ansiRegExp(), '');
-        reporter.startStep(step.toString());
-        currentStep = step;
-      }
+    startMetaStep(step.metaStep);
+    if (currentStep !== step) {
+      // In multi-session scenarios, actors' names will be highlighted with ANSI
+      // escape sequences which are invalid XML values
+      step.actor = step.actor.replace(ansiRegExp(), '');
+      reporter.startStep(step.toString());
+      currentStep = step;
     }
   });
 

package/lib/plugin/commentStep.js

@@ -41,7 +41,7 @@ const defaultGlobalName = '__';
  * ### Config
  *
  * * `enabled` - (default: false) enable a plugin
- * * `regusterGlobal` - (default: false) register `__` template literal function globally. You can override function global name by providing a name as a value.
+ * * `registerGlobal` - (default: false) register `__` template literal function globally. You can override function global name by providing a name as a value.
  *
  * ### Examples
  *

package/lib/plugin/{puppeteerCoverage.js → coverage.js}

@@ -1,4 +1,4 @@
-const debug = require('debug')('codeceptjs:plugin:puppeteerCoverage');
+const debugModule = require('debug');
 const fs = require('fs');
 const path = require('path');
 
@@ -13,7 +13,7 @@ const defaultConfig = {
   uniqueFileName: true,
 };
 
-const supportedHelpers = ['Puppeteer'];
+const supportedHelpers = ['Puppeteer', 'Playwright'];
 
 function buildFileName(test, uniqueFileName) {
   let fileName = clearString(test.title);
@@ -41,15 +41,14 @@ function buildFileName(test, uniqueFileName) {
 }
 
 /**
- * Dumps puppeteers code coverage after every test.
+ * Dumps code coverage from Playwright/Puppeteer after every test.
  *
  * #### Configuration
  *
- * Configuration can either be taken from a corresponding helper (deprecated) or a from plugin config (recommended).
  *
  * ```js
  * plugins: {
- *    puppeteerCoverage: {
+ *    playwrightCoverage: {
  *      enabled: true
  *    }
  * }
@@ -59,33 +58,22 @@ function buildFileName(test, uniqueFileName) {
  *
  * * `coverageDir`: directory to dump coverage files
  * * `uniqueFileName`: generate a unique filename by adding uuid
- *
- *  First of all, your mileage may vary!
- *
- *  To work, you need the client javascript code to be NOT uglified. They need to be built in "development" mode.
- *  And the end of your tests, you'll get a directory full of coverage per test run.  Now what?
- *  You'll need to convert the coverage code to something istanbul can read.  Good news is someone wrote the code
- *  for you (see puppeteer-to-istanbul link below).  Then using istanbul you need to combine the converted
- *  coverage and create a report.  Good luck!
- *
- *  Links:
- *  * https://github.com/GoogleChrome/puppeteer/blob/v1.12.2/docs/api.md#class-coverage
- *  * https://github.com/istanbuljs/puppeteer-to-istanbul
- *  * https://github.com/gotwarlost/istanbul
  */
 module.exports = function (config) {
   const helpers = Container.helpers();
   let coverageRunning = false;
   let helper;
 
+  let debug;
   for (const helperName of supportedHelpers) {
     if (Object.keys(helpers).indexOf(helperName) > -1) {
       helper = helpers[helperName];
+      debug = debugModule(`codeceptjs:plugin:${helperName.toLowerCase()}Coverage`);
     }
   }
 
   if (!helper) {
-    console.error('Coverage is only supported in Puppeteer');
+    console.error('Coverage is only supported in Puppeteer, Playwright');
     return; // no helpers for screenshot
   }
 
@@ -102,7 +90,7 @@ module.exports = function (config) {
       'starting coverage',
       async () => {
         try {
-          if (!coverageRunning) {
+          if (!coverageRunning && helper.page && helper.page.coverage) {
             debug('--> starting coverage <--');
             coverageRunning = true;
             await helper.page.coverage.startJSCoverage();
@@ -115,13 +103,13 @@ module.exports = function (config) {
     );
   });
 
-  // Save puppeteer coverage data after every test run
+  // Save coverage data after every test run
   event.dispatcher.on(event.test.after, async (test) => {
     recorder.add(
       'saving coverage',
       async () => {
         try {
-          if (coverageRunning) {
+          if (coverageRunning && helper.page && helper.page.coverage) {
             debug('--> stopping coverage <--');
             coverageRunning = false;
             const coverage = await helper.page.coverage.stopJSCoverage();

package/lib/plugin/customLocator.js

@@ -38,7 +38,7 @@ const defaultConfig = {
  * // in codecept.conf.js
  * plugins: {
  *  customLocator: {
- *    enabled: true
+ *    enabled: true,
  *    attribute: 'data-test'
  *  }
  * }
@@ -57,7 +57,7 @@ const defaultConfig = {
  * // in codecept.conf.js
  * plugins: {
  *  customLocator: {
- *    enabled: true
+ *    enabled: true,
  *    prefix: '=',
  *    attribute: 'data-qa'
  *  }

package/lib/plugin/screenshotOnFail.js

@@ -107,6 +107,11 @@ module.exports = function (config) {
         if (allureReporter) {
           allureReporter.addAttachment('Last Seen Screenshot', fs.readFileSync(path.join(global.output_dir, fileName)), 'image/png');
         }
+
+        const cucumberReporter = Container.plugins('cucumberJsonReporter');
+        if (cucumberReporter) {
+          cucumberReporter.addScreenshot(test.artifacts.screenshot);
+        }
       } catch (err) {
         output.plugin(err);
         if (

package/lib/plugin/subtitles.js

@@ -0,0 +1,88 @@
+const { v4: uuidv4 } = require('uuid');
+const fsPromise = require('fs').promises;
+const path = require('path');
+const event = require('../event');
+
+// This will convert a given timestamp in milliseconds to
+// an SRT recognized timestamp, ie HH:mm:ss,SSS
+function formatTimestamp(timestampInMs) {
+  const date = new Date(0, 0, 0, 0, 0, 0, timestampInMs);
+  const hours = date.getHours();
+  const minutes = date.getMinutes();
+  const seconds = date.getSeconds();
+  const ms = timestampInMs - (hours * 3600000 + minutes * 60000 + seconds * 1000);
+  return `${hours.toString().padStart(2, '0')}:${minutes.toString().padStart(2, '0')}:${seconds.toString().padStart(2, '0')},${ms.toString().padStart(3, '0')}`;
+}
+
+let steps = {};
+let testStartedAt;
+/**
+ * Automatically captures steps as subtitle, and saves it as an artifact when a video is found for a failed test
+ *
+ * #### Configuration
+ * ```js
+ * plugins: {
+ *  subtitles: {
+ *    enabled: true
+ *  }
+ * }
+ * ```
+ */
+module.exports = function () {
+  event.dispatcher.on(event.test.before, (_) => {
+    testStartedAt = Date.now();
+    steps = {};
+  });
+
+  event.dispatcher.on(event.step.started, (step) => {
+    const stepStartedAt = Date.now();
+    step.id = uuidv4();
+
+    let title = `${step.actor}.${step.name}(${step.args ? step.args.join(',') : ''})`;
+    if (title.length > 100) {
+      title = `${title.substring(0, 100)}...`;
+    }
+
+    steps[step.id] = {
+      start: formatTimestamp(stepStartedAt - testStartedAt),
+      startedAt: stepStartedAt,
+      title,
+    };
+  });
+
+  event.dispatcher.on(event.step.finished, (step) => {
+    if (step && step.id && steps[step.id]) {
+      steps[step.id].end = formatTimestamp(Date.now() - testStartedAt);
+    }
+  });
+
+  event.dispatcher.on(event.test.after, async (test) => {
+    if (test && test.artifacts && test.artifacts.video) {
+      const stepsSortedByStartTime = Object.values(steps);
+      stepsSortedByStartTime.sort((stepA, stepB) => {
+        return stepA.startedAt - stepB.startedAt;
+      });
+
+      let subtitle = '';
+
+      // For an SRT file, every subtitle has to be in the format as mentioned below:
+      //
+      // 1
+      // HH:mm:ss,SSS --> HH:mm:ss,SSS
+      // [title]
+      stepsSortedByStartTime.forEach((step, index) => {
+        if (step.end) {
+          subtitle = `${subtitle}${index + 1}
+${step.start} --> ${step.end}
+${step.title}
+
+`;
+        }
+      });
+
+      const { dir: artifactsDirectory, name: fileName } = path.parse(test.artifacts.video);
+      await fsPromise.writeFile(`${artifactsDirectory}/${fileName}.srt`, subtitle);
+      test.artifacts.subtitle = `${artifactsDirectory}/${fileName}.srt`;
+    }
+  });
+};

package/lib/plugin/tryTo.js

@@ -89,7 +89,7 @@ function tryTo(callback) {
     recorder.session.catch((err) => {
       result = false;
       const msg = err.inspect ? err.inspect() : err.toString();
-      debug(`Unsuccesful try > ${msg}`);
+      debug(`Unsuccessful try > ${msg}`);
       recorder.session.restore('tryTo');
       return result;
     });

package/lib/step.js

@@ -212,16 +212,18 @@ class MetaStep extends Step {
       step.metaStep = this;
     };
     event.dispatcher.prependListener(event.step.before, registerStep);
+    let rethrownError = null;
     try {
       this.startTime = Date.now();
       result = fn.apply(this.context, this.args);
     } catch (error) {
-      this.status = 'failed';
+      this.setStatus('failed');
+      rethrownError = error;
     } finally {
       this.endTime = Date.now();
-
       event.dispatcher.removeListener(event.step.before, registerStep);
     }
+    if (rethrownError) { throw rethrownError; }
     return result;
   }
 }

package/lib/ui.js

@@ -176,8 +176,12 @@ module.exports = function (suite) {
      * @kind constant
      * @type {CodeceptJS.IScenario}
      */
-    context.xScenario = context.Scenario.skip = function (title) {
-      return context.Scenario(title, {});
+    context.xScenario = context.Scenario.skip = function (title, opts = {}, fn) {
+      if (typeof opts === 'function' && !fn) {
+        opts = {};
+      }
+
+      return context.Scenario(title, opts);
     };
 
     /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "codeceptjs",
-  "version": "3.0.6",
+  "version": "3.1.2",
   "description": "Supercharged End 2 End Testing Framework for NodeJS",
   "keywords": [
     "acceptance",
@@ -84,8 +84,8 @@
     "promise-retry": "^1.1.1",
     "requireg": "^0.2.2",
     "resq": "^1.10.0",
-    "semver": "^6.2.0",
-    "sprintf-js": "^1.1.1"
+    "sprintf-js": "^1.1.1",
+    "uuid": "^8.3.2"
   },
   "devDependencies": {
     "@codeceptjs/detox-helper": "^1.0.2",
@@ -123,10 +123,11 @@
     "nodemon": "^1.19.4",
     "playwright": "^1.9.1",
     "protractor": "^5.4.4",
-    "puppeteer": "^8.0.0",
+    "puppeteer": "^10.0.0",
     "qrcode-terminal": "^0.12.0",
     "rosie": "^1.6.0",
     "runok": "^0.9.2",
+    "semver": "^6.3.0",
     "sinon": "^9.2.2",
     "sinon-chai": "^3.5.0",
     "testcafe": "^1.9.4",

package/typings/index.d.ts

@@ -8,13 +8,13 @@ declare namespace CodeceptJS {
     import("./utils").Translate<T, Translation.Actions>;
 
   type Cookie = {
-    name: string
-    value: string
-  }
+    name: string;
+    value: string;
+  };
 
   interface PageScrollPosition {
-    x: number,
-    y: number
+    x: number;
+    y: number;
   }
 
   // Could get extended by user generated typings
@@ -23,7 +23,7 @@ declare namespace CodeceptJS {
   interface IHook {}
   interface IScenario {}
   interface IFeature {
-    (title: string): FeatureConfig
+    (title: string): FeatureConfig;
   }
   interface CallbackOrder extends Array<any> {}
   interface SupportObject {
@@ -51,25 +51,48 @@ declare namespace CodeceptJS {
     | { frame: string }
     | { android: string }
     | { ios: string }
-    | { android: string, ios: string }
-    | { react: string };
-
-  interface CustomLocators { }
-  type LocatorOrString = string | ILocator | Locator | CustomLocators[keyof CustomLocators];
+    | { android: string; ios: string }
+    | { react: string }
+    | { shadow: string }
+    | { custom: string };
+
+  interface CustomLocators {}
+  type LocatorOrString =
+    | string
+    | ILocator
+    | Locator
+    | CustomLocators[keyof CustomLocators];
 
   type StringOrSecret = string | CodeceptJS.Secret;
 
-  interface HookCallback { (args: SupportObject): void; }
-  interface Scenario extends IScenario { only: IScenario, skip: IScenario, todo: IScenario}
-  interface Feature extends IFeature { skip: IFeature }
-  interface IData { Scenario: IScenario, only: { Scenario: IScenario } }
+  interface HookCallback {
+    (args: SupportObject): void;
+  }
+  interface Scenario extends IScenario {
+    only: IScenario;
+    skip: IScenario;
+    todo: IScenario;
+  }
+  interface Feature extends IFeature {
+    skip: IFeature;
+  }
+  interface IData {
+    Scenario: IScenario;
+    only: { Scenario: IScenario };
+  }
 
   interface IScenario {
     // Scenario.todo can be called only with a title.
     (title: string, callback?: HookCallback): ScenarioConfig;
-    (title: string, opts: { [key: string]: any }, callback: HookCallback): ScenarioConfig;
+    (
+      title: string,
+      opts: { [key: string]: any },
+      callback: HookCallback
+    ): ScenarioConfig;
+  }
+  interface IHook {
+    (callback: HookCallback): void;
   }
-  interface IHook { (callback: HookCallback): void; }
 
   interface Globals {
     codeceptjs: typeof codeceptjs;
@@ -164,12 +187,12 @@ declare namespace Mocha {
   }
 
   interface Suite extends SuiteRunnable {
-    tags: any[]
-    comment: string
-    feature: any
+    tags: any[];
+    comment: string;
+    feature: any;
   }
 
-  interface Test  extends Runnable {
+  interface Test extends Runnable {
     tags: any[];
   }
 }