@zohodesk/testinglibrary 0.1.9 → 0.1.16-experimental

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

@@ -9,76 +9,94 @@ var _test = require("@playwright/test");
 var _path = _interopRequireDefault(require("path"));
 var _readConfigFile = require("../readConfigFile");
 var _configUtils = require("./config-utils");
-var _bddFramework = require("../../../bdd-framework");
-const defaultCIBrowsers = ['Chrome', 'Firefox', 'Edge', 'Safari'];
+var _ProjectConfiguration = require("./ProjectConfiguration");
+var _Reporter = _interopRequireDefault(require("../reporter/Reporter"));
+var _ConfigurationHelper = require("../configuration/ConfigurationHelper");
+var _configConstants = _interopRequireDefault(require("../constants/configConstants"));
+const uatConfig = (0, _readConfigFile.generateConfigFromFile)();
+const stage = (0, _ConfigurationHelper.getRunStage)();
+const proxyConfig = (0, _configUtils.getProxyConfig)();
 const {
+  bddMode,
   browsers,
-  trace,
-  video,
+  isSmokeTest,
   isAuthMode,
   openReportOn,
   reportPath,
-  bddMode,
   expectTimeout,
   testTimeout,
   authFilePath,
   viewport,
-  featureFilesFolder,
+  globalTimeout,
+  customReporter,
+  trace,
+  video,
+  testIdAttribute,
   stepDefinitionsFolder,
-  testIdAttribute
-} = (0, _readConfigFile.generateConfigFromFile)();
-const browserList = process.env.mode === 'ci' ? defaultCIBrowsers : browsers;
+  shard
+} = uatConfig;
 const projects = (0, _configUtils.getProjects)({
-  browsers: browserList,
+  browsers,
   isAuthMode,
+  isSmokeTest,
   authFilePath,
   expectTimeout,
   testTimeout,
   viewport
 });
