@zohodesk/testinglibrary 0.0.3 → 0.0.4-n20-experimental

package/build/core/playwright/test-runner.js

@@ -0,0 +1,116 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+exports.runPreprocessing = runPreprocessing;
+var _child_process = require("child_process");
+var _path = _interopRequireDefault(require("path"));
+var _customCommands = require("./custom-commands");
+var _cliArgsToObject = require("../../utils/cliArgsToObject");
+var _envInitializer = require("./env-initializer");
+var _logger = require("../../utils/logger");
+var _readConfigFile = require("./readConfigFile");
+var _rootPath = require("../../utils/rootPath");
+var _tagProcessor = _interopRequireDefault(require("./tagProcessor"));
+var _configUtils = require("./setup/config-utils");
+var _browserTypes = require("./constants/browserTypes");
+var _ConfigurationHelper = require("./configuration/ConfigurationHelper");
+var _Configuration = _interopRequireDefault(require("./configuration/Configuration"));
+var _UserArgs = _interopRequireDefault(require("./configuration/UserArgs"));
+var _RunnerHelper = _interopRequireDefault(require("./runner/RunnerHelper"));
+var _Runner = _interopRequireDefault(require("./runner/Runner"));
+function runPreprocessing(tagArgs, configPath) {
+  const beforeCommand = 'node';
+  const bddGenPath = _path.default.resolve((0, _rootPath.getExecutableBinaryPath)('bddgen'));
+  const beforeArgs = [bddGenPath, '-c', configPath];
+  if (tagArgs) {
+    beforeArgs.push('--tags');
+    beforeArgs.push(tagArgs);
+  }
+  return new Promise((resolve, reject) => {
+    const childProcessForPreprocessing = (0, _child_process.spawn)(beforeCommand, beforeArgs, {
+      stdio: 'inherit',
+      env: {
+        ...process.env
+      }
+    });
+    childProcessForPreprocessing.on('error', data => {
+      _logger.Logger.log(_logger.Logger.FAILURE_TYPE, data);
+      reject(data);
+    });
+    childProcessForPreprocessing.on('exit', code => {
+      if (code === 0) {
+        _logger.Logger.log(_logger.Logger.SUCCESS_TYPE, 'Feature Files Processed Successfully');
+        resolve();
+      } else {
+        reject(`BddGen exited with code ${code}`);
+      }
+    });
+  });
+}
+function runPlaywright(command, args) {
+  return new Promise((resolve, reject) => {
+    const childProcessForRunningPlaywright = (0, _child_process.spawn)(command, args, {
+      stdio: 'inherit',
+      env: {
+        ...process.env
+      }
+    });
+    childProcessForRunningPlaywright.on('error', error => {
+      _logger.Logger.log(_logger.Logger.FAILURE_TYPE, error);
+    });
+    childProcessForRunningPlaywright.on('exit', (code, signal) => {
+      if (code !== 0) {
+        reject(`Child Process Exited with Code ${code} and Signal ${signal}`);
+      } else {
+        _logger.Logger.log(_logger.Logger.SUCCESS_TYPE, 'Test Ran Successfully');
+        resolve();
+      }
+    });
+    process.on('exit', () => {
+      childProcessForRunningPlaywright.kill();
+      reject('Terminating Playwright Process...');
+    });
+    process.on('SIGINT', () => {
+      childProcessForRunningPlaywright.kill();
+      reject('Cleaning up...');
+    });
+  });
+}
+function main() {
+  // Getting the default config's from framework
+  const uatConfig = new _Configuration.default((0, _readConfigFile.getDefaultConfig)());
+  // overriding the application config's from project
+  const userArgConfig = new _Configuration.default(_UserArgs.default.parseToObject(process.argv.slice(2)));
+  const mode = userArgConfig.get("mode");
+  uatConfig.addAll(new _Configuration.default((0, _ConfigurationHelper.getApplicationConfig)(mode)));
+  // overriding the user config's from CLI
+  uatConfig.addAll(userArgConfig);
+  const modules = uatConfig.get('modules');
+
+  //We need to change this process.env variable to pass the module name in future.
+  process.env.modules = modules;
+  const {
+    isAuthMode,
+    editionOrder,
+    debug,
+    bddMode = false,
+    headless = false
+  } = uatConfig.getAll();
+  (0, _envInitializer.initializeEnvConfig)(mode, isAuthMode);
+
+  //This is only used for pass the user arguments to need places in legacy code. We need to rewamp that also.
+  const userArgsObject = userArgConfig.getAll();
+  const tagProcessor = new _tagProcessor.default(editionOrder);
+  const tagArgs = tagProcessor.processTags(uatConfig.getAll());
+  const runnerObj = new _Runner.default();
+  runnerObj.setTagArgs(tagArgs);
+  runnerObj.setUserArgs(userArgsObject);
+  runnerObj.setConfig(uatConfig);
+  const runner = _RunnerHelper.default.createRunner('spawn', runnerObj);
+  runner.run();
+}
+var _default = exports.default = main;

