@zohodesk/testinglibrary 0.1.7 → 0.1.8-exp-bdd

package/package.json

@@ -1,55 +1,54 @@
-{
-  "name": "@zohodesk/testinglibrary",
-  "version": "0.1.7",
-  "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"
-  }
-}
+{
+  "name": "@zohodesk/testinglibrary",
+  "version": "0.1.8-exp-bdd",
+  "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"
+  }
+}

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/config/lang.js

@@ -1,14 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.LANG_EN = void 0;
-exports.isEnglish = isEnglish;
-/**
- * Helpers for Cucumber language option.
- */
-const LANG_EN = exports.LANG_EN = 'en';
-function isEnglish(lang) {
-  return !lang || lang === LANG_EN;
-}

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

@@ -1,48 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.extractFixtureNames = extractFixtureNames;
-exports.extractFixtureNamesFromFnBodyMemo = extractFixtureNamesFromFnBodyMemo;
-var _fixtureParameterNames = require("../playwright/fixtureParameterNames");
-var _bddFixtures = require("../run/bddFixtures");
-var _exit = require("../utils/exit");
-const bodyFixturesSymbol = Symbol('bodyFixtures');
-/**
- * This function is used for playwright-style steps and decorators.
- * It extracts fixtures names from first parameter of function
- * using Playwright's helper.
- */
-function extractFixtureNames(fn) {
-  return (0, _fixtureParameterNames.fixtureParameterNames)(fn).filter(name => !(0, _bddFixtures.isBddAutoInjectFixture)(name));
-}
-/**
- * This function is used for cucumber-style steps.
- * It looks for `this.useFixture('xxx')` entries in function body
- * and extracts fixtures names from it.
- */
-function extractFixtureNamesFromFnBodyMemo(fn) {
-  if (typeof fn !== 'function') {
-    return [];
-  }
-  const fnWithFixtures = fn;
-  if (!fnWithFixtures[bodyFixturesSymbol]) {
-    fnWithFixtures[bodyFixturesSymbol] = extractFixtureNamesFromFnBody(fn).filter(name => !(0, _bddFixtures.isBddAutoInjectFixture)(name));
-  }
-  return fnWithFixtures[bodyFixturesSymbol];
-}
-function extractFixtureNamesFromFnBody(fn) {
-  const matches = fn.toString().matchAll(/this\.useFixture\((.+)\)/gi) || [];
-  return [...matches].map(match => getFixtureName(match[1]));
-}
-function getFixtureName(arg) {
-  if (!/^['"`]/.test(arg)) {
-    // todo: log file location with incorrect useFixture
-    (0, _exit.exit)('this.useFixture() can accept only static string as an argument.');
-  }
-  if (arg.startsWith('`') && arg.includes('${')) {
-    (0, _exit.exit)('this.useFixture() can accept only static string as an argument.');
-  }
-  return arg.replace(/['"`]/g, '');
-}

package/build/bdd-framework/hooks/scenario.js

@@ -1,107 +0,0 @@
-"use strict";
-
-var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.getScenarioHooksFixtures = getScenarioHooksFixtures;
-exports.hasScenarioHooks = hasScenarioHooks;
-exports.runScenarioHooks = runScenarioHooks;
-exports.scenarioHookFactory = scenarioHookFactory;
-var _tagExpressions = _interopRequireDefault(require("@cucumber/tag-expressions"));
-var _fixtureParameterNames = require("../playwright/fixtureParameterNames");
-var _utils = require("../utils");
-/**
- * Scenario level hooks: Before / After.
- *
- * before(async ({ page }) => {})
- */
-
-const scenarioHooks = [];
-let scenarioHooksFixtures;
-/**
- * Returns Before() / After() functions.
- */
-function scenarioHookFactory(type) {
-  return (...args) => {
-    addHook({
-      type,
-      options: getOptionsFromArgs(args),
-      fn: getFnFromArgs(args)
-    });
-  };
-}
-function hasScenarioHooks() {
-  return scenarioHooks.length > 0;
-}
-// eslint-disable-next-line complexity
-async function runScenarioHooks(type, fixtures) {
-  let error;
-  for (const hook of scenarioHooks) {
-    if (hook.type !== type) {
-      continue;
-    }
-    if (hook.tagsExpression && !hook.tagsExpression.evaluate(fixtures.$tags)) {
-      continue;
-    }
-    const {
-      timeout
-    } = hook.options;
-    try {
-      await (0, _utils.callWithTimeout)(() => hook.fn.call(fixtures.$bddWorld, fixtures), timeout, `${type} hook timeout (${timeout} ms)`);
-    } catch (e) {
-      if (type === 'before') {
-        throw e;
-      }
-      if (!error) {
-        error = e;
-      }
-    }
-  }
-  if (error) {
-    throw error;
-  }
-}
-function getScenarioHooksFixtures() {
-  if (!scenarioHooksFixtures) {
-    const fixturesFakeObj = {
-      $bddWorld: null,
-      $tags: null,
-      $testInfo: null
-    };
-    const set = new Set();
-    scenarioHooks.forEach(hook => {
-      (0, _fixtureParameterNames.fixtureParameterNames)(hook.fn).filter(fixtureName => !Object.prototype.hasOwnProperty.call(fixturesFakeObj, fixtureName)).forEach(fixtureName => set.add(fixtureName));
-    });
-    scenarioHooksFixtures = [...set];
-  }
-  return scenarioHooksFixtures;
-}
-function getOptionsFromArgs(args) {
-  if (typeof args[0] === 'string') {
-    return {
-      tags: args[0]
-    };
-  }
-  if (typeof args[0] === 'object') {
-    return args[0];
-  }
-  return {};
-}
-function getFnFromArgs(args) {
-  return args.length === 1 ? args[0] : args[1];
-}
-function setTagsExpression(hook) {
-  if (hook.options.tags) {
-    hook.tagsExpression = (0, _tagExpressions.default)(hook.options.tags);
-  }
-}
-function addHook(hook) {
-  setTagsExpression(hook);
-  if (hook.type === 'before') {
-    scenarioHooks.push(hook);
-  } else {
-    // 'after' hooks run in reverse order
-    scenarioHooks.unshift(hook);
-  }
-}

package/build/bdd-framework/hooks/worker.js

@@ -1,83 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.getWorkerHooksFixtures = getWorkerHooksFixtures;
-exports.runWorkerHooks = runWorkerHooks;
-exports.workerHookFactory = workerHookFactory;
-var _fixtureParameterNames = require("../playwright/fixtureParameterNames");
-var _utils = require("../utils");
-/**
- * Worker-level hooks: BeforeAll / AfterAll.
- */
-
-const workerHooks = [];
-let workerHooksFixtures;
-/**
- * Returns BeforeAll() / AfterAll() functions.
- */
-function workerHookFactory(type) {
-  return (...args) => {
-    addHook({
-      type,
-      options: getOptionsFromArgs(args),
-      fn: getFnFromArgs(args)
-    });
-  };
-}
-// eslint-disable-next-line complexity
-async function runWorkerHooks(type, fixtures) {
-  let error;
-  for (const hook of workerHooks) {
-    if (hook.type !== type) {
-      continue;
-    }
-    const {
-      timeout
-    } = hook.options;
-    try {
-      await (0, _utils.callWithTimeout)(() => hook.fn(fixtures), timeout, `${type} hook timeout (${timeout} ms)`);
-    } catch (e) {
-      if (type === 'beforeAll') {
-        throw e;
-      }
-      if (!error) {
-        error = e;
-      }
-    }
-  }
-  if (error) {
-    throw error;
-  }
-}
-function getWorkerHooksFixtures() {
-  if (!workerHooksFixtures) {
-    const fixturesFakeObj = {
-      $workerInfo: null
-    };
-    const set = new Set();
-    workerHooks.forEach(hook => {
-      (0, _fixtureParameterNames.fixtureParameterNames)(hook.fn).filter(fixtureName => !Object.prototype.hasOwnProperty.call(fixturesFakeObj, fixtureName)).forEach(fixtureName => set.add(fixtureName));
-    });
-    workerHooksFixtures = [...set];
-  }
-  return workerHooksFixtures;
-}
-function getOptionsFromArgs(args) {
-  if (typeof args[0] === 'object') {
-    return args[0];
-  }
-  return {};
-}
-function getFnFromArgs(args) {
-  return args.length === 1 ? args[0] : args[1];
-}
-function addHook(hook) {
-  if (hook.type === 'beforeAll') {
-    workerHooks.push(hook);
-  } else {
-    // 'afterAll' hooks run in reverse order
-    workerHooks.unshift(hook);
-  }
-}

package/build/bdd-framework/run/StepInvoker.js

@@ -1,73 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.StepInvoker = void 0;
-var _loadSteps = require("../cucumber/loadSteps");
-var _getLocationInFile = require("../playwright/getLocationInFile");
-var _testTypeImpl = require("../playwright/testTypeImpl");
-var _defineStep = require("../stepDefinitions/defineStep");
-var _lang = require("../config/lang");
-/**
- * Class to invoke steps in generated files.
- */
-
-class StepInvoker {
-  world;
-  keyword;
-  text = '';
-  argument;
-  constructor(world, keyword) {
-    this.world = world;
-    this.keyword = keyword;
-    this.invoke = this.invoke.bind(this);
-  }
-  async invoke(text, argument, stepFixtures) {
-    this.text = text;
-    this.argument = argument;
-    const {
-      world
-    } = this;
-    world.stepFixtures = stepFixtures || {};
-    const stepDefinition = this.getStepDefinition();
-    // Get location of step call in generated test file.
-    // This call must be exactly here to have correct call stack (before async calls)
-    const location = (0, _getLocationInFile.getLocationInFile)(world.test.info().file);
-    const stepTitle = this.getStepTitle();
-    const code = (0, _defineStep.getStepCode)(stepDefinition);
-    const parameters = await this.getStepParameters(stepDefinition);
-    return (0, _testTypeImpl.runStepWithCustomLocation)(world.test, stepTitle, location, () => code.apply(world, parameters));
-  }
-  getStepDefinition() {
-    const stepDefinition = (0, _loadSteps.findStepDefinition)(this.world.options.supportCodeLibrary, this.text, this.world.testInfo.file);
-    if (!stepDefinition) {
-      throw new Error(`Undefined step: "${this.text}"`);
-    }
-    return stepDefinition;
-  }
-  async getStepParameters(stepDefinition) {
-    const {
-      text,
-      argument,
-      world
-    } = this;
-    const {
-      parameters
-    } = await stepDefinition.getInvocationParameters({
-      hookParameter: {},
-      step: {
-        text,
-        argument
-      },
-      world
-    });
-    return parameters;
-  }
-  getStepTitle() {
-    // Currently prepend keyword only for English.
-    // For other langs it's more complex as we need to pass original keyword from step.
-    return (0, _lang.isEnglish)(this.world.options.lang) ? `${this.keyword} ${this.text}` : this.text;
-  }
-}
-exports.StepInvoker = StepInvoker;