@zohodesk/testinglibrary 0.0.59-n20-experimental → 0.0.60-n20-experimental

package/build/core/playwright/constants/reporterConstants.js

@@ -11,5 +11,6 @@ const stage = (0, _ConfigurationHelper.getRunStage)();
 class ReporterConstants {
   static DEFAULT_REPORTER_PATH = `${_configConstants.default.TEST_SLICE_FOLDER}/${stage}/test-results/playwright-test-results.json`;
   static LAST_RUN_REPORTER_PATH = `${_configConstants.default.TEST_SLICE_FOLDER}/${stage}/test-results/.last-run.json`;
+  static DEFAULT_UNIT_TEST_REPORTER_PATH = `${_configConstants.default.TEST_SLICE_FOLDER}/unit-test/unit_reports/report.html`;
 }
 exports.default = ReporterConstants;

package/build/core/playwright/readConfigFile.js

@@ -55,8 +55,7 @@ function getDefaultConfig() {
     featureFilesFolder: 'feature-files',
     stepDefinitionsFolder: 'steps',
     testSetup: {},
-    editionOrder: ['Free', 'Express', 'Standard', 'Professional', 'Enterprise'],
-    showCaseTimings: true
+    editionOrder: ['Free', 'Express', 'Standard', 'Professional', 'Enterprise']
   };
 }
 function combineDefaultConfigWithUserConfig(userConfiguration) {
@@ -114,7 +113,6 @@ function combineDefaultConfigWithUserConfig(userConfiguration) {
  * @property {string} testIdAttribute: Change the default data-testid attribute. configure what attribute to search while calling getByTestId
  * @property {Array} editionOrder: Order in the form of larger editions in the back. Edition with the most privelages should be last
  * @property {testSetupConfig} testSetup: Specify page and context functions that will be called while intilaizing fixtures.
- * @property {boolean} showCaseTimings: When true, the console reporter prints per-case start/end wall-clock times (h:mm:ss AM/PM) and a case-timings.json sidecar is written to reportPath for the HTML report addon. Default: true.
  */
 
 /**

package/build/core/playwright/reporter/PlaywrightReporter.js

@@ -0,0 +1,44 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+var _child_process = require("child_process");
+var _path = _interopRequireDefault(require("path"));
+var _logger = require("../../../utils/logger");
+var _rootPath = require("../../../utils/rootPath");
+var _readConfigFile = require("../readConfigFile");
+class PlaywrightReporter {
+  static generate() {
+    const userArgs = process.argv.slice(3);
+    const playwrightPath = _path.default.resolve((0, _rootPath.getExecutableBinaryPath)('playwright'));
+    const command = playwrightPath;
+    const {
+      reportPath: htmlPath
+    } = (0, _readConfigFile.generateConfigFromFile)();
+    const args = ['show-report', htmlPath].concat(userArgs);
+    const childProcess = (0, _child_process.spawn)(command, args, {
+      stdio: 'inherit'
+    });
+    childProcess.on('error', error => {
+      _logger.Logger.log(_logger.Logger.FAILURE_TYPE, error);
+    });
+    childProcess.on('exit', (code, signal) => {
+      _logger.Logger.log(_logger.Logger.FAILURE_TYPE, `Child Process Exited with Code ${code} and Signal ${signal}`);
+      process.exit();
+    });
+    process.on('exit', () => {
+      _logger.Logger.log(_logger.Logger.INFO_TYPE, 'Terminating Playwright Process...');
+      childProcess.kill();
+      return;
+    });
+    process.on('SIGINT', () => {
+      _logger.Logger.log(_logger.Logger.INFO_TYPE, 'Cleaning up...');
+      childProcess.kill();
+      process.exit();
+    });
+  }
+}
+exports.default = PlaywrightReporter;

package/build/core/playwright/reporter/UnitReporter.js

@@ -0,0 +1,27 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+var _child_process = require("child_process");
+var _path = _interopRequireDefault(require("path"));
+var _os = require("os");
+var _logger = require("../../../utils/logger");
+var _reporterConstants = _interopRequireDefault(require("../constants/reporterConstants"));
+class UnitReporter {
+  static generate() {
+    const reportPath = _path.default.resolve(process.cwd(), _reporterConstants.default.DEFAULT_UNIT_TEST_REPORTER_PATH);
+    _logger.Logger.log(_logger.Logger.SUCCESS_TYPE, `Opening unit test report: ${reportPath}`);
+    const os = (0, _os.platform)();
+    const openCommand = os === 'darwin' ? 'open' : os === 'win32' ? 'start' : 'xdg-open';
+    (0, _child_process.execFile)(openCommand, [reportPath], error => {
+      if (error) {
+        _logger.Logger.log(_logger.Logger.FAILURE_TYPE, `Failed to open report: ${error.message}`);
+      }
+      process.exit();
+    });
+  }
+}
+exports.default = UnitReporter;

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

@@ -12,22 +12,6 @@ var _readConfigFile = require("../readConfigFile");
 var _logger = require("../../../utils/logger");
 var _configFileNameProvider = require("../helpers/configFileNameProvider");
 var _mergeAbortedTests = _interopRequireDefault(require("../reporter/helpers/mergeAbortedTests"));
-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;
@@ -42,22 +26,11 @@ class JSONSummaryReporter {
     this.failedSteps = [];
     this.status = 'unknown';
     this.startedAt = 0;
-    const config = (0, _readConfigFile.generateConfigFromFile)();
-    this._open = config.openReportOn;
-    this._showCaseTimings = config.showCaseTimings !== false;
-    this._caseTimings = [];
+    this._open = (0, _readConfigFile.generateConfigFromFile)().openReportOn;
   }
   onBegin() {
     this.startedAt = Date.now();
   }
-  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 = [];
@@ -103,40 +76,6 @@ class JSONSummaryReporter {
       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
-            };
-          })
-        });
-      }
-    }
   }
   onError(error) {
     this.errored.push({
@@ -183,16 +122,6 @@ class JSONSummaryReporter {
       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

package/build/lib/cli.js

@@ -2,7 +2,9 @@
 
 var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
 var _testRunner = _interopRequireDefault(require("../core/playwright/test-runner"));
-var _reportGenerator = _interopRequireDefault(require("../core/playwright/report-generator"));
+var _unitTestingFramework = require("@zohodesk/unit-testing-framework");
+var _PlaywrightReporter = _interopRequireDefault(require("../core/playwright/reporter/PlaywrightReporter"));
+var _UnitReporter = _interopRequireDefault(require("../core/playwright/reporter/UnitReporter"));
 var _codegen = _interopRequireDefault(require("../core/playwright/codegen"));
 var _logger = require("../utils/logger");
 var _setupProject = _interopRequireDefault(require("../setup-folder-structure/setupProject"));
@@ -11,15 +13,25 @@ var _clearCaches = _interopRequireDefault(require("../core/playwright/clear-cach
 var _helper = _interopRequireDefault(require("../setup-folder-structure/helper"));
 var _parseUserArgs = _interopRequireDefault(require("../core/playwright/helpers/parseUserArgs"));
 var _validateFeature = _interopRequireDefault(require("../core/playwright/validateFeature"));
-// import createJestRunner from '../core/jest/runner/jest-runner';
-
+var _commonUtils = require("../utils/commonUtils");
 const [,, option, ...otherOptions] = process.argv;
 switch (option) {
   case 'test':
     {
       _logger.Logger.log(_logger.Logger.SUCCESS_TYPE, 'Running Tests..');
       (0, _testRunner.default)();
-      //createJestRunner();
+      break;
+    }
+  case 'unit-test':
+    {
+      const testFile = process.argv[3];
+      _logger.Logger.log(_logger.Logger.SUCCESS_TYPE, 'Running Unit Tests..');
+      const options = {};
+      if (testFile) {
+        _logger.Logger.log(_logger.Logger.INFO_TYPE, `Filtering tests with pattern: ${testFile}`);
+        options.testPathPattern = testFile;
+      }
+      (0, _unitTestingFramework.createJestRunner)(options);
       break;
     }
   case 'validate':
@@ -40,9 +52,14 @@ switch (option) {
     }
   case 'report':
     {
-      // console.log('\x1b[36mGenerating Reports...\x1b[0m');
-      _logger.Logger.log(_logger.Logger.SUCCESS_TYPE, 'Generating Reports...');
-      (0, _reportGenerator.default)();
+      _logger.Logger.log(_logger.Logger.SUCCESS_TYPE, 'Generating UAT Reports...');
+      _PlaywrightReporter.default.generate();
+      break;
+    }
+  case 'ut-report':
+    {
+      _logger.Logger.log(_logger.Logger.SUCCESS_TYPE, 'Generating Unit Test Reports...');
+      _UnitReporter.default.generate();
       break;
     }
   case 'codegen':
@@ -69,6 +86,12 @@ switch (option) {
       (0, _clearCaches.default)();
       break;
     }
+  case 'stepsGenerator':
+    {
+      _logger.Logger.log(_logger.Logger.SUCCESS_TYPE, 'Created agents and prompts md files under .github folder...');
+      (0, _commonUtils.copyGithubFolder)();
+      break;
+    }
   case 'help':
   default:
     {

package/build/utils/commonUtils.js

@@ -5,6 +5,7 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.copyCommonSpecs = copyCommonSpecs;
+exports.copyGithubFolder = copyGithubFolder;
 var _fileUtils = require("./fileUtils");
 var _path = _interopRequireDefault(require("path"));
 var _configConstants = _interopRequireDefault(require("../core/playwright/constants/configConstants"));
@@ -17,4 +18,12 @@ function copyCommonSpecs() {
   const destDirectory = _path.default.resolve(process.cwd(), _configConstants.default.TEST_SLICE_FOLDER, stage, 'modules', '.testingLib-common');
   (0, _fileUtils.deleteFolder)(destDirectory);
   (0, _fileUtils.copyDirectory)(commonSpecPath, destDirectory);
+}
+function copyGithubFolder() {
+  const libraryPath = require.resolve("@zohodesk/testinglibrary");
+  // libraryPath will be build/index.js, go two levels up to reach the package root where .github lives
+  const githubSrcPath = _path.default.resolve(libraryPath, '../../', '.github');
+  const destDirectory = _path.default.resolve(process.cwd(), '../../', '.github');
+  (0, _fileUtils.deleteFolder)(destDirectory);
+  (0, _fileUtils.copyDirectory)(githubSrcPath, destDirectory);
 }