@zohodesk/testinglibrary 0.4.8-experimental → 2.9.2

package/.gitlab-ci.yml

@@ -1,4 +1,4 @@
-image: repository.desk.csez.zohocorpin.com/base-image/testing-framework-gitlab-runne-base:v3
+image: repository.desk.csez.zohocorpin.com/base-image/testing-framework-gitlab-runne-base:v2
 
 workflow:
   rules:
@@ -86,27 +86,6 @@ uat-profile:
     paths:
       - examples/uat/playwright-report 
 
-
-uat-unauth:
-  stage: uat
-  image: repository.desk.csez.zohocorpin.com/base-image/testing-framework-gitlab-runne-base:v2
-  script:
-    - npm install 
-    - npm run build
-    - cd examples
-    - npm install $(npm pack ../../testing-framework | tail -1)
-    - output=$(npm run uatunauth)
-    - echo "$output"
-    - if [[ "$output" == *"failed"* ]]; then
-    -   exit 1
-    - fi
-
-
-  artifacts:
-    when: always
-    paths:
-      - examples/uat/playwright-report 
-
 uat-nobdd:
   stage: uat
   script:
@@ -123,4 +102,3 @@ uat-nobdd:
     when: always
     paths:
       - nobdd/uat/playwright-report
-

package/README.md

@@ -26,41 +26,20 @@
 ### Bug fix
   - Updated the custom-reported to include the errors in tests during the executions. It will help us avoid the stage passed without the actual test execution. 
 
-
-## Version History
-
-### v0.2.9 - 25-10-2024
+### v0.2.9 - 24-10-2024
 
 #### Feature
   - Added support for scenario level tag support
   - Added a new cli optin like uat-validate to validate the feature files using playwright-bdd
   - Mode based configuration implementations
   - @only option enabled in dev pipeline
-  - Latest setup related configuration changed for init option
-
-### v0.3.0 - 25-10-2024
-
-#### Features
-  - Added support for scenario level tag support
-  - Updated the configuration for `video` and `trace` to accept Playwright-specific values instead of boolean values.
-  - Below package versions are updated in this release. 
-    - playwright - 1.48.0, 
-    - playwright-bdd - 7.5.0,
-    - @playwright/test - 1.48.0,
-    - @cucumber/cucumber - 11.0.1
-  - From this version, We adopt the playwright-bdd as library instead of modified source
-  - Published on 11-11-2024
-  
-#### Deprecations
-  - **Deprecated**: Passing `video` and `trace` as boolean (`true`/`false`) in project configuration.
-  - **New Approach**: Use Playwright values for `video` and `trace` options, such as `'on'`, `'retain-on-failure'`, or `'off'`.
-
-### v0.3.1 - 13-11-2024
-
-#### Issue Fix
-- Adding bddmode to get the fixtures.
 
 ### v0.2.9.1 - 14-11-2024
 
 #### Enhancement
    - Beta feature Actors and edition configurations are unified 
+
+### v0.2.9.2 - 22-11-2024   
+
+#### BugFix
+    - Implemented synchronization for the login process. This fix will help avoid login session-related failures in UAT.

package/build/bdd-framework/cli/commands/env.js

@@ -0,0 +1,42 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.envCommand = void 0;
+exports.getOwnVersion = getOwnVersion;
+var _commander = require("commander");
+var _options = require("../options");
+var _path = _interopRequireDefault(require("path"));
+var _logger = require("../../utils/logger");
+var _utils = require("../../utils");
+var _loadConfig = require("../../playwright/loadConfig");
+const logger = new _logger.Logger({
+  verbose: true
+});
+const envCommand = exports.envCommand = new _commander.Command('env').description('Prints environment info').addOption(_options.configOption).action(opts => {
+  logger.log(`Playwright-bdd environment info:\n`);
+  logger.log(`platform: ${process.platform}`);
+  logger.log(`node: ${process.version}`);
+  showPackageVersion('playwright-bdd');
+  showPackageVersion('@playwright/test');
+  showPackageVersion('@cucumber/cucumber');
+  showPlaywrightConfigPath(opts.config);
+});
+function showPackageVersion(packageName) {
+  const version = packageName === 'playwright-bdd' ? getOwnVersion() : (0, _utils.getPackageVersion)(packageName);
+  logger.log(`${packageName}: v${version}`);
+}
+/**
+ * Getting own version by relative path instead of using getPackageVersion(),
+ * to aneble using directly from /dist in tests.
+ */
+function getOwnVersion() {
+  return '6.1.1';
+}
+function showPlaywrightConfigPath(cliConfigPath) {
+  const resolvedConfigFile = (0, _loadConfig.resolveConfigFile)(cliConfigPath);
+  const relPath = _path.default.relative(process.cwd(), resolvedConfigFile);
+  logger.log(`Playwright config file: ${relPath}`);
+}

