@zohodesk/testinglibrary 0.1.8-exp-bdd-v1 → 0.1.8-exp.1

package/package.json

@@ -1,54 +1,55 @@
-{
-  "name": "@zohodesk/testinglibrary",
-  "version": "0.1.8-exp-bdd-v1",
-  "description": "",
-  "main": "./build/index.js",
-  "scripts": {
-    "postinstall": "node bin/postinstall.js",
-    "test": "echo \"Error: no test specified\" && exit 1",
-    "clean": "rmdir /s /q build && mkdir build",
-    "build-babel": "babel -d ./build ./src --copy-files",
-    "build": "npm run clean && npm run build-babel",
-    "prepare": "npm run build",
-    "lint": "eslint src/* --fix"
-  },
-  "exports": {
-    ".": "./build/index.js",
-    "./decorators": "./build/decorators.js"
-  },
-  "keywords": [],
-  "author": "",
-  "license": "ISC",
-  "dependencies": {
-    "@babel/preset-react": "7.22.5",
-    "@cucumber/cucumber": "9.2.0",
-    "@playwright/test": "1.39.0",
-    "@testing-library/jest-dom": "5.11.9",
-    "@testing-library/react": "11.2.7",
-    "@testing-library/react-hooks": "7.0.2",
-    "babel-jest": "29.6.2",
-    "babel-plugin-transform-dynamic-import": "2.1.0",
-    "commander": "11.0.0",
-    "fast-glob": "3.3.1",
-    "jest": "29.6.2",
-    "jest-environment-jsdom": "29.6.2",
-    "msw": "1.2.3"
-  },
-  "bin": {
-    "ZDTestingFramework": "./bin/cli.js"
-  },
-  "peerDependencies": {
-    "react": "*",
-    "react-dom": "*",
-    "eslint": "*"
-  },
-  "devDependencies": {
-    "@babel/cli": "7.22.15",
-    "@babel/core": "7.22.17",
-    "@babel/node": "7.22.15",
-    "@babel/plugin-transform-runtime": "7.22.15",
-    "@babel/polyfill": "7.12.1",
-    "@babel/preset-env": "7.22.15",
-    "@babel/runtime": "7.22.15"
-  }
-}
+{
+  "name": "@zohodesk/testinglibrary",
+  "version": "0.1.8-exp.1",
+  "description": "",
+  "main": "./build/index.js",
+  "scripts": {
+    "postinstall": "node bin/postinstall.js",
+    "test": "echo \"Error: no test specified\" && exit 1",
+    "clean": "rm -rf build && mkdir build",
+    "build-babel": "babel -d ./build ./src --copy-files",
+    "build": "npm run clean && npm run build-babel",
+    "prepare": "npm run build",
+    "lint": "eslint src/* --fix"
+  },
+  "exports": {
+    ".": "./build/index.js",
+    "./decorators": "./build/decorators.js"
+  },
+  "keywords": [],
+  "author": "",
+  "license": "ISC",
+  "dependencies": {
+    "@babel/preset-react": "7.22.5",
+    "@cucumber/cucumber": "9.2.0",
+    "@playwright/test": "1.40.1",
+    "@testing-library/jest-dom": "5.11.9",
+    "@testing-library/react": "11.2.7",
+    "@testing-library/react-hooks": "7.0.2",
+    "babel-jest": "29.6.2",
+    "babel-plugin-transform-dynamic-import": "2.1.0",
+    "fast-glob": "3.3.1",
+    "jest": "29.6.2",
+    "jest-environment-jsdom": "29.6.2",
+    "msw": "1.2.3",
+    "playwright": "1.40.1"
+  },
+  "bin": {
+    "ZDTestingFramework": "./bin/cli.js"
+  },
+  "peerDependencies": {
+    "react": "*",
+    "react-dom": "*",
+    "eslint": "*"
+  },
+  "devDependencies": {
+    "@babel/cli": "7.22.15",
+    "@babel/core": "7.22.17",
+    "@babel/node": "7.22.15",
+    "@babel/plugin-transform-runtime": "7.22.15",
+    "@babel/polyfill": "7.12.1",
+    "@babel/preset-env": "7.22.15",
+    "@babel/runtime": "7.22.15",
+    "commander": "^11.0.0"
+  }
+}

package/playwright.config.js