package/build/core/playwright/types.js

@@ -0,0 +1,44 @@
+/**
+ * @typedef {Object|null} viewportConfig
+ * @property {number} width - width of the viewport
+ * @property {number} height - height of the viewport
+ */
+/**
+ * @typedef {Object|null} viewportConfig
+ * @property {number} width - width of the viewport
+ * @property {number} height - height of the viewport
+ */
+
+/**
+ * @typedef {Object|null} testSetupConfig
+ * @property {any} page - Function that will be called while setting up page fixtures
+ * @property {any} context - Function that will be called while setting up context fixtures
+ */
+
+/**
+ * Represents the user configuration object.
+ * @typedef {Object} UserConfig
+ * @property {string} uatDirectory - Directory in which uat configuration is places.
+ * @property {string} headless - Headless Browsers mode.
+ * @property {number} trace - trace for test cases.
+ * @property {boolean} video - video for test cases,
+ * @property {boolean} debug - debug mode
+ * @property {string} mode: mode in which the test cases needs to run
+ * @property {boolean} isAuthMode -  Auth Mode. config whether authentication step needed before running test cases
+ * @property {string} authFilePath - File Path where the cookies stored
+ * @property {any} browsers: List of browsers
+ * @property {string} openReportOn: default Option value (never, on-failure and always)
+ * @property {any} reportPath : directory where report is generate
+ * @property {boolean} bddMode: Feature files needs to be processed
+ * @property {number} expectTimeout: time in milliseconds which the expect condition should fail
+ * @property {number} testTimeout: time in milliseconds which the test should fail
+ * @property {Object} additionalPages: custom pages configuration
+ * @property {string} featureFilesFolder: folder name under which feature-files will be placed. Default is feature-files
+ * @property {string} stepDefinitionsFolder: folder name under which step implementations will be placed. Default is steps
+ * @property {viewportConfig} viewport: viewport configuration for the browser. Default is { width: 1280, height: 720 }
+ * @property {string} testIdAttribute: Change the default data-testid attribute. configure what attribute to search while calling getByTestId
+ * @property {Array} editionOrder: Order in the form of larger editions in the back. Edition with the most privelages should be last
+ * @property {testSetupConfig} testSetup: Specify page and context functions that will be called while intilaizing fixtures.
+ * @property {string} modules: Modules name to be used for running the specific module test cases.
+ */
+"use strict";

package/build/core/playwright/validateFeature.js

@@ -0,0 +1,28 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+var _parseUserArgs = _interopRequireDefault(require("./helpers/parseUserArgs"));
+var _readConfigFile = require("./readConfigFile");
+var _tagProcessor = _interopRequireDefault(require("./tagProcessor"));
+var _testRunner = require("./test-runner");
+var _logger = require("../../utils/logger");
+const validateFeatureFiles = () => {
+  const userArgsObject = (0, _parseUserArgs.default)();
+  const uatConfig = (0, _readConfigFile.generateConfigFromFile)();
+  const {
+    editionOrder
+  } = uatConfig;
+  const configPath = (0, _readConfigFile.isUserConfigFileAvailable)() ? require.resolve('./setup/config-creator.js') : require.resolve('../../../playwright.config.js');
+  const tagProcessor = new _tagProcessor.default(editionOrder);
+  const tagArgs = tagProcessor.processTags(userArgsObject);
+  (0, _testRunner.runPreprocessing)(tagArgs, configPath).then(() => {
+    _logger.Logger.log(_logger.Logger.SUCCESS_TYPE, 'Feature files validated successfully.');
+  }).catch(error => {
+    _logger.Logger.log(_logger.Logger.FAILURE_TYPE, `Error while validating the feature files - ${error}`);
+  });
+};
+var _default = exports.default = validateFeatureFiles;

