@zohodesk/testinglibrary 3.1.10-experimental → 3.1.14

package/.gitlab-ci.yml

@@ -146,4 +146,18 @@ uatconfigmodule:
     paths:
       - examples/uat/playwright-report
 
+uat-smoketest:
+  stage: uat
+  script:
+    - cd examples
+    - npm install $(npm pack ../../testing-framework | tail -1)
+    - output=$(npm run uat-smoketest)
+    - echo "$output"
+    - node ../ValidateUATReport.js examples
+
+  artifacts:
+    when: always
+    paths:
+      - examples/uat/playwright-report
+
       

package/build/core/playwright/builtInFixtures/page.js

@@ -9,6 +9,8 @@ var _auth = require("../helpers/auth");
 var _readConfigFile = require("../readConfigFile");
 /* eslint-disable global-require */
 
+//import { additionProfiles } from '../helpers/additionalProfiles';
+
 function getTagInputFromSelectedTags(tags, inputString) {
   const selectedTag = [...tags].reverse().find(tag => tag.startsWith(inputString));
   let tagInput = null;
@@ -18,7 +20,7 @@ function getTagInputFromSelectedTags(tags, inputString) {
   return tagInput;
 }
 function getCustomAccountDetails(tags) {
-  const tagsTobeFiltered = ['@profile', '@edition', '@beta', '@portal'];
+  const tagsTobeFiltered = ['@profile', '@edition', '@beta', '@portal', '@additional_profile'];
   const filteredTags = tags.filter(tag => tagsTobeFiltered.some(prefix => tag.startsWith(prefix)));
   if (filteredTags && filteredTags.length > 0) {
     const portalInfo = getTagInputFromSelectedTags(filteredTags, '@portal');

package/build/core/playwright/helpers/additionalProfiles.js

@@ -0,0 +1,18 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.additionProfiles = additionProfiles;
+var _getUsers = require("./auth/getUsers");
+function additionProfiles(tags, editionInfo, betaFeature, portalInfo) {
+  const additionalProfileTags = tags.filter(tag => tag.startsWith('@additional_profile_'));
+  let additionalProfileActors = [];
+  if (additionalProfileTags.length > 0 && editionInfo) {
+    additionalProfileActors = additionalProfileTags.map(tag => {
+      const additionalProfile = tag.replace('@additional_profile_', '');
+      return (0, _getUsers.getUserForSelectedEditionAndProfile)(editionInfo, additionalProfile, betaFeature, portalInfo);
+    });
+  }
+  return additionalProfileActors;
+}

package/build/core/playwright/helpers/auth/index.js

@@ -4,12 +4,6 @@ var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefau
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-Object.defineProperty(exports, "DataGenerator", {
-  enumerable: true,
-  get: function () {
-    return _DataGenerator.default;
-  }
-});
 Object.defineProperty(exports, "accountLogin", {
   enumerable: true,
   get: function () {
@@ -79,5 +73,4 @@ Object.defineProperty(exports, "verifyIfCookieFileExists", {
 var _accountLogin = _interopRequireDefault(require("./accountLogin"));
 var _checkAuthCookies = require("./checkAuthCookies");
 var _getUsers = require("./getUsers");
-var _loginSteps = _interopRequireDefault(require("./loginSteps"));
-var _DataGenerator = _interopRequireDefault(require("../../../../common/data-generator/DataGenerator"));
+var _loginSteps = _interopRequireDefault(require("./loginSteps"));

package/build/core/playwright/helpers/auth/loginSteps.js

@@ -10,7 +10,6 @@ var _fileMutex = _interopRequireDefault(require("../fileMutex"));
 var _fileMutexConfig = require("../../constants/fileMutexConfig");
 var _checkAuthCookies = require("./checkAuthCookies");
 var _checkAuthDirectory = require("../checkAuthDirectory");
-var _fs = require("fs");
 /* eslint-disable no-console */
 
 async function performLoginSteps(testInfo, isLoggedIn, loginSteps) {

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

@@ -12,6 +12,7 @@ var _configUtils = require("./config-utils");
 const uatConfig = (0, _readConfigFile.generateConfigFromFile)();
 const {
   browsers,
+  isSmokeTest,
   trace,
   video,
   isAuthMode,
@@ -31,14 +32,23 @@ const {
 const projects = (0, _configUtils.getProjects)({
   browsers,
   isAuthMode,
+  isSmokeTest,
   authFilePath,
   expectTimeout,
   testTimeout,
   viewport
 });
-const testDir = (0, _configUtils.getTestDir)(bddMode, process.cwd(), {
-  featureFilesFolder,
-  stepDefinitionsFolder
+const testDir = (0, _configUtils.getTestDir)(bddMode, {
+  featureFilesFolder: (0, _configUtils.getPathsForFeatureFiles)(process.cwd()),
+  stepDefinitionsFolder: _path.default.join(process.cwd(), 'uat', '**', 'steps', '*.spec.js'),
+  outputDir: _path.default.join(process.cwd(), 'uat', '.features-gen'),
+  uatPath: _path.default.join(process.cwd(), 'uat')
+});
+const smokeTestDir = (0, _configUtils.getTestDir)(bddMode, {
+  featureFilesFolder: _path.default.join(process.cwd(), 'uat', 'smokeTest', '**', '*.feature'),
+  stepDefinitionsFolder: _path.default.join(process.cwd(), 'uat', 'smokeTest', '**', '*smokeTest.spec.js'),
+  outputDir: _path.default.join(process.cwd(), 'uat', '.features-smoke-gen'),
+  uatPath: _path.default.join(process.cwd(), 'uat', 'smokeTest')
 });
 const use = {
   trace,
@@ -61,7 +71,20 @@ if (customReporter) {
  *
  * @returns {import('@playwright/test').PlaywrightTestConfig}
  */
+
 function getPlaywrightConfig() {
+  const commonConfig = {
+    storageState: isAuthMode ? (0, _readConfigFile.getAuthFilePath)(_path.default.resolve(process.cwd(), authFilePath)) : {}
+  };
+  const dependencies = isAuthMode ? ['setup'] : [];
+  const smokeTestProject = {
+    name: 'smokeTest',
+    testDir: smokeTestDir,
+    use: {
+      ...commonConfig
+    },
+    dependencies: dependencies
+  };
   const playwrightConfig = {
     testDir,
     globalTimeout: globalTimeout || 3600000,
@@ -78,11 +101,11 @@ function getPlaywrightConfig() {
       testMatch: /.*\.setup\.js/,
       testDir: _path.default.join(process.cwd(), 'uat'),
       teardown: 'cleanup'
-    }, {
+    }, ...(isSmokeTest ? [smokeTestProject] : []), {
       name: 'cleanup',
       testMatch: /.*\.teardown\.js/,
       testDir: _path.default.join(process.cwd(), 'uat')
-    }, ...projects] : [...projects],
+    }, ...projects] : [...projects, ...(isSmokeTest ? [smokeTestProject] : [])],
     ...uatConfig
   };
   return playwrightConfig;

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

@@ -6,6 +6,7 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.getBrowsersList = getBrowsersList;
 exports.getModulePathForFeatureFiles = getModulePathForFeatureFiles;
+exports.getPathsForFeatureFiles = getPathsForFeatureFiles;
 exports.getProjects = getProjects;
 exports.getTestDir = getTestDir;
 var _test = require("@playwright/test");
@@ -19,9 +20,11 @@ var _fileUtils = require("../../../utils/fileUtils");
  ** Playwright project configuration
  * @returns {import('@playwright/test').Project}
  */
+
 function getBrowserConfig({
   browserName,
   isAuthMode,
+  isSmokeTest,
   authFilePath,
   expectTimeout,
   testTimeout,
@@ -32,7 +35,9 @@ function getBrowserConfig({
     viewport,
     storageState: isAuthMode ? (0, _readConfigFile.getAuthFilePath)(_path.default.resolve(process.cwd(), authFilePath)) : {}
   };
-  const dependencies = isAuthMode ? ['setup'] : [];
+  // Determine dependencies based on the mode and smoke test status
+  let dependencies = isAuthMode ? ['setup'] : [];
+  dependencies = isSmokeTest ? [...dependencies, 'smokeTest'] : dependencies;
   if (browser === 'chrome') {
     return {
       name: _browserTypes.BROWSER_PROJECT_MAPPING.CHROME,
@@ -99,6 +104,7 @@ function getBrowserConfig({
 function getProjects({
   browsers,
   isAuthMode,
+  isSmokeTest,
   authFilePath,
   expectTimeout,
   testTimeout,
@@ -107,6 +113,7 @@ function getProjects({
   return browsers.map(browserName => getBrowserConfig({
     browserName,
     isAuthMode,
+    isSmokeTest,
     authFilePath,
     expectTimeout,
     testTimeout,
@@ -162,18 +169,21 @@ function getModulePathForFeatureFiles(moduleList) {
   });
   return validModuleList;
 }
-function getTestDir(bddMode, cwd, {
-  stepDefinitionsFolder
+function getTestDir(bddMode, {
+  featureFilesFolder,
+  stepDefinitionsFolder,
+  outputDir,
+  uatPath
 }) {
   return bddMode ? (0, _playwrightBdd.defineBddConfig)({
-    features: getPathsForFeatureFiles(cwd),
-    steps: [_path.default.join(cwd, 'uat', '**', stepDefinitionsFolder, '*.spec.js'), _path.default.join(cwd, '/node_modules/@zohodesk/testinglibrary/build/common/', '**', 'uat', '**', '*.spec.js'), require.resolve('../fixtures.js')],
+    features: featureFilesFolder,
+    steps: [stepDefinitionsFolder, require.resolve('../fixtures.js')],
     importTestFrom: require.resolve('../fixtures.js'),
-    featuresRoot: _path.default.join(cwd, 'uat'),
-    outputDir: _path.default.join(cwd, 'uat', '.features-gen'),
+    featuresRoot: uatPath,
+    outputDir: outputDir,
     disableWarnings: {
       importTestFrom: true
     },
     publish: true
-  }) : _path.default.join(cwd, 'uat');
+  }) : uatPath;
 }

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

@@ -32,23 +32,12 @@ class CustomJsonReporter {
       attachments: result.attachments,
       startTime: result.startTime,
       retry: result.retry,
-      stderr: result.stderr.map(err => ({
-        text: err
-      })),
-      stdout: result.stdout.map(out => ({
-        text: out
-      })),
+      stderr: result.stderr.map(err => stdioEntry(err)),
+      stdout: result.stdout.map(out => stdioEntry(out)),
       workerIndex: result.workerIndex,
       duration: result.duration,
-      errors: ((_result$errors = result.errors) === null || _result$errors === void 0 ? void 0 : _result$errors.map(({
-        message,
-        stack,
-        snippet
-      }) => ({
-        message,
-        stack,
-        snippet
-      }))) ?? [],
+      error: result.error,
+      errors: (_result$errors = result.errors) === null || _result$errors === void 0 ? void 0 : _result$errors.map(processError),
       steps: ((_result$steps = result.steps) === null || _result$steps === void 0 ? void 0 : _result$steps.map(step => extractMergedSteps(this.report.config.rootDir, step))) ?? []
     };
     const existingResults = this.testResultsById.get(key) ?? [];
@@ -60,7 +49,22 @@ class CustomJsonReporter {
       const extracted = suite.suites.map(suite => extractMergedSuite(this.report.config.rootDir, suite, this.testResultsById));
       this.report.suites.push(...extracted);
     });
-    _fs.default.writeFileSync(this.outputFile, JSON.stringify(this.report, null, 2));
+    const writableStream = _fs.default.createWriteStream(this.outputFile);
+    writableStream.write('{\n');
+    writableStream.write(`  "config": ${JSON.stringify(this.report.config, null, 2)},\n`);
+    writableStream.write('  "suites": [\n');
+    for (let i = 0; i < this.report.suites.length; i++) {
+      const suite = this.report.suites[i];
+      let suiteStr = JSON.stringify(suite, null, 2).split('\n').map(line => '    ' + line).join('\n');
+      if (i < this.report.suites.length - 1) {
+        suiteStr += ',';
+      }
+      suiteStr += '\n';
+      writableStream.write(suiteStr);
+    }
+    writableStream.write('  ]\n');
+    writableStream.write('}\n');
+    writableStream.end();
     console.log(`Custom JSON report written to: ${this.outputFile}`);
   }
 }
@@ -163,4 +167,125 @@ const parseLocation = (rootDir, {
   file: isRelative ? _path.default.relative(rootDir, file) : file,
   line,
   column
-} : {};
+} : {};
+const stdioEntry = s => typeof s === 'string' ? {
+  text: s
+} : {
+  buffer: s.toString('base64')
+};
+const processError = error => {
+  const message = error.message || error.value || '';
+  const stack = error.stack;
+  if (!stack && !error.location) return {
+    message
+  };
+  const tokens = [];
+  const parsedStack = stack ? constructErrorStack(stack) : undefined;
+  tokens.push((parsedStack === null || parsedStack === void 0 ? void 0 : parsedStack.message) || message);
+  if (error.snippet) {
+    tokens.push('');
+    tokens.push(error.snippet);
+  }
+  if (parsedStack && parsedStack.stackLines.length) {
+    const dimmedStackLines = parsedStack.stackLines.split('\n').map(line => dimify(line));
+    tokens.push(dimmedStackLines.join('\n'));
+  }
+  let location = error.location;
+  if (parsedStack && !location) location = parsedStack.location;
+  if (error.cause) tokens.push(dimify('[cause]: ') + processError(error.cause).message);
+  return {
+    location,
+    message: tokens.join('\n')
+  };
+};
+const constructErrorStack = stack => parseErrorStack(stack, _path.default.sep, false);
+const dimify = text => `\x1b[2m${text}\x1b[22m`;
+const parseErrorStack = (stack, pathSeparator, showInternalStackFrames = false) => {
+  const lines = stack.split("\n");
+  let firstStackLineIndex = lines.findIndex(line => line.startsWith("    at "));
+  if (firstStackLineIndex === -1) firstStackLineIndex = lines.length;
+  const message = lines.slice(0, firstStackLineIndex).join("\n");
+  const stackStartIndex = indexLocator(stack, '\n', firstStackLineIndex) + 1 || 0;
+  const stackLinesString = stackStartIndex ? stack.slice(stackStartIndex) : '';
+  let location;
+  const stackLinesArr = stackLinesString.split('\n');
+  for (const line of stackLinesArr) {
+    const frame = parseStackFrame(line, pathSeparator, showInternalStackFrames);
+    if (!frame || !frame.file) continue;
+    if (isInNodeModules(frame.file, pathSeparator)) continue;
+    location = {
+      file: frame.file,
+      column: frame.column || 0,
+      line: frame.line || 0
+    };
+    break;
+  }
+  return {
+    message,
+    stackLines: stackLinesString,
+    location
+  };
+};
+const indexLocator = (str, pat, n) => {
+  let L = str.length,
+    i = -1;
+  while (n-- && i++ < L) {
+    i = str.indexOf(pat, i);
+    if (i < 0) break;
+  }
+  return i;
+};
+const isInNodeModules = (file, pathSeparator) => file.includes(`${pathSeparator}node_modules${pathSeparator}`);
+const parseStackFrame = (text, pathSeparator, showInternalStackFrames) => {
+  const re = new RegExp("^(?:\\s*at )?(?:(new) )?(?:(.*?) \\()?(?:eval at ([^ ]+) \\((.+?):(\\d+):(\\d+)\\), )?(?:(.+?):(\\d+):(\\d+)|(native))(\\)?)$");
+  const methodRe = /^(.*?) \[as (.*?)\]$/;
+  const match = text && text.match(re);
+  if (!match) return null;
+  let fname = match[2];
+  let file = match[7];
+  if (!file) return null;
+  if (!showInternalStackFrames && (file.startsWith("internal") || file.startsWith("node:"))) return null;
+  const line = match[8];
+  const column = match[9];
+  const closeParen = match[11] === ")";
+  const frame = {
+    file: "",
+    line: 0,
+    column: 0
+  };
+  if (line) frame.line = Number(line);
+  if (column) frame.column = Number(column);
+  if (closeParen && file) {
+    let closes = 0;
+    for (let i = file.length - 1; i > 0; i--) {
+      if (file.charAt(i) === ")") {
+        closes++;
+      } else if (file.charAt(i) === "(" && file.charAt(i - 1) === " ") {
+        closes--;
+        if (closes === -1 && file.charAt(i - 1) === " ") {
+          const before = file.slice(0, i - 1);
+          const after = file.slice(i + 1);
+          file = after;
+          fname += ` (${before}`;
+          break;
+        }
+      }
+    }
+  }
+  if (fname) {
+    const methodMatch = fname.match(methodRe);
+    if (methodMatch) fname = methodMatch[1];
+  }
+  if (file) {
+    if (file.startsWith("file://")) file = fileURLToPath(file, pathSeparator);
+    frame.file = file;
+  }
+  if (fname) frame.function = fname;
+  return frame;
+};
+const fileURLToPath = (fileUrl, pathSeparator) => {
+  if (!fileUrl.startsWith("file://")) return fileUrl;
+  let path = decodeURIComponent(fileUrl.slice(7));
+  if (path.startsWith("/") && /^[a-zA-Z]:/.test(path.slice(1))) path = path.slice(1);
+  return path.replace(/\//g, pathSeparator);
+};