@qavajs/cypress-runner-adapter 1.8.0 → 1.9.1

package/adapter/index.js

@@ -1,4 +1,5 @@
-const { ensureFileSync, writeFileSync, readFileSync } = require('fs-extra');
+const { mkdirSync, writeFileSync, readFileSync } = require('node:fs');
+const { dirname } = require('node:path');
 const { randomUUID } = require('node:crypto');
 const { AstBuilder, compile, GherkinClassicTokenMatcher, Parser } = require('@cucumber/gherkin');
 const webpackPreprocessor = require('@cypress/webpack-preprocessor')();
@@ -26,7 +27,7 @@ module.exports = async function cucumber(file) {
     const tagExpression = tagExpressionParser(process.env.TAGS || '');
     const testCases = compile(gherkinDocument, filePath, uuidFn)
         .filter(test => tagExpression.evaluate(test.tags.map(tag => tag.name)));
-    ensureFileSync(outputPath);
+    mkdirSync(dirname(outputPath), { recursive: true });
     writeFileSync(outputPath, adapter(testCases), 'utf-8');
     return outputPath;
 }

package/adapter/make_mocha_tests_it.js

@@ -60,11 +60,22 @@ module.exports = function makeMochaTest(tests) {
 
     supportCodeLibrary.World.prototype.executeStep = executeStepByText;
 
-    function runStep(name, callback) {
+    function runStep({ keyword, name }, callback) {
+        const displayName = keyword ? keyword : name;
+        const message = keyword && name ? name : '';
+        let group;
         cy.then(() => {
-            Cypress.log({ displayName: name, message: '' });
-        })
+            group = Cypress.log({
+                name,
+                displayName,
+                message,
+                groupStart: true,
+            });
+        });
         callback();
+        cy.then(() => {
+            group.endGroup();
+        });
     }
 
     function findTest(tests, name) {
@@ -94,7 +105,7 @@ module.exports = function makeMochaTest(tests) {
         });
         for (const beforeTest of supportCodeLibrary.beforeTestCaseHookDefinitions) {
             if (beforeTest.appliesToTestCase(test)) {
-                runStep(beforeTest.name, function () {
+                runStep({ name: beforeTest.name }, function () {
                     beforeTest.code.apply(world, [{
                         pickle: test,
                         gherkinDocument: tests,
@@ -127,7 +138,7 @@ module.exports = function makeMochaTest(tests) {
         }
         for (const afterTest of supportCodeLibrary.afterTestCaseHookDefinitions) {
             if (afterTest.appliesToTestCase(test)) {
-                runStep(afterTest.name, function () {
+                runStep({ name: afterTest.name }, function () {
                     afterTest.code.apply(world, [{
                         pickle: test,
                         result,
@@ -144,8 +155,7 @@ module.exports = function makeMochaTest(tests) {
         it('Scenario: ' + test.name, function () {
             const world = this.world;
             for (const step of test.steps) {
-                const stepName = `${keyword(step)} ${stepNameText(step)}`;
-                runStep(stepName, function () {
+                runStep({ keyword: keyword(step), name: stepNameText(step) }, () => {
                     this.step = step;
                     const result = { status: 'passed', duration: 0 };
                     for (const beforeStep of supportCodeLibrary.beforeTestStepHookDefinitions) {

package/adapter.d.ts

@@ -1 +1 @@
-export default function (file: any): void;
+export default function (file: any): Promise<any>;

package/index.d.ts

@@ -35,5 +35,6 @@ export class World {
         log: (...args: any) => void;
         attach: (...args: any) => void;
         link: (...args: any) => void;
+        executeStep: (...args: any) => Promise<any>;
     });
 }

package/package.json

@@ -1,7 +1,15 @@
 {
   "name": "@qavajs/cypress-runner-adapter",
-  "version": "1.8.0",
+  "version": "1.9.1",
   "main": "index.js",
+  "files": [
+    "adapter",
+    "supportCodeLibrary",
+    "index.js",
+    "index.d.ts",
+    "adapter.js",
+    "adapter.d.ts"
+  ],
   "scripts": {
     "debug": "cypress open --config-file test/cypress.config.js",
     "test": "cypress run --config-file test/cypress.config.js",
@@ -25,11 +33,10 @@
     "@cucumber/cucumber-expressions": "^19.0.0",
     "@cucumber/gherkin": "^39.0.0",
     "@cucumber/tag-expressions": "^9.1.0",
-    "@cypress/webpack-preprocessor": "^7.0.2",
-    "fs-extra": "^11.3.3"
+    "@cypress/webpack-preprocessor": "^7.0.2"
   },
   "devDependencies": {
-    "cypress": "^15.11.0",
+    "cypress": "^15.12.0",
     "mochawesome": "^7.1.4"
   },
   "keywords": [
@@ -42,4 +49,4 @@
     "test",
     "test-automation"
   ]
-}
+}

package/supportCodeLibrary/data_table.js

@@ -47,6 +47,6 @@ export default class DataTable {
         const transposed = this.rawTable[0].map((x, i) =>
             this.rawTable.map((y) => y[i])
         )
-        return new Data_table(transposed)
+        return new DataTable(transposed)
     }
 }

package/supportCodeLibrary/index.js

@@ -52,8 +52,7 @@ export function Given(pattern, code) {
 }
 
 export function Before(optionsOrCode, code) {
-    const defaultOptions = { name: 'Before' };
-    const options = code ? Object.assign(defaultOptions, optionsOrCode) : defaultOptions;
+    const options = code ? Object.assign({ name: 'Before' }, optionsOrCode) : { name: 'Before' };
     const handler = code ?? optionsOrCode;
     supportCodeLibrary.beforeTestCaseHookDefinitions.push(new TestCaseHookDefinition({
         code: handler,
@@ -62,8 +61,7 @@ export function Before(optionsOrCode, code) {
 }
 
 export function After(optionsOrCode, code) {
-    const defaultOptions = { name: 'After' };
-    const options = code ? Object.assign(defaultOptions, optionsOrCode) : defaultOptions;
+    const options = code ? Object.assign({ name: 'After' }, optionsOrCode) : { name: 'After' };
     const handler = code ?? optionsOrCode;
     supportCodeLibrary.afterTestCaseHookDefinitions.push(new TestCaseHookDefinition({
         code: handler,

package/CHANGELOG.md

@@ -1,79 +0,0 @@
-# Change Log
-
-All notable changes to the "@qavajs/cypress-runner-adapter" will be documented in this file.
-
-Check [Keep a Changelog](http://keepachangelog.com/) for recommendations on how to structure this file.
-
-:rocket: - new feature
-
-:beetle: - bugfix
-
-:x: - deprecation/removal
-
-:pencil: - chore
-
-:microscope: - experimental
-
-## [1.8.0]
-- :rocket: added `testCaseStartedId` and `testStepId` as hooks parameters to comply cucumber spec
-
-## [1.7.0]
-- :rocket: updated @cucumber/cucumber-expressions, @cucumber/gherkin, @cucumber/tag-expressions
-
-## [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
-
-## [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`
-```bash
-MODE=it npx cypress open
-```
-
-## [1.2.1]
-- :pencil: updated to cypress 15.3
-
-## [1.2.0]
-- :pencil: updated to cypress 15
-
-## [1.1.0]
-- :pencil: updated to cypress 14
-
-## [1.0.1]
-- :pencil: updated dependencies
-
-## [1.0.0]
-- :rocket: added `this.executeStep` world method
-
-## [0.2.0]
-- :rocket: added _BeforeAll_ and _AfterAll_ hooks support
-
-## [0.1.1]
-- :beetle: changed browserify to webpack
-
-## [0.1.0]
-- :rocket: initial implementation