package/build/bdd-framework/cli/commands/export.js

@@ -0,0 +1,62 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.exportCommand = void 0;
+var _path = _interopRequireDefault(require("path"));
+var _commander = require("commander");
+var _options = require("../options");
+var _loadConfig = require("../../playwright/loadConfig");
+var _logger = require("../../utils/logger");
+var _env = require("../../config/env");
+var _test = require("./test");
+var _gen = require("../../gen");
+const logger = new _logger.Logger({
+  verbose: true
+});
+const exportCommand = exports.exportCommand = new _commander.Command('export').description('Prints step definitions').addOption(_options.configOption).option('--unused-steps', 'Output only unused steps').action(async opts => {
+  const {
+    resolvedConfigFile
+  } = await (0, _loadConfig.loadConfig)(opts.config);
+  logger.log(`Using config: ${_path.default.relative(process.cwd(), resolvedConfigFile)}`);
+  const configs = Object.values((0, _env.getEnvConfigs)());
+  (0, _test.assertConfigsCount)(configs);
+  if (opts.unusedSteps) {
+    await showUnusedStepsForConfigs(configs);
+  } else {
+    await showStepsForConfigs(configs);
+  }
+});
+async function showStepsForConfigs(configs) {
+  // here we don't need workers (as in test command) because if some step files
+  // are already in node cache, we collected them.
+  const steps = new Set();
+  const tasks = configs.map(async config => {
+    const stepDefinitions = await new _gen.TestFilesGenerator(config).extractSteps();
+    stepDefinitions.forEach(s => steps.add(`* ${getStepText(s)}`));
+  });
+  await Promise.all(tasks);
+  logger.log(`List of all steps (${steps.size}):`);
+  steps.forEach(stepText => logger.log(stepText));
+}
+async function showUnusedStepsForConfigs(configs) {
+  const steps = new Set();
+  const tasks = configs.map(async config => {
+    const stepDefinitions = await new _gen.TestFilesGenerator(config).extractUnusedSteps();
+    stepDefinitions.forEach(s => steps.add(`* ${getStepText(s)}`));
+  });
+  await Promise.all(tasks);
+  logger.log(`List of unused steps (${steps.size}):`);
+  steps.forEach(stepText => logger.log(stepText));
+}
+function getStepText({
+  pattern,
+  keyword
+}) {
+  // for Unknown return When as it looks the most suitable
+  const keywordText = keyword === 'Unknown' ? 'When' : keyword;
+  const patternText = typeof pattern === 'string' ? pattern : pattern.source;
+  return `${keywordText} ${patternText}`;
+}

package/build/bdd-framework/cli/commands/test.js

@@ -0,0 +1,64 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.assertConfigsCount = assertConfigsCount;
+exports.testCommand = void 0;
+var _worker_threads = require("worker_threads");
+var _events = require("events");
+var _path = _interopRequireDefault(require("path"));
+var _commander = require("commander");
+var _gen = require("../../gen");
+var _loadConfig = require("../../playwright/loadConfig");
+var _env = require("../../config/env");
+var _config = require("../../config");
+var _options = require("../options");
+var _exit = require("../../utils/exit");
+const GEN_WORKER_PATH = _path.default.resolve(__dirname, '..', 'worker.js');
+const testCommand = exports.testCommand = new _commander.Command('test').description('Generate Playwright test files from Gherkin documents').addOption(_options.configOption).option('--tags <expression>', `Tags expression to filter scenarios for generation`).option('--verbose', `Verbose mode (default: ${Boolean(_config.defaults.verbose)})`).action(async opts => {
+  await (0, _loadConfig.loadConfig)(opts.config);
+  const configs = readConfigsFromEnv();
+  mergeCliOptions(configs, opts);
+  await generateFilesForConfigs(configs);
+});
+function readConfigsFromEnv() {
+  const configs = Object.values((0, _env.getEnvConfigs)());
+  assertConfigsCount(configs);
+  return configs;
+}
+function mergeCliOptions(configs, opts) {
+  configs.forEach(config => {
+    if ('tags' in opts) {
+      config.tags = opts.tags;
+    }
+    if ('verbose' in opts) {
+      config.verbose = Boolean(opts.verbose);
+    }
+  });
+}
+function assertConfigsCount(configs) {
+  if (configs.length === 0) {
+    (0, _exit.exit)(`No BDD configs found. Did you use defineBddConfig() in playwright.config.ts?`);
+  }
+}
+async function generateFilesForConfigs(configs) {
+  // run first config in main thread and other in workers (to have fresh require cache)
+  // See: https://github.com/vitalets/playwright-bdd/issues/32
+  const tasks = configs.map((config, index) => {
+    return index === 0 ? new _gen.TestFilesGenerator(config).generate() : runInWorker(config);
+  });
+  return Promise.all(tasks);
+}
+async function runInWorker(config) {
+  const worker = new _worker_threads.Worker(GEN_WORKER_PATH, {
+    workerData: {
+      config
+    }
+  });
+  const [exitCode] = await (0, _events.once)(worker, 'exit');
+  if (exitCode) {
+    (0, _exit.exit)();
+  }
+}