package/build/decorators.d.ts

@@ -0,0 +1 @@
+export * from 'playwright-bdd/decorators';

package/build/decorators.js

@@ -0,0 +1,16 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+var _decorators = require("playwright-bdd/decorators");
+Object.keys(_decorators).forEach(function (key) {
+  if (key === "default" || key === "__esModule") return;
+  if (key in exports && exports[key] === _decorators[key]) return;
+  Object.defineProperty(exports, key, {
+    enumerable: true,
+    get: function () {
+      return _decorators[key];
+    }
+  });
+});

package/build/index.d.ts

@@ -0,0 +1,78 @@
+import {
+  expect,
+  test,
+  createBdd
+} from './core/playwright/index';
+import { fireEvent, render } from '@testing-library/react';
+import {
+  PlaywrightTestArgs,
+  PlaywrightTestOptions,
+  PlaywrightWorkerArgs,
+  PlaywrightWorkerOptions,
+  TestType,
+  Page
+} from '@playwright/test';
+import { DefineStepPattern } from '@cucumber/cucumber/lib/support_code_library_builder/types';
+
+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();
+
+type UserConfig = import('./core/playwright/readConfigFile').UserConfig;
+
+export {
+  UserConfig,
+  Given,
+  Then,
+  When,
+  Step,
+  And,
+  But,
+  expect,
+  test,
+  createBdd,
+  Page
+};
+
+export * from '@playwright/test/types/test';

package/build/index.js

@@ -0,0 +1,105 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.When = exports.Then = exports.Step = exports.Given = exports.But = exports.And = void 0;
+Object.defineProperty(exports, "accountLogin", {
+  enumerable: true,
+  get: function () {
+    return _index.accountLogin;
+  }
+});
+Object.defineProperty(exports, "createBdd", {
+  enumerable: true,
+  get: function () {
+    return _index.createBdd;
+  }
+});
+Object.defineProperty(exports, "expect", {
+  enumerable: true,
+  get: function () {
+    return _index.expect;
+  }
+});
+Object.defineProperty(exports, "getDefaultActor", {
+  enumerable: true,
+  get: function () {
+    return _index.getDefaultActor;
+  }
+});
+Object.defineProperty(exports, "getListOfActors", {
+  enumerable: true,
+  get: function () {
+    return _index.getListOfActors;
+  }
+});
+Object.defineProperty(exports, "getRunMode", {
+  enumerable: true,
+  get: function () {
+    return _index.getRunMode;
+  }
+});
+Object.defineProperty(exports, "getUserForSelectedEditionAndProfile", {
+  enumerable: true,
+  get: function () {
+    return _index.getUserForSelectedEditionAndProfile;
+  }
+});
+Object.defineProperty(exports, "isCI", {
+  enumerable: true,
+  get: function () {
+    return _index.isCI;
+  }
+});
+Object.defineProperty(exports, "isDevelopmentSetup", {
+  enumerable: true,
+  get: function () {
+    return _index.isDevelopmentSetup;
+  }
+});
+Object.defineProperty(exports, "loadCookiesIfPresent", {
+  enumerable: true,
+  get: function () {
+    return _index.loadCookiesIfPresent;
+  }
+});
+Object.defineProperty(exports, "performLoginSteps", {
+  enumerable: true,
+  get: function () {
+    return _index.performLoginSteps;
+  }
+});
+Object.defineProperty(exports, "setup", {
+  enumerable: true,
+  get: function () {
+    return _index.setup;
+  }
+});
+Object.defineProperty(exports, "test", {
+  enumerable: true,
+  get: function () {
+    return _index.test;
+  }
+});
+Object.defineProperty(exports, "verifyIfCookieFileExists", {
+  enumerable: true,
+  get: function () {
+    return _index.verifyIfCookieFileExists;
+  }
+});
+var _index = require("./core/playwright/index");
+// import { fireEvent, render } from '@testing-library/react';
+
+const {
+  Given,
+  Then,
+  When,
+  Step
+} = (0, _index.createBdd)();
+exports.Step = Step;
+exports.When = When;
+exports.Then = Then;
+exports.Given = Given;
+const And = exports.And = Then;
+const But = exports.But = Then;

