@zohodesk/testinglibrary 0.1.4-exp.1 → 0.1.4-exp.2

package/build/core/playwright/setup/config-creator.js

@@ -60,7 +60,7 @@ function getPlaywrightConfig() {
     reporter: [['html', {
       outputFolder: reportPath,
       open: openReportOn
-    }], ['list'], ['./src/reporter.js']],
+    }], ['list'], ['./custom-reporter.js']],
     timeout: testTimeout,
     expect: {
       timeout: expectTimeout

package/build/core/playwright/setup/custom-reporter.js

@@ -29,7 +29,9 @@ class JSONSummaryReporter {
     const fileName = [];
     let clean = true;
     for (const s of test.titlePath()) {
-      if (s === '' && clean) continue;
+      if (s === '' && clean) {
+        continue;
+      }
       clean = false;
       title.push(s);
       if (s.includes('.ts') || s.includes('.js')) {
@@ -59,7 +61,9 @@ class JSONSummaryReporter {
     });
     // removing duplicate tests from the failed array
     this.failed = this.failed.filter((element, index) => {
-      if (!this.passed.includes(element)) return this.failed.indexOf(element) === index;
+      if (!this.passed.includes(element)) {
+        return this.failed.indexOf(element) === index;
+      }
     });
     // removing duplicate tests from the skipped array
     this.skipped = this.skipped.filter((element, index) => {

package/build/index.d.ts

@@ -1,5 +1,58 @@
-import { Given, Then, When, Step, expect, test, createBdd } from './core/playwright/index';
+import { expect, test } from './core/playwright/index';
 import { fireEvent, render } from '@testing-library/react';
+import {
+  PlaywrightTestArgs,
+  PlaywrightTestOptions,
+  PlaywrightWorkerArgs,
+  PlaywrightWorkerOptions,
+  TestType
+} from '@playwright/test';
 
-export { Given, Then, When, Step, expect, test, createBdd, fireEvent, render };
-export * from '@playwright/test/types/test';
+export type KeyValue = { [key: string]: any };
+
+export type BuiltInFixturesWorker = PlaywrightWorkerArgs &
+  PlaywrightWorkerOptions;
+export type BuiltInFixtures = PlaywrightTestArgs &
+  PlaywrightTestOptions &
+  BuiltInFixturesWorker;
+
+export type FixturesArg<T extends KeyValue = {}, W extends KeyValue = {}> = T &
+  W &
+  BuiltInFixtures;
+
+export declare let hasCustomTest: boolean;
+
+export declare function createBdd<
+  T extends KeyValue = BuiltInFixtures,
+  W extends KeyValue = BuiltInFixturesWorker,
+  World
+>(
+  customTest?: TestType<T, W> | null,
+  _CustomWorld?: new (...args: any[]) => World
+): {
+  Given: (pattern: DefineStepPattern, fn: StepFunction<T, W>) => void;
+  When: (pattern: DefineStepPattern, fn: StepFunction<T, W>) => void;
+  Then: (pattern: DefineStepPattern, fn: StepFunction<T, W>) => void;
+  And: (pattern: DefineStepPattern, fn: StepFunction<T, W>) => void;
+  But: (pattern: DefineStepPattern, fn: StepFunction<T, W>) => void;
+  Step: (pattern: DefineStepPattern, fn: StepFunction<T, W>) => void;
+  Before: any;
+  After: any;
+  BeforeAll: any;
+  AfterAll: any;
+};
+
+type StepFunctionFixturesArg<
+  T extends KeyValue,
+  W extends KeyValue
+> = FixturesArg<T, W>;
+type StepFunction<T extends KeyValue, W extends KeyValue> = (
+  fixtures: StepFunctionFixturesArg<T, W>,
+  ...args: any[]
+) => unknown;
+
+const { Given, Then, When, Step, And, But } = createBdd();
+
+export { Given, Then, When, Step, And, But, expect, test, createBdd };
+
+export * from '@playwright/test/types/test';

package/build/index.js

@@ -3,7 +3,7 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.When = exports.Then = exports.Step = exports.Given = void 0;
+exports.When = exports.Then = exports.Step = exports.Given = exports.But = exports.And = void 0;
 Object.defineProperty(exports, "createBdd", {
   enumerable: true,
   get: function () {
@@ -45,4 +45,8 @@ const {
 exports.Step = Step;
 exports.When = When;
 exports.Then = Then;
-exports.Given = Given;
+exports.Given = Given;
+const And = Then;
+exports.And = And;
+const But = Then;
+exports.But = But;

package/build/lib/cli.js

@@ -8,6 +8,7 @@ var _logger = require("../utils/logger");
 var _setupProject = _interopRequireDefault(require("../setup-folder-structure/setupProject"));
 var _parser = require("../parser/parser");
 var _clearCaches = _interopRequireDefault(require("../core/playwright/clear-caches"));
+var _helper = _interopRequireDefault(require("../setup-folder-structure/helper"));
 // import createJestRunner from '../core/jest/runner/jest-runner';
 
 const [,, option, ...otherOptions] = process.argv;
@@ -53,6 +54,11 @@ switch (option) {
       (0, _clearCaches.default)();
       break;
     }
+  case 'help':
+    {
+      (0, _helper.default)();
+      break;
+    }
   default:
     {
       _logger.Logger.log(_logger.Logger.SUCCESS_TYPE, 'Supported Commands test and report');

package/build/setup-folder-structure/helper.js

@@ -0,0 +1,34 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+var _commander = require("commander");
+var _fs = require("fs");
+var _path = _interopRequireDefault(require("path"));
+var _logger = require("../utils/logger");
+function helpercmd() {
+  const packageJsonPath = _path.default.resolve(process.cwd(), './package.json');
+  if ((0, _fs.existsSync)(packageJsonPath) && process.argv.includes('--version')) {
+    const {
+      dependencies
+    } = require(packageJsonPath);
+    _logger.Logger.log(_logger.Logger.SUCCESS_TYPE, `zohodesk/testinglibrary Version : ${dependencies['@zohodesk/testinglibrary']}`);
+    _commander.program.version(dependencies['@zohodesk/testinglibrary'] || '0.0.1');
+    return;
+  }
+  _logger.Logger.log(_logger.Logger.SUCCESS_TYPE, 'Supported Commands...');
+  _commander.program.name('npx ZDTestingFramework');
+  _commander.program.command('test').description('This command is used to execute tests');
+  _commander.program.command('init').description('This command will initialize Project');
+  _commander.program.command('report').description('This command is used to generate a report summarizing the results of  executed tests.');
+  _commander.program.command('codegen').description('This command is used to assist developer to write test case');
+  _commander.program.option('--headed', 'Run tests with a headed browser.');
+  _commander.program.option('--debug', 'This command is used to initiate a debugging session');
+  _commander.program.option('--tags', 'Run specific test case with mentioned tags (Useage: -- --tags="@live")');
+  _commander.program.parse(process.argv);
+}
+var _default = helpercmd;
+exports.default = _default;

package/npm-shrinkwrap.json

@@ -1,6 +1,6 @@
 {
   "name": "@zohodesk/testinglibrary",
-  "version": "0.1.4",
+  "version": "0.1.4-exp.2",
   "lockfileVersion": 1,
   "requires": true,
   "dependencies": {
@@ -2577,20 +2577,20 @@
       "integrity": "sha512-Aq58f5HiWdyDlFffbbSjAlv596h/cOnt2DO1w3DOC7OJ5EHs0hd/nycJfiu9RJbT6Yk6F1knnRRXNSpxoIVZ9Q=="
     },
     "@playwright/test": {
-      "version": "1.39.0",
-      "resolved": "https://registry.npmjs.org/@playwright/test/-/test-1.39.0.tgz",
-      "integrity": "sha512-3u1iFqgzl7zr004bGPYiN/5EZpRUSFddQBra8Rqll5N0/vfpqlP9I9EXqAoGacuAbX6c9Ulg/Cjqglp5VkK6UQ==",
+      "version": "1.40.0",
+      "resolved": "https://registry.npmjs.org/@playwright/test/-/test-1.40.0.tgz",
+      "integrity": "sha512-PdW+kn4eV99iP5gxWNSDQCbhMaDVej+RXL5xr6t04nbKLCBwYtA046t7ofoczHOm8u6c+45hpDKQVZqtqwkeQg==",
       "requires": {
-        "playwright": "1.39.0"
+        "playwright": "1.40.0"
       },
       "dependencies": {
         "playwright": {
-          "version": "1.39.0",
-          "resolved": "https://registry.npmjs.org/playwright/-/playwright-1.39.0.tgz",
-          "integrity": "sha512-naE5QT11uC/Oiq0BwZ50gDmy8c8WLPRTEWuSSFVG2egBka/1qMoSqYQcROMT9zLwJ86oPofcTH2jBY/5wWOgIw==",
+          "version": "1.40.0",
+          "resolved": "https://registry.npmjs.org/playwright/-/playwright-1.40.0.tgz",
+          "integrity": "sha512-gyHAgQjiDf1m34Xpwzaqb76KgfzYrhK7iih+2IzcOCoZWr/8ZqmdBw+t0RU85ZmfJMgtgAiNtBQ/KS2325INXw==",
           "requires": {
             "fsevents": "2.3.2",
-            "playwright-core": "1.39.0"
+            "playwright-core": "1.40.0"
           }
         }
       }
@@ -3572,7 +3572,8 @@
     "commander": {
       "version": "11.0.0",
       "resolved": "https://registry.npmjs.org/commander/-/commander-11.0.0.tgz",
-      "integrity": "sha512-9HMlXtt/BNoYr8ooyjjNRdIilOTkVJXB+GhxMTtOKwk0R4j4lS4NpjuqmRxroBfnfTSHQIHQB7wryHhXarNjmQ=="
+      "integrity": "sha512-9HMlXtt/BNoYr8ooyjjNRdIilOTkVJXB+GhxMTtOKwk0R4j4lS4NpjuqmRxroBfnfTSHQIHQB7wryHhXarNjmQ==",
+      "dev": true
     },
     "commondir": {
       "version": "1.0.1",
@@ -6724,9 +6725,9 @@
       }
     },
     "playwright-core": {
-      "version": "1.39.0",
-      "resolved": "https://registry.npmjs.org/playwright-core/-/playwright-core-1.39.0.tgz",
-      "integrity": "sha512-+k4pdZgs1qiM+OUkSjx96YiKsXsmb59evFoqv8SKO067qBA+Z2s/dCzJij/ZhdQcs2zlTAgRKfeiiLm8PQ2qvw=="
+      "version": "1.40.0",
+      "resolved": "https://registry.npmjs.org/playwright-core/-/playwright-core-1.40.0.tgz",
+      "integrity": "sha512-fvKewVJpGeca8t0ipM56jkVSU6Eo0RmFvQ/MaCQNDYm+sdvKkMBBWTE1FdeMqIdumRaXXjZChWHvIzCGM/tA/Q=="
     },
     "pretty-format": {
       "version": "29.7.0",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@zohodesk/testinglibrary",
-  "version": "0.1.4-exp.1",
+  "version": "0.1.4-exp.2",
   "description": "",
   "main": "./build/index.js",
   "scripts": {
@@ -22,13 +22,12 @@
   "dependencies": {
     "@babel/preset-react": "7.22.5",
     "@cucumber/cucumber": "9.2.0",
-    "@playwright/test": "1.39.0",
+    "@playwright/test": "1.40.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",
@@ -49,6 +48,7 @@
     "@babel/plugin-transform-runtime": "7.22.15",
     "@babel/polyfill": "7.12.1",
     "@babel/preset-env": "7.22.15",
-    "@babel/runtime": "7.22.15"
+    "@babel/runtime": "7.22.15",
+    "commander": "^11.0.0"
   }
-}
+}