-const testDir = (0, _configUtils.getTestDir)(bddMode, process.cwd(), {
-  featureFilesFolder,
-  stepDefinitionsFolder
-});
-const testOptions = (0, _configUtils.getTestUseOptions)({
-  trace,
-  video,
-  viewport,
-  testIdAttribute
+const reporter = _Reporter.default.getReporterClass(_Reporter.default.resolveType(shard)).getReporter({
+  stage,
+  shard,
+  reportPath,
+  openReportOn,
+  customReporter
 });
 
 /**
  * Playwright configuration object
  *
  * @returns {import('@playwright/test').PlaywrightTestConfig}
-*/
+ */
+
+const use = {
+  trace,
+  video,
+  viewport,
+  testIdAttribute,
+  ...(proxyConfig ? {
+    proxy: proxyConfig
+  } : {})
+};
+const testDir = (0, _configUtils.getTestDir)(bddMode, {
+  featureFilesFolder: (0, _configUtils.getPathsForFeatureFiles)(process.cwd()),
+  stepDefinitionsFolder: _path.default.join(process.cwd(), _configConstants.default.TEST_SLICE_FOLDER, '**', '**', stepDefinitionsFolder, '*.spec.js'),
+  outputDir: _path.default.join(process.cwd(), _configConstants.default.TEST_SLICE_FOLDER, stage, _configConstants.default.FEATURES_GEN_DIR),
+  uatPath: _path.default.join(process.cwd(), _configConstants.default.TEST_SLICE_FOLDER, stage)
+});
 function getPlaywrightConfig() {
-  return {
+  const smokeTestProject = isSmokeTest ? (0, _ProjectConfiguration.smokeTestConfig)() : [];
+  const setupProject = isAuthMode ? (0, _ProjectConfiguration.setupConfig)() : [];
+  const isTearDown = JSON.parse(process.env.tearDown);
+  const cleanupProject = isTearDown ? (0, _ProjectConfiguration.cleanupConfig)() : [];
+  const {
+    shard: _shard,
+    reporter: _reporter,
+    ...uatConfigForPlaywright
+  } = uatConfig;
+  const playwrightConfig = {
     testDir,
-    outputDir: _path.default.join(process.cwd(), 'uat', 'test-results'),
+    globalTimeout: globalTimeout || 3600000,
+    outputDir: _path.default.join(process.cwd(), _configConstants.default.TEST_SLICE_FOLDER, stage, 'test-results'),
     fullyParallel: true,
-    forbidOnly: !!process.env.CI,
-    retries: process.env.CI ? 2 : 0,
-    workers: process.env.CI ? 1 : 1,
-    reporter: [['html', {
-      outputFolder: reportPath,
-      open: openReportOn
-    }], ['list'], ['./custom-reporter.js']],
     timeout: testTimeout,
     expect: {
       timeout: expectTimeout
     },
-    use: testOptions,
-    projects: isAuthMode ? [{
-      name: 'setup',
-      testMatch: /.*\.setup\.js/,
-      testDir: _path.default.join(process.cwd(), 'uat'),
-      teardown: 'cleanup'
-    }, {
-      name: 'cleanup',
-      testMatch: /.*\.teardown\.js/,
-      testDir: _path.default.join(process.cwd(), 'uat')
-    }, ...projects] : [...projects]
+    use,
+    projects: [...setupProject, ...smokeTestProject, ...projects, ...cleanupProject],
+    ...uatConfigForPlaywright,
+    reporter
   };
+  return playwrightConfig;
 }
 var _default = exports.default = (0, _test.defineConfig)(getPlaywrightConfig());

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

@@ -5,24 +5,31 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.getBrowsersList = getBrowsersList;
+exports.getModulePathForFeatureFiles = getModulePathForFeatureFiles;
+exports.getPathsForFeatureFiles = getPathsForFeatureFiles;
 exports.getProjects = getProjects;
+exports.getProxyConfig = getProxyConfig;
 exports.getTestDir = getTestDir;
-exports.getTestUseOptions = getTestUseOptions;
 var _test = require("@playwright/test");
 var _path = _interopRequireDefault(require("path"));
 var _readConfigFile = require("../readConfigFile");
-var _bddFramework = require("../../../bdd-framework");
+var _playwrightBdd = require("playwright-bdd");
 var _logger = require("../../../utils/logger");
 var _browserTypes = require("../constants/browserTypes");
-var _configFileNameProvider = require("../helpers/configFileNameProvider");
+var _browserTimeoutFactor = require("../helpers/browserTimeoutFactor");
 var _fileUtils = require("../../../utils/fileUtils");
+var _ConfigurationHelper = require("../configuration/ConfigurationHelper");
+var _configConstants = _interopRequireDefault(require("../constants/configConstants"));
 /**
  ** Playwright project configuration
  * @returns {import('@playwright/test').Project}
  */
+
+const stage = (0, _ConfigurationHelper.getRunStage)();
 function getBrowserConfig({
   browserName,
   isAuthMode,
+  isSmokeTest,
   authFilePath,
   expectTimeout,
   testTimeout,
@@ -33,7 +40,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,
@@ -62,11 +71,12 @@ function getBrowserConfig({
       dependencies
     };
   } else if (browser === 'firefox') {
+    const factor = (0, _browserTimeoutFactor.getBrowserTimeoutFactor)(_browserTypes.BROWSER_PROJECT_MAPPING.FIREFOX);
     return {
       name: _browserTypes.BROWSER_PROJECT_MAPPING.FIREFOX,
-      timeout: 2 * testTimeout,
+      timeout: factor * testTimeout,
       expect: {
-        timeout: 2 * expectTimeout
+        timeout: factor * expectTimeout
       },
       use: {
         ..._test.devices['Desktop Firefox'],
@@ -75,11 +85,12 @@ function getBrowserConfig({
       dependencies
     };
   } else if (browser === 'safari') {
+    const factor = (0, _browserTimeoutFactor.getBrowserTimeoutFactor)(_browserTypes.BROWSER_PROJECT_MAPPING.SAFARI);
     return {
       name: _browserTypes.BROWSER_PROJECT_MAPPING.SAFARI,
-      timeout: 4 * testTimeout,
+      timeout: factor * testTimeout,
       expect: {
-        timeout: 4 * expectTimeout
+        timeout: factor * expectTimeout
       },
       use: {
         ..._test.devices['Desktop Safari'],
@@ -100,6 +111,7 @@ function getBrowserConfig({
 function getProjects({
   browsers,
   isAuthMode,
+  isSmokeTest,
   authFilePath,
   expectTimeout,
   testTimeout,
@@ -108,6 +120,7 @@ function getProjects({
   return browsers.map(browserName => getBrowserConfig({
     browserName,
     isAuthMode,
+    isSmokeTest,
     authFilePath,
     expectTimeout,
     testTimeout,
@@ -136,42 +149,60 @@ function getPathsForFeatureFiles(cwd) {
       const {
         failed = []
       } = JSON.parse(testSummary);
-      const casesToRun = failed.map(filePath => _path.default.join(cwd, 'uat', filePath.replace(/\.spec\.js$|\.js$/, '')));
+      const casesToRun = failed.map(filePath => _path.default.join(cwd, _configConstants.default.TEST_SLICE_FOLDER, filePath.replace(/\.spec\.js$|\.js$/, '')));
+      ;
       return casesToRun;
     } else {
       _logger.Logger.log(_logger.Logger.INFO_TYPE, `Unable to read test summary from the ${reportPath}. Verify If File Exists in the path`);
       _logger.Logger.log(_logger.Logger.INFO_TYPE, 'Going to run all test cases');
     }
+  } else if (process.env.modules !== 'undefined' && process.env.modules.length > 0) {
+    let modules = process.env.modules;
+    let moduleList = modules.split(',');
+    return getModulePathForFeatureFiles(moduleList);
   }
-  return [_path.default.join(cwd, 'uat', '**', '*.feature')];
+  return [_path.default.join(cwd, _configConstants.default.TEST_SLICE_FOLDER, stage, 'modules', '**', 'feature-files', '*.feature')];
 }
-function getTestDir(bddMode, cwd, {
-  stepDefinitionsFolder
-}) {
-  return bddMode ? (0, _bddFramework.defineBddConfig)({
-    paths: getPathsForFeatureFiles(cwd),
-    import: [_path.default.join(cwd, 'uat', '**', stepDefinitionsFolder, '*.spec.js')],
-    featuresRoot: _path.default.join(cwd, 'uat'),
-    outputDir: _path.default.join(cwd, 'uat', '.features-gen'),
-    publish: true
-  }) : _path.default.join(cwd, 'uat');
+function getModulePathForFeatureFiles(moduleList) {
+  let validModuleList = [];
+  moduleList.forEach(moduleName => {
+    let modulePath = _path.default.join(process.cwd(), _configConstants.default.TEST_SLICE_FOLDER, '**', 'modules', '**', `${moduleName}`);
+    if ((0, _fileUtils.checkIfFolderExistsWithPattern)(modulePath)) {
+      validModuleList.push(_path.default.join(modulePath, '**', '*.feature'));
+    } else {
+      validModuleList = [];
+      throw new Error(`Module ${moduleName} does not exist. We have not triggered the execution for this module`);
+    }
+  });
+  return validModuleList;
 }
-function getTestUseOptions({
-  viewport,
-  trace,
-  video,
-  testIdAttribute
+
+// Node's fetch (undici) does not honor HTTP_PROXY/HTTPS_PROXY, which breaks calls to internal
+// hosts only reachable through the corporate proxy. Reading it here lets callers pass it into
+// Playwright's browser contexts and their `request`/`page.request` API contexts.
+function getProxyConfig() {
+  const proxyServer = process.env.HTTPS_PROXY || process.env.https_proxy || process.env.HTTP_PROXY || process.env.http_proxy;
+  const noProxy = process.env.NO_PROXY || process.env.no_proxy;
+  return proxyServer ? {
+    server: proxyServer,
+    bypass: noProxy
+  } : undefined;
+}
+function getTestDir(bddMode, {
+  featureFilesFolder,
+  stepDefinitionsFolder,
+  outputDir,
+  uatPath
 }) {
-  let defaultTestuseOptions = {
-    viewport,
-    testIdAttribute,
-    trace: trace ? 'on' : 'off',
-    video: video ? {
-      mode: 'on',
-      size: {
-        ...viewport
-      }
-    } : 'off'
-  };
-  return defaultTestuseOptions;
+  return bddMode ? (0, _playwrightBdd.defineBddConfig)({
+    features: featureFilesFolder,
+    steps: [stepDefinitionsFolder, require.resolve('../fixtures.js')],
+    importTestFrom: require.resolve('../fixtures.js'),
+    featuresRoot: uatPath,
+    outputDir: outputDir,
+    disableWarnings: {
+      importTestFrom: true
+    },
+    publish: true
+  }) : uatPath;
 }

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

@@ -11,6 +11,35 @@ var _fileUtils = require("../../../utils/fileUtils");
 var _readConfigFile = require("../readConfigFile");
 var _logger = require("../../../utils/logger");
 var _configFileNameProvider = require("../helpers/configFileNameProvider");
+var _mergeAbortedTests = _interopRequireDefault(require("../reporter/helpers/mergeAbortedTests"));
+var _reporterConstants = _interopRequireDefault(require("../constants/reporterConstants"));
+// Traverse the suite tree upward until we reach the project-level suite
+function getProjectName(test) {
+  let suite = test.parent;
+  while (suite) {
+    var _suite$project, _suite;
+    const name = (_suite$project = (_suite = suite).project) === null || _suite$project === void 0 || (_suite$project = _suite$project.call(_suite)) === null || _suite$project === void 0 ? void 0 : _suite$project.name;
+    if (name) return name;
+    suite = suite.parent;
+  }
+  return '';
+}
+function formatTime(date) {
+  return date.toLocaleTimeString('en-US', {
+    hour: 'numeric',
+    minute: '2-digit',
+    second: '2-digit',
+    hour12: true
+  });
+}
+function formatDuration(ms) {
+  if (ms < 1000) return `${ms}ms`;
+  const totalSeconds = ms / 1000;
+  if (totalSeconds < 60) return `${totalSeconds.toFixed(2)}s`;
+  const minutes = Math.floor(totalSeconds / 60);
+  const seconds = (totalSeconds - minutes * 60).toFixed(2);
+  return `${minutes}m ${seconds}s`;
+}
 class JSONSummaryReporter {
   constructor() {
     this.durationInMS = -1;
@@ -18,18 +47,31 @@ class JSONSummaryReporter {
     this.skipped = [];
     this.failed = [];
     this.warned = [];
+    this.errored = [];
     this.interrupted = [];
     this.timedOut = [];
     this.flakey = [];
     this.failedSteps = [];
     this.status = 'unknown';
     this.startedAt = 0;
-    this._open = (0, _readConfigFile.generateConfigFromFile)().openReportOn;
+    const config = (0, _readConfigFile.generateConfigFromFile)();
+    this._open = config.openReportOn;
+    this._showCaseTimings = config.showCaseTimings !== false;
+    this._caseTimings = [];
+    this.failedProject = null;
   }
   onBegin() {
     this.startedAt = Date.now();
   }
-  onTestEnd(test, result) {
+  onTestBegin(test) {
+    if (!this._showCaseTimings) return;
+    const {
+      fullTitle
+    } = this.getTitle(test);
+    const startedAtLabel = formatTime(new Date());
+    _logger.Logger.log(_logger.Logger.INFO_TYPE, `▶ ${fullTitle} — started at ${startedAtLabel}`);
+  }
+  getTitle(test) {
     const title = [];
     const fileName = [];
     let clean = true;
@@ -39,35 +81,93 @@ class JSONSummaryReporter {
       }
       clean = false;
       title.push(s);
-      if (s.includes('.ts') || s.includes('.js')) {
+      if (s.endsWith('.ts') || s.endsWith('.js')) {
         fileName.push(s);
       }
     }
-    // This will publish the file name + line number test begins on
-    const z = `${fileName[0]}`;
-    // Using the t variable in the push will push a full test name + test description
-    const t = title.join(' > ');
+
+    //Using the fullTitle variable in the push will push a full test name + test description
+
+    return {
+      fullTitle: title.join(' > '),
+      fileName: fileName[0] || ''
+    };
+  }
+  onTestEnd(test, result) {
+    const {
+      fullTitle,
+      fileName
+    } = this.getTitle(test);
+
     // Set the status
-    const stepTitleList = result.steps.map(step => ({
+    const stepTitleList = result.steps.filter(step => step.error).map(step => ({
       title: step.title,
       error: step.error,
-      testTitle: t
-    })).filter(step => step.error !== undefined);
+      testTitle: fullTitle
+    }));
     if (stepTitleList.length > 0) {
       this.failedSteps = [...this.failedSteps, ...stepTitleList];
     }
-    const status = !['passed', 'skipped'].includes(result.status) && t.includes('@warn') ? 'warned' : result.status;
+    const status = !['passed', 'skipped'].includes(result.status) && fullTitle.includes('@warn') ? 'warned' : result.status;
     // Logic to push the results into the correct array
     if (result.status === 'passed' && result.retry >= 1) {
-      this.flakey.push(z);
+      this.flakey.push(fileName);
     } else {
-      this[status].push(z);
+      this[status].push(fileName);
+    }
+    this[status].push(fileName);
+    if (this._showCaseTimings && result.startTime) {
+      const startDate = new Date(result.startTime);
+      const endDate = new Date(startDate.getTime() + (result.duration || 0));
+      const startLabel = formatTime(startDate);
+      const endLabel = formatTime(endDate);
+      const durationLabel = formatDuration(result.duration || 0);
+      const statusGlyph = result.status === 'passed' ? '✓' : result.status === 'skipped' ? '○' : '✗';
+      const logType = result.status === 'passed' ? _logger.Logger.SUCCESS_TYPE : result.status === 'skipped' ? _logger.Logger.INFO_TYPE : _logger.Logger.FAILURE_TYPE;
+      _logger.Logger.log(logType, `${statusGlyph} ${fullTitle} — ended at ${endLabel} (started ${startLabel}, took ${durationLabel})`);
+      const isFailure = result.status !== 'passed' && result.status !== 'skipped';
+      if (isFailure) {
+        var _result$error;
+        this._caseTimings.push({
+          title: fullTitle,
+          fileName,
+          status: result.status,
+          retry: result.retry,
+          startTime: startDate.toISOString(),
+          endTime: endDate.toISOString(),
+          startTimeFormatted: startLabel,
+          endTimeFormatted: endLabel,
+          duration: result.duration || 0,
+          durationFormatted: durationLabel,
+          errorMessage: (_result$error = result.error) === null || _result$error === void 0 ? void 0 : _result$error.message,
+          failedSteps: (result.steps || []).filter(step => step.error).map(step => {
+            var _step$error;
+            return {
+              title: step.title,
+              error: (_step$error = step.error) === null || _step$error === void 0 ? void 0 : _step$error.message
+            };
+          })
+        });
+      }
+    }
+    const isFailure = result.status !== 'passed' && result.status !== 'skipped';
+    if (isFailure && !this.failedProject) {
+      const projectName = getProjectName(test);
+      if (projectName) {
+        this.failedProject = projectName;
+      }
     }
-    this[status].push(z);
+  }
+  onError(error) {
+    this.errored.push({
+      error: error.message,
+      stack: error.stack
+    });
   }
   onEnd(result) {
     this.durationInMS = Date.now() - this.startedAt;
     this.status = result.status;
+
     // removing duplicate tests from passed array
     this.passed = this.passed.filter((element, index) => {
       return this.passed.indexOf(element) === index;
@@ -90,13 +190,36 @@ class JSONSummaryReporter {
     this.interrupted = this.interrupted.filter((element, index) => {
       return this.interrupted.indexOf(element) === index;
     });
+    this.errored = this.errored.filter((element, index) => {
+      return this.errored.indexOf(element) === index;
+    });
+    if (this.errored.length > 0) {
+      // Reflect setup failures in the final report status
+      this.status = "failed";
+    }
+    if (this.failedProject && _reporterConstants.default.PROJECT_FAILURE_REASON_MAP[this.failedProject]) {
+      this.failureReason = _reporterConstants.default.PROJECT_FAILURE_REASON_MAP[this.failedProject];
+    }
+
     // fs.writeFileSync('./summary.json', JSON.stringify(this, null, '  '));
     let {
       reportPath
     } = (0, _readConfigFile.generateConfigFromFile)();
     (0, _fileUtils.writeFileContents)(_path.default.join(reportPath, './', (0, _configFileNameProvider.getReportFileName)()), JSON.stringify(this, null, '  '));
+    if (this._showCaseTimings && this._caseTimings.length > 0) {
+      const timingsPayload = {
+        suiteStartedAt: new Date(this.startedAt).toISOString(),
+        suiteEndedAt: new Date(this.startedAt + this.durationInMS).toISOString(),
+        suiteDurationMs: this.durationInMS,
+        failedCount: this._caseTimings.length,
+        cases: this._caseTimings
+      };
+      (0, _fileUtils.writeFileContents)(_path.default.join(reportPath, 'case-timings.json'), JSON.stringify(timingsPayload, null, '  '));
+    }
   }
   onExit() {
+    // Update .last-run.json with aborted tests due to timing out or interruption
+    (0, _mergeAbortedTests.default)();
     const shouldClearLastLine = this._open !== 'always' || this._open !== 'on-failure';
     if (shouldClearLastLine) {
       /**Below code is to replace the playwright default report commond with abstraction tool command */

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

@@ -0,0 +1,32 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+var _test = require("@playwright/test");
+var _readConfigFile = require("../readConfigFile");
+var _PlaywrightReporter = _interopRequireDefault(require("../reporter/PlaywrightReporter"));
+var _ConfigurationHelper = require("../configuration/ConfigurationHelper");
+const {
+  openReportOn,
+  reportPath,
+  customReporter
+} = (0, _readConfigFile.generateConfigFromFile)();
+const stage = (0, _ConfigurationHelper.getRunStage)();
+
+/**
+ * Configuration used by `playwright merge-reports`. Only the reporters are read
+ * from here, the shard blob reports already carry the test results.
+ *
+ * @returns {import('@playwright/test').PlaywrightTestConfig}
+ */
+var _default = exports.default = (0, _test.defineConfig)({
+  reporter: _PlaywrightReporter.default.getReporter({
+    stage,
+    reportPath,
+    openReportOn,
+    customReporter
+  })
+});