@qavajs/cypress-runner-adapter 1.4.2 → 1.6.0

package/CHANGELOG.md

@@ -14,6 +14,15 @@ Check [Keep a Changelog](http://keepachangelog.com/) for recommendations on how
 
 :microscope: - experimental
 
+
+## [1.6.0]
+- :rocket: updated logs for Gherkin steps
+- :rocket: improved multi line and data table step logging
+
+## [1.5.0]
+- :rocket: added `world.log` method
+- :rocket: updated test.body to render corresponding step code
+
 ## [1.4.2]
 - :pencil: updated to cypress 15.7.0
 - :pencil: updated to gherkin to 37.0.0

package/adapter/make_mocha_tests_describe.js

@@ -1,4 +1,8 @@
 module.exports = function makeMochaTest(tests) {
+    function log(data) {
+        cy.log(data);
+    }
+
     function keyword(step) {
         switch (step.type) {
             case 'Context': return 'Given';
@@ -8,12 +12,25 @@ module.exports = function makeMochaTest(tests) {
         }
     }
 
-    function executeStepByText(text, argument) {
+    function stepName(pickleStep) {
+        let step = pickleStep.text;
+        if (pickleStep.argument) {
+            step += pickleStep.argument.docString ? ' [MultiLine]' : ' [DataTable]';
+        }
+        return step;
+    }
+
+    function findStepDefinition(text) {
         const steps = supportCodeLibrary.stepDefinitions
             .filter(stepDefinition => stepDefinition.matchesStepName(text));
         if (steps.length === 0) throw new Error(`Step '${text}' is not defined`);
         if (steps.length > 1) throw new Error(`Step '${text}' matches multiple step definitions`);
         const [step] = steps;
+        return step;
+    }
+
+    function executeStepByText(text, argument) {
+        const step = findStepDefinition(text);
         const { parameters } = step.getInvocationParameters({
             step: { text, argument },
             world: this
@@ -35,6 +52,7 @@ module.exports = function makeMochaTest(tests) {
         describe('Before All', function () {
             for (const beforeRun of supportCodeLibrary.beforeTestRunHookDefinitions) {
                 it('Before All', function () {
+                    this.test.body = beforeRun.code.toString();
                     beforeRun.code.apply();
                 });
             }
@@ -43,7 +61,11 @@ module.exports = function makeMochaTest(tests) {
 
     for (const test of tests) {
         describe('Scenario: ' + test.name, { testIsolation: false }, function () {
-            const world = new supportCodeLibrary.World();
+            const world = new supportCodeLibrary.World({
+                log,
+                attach: log,
+                link: log
+            });
             world.executeStep = executeStepByText;
             let skip = false;
             let status = 'passed';
@@ -81,6 +103,8 @@ module.exports = function makeMochaTest(tests) {
             for (const beforeTest of supportCodeLibrary.beforeTestCaseHookDefinitions) {
                 if (beforeTest.appliesToTestCase(test)) {
                     it(beforeTest.name, function () {
+                        this.test.body = beforeTest.code.toString();
+                        world.test = this;
                         if (skip) return this.skip();
                         beforeTest.code.apply(world, [{
                             pickle: test,
@@ -91,7 +115,8 @@ module.exports = function makeMochaTest(tests) {
                 }
             }
             for (const step of test.steps) {
-                it(keyword(step) + ': ' + step.text, function () {
+                it(`${keyword(step)} ${stepName(step)}`, function () {
+                    this.test.body = findStepDefinition(step.text).code.toString();
                     this.step = step;
                     if (skip) return this.skip();
                     for (const beforeStep of supportCodeLibrary.beforeTestStepHookDefinitions) {
@@ -109,6 +134,7 @@ module.exports = function makeMochaTest(tests) {
             for (const afterTest of supportCodeLibrary.afterTestCaseHookDefinitions) {
                 if (afterTest.appliesToTestCase(test)) {
                     it(afterTest.name, function () {
+                        this.test.body = afterTest.code.toString();
                         this.step = null;
                         afterTest.code.apply(world, [{
                             pickle: test,
@@ -130,6 +156,7 @@ module.exports = function makeMochaTest(tests) {
         describe('After All', function () {
             for (const afterRun of supportCodeLibrary.afterTestRunHookDefinitions) {
                 it('After All', function () {
+                    this.test.body = afterRun.code.toString();
                     afterRun.code.apply();
                 });
             }

package/adapter/make_mocha_tests_it.js

@@ -1,4 +1,8 @@
 module.exports = function makeMochaTest(tests) {
+    function log(data) {
+        cy.log(data);
+    }
+
     function keyword(step) {
         switch (step.type) {
             case 'Context':
@@ -12,6 +16,14 @@ module.exports = function makeMochaTest(tests) {
         }
     }
 
+    function stepNameText(pickleStep) {
+        let step = pickleStep.text;
+        if (pickleStep.argument) {
+            step += pickleStep.argument.docString ? ' [MultiLine]' : ' [DataTable]';
+        }
+        return step;
+    }
+
     function getResult(currentTest) {
         return {
             duration: currentTest.duration,
@@ -60,6 +72,10 @@ module.exports = function makeMochaTest(tests) {
         return tests.find(test => test.name === testName);
     }
 
+    function renderGherkinTest(steps) {
+        return steps.map(step => `${keyword(step)} ${step.text}`).join('\n');
+    }
+
     if (supportCodeLibrary.beforeTestRunHookDefinitions.length > 0) {
         before(function () {
             for (const beforeRun of supportCodeLibrary.beforeTestRunHookDefinitions) {
@@ -70,7 +86,12 @@ module.exports = function makeMochaTest(tests) {
 
     beforeEach(function () {
         const test = findTest(tests, this.currentTest.title);
-        const world = this.world = new supportCodeLibrary.World();
+        this.currentTest.body = renderGherkinTest(test.steps);
+        const world = this.world = new supportCodeLibrary.World({
+            log,
+            attach: log,
+            link: log
+        });
         for (const beforeTest of supportCodeLibrary.beforeTestCaseHookDefinitions) {
             if (beforeTest.appliesToTestCase(test)) {
                 runStep(beforeTest.name, function () {
@@ -119,10 +140,10 @@ module.exports = function makeMochaTest(tests) {
         it('Scenario: ' + test.name, function () {
             const world = this.world;
             for (const step of test.steps) {
-                const stepName = keyword(step) + ': ' + step.text;
+                const stepName = `${keyword(step)} ${stepNameText(step)}`;
                 runStep(stepName, function () {
                     this.step = step;
-                    const result = { status: 'passed', duration: 0 };
+                    const result = {status: 'passed', duration: 0};
                     for (const beforeStep of supportCodeLibrary.beforeTestStepHookDefinitions) {
                         if (beforeStep.appliesToTestCase(step)) {
                             beforeStep.code.apply(world, [{

package/index.d.ts

@@ -29,4 +29,11 @@ export function BeforeAll(fn: Function): void;
 export function AfterAll(fn: Function): void;
 export function setWorldConstructor(world: IWorld): void;
 export function defineParameterType(option: ParameterTypeOption): void;
-export function Template(template: (...args: any[]) => string): () => void;
+export function Template(template: (...args: any[]) => string): () => void;
+export class World {
+    constructor(options: {
+        log: (...args: any) => void;
+        attach: (...args: any) => void;
+        link: (...args: any) => void;
+    });
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@qavajs/cypress-runner-adapter",
-  "version": "1.4.2",
+  "version": "1.6.0",
   "main": "index.js",
   "scripts": {
     "debug": "cypress open --config-file test/cypress.config.js",
@@ -23,13 +23,14 @@
   "homepage": "https://qavajs.github.io/docs/intro",
   "dependencies": {
     "@cucumber/cucumber-expressions": "^18.0.1",
-    "@cucumber/gherkin": "^37.0.0",
-    "@cucumber/tag-expressions": "^8.0.0",
+    "@cucumber/gherkin": "^37.0.1",
+    "@cucumber/tag-expressions": "^8.1.0",
     "@cypress/webpack-preprocessor": "^7.0.2",
-    "fs-extra": "^11.3.2"
+    "fs-extra": "^11.3.3"
   },
   "devDependencies": {
-    "cypress": "^15.7.0"
+    "cypress": "^15.9.0",
+    "mochawesome": "^7.1.4"
   },
   "keywords": [
     "cypress",

package/supportCodeLibrary/index.js

@@ -5,7 +5,14 @@ import TestCaseHookDefinition from './test_case_hook_definition';
 import TestStepHookDefinition from './test_step_hook_definition';
 import { buildParameterType } from './build_parameter_type';
 import TestRunHookDefinition from './test_run_hook_definition';
-class World {}
+
+export class World {
+    constructor(options) {
+        this.log = options.log;
+        this.attach = options.attach;
+        this.link = options.link;
+    }
+}
 
 const supportCodeLibrary = {
     stepDefinitions: [],