@zohodesk/testinglibrary 0.0.9 → 0.0.10-n20-experimental

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/cucumber/loadConfig.js

@@ -1,17 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.loadConfig = loadConfig;
-var _api = require("@cucumber/cucumber/api");
-const cache = new Map();
-async function loadConfig(options, environment) {
-  const cacheKey = JSON.stringify(options);
-  let config = cache.get(cacheKey);
-  if (!config) {
-    config = (0, _api.loadConfiguration)(options, environment);
-    cache.set(cacheKey, config);
-  }
-  return config;
-}

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

@@ -1,39 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.loadFeatures = loadFeatures;
-var _loadSources = require("./loadSources");
-var _utils = require("../utils");
-async function loadFeatures(runConfiguration, environment) {
-  const {
-    filteredPickles,
-    parseErrors
-  } = await (0, _loadSources.loadSources)(runConfiguration.sources, environment);
-  handleParseErrors(parseErrors);
-  return groupByDocument(filteredPickles);
-}
-function groupByDocument(filteredPickles) {
-  const features = new Map();
-  filteredPickles.forEach(({
-    pickle,
-    gherkinDocument
-  }) => {
-    let pickles = features.get(gherkinDocument);
-    if (!pickles) {
-      pickles = [];
-      features.set(gherkinDocument, pickles);
-    }
-    pickles.push(pickle);
-  });
-  return features;
-}
-function handleParseErrors(parseErrors) {
-  if (parseErrors.length) {
-    const message = parseErrors.map(parseError => {
-      return `Parse error in "${parseError.source.uri}" ${parseError.message}`;
-    }).join('\n');
-    (0, _utils.exitWithMessage)(message);
-  }
-}

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

@@ -1,20 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.loadSnippetBuilder = loadSnippetBuilder;
-var _cucumber = require("@cucumber/cucumber");
-/**
- * Loads snippet builder
- * See: https://github.com/cucumber/cucumber-js/blob/main/src/formatter/builder.ts
- */
-
-async function loadSnippetBuilder(supportCodeLibrary, snippetInterface, snippetSyntax) {
-  return _cucumber.FormatterBuilder.getStepDefinitionSnippetBuilder({
-    cwd: process.cwd(),
-    snippetInterface,
-    snippetSyntax,
-    supportCodeLibrary
-  });
-}

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

@@ -1,57 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.loadSources = loadSources;
-var _paths = require("@cucumber/cucumber/lib/api/paths");
-var _messages = require("@cucumber/messages");
-var _environment = require("@cucumber/cucumber/lib/api/environment");
-var _gherkin = require("@cucumber/cucumber/lib/api/gherkin");
-var _console_logger = require("@cucumber/cucumber/lib/api/console_logger");
-/**
- * Copied from original load_sources, but returns full Pickles.
- * See: https://github.com/cucumber/cucumber-js/blob/main/src/api/load_sources.ts
- */
-
-/**
- * Load and parse features, produce a filtered and ordered test plan and/or parse errors.
- *
- * @public
- * @param coordinates - Coordinates required to find features
- * @param environment - Project environment.
- */
-async function loadSources(coordinates, environment = {}) {
-  const {
-    cwd,
-    stderr,
-    debug
-  } = (0, _environment.mergeEnvironment)(environment);
-  const logger = new _console_logger.ConsoleLogger(stderr, debug);
-  const newId = _messages.IdGenerator.uuid();
-  const {
-    unexpandedFeaturePaths,
-    featurePaths
-  } = await (0, _paths.resolvePaths)(logger, cwd, coordinates);
-  if (featurePaths.length === 0) {
-    return {
-      filteredPickles: [],
-      parseErrors: []
-    };
-  }
-  const {
-    filteredPickles,
-    parseErrors
-  } = await (0, _gherkin.getFilteredPicklesAndErrors)({
-    newId,
-    cwd,
-    logger,
-    unexpandedFeaturePaths,
-    featurePaths,
-    coordinates
-  });
-  return {
-    filteredPickles,
-    parseErrors
-  };
-}

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

