@zohodesk/testinglibrary 0.1.6 → 0.1.7-exp.2

package/build/core/playwright/tag-processor.js

@@ -4,6 +4,9 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.tagProcessor = tagProcessor;
+var _logger = require("../../utils/logger");
+/* eslint-disable dot-notation */
+
 function getTagsString(tags, editionTags) {
   return tags && tags !== '' ? `${tags} and not (${editionTags})` : `not (${editionTags})`;
 }
@@ -37,7 +40,7 @@ function editionPreprocessing(editionOrder, selectedEdition) {
     }
     return resultArray;
   }
-  Logger.log(Logger.INFO_TYPE, `No matching editions ${selectedEdition} found. Running with default edition`);
+  _logger.Logger.log(_logger.Logger.INFO_TYPE, `No matching editions ${selectedEdition} found. Running with default edition`);
   return [];
 }
 function buildEditionTags(editionArgs, operator) {
@@ -56,7 +59,8 @@ function tagProcessor(userArgsObject, editionOrder) {
       }
     } else {
       // More than one edition given
-      const editionTags = buildEditionTags(editionsArray, 'and');
+      const filteredEditions = editionOrder.filter(edition => !editionsArray.includes(edition));
+      const editionTags = buildEditionTags(filteredEditions, 'or');
       tagArgs = `${getTagsString(tagArgs, editionTags)}`;
     }
   }

package/build/setup-folder-structure/reportEnhancement/addonScript.html

@@ -0,0 +1,25 @@
+<script>
+    function sortEdition(event) {
+      var currentURL = window.location.href;
+      const endPointCount = window.location.href.indexOf('#');
+      if (!(endPointCount == -1)) {
+        window.history.pushState({}, '', currentURL.slice(0, endPointCount));
+        currentURL = currentURL.slice(0, endPointCount);
+      }
+      console.log(currentURL);
+      window.open(`${currentURL}#?q=@edition_${event.target.value}`, '_self');
+    }
+  </script>
+  <div class="mainContainer" style="margin-left: 20px; display: flex;">
+    <div class="selectEditionContainer" style="padding: 20px;">
+      <select class="selectEdition" style="padding: 5px; width: 100px; border-radius: 6px; border: 1px solid var(--color-border-default);"  onchange="sortEdition(event)">
+        <option value="EnterPrise">EnterPrise</option>
+        <option value="Professional">Professional</option>
+        <option value="Express">Express</option>
+        <option value="Standard">Standard</option>
+        <option value="Free">Free</option>
+      </select>
+    </div>
+  </div>
+
+  

package/build/setup-folder-structure/reportEnhancement/reportAlteration.js

@@ -0,0 +1,25 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.preProcessReport = preProcessReport;
+var _fs = _interopRequireDefault(require("fs"));
+var _logger = require("./../../utils/logger");
+var _path = _interopRequireDefault(require("path"));
+const htmlFilePath = _path.default.resolve(process.cwd(), 'uat', 'playwright-report', 'index.html');
+const fileHtml = _fs.default.readFileSync(htmlFilePath, 'utf-8');
+const addOnHtml = _fs.default.readFileSync(_path.default.resolve(__filename, '../', 'addonScript.html'), 'utf-8');
+const splitedHTML = fileHtml.split('\n');
+const toAdd = addOnHtml.split('\n');
+function preProcessReport() {
+  if (_fs.default.existsSync(htmlFilePath)) {
+    const modifiedContent = [...splitedHTML.slice(0, 55), ...toAdd, ...splitedHTML.slice(56)].join('').toString();
+    _fs.default.writeFileSync(htmlFilePath, modifiedContent);
+    return;
+  } else {
+    _logger.Logger.log(_logger.Logger.FAILURE_TYPE, 'Report is not generated Properly ...');
+  }
+  return null;
+}

package/build/utils/fileUtils.js

@@ -10,6 +10,7 @@ exports.deleteFolder = deleteFolder;
 exports.readFileContents = readFileContents;
 exports.writeFileContents = writeFileContents;
 var _fs = _interopRequireDefault(require("fs"));