package/build/bdd-framework/cli/index.js

@@ -0,0 +1,11 @@
+#!/usr/bin/env node
+"use strict";
+
+var _commander = require("commander");
+var _test = require("./commands/test");
+var _env = require("./commands/env");
+var _export = require("./commands/export");
+const program = new _commander.Command();
+program.name('bddgen').description(`Playwright-bdd CLI v${(0, _env.getOwnVersion)()}`).addCommand(_test.testCommand, {
+  isDefault: true
+}).addCommand(_export.exportCommand).addCommand(_env.envCommand).addHelpCommand(false).parse();

package/build/bdd-framework/cli/options.js

@@ -0,0 +1,19 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.configOption = void 0;
+exports.getCliConfigPath = getCliConfigPath;
+var _commander = require("commander");
+/**
+ * Config option moved to separate file as it used in test run.
+ */
+
+const configOption = exports.configOption = new _commander.Option(`-c, --config <file>`, `Path to Playwright configuration file (default: playwright.config.(js|ts))`);
+/**
+ * Helper used in test run to detect config location.
+ */
+function getCliConfigPath() {
+  return new _commander.Command().allowUnknownOption().addOption(configOption).parse().getOptionValue('config');
+}

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

@@ -0,0 +1,13 @@
+"use strict";
+
+var _worker_threads = require("worker_threads");
+var _gen = require("../gen");
+/**
+ * Worker to generate test files with fresh require/import cache
+ * See: https://github.com/nodejs/modules/issues/307#issuecomment-858729422
+ */
+
+async function main() {
+  await new _gen.TestFilesGenerator(_worker_threads.workerData.config).generate();
+}
+main();

package/build/bdd-framework/config/configDir.js

@@ -0,0 +1,35 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.getPlaywrightConfigDir = getPlaywrightConfigDir;
+var _path = _interopRequireDefault(require("path"));
+var _loadConfig = require("../playwright/loadConfig");
+var _options = require("../cli/options");
+/**
+ * Store playwright config dir in env to provide access to it in workers.
+ * Important that in workers there is different process.argv, that's why we save it to env.
+ * Config dir is needed to resolve all paths (features, step definitions).
+ */
+
+/**
+ * Returns Playwright config dir considering cli --config option.
+ */
+function getPlaywrightConfigDir({
+  resolveAndSave = false
+} = {}) {
+  let configDir = process.env.PLAYWRIGHT_BDD_CONFIG_DIR;
+  if (!configDir) {
+    if (resolveAndSave) {
+      const cliConfigPath = (0, _options.getCliConfigPath)();
+      const playwrightConfigFile = (0, _loadConfig.resolveConfigFile)(cliConfigPath);
+      configDir = playwrightConfigFile ? _path.default.dirname(playwrightConfigFile) : process.cwd();
+      process.env.PLAYWRIGHT_BDD_CONFIG_DIR = configDir;
+    } else {
+      throw new Error(`Something went wrong: PLAYWRIGHT_BDD_CONFIG_DIR is not set.`);
+    }
+  }
+  return configDir;
+}

package/build/bdd-framework/config/enrichReporterData.js