@@ -1,35 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.findStepDefinition = findStepDefinition;
-exports.hasTsNodeRegister = hasTsNodeRegister;
-exports.loadSteps = loadSteps;
-var _api = require("@cucumber/cucumber/api");
-var _utils = require("../utils");
-var _transform = require("../playwright/transform");
-const cache = new Map();
-async function loadSteps(runConfiguration, environment = {}) {
-  const cacheKey = JSON.stringify(runConfiguration);
-  let lib = cache.get(cacheKey);
-  if (!lib) {
-    // use Playwright's built-in hook to compile TypeScript steps
-    const uninstall = !hasTsNodeRegister(runConfiguration) ? (0, _transform.installTransform)() : () => {};
-    lib = (0, _api.loadSupport)(runConfiguration, environment).finally(() => uninstall());
-    cache.set(cacheKey, lib);
-  }
-  return lib;
-}
-function findStepDefinition(supportCodeLibrary, stepText, file) {
-  const matchedSteps = supportCodeLibrary.stepDefinitions.filter(step => {
-    return step.matchesStepName(stepText);
-  });
-  if (matchedSteps.length === 0) return;
-  if (matchedSteps.length > 1) (0, _utils.exitWithMessage)([`Several step definitions found for text: ${stepText} (${file})`, ...matchedSteps.map(s => `- ${s.pattern}`)].join('\n'));
-  // todo: check stepDefinition.keyword with PickleStepType
-  return matchedSteps[0];
-}
-function hasTsNodeRegister(runConfiguration) {
-  return runConfiguration.support.requireModules.includes('ts-node/register');
-}

package/build/bdd-framework/decorators.js

@@ -1,22 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-Object.defineProperty(exports, "Fixture", {
-  enumerable: true,
-  get: function () {
-    return _poms.Fixture;
-  }
-});
-exports.When = exports.Then = exports.Step = exports.Given = void 0;
-var _poms = require("./stepDefinitions/decorators/poms");
-var _steps = require("./stepDefinitions/decorators/steps");
-const Given = (0, _steps.createStepDecorator)('Given');
-exports.Given = Given;
-const When = (0, _steps.createStepDecorator)('When');
-exports.When = When;
-const Then = (0, _steps.createStepDecorator)('Then');
-exports.Then = Then;
-const Step = (0, _steps.createStepDecorator)('Unknown');
-exports.Step = Step;

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

@@ -1,88 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.Formatter = void 0;
-var _jsStringWrap = require("../utils/jsStringWrap");
-/**
- * Helper to format Playwright test file.
- */
-
-const TAGS_FIXTURE_TEST_KEY_SEPARATOR = '|';
-class Formatter {
-  config;
-  constructor(config) {
-    this.config = config;
-  }
-  fileHeader(uri, importTestFrom) {
-    const file = (importTestFrom === null || importTestFrom === void 0 ? void 0 : importTestFrom.file) || '@zohodesk/testinglibrary';
-    let varName = (importTestFrom === null || importTestFrom === void 0 ? void 0 : importTestFrom.varName) || 'test';
-    if (varName !== 'test') varName = `${varName} as test`;
-    return [`/** Generated from: ${uri} */`,
-    // this.quoted() is not possible for 'import from' as backticks not parsed
-    `import { ${varName} } from ${JSON.stringify(file)};`, ''];
-  }
-  suite(node, children) {
-    // prettier-ignore
-    return [`test.describe${this.getSubFn(node)}(${this.quoted(node.title)}, () => {`, '', ...children.map(indent), `});`, ''];
-  }
-  beforeEach(fixtures, children) {
-    const fixturesStr = [...fixtures].join(', ');
-    // prettier-ignore
-    return [`test.beforeEach(async ({ ${fixturesStr} }) => {`, ...children.map(indent), `});`, ''];
-  }
-  test(node, fixtures, children) {
-    const fixturesStr = [...fixtures].join(', ');
-    // prettier-ignore
-    return [`test${this.getSubFn(node)}(${this.quoted(node.title)}, async ({ ${fixturesStr} }) => {`, ...children.map(indent), `});`, ''];
-  }
-  // eslint-disable-next-line max-params
-  step(keyword, text, argument, fixtureNames = []) {
-    const fixtures = fixtureNames.length ? `{ ${fixtureNames.join(', ')} }` : '';
-    const argumentArg = argument ? JSON.stringify(argument) : fixtures ? 'null' : '';
-    const textArg = this.quoted(text);
-    const args = [textArg, argumentArg, fixtures].filter(arg => arg !== '').join(', ');
-    return `await ${keyword}(${args});`;
-  }
-  missingStep(keyword, text) {
-    return `// missing step: ${keyword}(${this.quoted(text)});`;
-  }
-  useFixtures(fixtures) {
-    return fixtures.length > 0 ? ['// == technical section ==', '', 'test.use({', ...fixtures.map(indent), '});'] : [];
-  }
-  testFixture() {
-    return ['$test: ({}, use) => use(test),'];
-  }
-  tagsFixture(testNodes) {
-    const lines = testNodes.filter(node => node.tags.length).map(node => {
-      // remove first parent as it is the same for all tests: root suite
-      const key = node.titlePath.slice(1).join(TAGS_FIXTURE_TEST_KEY_SEPARATOR);
-      return `${JSON.stringify(key)}: ${JSON.stringify(node.tags)},`;
-    });
-    return lines.length > 0 ? ['$tags: ({}, use, testInfo) => use({', ...lines.map(indent),
-    // .slice(2) -> b/c we remove filename and root suite title
-    `}[testInfo.titlePath.slice(2).join(${JSON.stringify(TAGS_FIXTURE_TEST_KEY_SEPARATOR)})] || []),`] : [];
-  }
-  getSubFn(node) {
-    if (node.flags.only) return '.only';
-    if (node.flags.skip) return '.skip';
-    if (node.flags.fixme) return '.fixme';
-    return '';
-  }
-  /**
-     * Apply this function only to string literals (mostly titles here).
-     * Objects and arrays are handled with JSON.strinigfy,
-     * b/c object keys can't be in backtiks.
-     * See: https://stackoverflow.com/questions/33194138/template-string-as-object-property-name
-     */
-  quoted(str) {
-    return (0, _jsStringWrap.jsStringWrap)(str, {
-      quotes: this.config.quotes
-    });
-  }
-}
-exports.Formatter = Formatter;
-function indent(value) {
-  return value ? `${'  '}${value}` : value;
-}

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

