@qavajs/cypress-runner-adapter 1.3.0 → 1.4.1

package/CHANGELOG.md

@@ -14,6 +14,21 @@ Check [Keep a Changelog](http://keepachangelog.com/) for recommendations on how
 
 :microscope: - experimental
 
+## [1.4.1]
+- :beetle: fixed `result` property in `After` and `AfterStep` hooks
+- :rocket: added workaround to complete `AfterStep` hook in case of step fail
+
+## [1.4.0]
+- :rocket: added `Template` utility function
+```typescript
+import { When, Template } from '@qavajs/playwright-runner-adapter';
+
+When('I click {string} and verify {string}', Template((locator, expected) => `
+    I click '${locator}'
+    I expect '${locator} > Value' to equal '${expected}'
+`));
+```
+
 ## [1.3.0]
 - :rocket: added tags support
 - :rocket: added alternative 'it mode' to translate gherkin tests to mocha `it` instead of `describe`

package/adapter/make_mocha_tests_describe.js

@@ -46,8 +46,20 @@ module.exports = function makeMochaTest(tests) {
             const world = new supportCodeLibrary.World();
             world.executeStep = executeStepByText;
             let skip = false;
-            let result = 'passed';
+            let status = 'passed';
+            let duration = 0;
+            let exception;
+            let message;
             afterEach(function () {
+                if (this.currentTest.state !== 'passed') {
+                    skip = true;
+                }
+                duration += this.currentTest.duration;
+                if (this.currentTest.state === 'failed') {
+                    status = this.currentTest.state;
+                    exception = this.currentTest.err;
+                    message = this.currentTest.err?.message;
+                }
                 if (this.step) {
                     for (const afterStep of supportCodeLibrary.afterTestStepHookDefinitions) {
                         if (afterStep.appliesToTestCase(this.step)) {
@@ -55,15 +67,16 @@ module.exports = function makeMochaTest(tests) {
                                 pickle: test,
                                 pickleStep: this.step,
                                 gherkinDocument: tests,
-                                result: this.currentTest.state
+                                result: {
+                                    duration,
+                                    status,
+                                    exception,
+                                    message
+                                }
                             }]);
                         }
                     }
                 }
-                if (this.currentTest.state !== 'passed') {
-                    skip = true;
-                }
-                result = this.currentTest.state;
             });
             for (const beforeTest of supportCodeLibrary.beforeTestCaseHookDefinitions) {
                 if (beforeTest.appliesToTestCase(test)) {
@@ -96,9 +109,15 @@ module.exports = function makeMochaTest(tests) {
             for (const afterTest of supportCodeLibrary.afterTestCaseHookDefinitions) {
                 if (afterTest.appliesToTestCase(test)) {
                     it(afterTest.name, function () {
+                        this.step = null;
                         afterTest.code.apply(world, [{
                             pickle: test,
-                            result,
+                            result: {
+                                duration,
+                                status,
+                                exception,
+                                message
+                            },
                             gherkinDocument: tests,
                             willBeRetried: false
                         }]);

package/adapter/make_mocha_tests_it.js

@@ -12,13 +12,22 @@ module.exports = function makeMochaTest(tests) {
         }
     }
 
+    function getResult(currentTest) {
+        return {
+            duration: currentTest.duration,
+            message: currentTest.err?.message,
+            status: currentTest.state,
+            exception: currentTest.err
+        }
+    }
+
     function executeStepByText(text, argument) {
         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;
-        const { parameters } = step.getInvocationParameters({
+        const [step] = steps;
+        const {parameters} = step.getInvocationParameters({
             step: {text, argument},
             world: this
         });
@@ -75,15 +84,29 @@ module.exports = function makeMochaTest(tests) {
         }
     });
 
-    afterEach( function () {
+    afterEach(function () {
         const test = findTest(tests, this.currentTest.title);
         const world = this.world;
+        const result = getResult(this.currentTest);
+        // corner case to complete AfterStep if test is failed
+        if (result.status === 'failed' && this.step) {
+            for (const afterStep of supportCodeLibrary.afterTestStepHookDefinitions) {
+                if (afterStep.appliesToTestCase(this.step)) {
+                    afterStep.code.apply(world, [{
+                        pickle: test,
+                        pickleStep: this.step,
+                        gherkinDocument: tests,
+                        result
+                    }]);
+                }
+            }
+        }
         for (const afterTest of supportCodeLibrary.afterTestCaseHookDefinitions) {
             if (afterTest.appliesToTestCase(test)) {
                 runStep(afterTest.name, function () {
                     afterTest.code.apply(world, [{
                         pickle: test,
-                        result: null,
+                        result,
                         gherkinDocument: tests,
                         willBeRetried: false
                     }]);
@@ -99,7 +122,7 @@ module.exports = function makeMochaTest(tests) {
                 const stepName = keyword(step) + ': ' + step.text;
                 runStep(stepName, function () {
                     this.step = step;
-                    this.currentTest = { state: 'passed' };
+                    const result = { status: 'passed', duration: 0 };
                     for (const beforeStep of supportCodeLibrary.beforeTestStepHookDefinitions) {
                         if (beforeStep.appliesToTestCase(step)) {
                             beforeStep.code.apply(world, [{
@@ -116,7 +139,7 @@ module.exports = function makeMochaTest(tests) {
                                 pickle: test,
                                 pickleStep: this.step,
                                 gherkinDocument: tests,
-                                result: this.currentTest.state
+                                result
                             }]);
                         }
                     }

package/index.d.ts

@@ -29,3 +29,4 @@ 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;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@qavajs/cypress-runner-adapter",
-  "version": "1.3.0",
+  "version": "1.4.1",
   "main": "index.js",
   "scripts": {
     "debug": "cypress open --config-file test/cypress.config.js",
@@ -20,16 +20,16 @@
   "bugs": {
     "url": "https://github.com/qavajs/cypress-runner-adapter/issues"
   },
-  "homepage": "https://github.com/qavajs/cypress-runner-adaptert#readme",
+  "homepage": "https://qavajs.github.io/docs/intro",
   "dependencies": {
     "@cucumber/cucumber-expressions": "^18.0.1",
-    "@cucumber/gherkin": "^35.1.0",
-    "@cucumber/tag-expressions": "^7.0.0",
+    "@cucumber/gherkin": "^36.0.0",
+    "@cucumber/tag-expressions": "^8.0.0",
     "@cypress/webpack-preprocessor": "^7.0.1",
     "fs-extra": "^11.3.2"
   },
   "devDependencies": {
-    "cypress": "^15.3.0"
+    "cypress": "^15.5.0"
   },
   "keywords": [
     "cypress",

package/supportCodeLibrary/index.js

@@ -103,4 +103,28 @@ export function defineParameterType(options) {
     supportCodeLibrary.parameterTypeRegistry.defineSourcedParameterType(parameterType, {})
 }
 
+/**
+ * Define template step
+ * @param {() => string} scenario - multiline string with steps
+ * @example
+ * When('I click {string} and verify {string}', Template((locator, expected) => `
+ *     I click '${locator}'
+ *     I expect '${locator} > Value' to equal '${expected}'
+ * `));
+ */
+export function Template(scenario) {
+    return new Proxy(scenario, {
+        apply: function (template, world, args) {
+            const scenario = template(...args) ;
+            const steps = scenario
+                .split('\n')
+                .map(step => step.trim())
+                .filter(Boolean);
+            for (const step of steps) {
+                world.executeStep(step);
+            }
+        },
+    })
+}
+