@@ -0,0 +1,23 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.enableEnrichReporterData = enableEnrichReporterData;
+exports.getEnrichReporterData = getEnrichReporterData;
+function enableEnrichReporterData() {
+  process.env.PLAYWRIGHT_BDD_ENRICH_REPORTER_DATA = '1';
+}
+function getEnrichReporterData(config) {
+  const enrichReporterDataFromEnv = Boolean(process.env.PLAYWRIGHT_BDD_ENRICH_REPORTER_DATA);
+  if (config.enrichReporterData === true) {
+    return true;
+  }
+  if (config.enrichReporterData === false) {
+    if (enrichReporterDataFromEnv) {
+      throw new Error([`Cucumber reports can't work with enrichReporterData = false in bdd config.`, `Please, set enrichReporterData = true OR remove it from config`, `to let it be auto-configured.`].join(' '));
+    }
+    return false;
+  }
+  return enrichReporterDataFromEnv;
+}

package/build/bdd-framework/config/env.js

@@ -0,0 +1,50 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.getConfigFromEnv = getConfigFromEnv;
+exports.getEnvConfigs = getEnvConfigs;
+exports.saveConfigToEnv = saveConfigToEnv;
+var _path = _interopRequireDefault(require("path"));
+var _exit = require("../utils/exit");
+/**
+ * Storing configs in env var PLAYWRIGHT_BDD_CONFIGS as JSON-stringified values.
+ * For passing configs to playwright workers and bddgen.
+ */
+
+function saveConfigToEnv(config) {
+  const envConfigs = getEnvConfigs();
+  const existingConfig = envConfigs[config.outputDir];
+  if (existingConfig) {
+    // Playwright config can be evaluated several times.
+    // Throw error only if different calls of defineBddConfig() use the same outputDir.
+    // See: https://github.com/vitalets/playwright-bdd/issues/39#issuecomment-1653805368
+    if (!isSameConfigs(config, existingConfig)) {
+      (0, _exit.exit)(`When using several calls of defineBddConfig()`, `please manually provide different "outputDir" option.`);
+    }
+    return;
+  }
+  envConfigs[config.outputDir] = config;
+  saveEnvConfigs(envConfigs);
+}
+function getConfigFromEnv(outputDir) {
+  const envConfigs = getEnvConfigs();
+  outputDir = _path.default.resolve(outputDir);
+  const config = envConfigs[outputDir];
+  if (!config) {
+    // exit(`Config not found for outputDir: "${outputDir}".`, `Available dirs: ${Object.keys(envConfigs).join('\n')}`);
+    return {};
+  }
+  return config;
+}
+function getEnvConfigs() {
+  return JSON.parse(process.env.PLAYWRIGHT_BDD_CONFIGS || '{}');
+}
+function saveEnvConfigs(envConfigs) {
+  process.env.PLAYWRIGHT_BDD_CONFIGS = JSON.stringify(envConfigs);
+}
+function isSameConfigs(config1, config2) {
+  return JSON.stringify(config1) === JSON.stringify(config2);
+}

package/build/bdd-framework/config/index.js

@@ -0,0 +1,94 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.defaults = void 0;
+exports.defineBddConfig = defineBddConfig;
+exports.extractCucumberConfig = extractCucumberConfig;
+var _path = _interopRequireDefault(require("path"));
+var _env = require("./env");
+var _configDir = require("./configDir");
+var _utils = require("../utils");
+/**
+ * BDD Config.
+ */
+
+const defaults = exports.defaults = {
+  outputDir: '.features-gen',
+  verbose: false,
+  examplesTitleFormat: 'Example #<_index_>',
+  publishQuiet: true,
+  quotes: 'double'
+};
+function defineBddConfig(inputConfig) {
+  const isMainProcess = !process.env.TEST_WORKER_INDEX;
+  const configDir = (0, _configDir.getPlaywrightConfigDir)({
+    resolveAndSave: isMainProcess
+  });
+  const config = getConfig(configDir, inputConfig);
+  // In main process store config in env to be accessible by workers
+  if (isMainProcess) {
+    (0, _env.saveConfigToEnv)(config);
+  }
+  return config.outputDir;
+}
+function getConfig(configDir, inputConfig) {
+  const config = Object.assign({}, defaults, inputConfig);
+  const featuresRoot = config.featuresRoot ? _path.default.resolve(configDir, config.featuresRoot) : configDir;
+  return {
+    ...config,
+    // important to resolve outputDir as it is used as unique key for input configs
+    outputDir: _path.default.resolve(configDir, config.outputDir),
+    importTestFrom: resolveImportTestFrom(configDir, config.importTestFrom),
+    featuresRoot
+  };
+}
+function extractCucumberConfig(config) {
+  // todo: find more strict way to omit own config fields
+  // see: https://bobbyhadz.com/blog/typescript-object-remove-property
+  const omitProps = {
+    outputDir: true,
+    importTestFrom: true,
+    verbose: true,
+    skip: true,
+    examplesTitleFormat: true,
+    quotes: true,
+    tags: true,
+    featuresRoot: true,
+    enrichReporterData: true
+  };
+  const keys = Object.keys(omitProps);
+  const cucumberConfig = {
+    ...config
+  };
+  keys.forEach(key => delete cucumberConfig[key]);
+  stripPublishQuiet(cucumberConfig);
+  return cucumberConfig;
+}
+function resolveImportTestFrom(configDir, importTestFrom) {
+  if (importTestFrom) {
+    const {
+      file,
+      varName
+    } = typeof importTestFrom === 'string' ? {
+      file: importTestFrom
+    } : importTestFrom;
+    return {
+      file: _path.default.resolve(configDir, file),
+      varName
+    };
+  }
+}
+function stripPublishQuiet(cucumberConfig) {
+  const cucumberVersion = (0, _utils.getPackageVersion)('@cucumber/cucumber');
+  // Playwright-bdd supports Cucumber from v9+
+  // publishQuiet was deprecated in Cucumber 9.4.0.
+  // See: https://github.com/cucumber/cucumber-js/pull/2311
+  // Remove publishQuite from Cucumber config to hide deprecation warning.
+  // See: https://github.com/vitalets/playwright-bdd/pull/47
+  if (!/^9\.[0123]\./.test(cucumberVersion)) {
+    delete cucumberConfig.publishQuiet;
+  }
+}

