@zohodesk/testinglibrary 0.3.1-experimental → 0.3.2-experimental

package/README.md

@@ -18,12 +18,10 @@
 
 ## Version History
 
-### v0.2.8 - 18-09-2024
+### v0.2.8 - 26-09-2024
 
-#### Features
+#### Feature
   - Added support for writing unitcases for framework implementations
-  - Updated the configuration for `video` and `trace` to accept Playwright-specific values instead of boolean values.
 
-#### Deprecations
-  - **Deprecated**: Passing `video` and `trace` as boolean (`true`/`false`) in project configuration.
-  - **New Approach**: Use Playwright values for `video` and `trace` options, such as `'on'`, `'retain-on-failure'`, or `'off'`.
+### Bug fix
+  - Updated the custom-reported to include the errors in tests during the executions. It will help us avoid the stage passed without the actual test execution. 

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

@@ -38,11 +38,12 @@ const testDir = (0, _configUtils.getTestDir)(bddMode, process.cwd(), {
   featureFilesFolder,
   stepDefinitionsFolder
 });
-let use = {
+const testOptions = (0, _configUtils.getTestUseOptions)({
   trace,
   video,
+  viewport,
   testIdAttribute
-};
+});
 
 /**
  * Playwright configuration object
@@ -65,7 +66,7 @@ function getPlaywrightConfig() {
     expect: {
       timeout: expectTimeout
     },
-    use,
+    use: testOptions,
     projects: isAuthMode ? [{
       name: 'setup',
       testMatch: /.*\.setup\.js/,

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

@@ -7,6 +7,7 @@ Object.defineProperty(exports, "__esModule", {
 exports.getBrowsersList = getBrowsersList;
 exports.getProjects = getProjects;
 exports.getTestDir = getTestDir;
+exports.getTestUseOptions = getTestUseOptions;
 var _test = require("@playwright/test");
 var _path = _interopRequireDefault(require("path"));
 var _readConfigFile = require("../readConfigFile");
@@ -154,4 +155,23 @@ function getTestDir(bddMode, cwd, {
     outputDir: _path.default.join(cwd, 'uat', '.features-gen'),
     publish: true
   }) : _path.default.join(cwd, 'uat');
+}
+function getTestUseOptions({
+  viewport,
+  trace,
+  video,
+  testIdAttribute
+}) {
+  let defaultTestuseOptions = {
+    viewport,
+    testIdAttribute,
+    trace: trace ? 'on' : 'off',
+    video: video ? {
+      mode: 'on',
+      size: {
+        ...viewport
+      }
+    } : 'off'
+  };
+  return defaultTestuseOptions;
 }

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

@@ -18,6 +18,7 @@ class JSONSummaryReporter {
     this.skipped = [];
     this.failed = [];
     this.warned = [];
+    this.errored = [];
     this.interrupted = [];
     this.timedOut = [];
     this.flakey = [];
@@ -29,7 +30,7 @@ class JSONSummaryReporter {
   onBegin() {
     this.startedAt = Date.now();
   }
-  onTestEnd(test, result) {
+  getTitle(test) {
     const title = [];
     const fileName = [];
     let clean = true;
@@ -39,35 +40,52 @@ 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(z);
+    this[status].push(fileName);
+  }
+  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,6 +108,14 @@ 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";
+    }
+
     // fs.writeFileSync('./summary.json', JSON.stringify(this, null, '  '));
     let {
       reportPath

package/jest.config.js

@@ -22,7 +22,7 @@ module.exports = {
       'preprocessor',
       'jsPreprocessor.js'
     ),
-    '^.+\\.jsx?$': 'babel-jest',
+    '^.+\\.jsx?$': 'babel-jest'
   },
   
   testMatch: ['**/__tests__/**/*.test.js'],

package/npm-shrinkwrap.json

@@ -1,6 +1,6 @@
 {
   "name": "@zohodesk/testinglibrary",
-  "version": "0.2.1",
+  "version": "0.3.2-experimental",
   "lockfileVersion": 1,
   "requires": true,
   "dependencies": {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@zohodesk/testinglibrary",
-  "version": "0.3.1-experimental",
+  "version": "0.3.2-experimental",
   "description": "",
   "main": "./build/index.js",
   "scripts": {
@@ -23,7 +23,7 @@
   "dependencies": {
     "@babel/preset-react": "7.22.5",
     "@cucumber/cucumber": "9.2.0",
-    "@playwright/test": "1.47.1",
+    "@playwright/test": "1.42.1",
     "@testing-library/jest-dom": "5.11.9",
     "@testing-library/react": "11.2.7",
     "@testing-library/react-hooks": "7.0.2",
@@ -33,7 +33,7 @@
     "jest": "29.6.2",
     "jest-environment-jsdom": "29.6.2",
     "msw": "1.2.3",
-    "playwright": "1.47.1",
+    "playwright": "1.42.1",
     "supports-color": "8.1.1"
   },
   "bin": {