+var _path = _interopRequireDefault(require("path"));
 function checkIfFileExists(file) {
   try {
     _fs.default.accessSync(file, _fs.default.constants.F_OK);
@@ -27,9 +28,7 @@ function readFileContents(filePath) {
   }
 }
 function writeFileContents(filePath, content, writeOptions = {}) {
-  let filePaths = filePath.split('/');
-  let fileName = filePaths.pop();
-  let directoryPath = filePaths.join('/');
+  const directoryPath = _path.default.dirname(filePath);
 
   // Check if the directory exists
   if (!_fs.default.existsSync(directoryPath)) {
@@ -38,7 +37,7 @@ function writeFileContents(filePath, content, writeOptions = {}) {
     });
   }
   try {
-    _fs.default.writeFileSync(`${directoryPath}/${fileName}`, content, writeOptions);
+    _fs.default.writeFileSync(`${filePath}`, content, writeOptions);
   } catch (err) {
     throw new Error(err);
   }

package/changelog.md

@@ -2,6 +2,16 @@
 
 ## Framework that abstracts the configuration for playwright and Jest
 
+# 0.1.7
+**Enhancements**
+- Added option to run  teardown logic.
+- Added support for tag based filtering.
+- Playwright-bdd version updated to 5.6.0.
+- New fixture added to add tag as annotations in test report
+
+**Issue Fixes**
+- Edition command option. Fixed the edition tags not generated properly
+
 # 0.1.6
 
 **Enhancements**

package/npm-shrinkwrap.json

@@ -1,6 +1,6 @@
 {
   "name": "@zohodesk/testinglibrary",
-  "version": "0.1.6",
+  "version": "0.1.7-exp.1",
   "lockfileVersion": 1,
   "requires": true,
   "dependencies": {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@zohodesk/testinglibrary",
-  "version": "0.1.6",
+  "version": "0.1.7-exp.2",
   "description": "",
   "main": "./build/index.js",
   "scripts": {

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

package/build/bdd-framework/stepDefinitions/createDecorators.js

@@ -1,108 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.Fixture = Fixture;
-exports.appendDecoratorSteps = appendDecoratorSteps;
-exports.createStepDecorator = createStepDecorator;
-exports.getPomNodeByFixtureName = getPomNodeByFixtureName;
-var _bddFixtures = require("../run/bddFixtures");
-var _defineStep = require("./defineStep");
-var _buildStepDefinition = require("../cucumber/buildStepDefinition");
-/* eslint-disable no-unused-vars */
-/**
- * Define steps via decorators.
- */
-
-const pomGraph = new Map();
-const decoratedStepSymbol = Symbol('decoratedStep');
-const decoratedSteps = new Set();
-function Fixture(fixtureName) {
-  // context parameter is required for decorator by TS even though it's not used
-  return (Ctor, _context) => {
-    createPomNode(Ctor, fixtureName);
-  };
-}
-function createStepDecorator(keyword) {
-  return pattern => {
-    // context parameter is required for decorator by TS even though it's not used
-    return (method, _context) => {
-      method[decoratedStepSymbol] = {
-        keyword,
-        pattern,
-        fn: method,
-        hasCustomTest: true,
-        isDecorator: true
-      };
-    };
-  };
-}
-function appendDecoratorSteps(supportCodeLibrary) {
-  decoratedSteps.forEach(stepConfig => {
-    const {
-      keyword,
-      pattern,
-      fn
-    } = stepConfig;
-    stepConfig.fn = (fixturesArg, ...args) => {
-      const fixture = getFirstNonAutoInjectFixture(fixturesArg, stepConfig);
-      return fn.call(fixture, ...args);
-    };
-    const code = (0, _defineStep.buildCucumberStepFn)(stepConfig);
-    const stepDefinition = (0, _buildStepDefinition.buildStepDefinition)({
-      keyword,
-      pattern,
-      code,
-      line: 0,
-      // not used in playwright-bdd
-      options: {},
-      // not used in playwright-bdd
-      uri: '' // not used in playwright-bdd
-    }, supportCodeLibrary);
-    supportCodeLibrary.stepDefinitions.push(stepDefinition);
-  });
-  decoratedSteps.clear();
-  // todo: fill supportCodeLibrary.originalCoordinates as it is used in snippets?
-}
-function getPomNodeByFixtureName(fixtureName) {
-  for (const pomNode of pomGraph.values()) {
-    if (pomNode.fixtureName === fixtureName) return pomNode;
-  }
-}
-function createPomNode(Ctor, fixtureName) {
-  const pomNode = {
-    fixtureName,
-    children: new Set()
-  };
-  pomGraph.set(Ctor, pomNode);
-  getDecoratedSteps(Ctor).forEach(stepConfig => {
-    stepConfig.pomNode = pomNode;
-    decoratedSteps.add(stepConfig);
-  });
-  const parentCtor = Object.getPrototypeOf(Ctor);
-  if (!parentCtor) return;
-  const parentPomNode = pomGraph.get(parentCtor) || createPomNode(parentCtor, '');
-  parentPomNode === null || parentPomNode === void 0 || parentPomNode.children.add(pomNode);
-  return pomNode;
-}
-function getDecoratedSteps(Ctor) {
-  if (!(Ctor !== null && Ctor !== void 0 && Ctor.prototype)) return [];
-  const propertyDescriptors = Object.getOwnPropertyDescriptors(Ctor.prototype);
-  return Object.keys(propertyDescriptors)
-  // filter out getters / setters
-  .filter(methodName => typeof propertyDescriptors[methodName].value === 'function').map(methodName => {
-    return propertyDescriptors[methodName].value[decoratedStepSymbol];
-  }).filter(Boolean);
-}
-function getFirstNonAutoInjectFixture(fixturesArg, stepConfig) {
-  // there should be exatcly one suitable fixture in fixturesArg
-  const fixtureNames = Object.keys(fixturesArg).filter(fixtureName => !(0, _bddFixtures.isBddAutoInjectFixture)(fixtureName));
-  if (fixtureNames.length === 0) {
-    throw new Error(`No suitable fixtures found for decorator step "${stepConfig.pattern}"`);
-  }
-  if (fixtureNames.length > 1) {
-    throw new Error(`Several suitable fixtures found for decorator step "${stepConfig.pattern}"`);
-  }
-  return fixturesArg[fixtureNames[0]];
-}