package/build/lib/cli.js

@@ -0,0 +1,78 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+var _testRunner = _interopRequireDefault(require("../core/playwright/test-runner"));
+var _reportGenerator = _interopRequireDefault(require("../core/playwright/report-generator"));
+var _codegen = _interopRequireDefault(require("../core/playwright/codegen"));
+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"));
+var _parseUserArgs = _interopRequireDefault(require("../core/playwright/helpers/parseUserArgs"));
+var _validateFeature = _interopRequireDefault(require("../core/playwright/validateFeature"));
+// import createJestRunner from '../core/jest/runner/jest-runner';
+
+const [,, option, ...otherOptions] = process.argv;
+switch (option) {
+  case 'test':
+    {
+      _logger.Logger.log(_logger.Logger.SUCCESS_TYPE, 'Running Tests..');
+      (0, _testRunner.default)();
+      //createJestRunner();
+      break;
+    }
+  case 'validate':
+    {
+      (0, _validateFeature.default)();
+      break;
+    }
+  case 're-run-failed':
+    {
+      _logger.Logger.log(_logger.Logger.SUCCESS_TYPE, 'Running Failed Tests..');
+      let {
+        filePath
+      } = (0, _parseUserArgs.default)();
+      process.env.isRerunFailedCases = true;
+      process.env.filePath = filePath;
+      (0, _testRunner.default)();
+      break;
+    }
+  case 'report':
+    {
+      // console.log('\x1b[36mGenerating Reports...\x1b[0m');
+      _logger.Logger.log(_logger.Logger.SUCCESS_TYPE, 'Generating Reports...');
+      (0, _reportGenerator.default)();
+      break;
+    }
+  case 'codegen':
+    {
+      _logger.Logger.log(_logger.Logger.INFO_TYPE, 'The purpose of codegen is to assist developer .....');
+      (0, _codegen.default)();
+      break;
+    }
+  case 'init':
+    {
+      _logger.Logger.log(_logger.Logger.SUCCESS_TYPE, 'Initializing projects...');
+      (0, _setupProject.default)();
+      break;
+    }
+  case 'generateSpecFile':
+    {
+      _logger.Logger.log(_logger.Logger.SUCCESS_TYPE, 'Generating Spec file...');
+      (0, _parser.generateSpecCodeForFeatureFile)(otherOptions);
+      break;
+    }
+  case 'clearCaches':
+    {
+      _logger.Logger.log(_logger.Logger.SUCCESS_TYPE, 'Clearing caches...');
+      (0, _clearCaches.default)();
+      break;
+    }
+  case 'help':
+  default:
+    {
+      (0, _helper.default)();
+      break;
+    }
+}

package/build/lib/post-install.js

@@ -0,0 +1,25 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+var _path = _interopRequireDefault(require("path"));
+var _child_process = require("child_process");
+var _logger = require("../utils/logger");
+var _rootPath = require("../utils/rootPath");
+// We are skipping the download of browsers when NODE_ENV is set to production or flag SKIP_BROWSER_DOWNLOAD is set to true
+
+let isSkipDownloadingBrowsers = Boolean(process.env.SKIP_BROWSER_DOWNLOAD);
+let isProductionMode = process.env.NODE_ENV === 'production';
+if (isSkipDownloadingBrowsers || isProductionMode) {
+  _logger.Logger.log(_logger.Logger.INFO_TYPE, 'Skipping browsers download in production mode');
+} else {
+  const playwrightPath = _path.default.resolve((0, _rootPath.getExecutableBinaryPath)('playwright'));
+  const command = playwrightPath;
+  const args = ['install'];
+  _logger.Logger.log(_logger.Logger.INFO_TYPE, `Downloading browsers for running tests`);
+  const childProcess = (0, _child_process.spawn)(command, args, {
+    stdio: 'inherit'
+  });
+  childProcess.on('error', error => {
+    _logger.Logger.log(_logger.Logger.FAILURE_TYPE, error);
+  });
+}

package/build/lint/index.js

@@ -0,0 +1,4 @@
+// const { parse, Document } = require('gherkin-io');
+
+// const document = await parse("Feature: Test\n...", "./features/test.feature");
+"use strict";