@@ -1,35 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.getKeywordsMap = getKeywordsMap;
-var _gherkin = require("@cucumber/gherkin");
-/**
- * Get i18n keywords.
- * See: https://github.com/cucumber/cucumber-js/blob/main/src/cli/i18n.ts
- */
-
-function getKeywordsMap(language) {
-  const origMap = _gherkin.dialects[language];
-  if (!origMap) {
-    throw new Error(`Language not found: ${language}`);
-  }
-  const targetMap = new Map();
-  const enKeywords = Object.keys(origMap);
-  enKeywords.forEach(enKeyword => handleKeyword(enKeyword, origMap, targetMap));
-  return targetMap;
-}
-function handleKeyword(enKeyword, origMap, targetMap) {
-  const nativeKeywords = origMap[enKeyword];
-  // Array.isArray converts to any[]
-  if (typeof nativeKeywords === 'string') return;
-  nativeKeywords.forEach(nativeKeyword => {
-    nativeKeyword = nativeKeyword.trim();
-    if (!nativeKeyword || nativeKeyword === '*') return;
-    targetMap.set(nativeKeyword, capitalizeFirstLetter(enKeyword));
-  });
-}
-function capitalizeFirstLetter(s) {
-  return s.charAt(0).toUpperCase() + s.slice(1);
-}

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