package/build/bdd-framework/config/lang.js

@@ -0,0 +1,14 @@
+"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/cucumber/buildStepDefinition.js

@@ -0,0 +1,43 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.buildStepDefinition = buildStepDefinition;
+var _messages = require("@cucumber/messages");
+var _cucumberExpressions = require("@cucumber/cucumber-expressions");
+var _step_definition = _interopRequireDefault(require("@cucumber/cucumber/lib/models/step_definition"));
+/**
+ * Extracted from cucumber SupportCodeLibraryBuilder.
+ * See: https://github.com/cucumber/cucumber-js/blob/main/src/support_code_library_builder/index.ts
+ */
+
+const newId = _messages.IdGenerator.uuid();
+function buildStepDefinition({
+  keyword,
+  pattern,
+  code,
+  line,
+  options,
+  uri
+}, supportCodeLibrary) {
+  // todo: handle error.undefinedParameterTypeName as it's done in cucumber?
+  const expression = typeof pattern === 'string' ? new _cucumberExpressions.CucumberExpression(pattern, supportCodeLibrary.parameterTypeRegistry) : new _cucumberExpressions.RegularExpression(pattern, supportCodeLibrary.parameterTypeRegistry);
+  // skip wrapping code as it is not needed for decorator steps
+  // const wrappedCode = this.wrapCode({
+  //   code,
+  //   wrapperOptions: options.wrapperOptions,
+  // })
+  return new _step_definition.default({
+    code,
+    expression,
+    id: newId(),
+    line,
+    options,
+    keyword,
+    pattern,
+    unwrappedCode: code,
+    uri
+  });
+}

package/build/bdd-framework/cucumber/createTestStep.js

@@ -0,0 +1,43 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.createTestStep = createTestStep;
+/**
+ * Creates partial TestStep for usage in reporter.
+ * It is partial, b/c final pickleStepId will be known only in reporter.
+ *
+ * See: https://github.com/cucumber/cucumber-js/blob/main/src/runtime/assemble_test_cases.ts#L93
+ */
+function createTestStep(stepDefinition, stepText) {
+  const result = stepDefinition.expression.match(stepText);
+  if (!result) {
+    // this should not happen as stepDefinition is already matched
+    throw Error(`Step definition didn't match step "${stepText}"`);
+  }
+  const stepMatchArguments = result.map(arg => {
+    return {
+      group: mapArgumentGroup(arg.group),
+      parameterTypeName: arg.parameterType.name
+    };
+  });
+  return {
+    // id will be generated in reporter, no need to generate it here
+    id: '',
+    // looks like it's useless to store stepDefinitionIds here
+    // b/c they will be different in reporter
+    // stepDefinitionIds: [stepDefinition.id],
+    stepMatchArgumentsLists: [{
+      stepMatchArguments
+    }]
+  };
+}
+function mapArgumentGroup(group) {
+  var _group$children;
+  return {
+    start: group.start,
+    value: group.value,
+    children: (_group$children = group.children) === null || _group$children === void 0 ? void 0 : _group$children.map(child => mapArgumentGroup(child))
+  };
+}