@@ -1,112 +1,112 @@
-// @ts-check
-const { defineConfig, devices } = require('@playwright/test');
-const path = require('path');
-const numCPUs = require('os').cpus().length;
-
-/**
- * Read environment variables from file.
- * https://github.com/motdotla/dotenv
- */
-// require('dotenv').config();
-
-/**
- * @see https://playwright.dev/docs/test-configuration
- */
-export default defineConfig({
-  testDir: path.join(path.resolve(process.cwd()), 'uat'),
-  outputDir: path.join(process.cwd(), 'uat', 'test-results'),
-  /* Run tests in files in parallel */
-  fullyParallel: true,
-  /* Fail the build on CI if you accidentally left test.only in the source code. */
-  forbidOnly: !!process.env.CI,
-  /* Retry on CI only */
-  retries: process.env.CI ? 2 : 0,
-  /* Opt out of parallel tests on CI. */
-  workers: process.env.CI ? 1 : 1,
-  /* Reporter to use. See https://playwright.dev/docs/test-reporters */
-  reporter: [['html', { outputFolder: path.join(process.cwd(), 'uat', 'playwright-report'), open: "always" }]],
-  timeout: 60 * 1000,
-  expect: {
-    timeout: 5 * 1000,
-  },
-
-  /* Shared settings for all the projects below. See https://playwright.dev/docs/api/class-testoptions. */
-  use: {
-    /* Base URL to use in actions like `await page.goto('/')`. */
-    //baseURL: process.env.domain,
-
-    /* Collect trace when retrying the failed test. See https://playwright.dev/docs/trace-viewer */
-    trace: 'on',
-    video: {
-      mode: 'on',
-      size: { width: 640, height: 480 }
-    }
-  },
-
-  /* Configure projects for major browsers */
-  projects: [
-    { name: 'setup', testMatch: /.*\.setup\.js/ },
-    {
-      name: 'chromium',
-      use: {
-        ...devices['Desktop Chrome'],
-        storageState: path.resolve(process.cwd(), 'uat', 'playwright/.auth/user.json')
-      },
-      dependencies: ['setup'],
-    },
-
-    {
-      name: 'firefox',
-      timeout: 4 * 60 * 1000,
-      expect: {
-        timeout: 80 * 1000,
-      },
-      use: {
-        ...devices['Desktop Firefox'],
-        storageState: path.resolve(process.cwd(), 'uat', 'playwright/.auth/user.json')
-      },
-      dependencies: ['setup'],
-    },
-
-    {
-      name: 'webkit',
-      timeout: 2 * 60 * 1000,
-      expect: {
-        timeout: 80 * 1000,
-      },
-      use: {
-        ...devices['Desktop Safari'],
-        storageState: path.resolve(process.cwd(), 'uat', 'playwright/.auth/user.json')
-      },
-      dependencies: ['setup'],
-    },
-
-    /* Test against mobile viewports. */
-    // {
-    //   name: 'Mobile Chrome',
-    //   use: { ...devices['Pixel 5'] },
-    // },
-    // {
-    //   name: 'Mobile Safari',
-    //   use: { ...devices['iPhone 12'] },
-    // },
-
-    /* Test against branded browsers. */
-    // {
-    //   name: 'Microsoft Edge',
-    //   use: { ...devices['Desktop Edge'], channel: 'msedge' },
-    // },
-    // {
-    //   name: 'Google Chrome',
-    //   use: { ...devices['Desktop Chrome'], channel: 'chrome' },
-    // },
-  ],
-
-  /* Run your local dev server before starting the tests */
-  // webServer: {
-  //   command: 'npm run start',
-  //   url: 'http://127.0.0.1:3000',
-  //   reuseExistingServer: !process.env.CI,
-  // },
-});
-
+// @ts-check
+const { defineConfig, devices } = require('@playwright/test');
+const path = require('path');
+const numCPUs = require('os').cpus().length;
+
+/**
+ * Read environment variables from file.
+ * https://github.com/motdotla/dotenv
+ */
+// require('dotenv').config();
+
+/**
+ * @see https://playwright.dev/docs/test-configuration
+ */
+export default defineConfig({
+  testDir: path.join(path.resolve(process.cwd()), 'uat'),
+  outputDir: path.join(process.cwd(), 'uat', 'test-results'),
+  /* Run tests in files in parallel */
+  fullyParallel: true,
+  /* Fail the build on CI if you accidentally left test.only in the source code. */
+  forbidOnly: !!process.env.CI,
+  /* Retry on CI only */
+  retries: process.env.CI ? 2 : 0,
+  /* Opt out of parallel tests on CI. */
+  workers: process.env.CI ? 1 : 1,
+  /* Reporter to use. See https://playwright.dev/docs/test-reporters */
+  reporter: [['html', { outputFolder: path.join(process.cwd(), 'uat', 'playwright-report'), open: "always" }]],
+  timeout: 60 * 1000,
+  expect: {
+    timeout: 5 * 1000,
+  },
+
+  /* Shared settings for all the projects below. See https://playwright.dev/docs/api/class-testoptions. */
+  use: {
+    /* Base URL to use in actions like `await page.goto('/')`. */
+    //baseURL: process.env.domain,
+
+    /* Collect trace when retrying the failed test. See https://playwright.dev/docs/trace-viewer */
+    trace: 'on',
+    video: {
+      mode: 'on',
+      size: { width: 640, height: 480 }
+    }
+  },
+
+  /* Configure projects for major browsers */
+  projects: [
+    { name: 'setup', testMatch: /.*\.setup\.js/ },
+    {
+      name: 'chromium',
+      use: {
+        ...devices['Desktop Chrome'],
+        storageState: path.resolve(process.cwd(), 'uat', 'playwright/.auth/user.json')
+      },
+      dependencies: ['setup'],
+    },
+
+    {
+      name: 'firefox',
+      timeout: 4 * 60 * 1000,
+      expect: {
+        timeout: 80 * 1000,
+      },
+      use: {
+        ...devices['Desktop Firefox'],
+        storageState: path.resolve(process.cwd(), 'uat', 'playwright/.auth/user.json')
+      },
+      dependencies: ['setup'],
+    },
+
+    {
+      name: 'webkit',
+      timeout: 2 * 60 * 1000,
+      expect: {
+        timeout: 80 * 1000,
+      },
+      use: {
+        ...devices['Desktop Safari'],
+        storageState: path.resolve(process.cwd(), 'uat', 'playwright/.auth/user.json')
+      },
+      dependencies: ['setup'],
+    },
+
+    /* Test against mobile viewports. */
+    // {
+    //   name: 'Mobile Chrome',
+    //   use: { ...devices['Pixel 5'] },
+    // },
+    // {
+    //   name: 'Mobile Safari',
+    //   use: { ...devices['iPhone 12'] },
+    // },
+
+    /* Test against branded browsers. */
+    // {
+    //   name: 'Microsoft Edge',
+    //   use: { ...devices['Desktop Edge'], channel: 'msedge' },
+    // },
+    // {
+    //   name: 'Google Chrome',
+    //   use: { ...devices['Desktop Chrome'], channel: 'chrome' },
+    // },
+  ],
+
+  /* Run your local dev server before starting the tests */
+  // webServer: {
+  //   command: 'npm run start',
+  //   url: 'http://127.0.0.1:3000',
+  //   reuseExistingServer: !process.env.CI,
+  // },
+});
+