@@ -1,160 +0,0 @@
-"use strict";
-
-var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.TestFilesGenerator = void 0;
-var _promises = _interopRequireDefault(require("fs/promises"));
-var _path = _interopRequireDefault(require("path"));
-var _fastGlob = _interopRequireDefault(require("fast-glob"));
-var _testFile = require("./testFile");
-var _loadConfig = require("../cucumber/loadConfig");
-var _loadFeatures = require("../cucumber/loadFeatures");
-var _loadSteps = require("../cucumber/loadSteps");
-var _config = require("../config");
-var _utils = require("../utils");
-var _snippets = require("../snippets");
-var _steps = require("../stepDefinitions/decorators/steps");
-var _transform = require("../playwright/transform");
-var _dir = require("../config/dir");
-var _logger = require("../utils/logger");
-var _tagExpressions = _interopRequireDefault(require("@cucumber/tag-expressions"));
-/**
- * Generate playwright test files from Gherkin documents.
- */
-
-class TestFilesGenerator {
-  config;
-  // all these props are exist
-  runConfiguration;
-  features;
-  supportCodeLibrary;
-  files = [];
-  tagsExpression;
-  logger;
-  constructor(config) {
-    this.config = config;
-    this.logger = new _logger.Logger({
-      verbose: config.verbose
-    });
-    if (config.tags) this.tagsExpression = (0, _tagExpressions.default)(config.tags);
-  }
-  async generate() {
-    await this.loadCucumberConfig();
-    await Promise.all([this.loadFeatures(), this.loadSteps()]);
-    this.buildFiles();
-    await this.checkUndefinedSteps();
-    this.checkImportCustomTest();
-    await this.clearOutputDir();
-    await this.saveFiles();
-  }
-  async extractSteps() {
-    await this.loadCucumberConfig();
-    await this.loadSteps();
-    return this.supportCodeLibrary.stepDefinitions;
-  }
-  async loadCucumberConfig() {
-    const environment = {
-      cwd: (0, _dir.getPlaywrightConfigDir)()
-    };
-    const {
-      runConfiguration
-    } = await (0, _loadConfig.loadConfig)({
-      provided: (0, _config.extractCucumberConfig)(this.config)
-    }, environment);
-    this.runConfiguration = runConfiguration;
-    this.warnForTsNodeRegister();
-  }
-  async loadFeatures() {
-    const environment = {
-      cwd: (0, _dir.getPlaywrightConfigDir)()
-    };
-    this.logger.log(`Loading features from: ${this.runConfiguration.sources.paths.join(', ')}`);
-    this.features = await (0, _loadFeatures.loadFeatures)(this.runConfiguration, environment);
-    this.logger.log(`Loaded features: ${this.features.size}`);
-  }
-  async loadSteps() {
-    const {
-      requirePaths,
-      importPaths
-    } = this.runConfiguration.support;
-    this.logger.log(`Loading steps from: ${requirePaths.concat(importPaths).join(', ')}`);
-    const environment = {
-      cwd: (0, _dir.getPlaywrightConfigDir)()
-    };
-    this.supportCodeLibrary = await (0, _loadSteps.loadSteps)(this.runConfiguration, environment);
-    await this.loadDecoratorSteps();
-    this.logger.log(`Loaded steps: ${this.supportCodeLibrary.stepDefinitions.length}`);
-  }
-  async loadDecoratorSteps() {
-    const {
-      importTestFrom
-    } = this.config;
-    if (importTestFrom) {
-      // require importTestFrom for case when it is not required by step definitions
-      // possible re-require but it's not a problem as it is cached by Node.js
-      await (0, _transform.requireTransform)().requireOrImport(importTestFrom.file);
-      (0, _steps.appendDecoratorSteps)(this.supportCodeLibrary);
-    }
-  }
-  buildFiles() {
-    this.files = [...this.features.entries()].map(([doc, pickles]) => {
-      return new _testFile.TestFile({
-        doc,
-        pickles,
-        supportCodeLibrary: this.supportCodeLibrary,
-        outputPath: this.getOutputPath(doc),
-        config: this.config,
-        tagsExpression: this.tagsExpression
-      }).build();
-    }).filter(file => file.testNodes.length > 0);
-  }
-  getOutputPath(doc) {
-    const configDir = (0, _dir.getPlaywrightConfigDir)();
-    // doc.uri is always relative to cwd (coming after cucumber handling)
-    // see: https://github.com/cucumber/cucumber-js/blob/main/src/api/gherkin.ts#L51
-    const relFeaturePath = doc.uri;
-    const absFeaturePath = _path.default.resolve(configDir, relFeaturePath);
-    const relOutputPath = _path.default.relative(this.config.featuresRoot, absFeaturePath);
-    if (relOutputPath.startsWith('..')) {
-      (0, _utils.exitWithMessage)(`All feature files should be located underneath featuresRoot.`, `Please change featuresRoot or paths in configuration.\n`, `featureFile: ${absFeaturePath}\n`, `featuresRoot: ${this.config.featuresRoot}\n`);
-    }
-    const absOutputPath = _path.default.resolve(this.config.outputDir, relOutputPath);
-    return `${absOutputPath}.spec.js`;
-  }
-  async checkUndefinedSteps() {
-    const undefinedSteps = this.files.reduce((sum, file) => sum + file.undefinedSteps.length, 0);
-    if (undefinedSteps > 0) {
-      const snippets = new _snippets.Snippets(this.files, this.runConfiguration, this.supportCodeLibrary);
-      await snippets.printSnippetsAndExit();
-    }
-  }
-  checkImportCustomTest() {
-    if (this.config.importTestFrom) return;
-    const hasCustomTest = this.files.some(file => file.hasCustomTest);
-    if (hasCustomTest) {
-      (0, _utils.exitWithMessage)(`When using custom "test" function in createBdd() you should`, `set "importTestFrom" config option that points to file exporting custom test.`);
-    }
-  }
-  async saveFiles() {
-    this.files.forEach(file => {
-      file.save();
-      this.logger.log(`Generated: ${_path.default.relative(process.cwd(), file.outputPath)}`);
-    });
-    this.logger.log(`Generated files: ${this.files.length}`);
-  }
-  async clearOutputDir() {
-    const pattern = `${_fastGlob.default.convertPathToPattern(this.config.outputDir)}/**/*.spec.js`;
-    const testFiles = await (0, _fastGlob.default)(pattern);
-    this.logger.log(`Clearing output dir: ${testFiles.length} file(s)`);
-    const tasks = testFiles.map(testFile => _promises.default.rm(testFile));
-    await Promise.all(tasks);
-  }
-  warnForTsNodeRegister() {
-    if ((0, _loadSteps.hasTsNodeRegister)(this.runConfiguration)) {
-      this.logger.warn(`WARNING: usage of requireModule: ['ts-node/register'] is not recommended for playwright-bdd.`, `Remove this option from defineBddConfig() and`, `Playwright's built-in loader will be used to compile TypeScript step definitions.`);
-    }
-  }
-}
-exports.TestFilesGenerator = TestFilesGenerator;

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}`;
-}