package/build/bdd-framework/cucumber/gherkin.d.ts

@@ -1,45 +0,0 @@
-/**
- * Copied from @cucumber/cucumber/lib/api/gherkin.d.ts
- * Fixes error:
- * Return type of exported function has or is using name 'PickleWithDocument'
- * from external module "../node_modules/@cucumber/cucumber/lib/api/gherkin"
- * but cannot be named
- */
-import {
-  Envelope,
-  GherkinDocument,
-  IdGenerator,
-  Location,
-  ParseError,
-  Pickle,
-} from '@cucumber/messages';
-import { ISourcesCoordinates } from '@cucumber/cucumber/lib/api/types';
-import { ILogger } from '@cucumber/cucumber/lib/logger';
-
-declare module '@cucumber/cucumber/lib/api/gherkin' {
-  export interface PickleWithDocument {
-    gherkinDocument: GherkinDocument;
-    location: Location;
-    pickle: Pickle;
-  }
-  export function getFilteredPicklesAndErrors({
-    newId,
-    cwd,
-    logger,
-    unexpandedFeaturePaths,
-    featurePaths,
-    coordinates,
-    onEnvelope,
-  }: {
-    newId: IdGenerator.NewId;
-    cwd: string;
-    logger: ILogger;
-    unexpandedFeaturePaths: string[];
-    featurePaths: string[];
-    coordinates: ISourcesCoordinates;
-    onEnvelope?: (envelope: Envelope) => void;
-  }): Promise<{
-    filteredPickles: PickleWithDocument[];
-    parseErrors: ParseError[];
-  }>;
-}

package/build/bdd-framework/gen/poms.js

@@ -1,46 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.POMS = void 0;
-exports.buildFixtureTag = buildFixtureTag;
-var _createDecorators = require("../stepDefinitions/createDecorators");
-/**
- * Handle POMs graph for decorator steps.
- */
-
-const FIXTURE_TAG_PREFIX = '@fixture:';
-class POMS {
-  usedPoms = new Map();
-  add(pomNode) {
-    if (pomNode) this.usedPoms.set(pomNode, null);
-  }
-  addByFixtureName(fixtureName) {
-    const pomNode = (0, _createDecorators.getPomNodeByFixtureName)(fixtureName);
-    if (pomNode) this.add(pomNode);
-  }
-  addByTag(tag) {
-    const fixtureName = extractFixtureName(tag);
-    if (fixtureName) this.addByFixtureName(fixtureName);
-  }
-  resolveFixtureNames(pomNode) {
-    const resolvedFixtureNames = this.usedPoms.get(pomNode);
-    if (resolvedFixtureNames) return resolvedFixtureNames;
-    const fixtureNames = [...pomNode.children].map(child => this.resolveFixtureNames(child)).flat();
-    if (this.usedPoms.has(pomNode)) {
-      // if nothing returned from children, use own fixtureName,
-      // otherwise use what returned from child
-      if (!fixtureNames.length) fixtureNames.push(pomNode.fixtureName);
-      this.usedPoms.set(pomNode, fixtureNames);
-    }
-    return fixtureNames;
-  }
-}
-exports.POMS = POMS;
-function extractFixtureName(tag) {
-  return tag.startsWith(FIXTURE_TAG_PREFIX) ? tag.replace(FIXTURE_TAG_PREFIX, '') : '';
-}
-function buildFixtureTag(fixtureName) {
-  return `${FIXTURE_TAG_PREFIX}${fixtureName}`;
-}

package/build/bdd-framework/stepDefinitions/createDecorators.js

@@ -1,108 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.Fixture = Fixture;
-exports.appendDecoratorSteps = appendDecoratorSteps;
-exports.createStepDecorator = createStepDecorator;
-exports.getPomNodeByFixtureName = getPomNodeByFixtureName;
-var _bddFixtures = require("../run/bddFixtures");
-var _defineStep = require("./defineStep");
-var _buildStepDefinition = require("../cucumber/buildStepDefinition");
-/* eslint-disable no-unused-vars */
-/**
- * Define steps via decorators.
- */
-
-const pomGraph = new Map();
-const decoratedStepSymbol = Symbol('decoratedStep');
-const decoratedSteps = new Set();
-function Fixture(fixtureName) {
-  // context parameter is required for decorator by TS even though it's not used
-  return (Ctor, _context) => {
-    createPomNode(Ctor, fixtureName);
-  };
-}
-function createStepDecorator(keyword) {
-  return pattern => {
-    // context parameter is required for decorator by TS even though it's not used
-    return (method, _context) => {
-      method[decoratedStepSymbol] = {
-        keyword,
-        pattern,
-        fn: method,
-        hasCustomTest: true,
-        isDecorator: true
-      };
-    };
-  };
-}
-function appendDecoratorSteps(supportCodeLibrary) {
-  decoratedSteps.forEach(stepConfig => {
-    const {
-      keyword,
-      pattern,
-      fn
-    } = stepConfig;
-    stepConfig.fn = (fixturesArg, ...args) => {
-      const fixture = getFirstNonAutoInjectFixture(fixturesArg, stepConfig);
-      return fn.call(fixture, ...args);
-    };
-    const code = (0, _defineStep.buildCucumberStepFn)(stepConfig);
-    const stepDefinition = (0, _buildStepDefinition.buildStepDefinition)({
-      keyword,
-      pattern,
-      code,
-      line: 0,
-      // not used in playwright-bdd
-      options: {},
-      // not used in playwright-bdd
-      uri: '' // not used in playwright-bdd
-    }, supportCodeLibrary);
-    supportCodeLibrary.stepDefinitions.push(stepDefinition);
-  });
-  decoratedSteps.clear();
-  // todo: fill supportCodeLibrary.originalCoordinates as it is used in snippets?
-}
-function getPomNodeByFixtureName(fixtureName) {
-  for (const pomNode of pomGraph.values()) {
-    if (pomNode.fixtureName === fixtureName) return pomNode;
-  }
-}
-function createPomNode(Ctor, fixtureName) {
-  const pomNode = {
-    fixtureName,
-    children: new Set()
-  };
-  pomGraph.set(Ctor, pomNode);
-  getDecoratedSteps(Ctor).forEach(stepConfig => {
-    stepConfig.pomNode = pomNode;
-    decoratedSteps.add(stepConfig);
-  });
-  const parentCtor = Object.getPrototypeOf(Ctor);
-  if (!parentCtor) return;
-  const parentPomNode = pomGraph.get(parentCtor) || createPomNode(parentCtor, '');
-  parentPomNode === null || parentPomNode === void 0 || parentPomNode.children.add(pomNode);
-  return pomNode;
-}
-function getDecoratedSteps(Ctor) {
-  if (!(Ctor !== null && Ctor !== void 0 && Ctor.prototype)) return [];
-  const propertyDescriptors = Object.getOwnPropertyDescriptors(Ctor.prototype);
-  return Object.keys(propertyDescriptors)
-  // filter out getters / setters
-  .filter(methodName => typeof propertyDescriptors[methodName].value === 'function').map(methodName => {
-    return propertyDescriptors[methodName].value[decoratedStepSymbol];
-  }).filter(Boolean);
-}
-function getFirstNonAutoInjectFixture(fixturesArg, stepConfig) {
-  // there should be exatcly one suitable fixture in fixturesArg
-  const fixtureNames = Object.keys(fixturesArg).filter(fixtureName => !(0, _bddFixtures.isBddAutoInjectFixture)(fixtureName));
-  if (fixtureNames.length === 0) {
-    throw new Error(`No suitable fixtures found for decorator step "${stepConfig.pattern}"`);
-  }
-  if (fixtureNames.length > 1) {
-    throw new Error(`Several suitable fixtures found for decorator step "${stepConfig.pattern}"`);
-  }
-  return fixturesArg[fixtureNames[0]];
-}

package/build/bdd-poc/core-runner/exportMethods.js

@@ -1,20 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.createBdd = createBdd;
-function Given(description, callback) {
-  globalStepMap.set(description, callback);
-}
-const Then = Given;
-const When = Given;
-const And = Given;
-function createBdd() {
-  return {
-    Given,
-    When,
-    Then,
-    And
-  };
-}

package/build/bdd-poc/core-runner/stepDefinitions.js

@@ -1,53 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.createNativeBDD = createNativeBDD;
-function $Given(description) {
-  const stepFunction = globalStepMap[description];
-  if (stepFunction === undefined) {
-    process.exit(1);
-  }
-  return function (pages, ...argument) {
-    const finalInput = getInputArray(description, argument);
-    return stepFunction(pages, ...finalInput);
-  };
-}
-function getInputArray(description, argument) {
-  const specInput = globalTestdata.get(description);
-  if (specInput.input && specInput.steptable) {
-    const stepInput = Object.values(specInput.currentArgument).pop() || 'null';
-    return [stepInput, specInput.dataTableStep];
-  }
-  if (specInput.input) {
-    return Object.values(specInput.currentArgument) || [];
-  }
-  if (specInput.steptable) {
-    return [specInput.dataTableStep];
-  }
-  if (specInput.scenarioTable) {
-    console.log(specInput.inputParameter);
-    var exceedParam = specInput.inputParameter[0];
-    const extracted = argument.map(element => {
-      return exceedParam[element];
-    });
-    const duplicate = Object.assign({}, specInput);
-    const extractInput = duplicate.inputParameter.shift();
-    duplicate.inputParameter.push(extractInput);
-    globalTestdata.set(description, Object.assign({}, duplicate));
-    return extracted;
-  }
-  return [];
-}
-const $When = $Given;
-const $And = $Given;
-const $Then = $Given;
-function createNativeBDD() {
-  return {
-    $Given,
-    $When,
-    $And,
-    $Then
-  };
-}

package/build/bdd-poc/main.js

@@ -1,10 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.cucumberBDDtoTestFile = cucumberBDDtoTestFile;
-var _stepFileGenerate = require("./test/stepGenerate/stepFileGenerate");
-async function cucumberBDDtoTestFile() {
-  await (0, _stepFileGenerate.generateSpecFiles)();
-}

package/build/bdd-poc/runner.js

@@ -1,19 +0,0 @@
-"use strict";
-
-var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.stepFileMap = stepFileMap;
-var _fastGlob = require("fast-glob");
-var _path = _interopRequireDefault(require("path"));
-async function stepFileMap() {
-  const featureFilePath = _path.default.resolve(process.cwd(), 'uat', 'modules', '**', '**', '**', '**', '**', '**', '**', '**', '*.spec.js').split(`\\`).join('/');
-  await (0, _fastGlob.globSync)(featureFilePath, {
-    dot: true,
-    cwd: process.cwd()
-  }).forEach(FilePath => {
-    const specFilePath = _path.default.resolve(process.cwd(), FilePath);
-    require(specFilePath);
-  });
-}