@zohodesk/testinglibrary 0.0.2 → 0.0.3-n20-experimental

package/.babelrc

@@ -0,0 +1,23 @@
+{
+  "presets": [
+    [
+      "@babel/preset-env",
+      {
+        "targets": {
+          "node": "14"
+        },
+        // We are adding plugin @babel/plugin-transform-destructuring to ensure babel does not transform the destructing 
+        // as playwright does not allow parameters without destrucring
+        "exclude": ["@babel/plugin-transform-destructuring"]
+      }
+    ]
+  ],
+  "plugins": [
+      ["@babel/plugin-transform-runtime"],
+      ["@babel/plugin-transform-modules-commonjs"]
+  ],
+  // Ignored as these are setup files needed during init script. Files inside that folder are copied not transformed
+  "ignore": [
+    "./src/setup-folder-structure/samples"
+  ]
+}

package/.eslintrc.js

@@ -0,0 +1,31 @@
+module.exports = {
+  "env": {
+    "node": true,
+    "es2021": true
+  },
+  "extends": "eslint:recommended",
+  "overrides": [
+    {
+      "env": {
+        "node": true
+      },
+      "files": [
+        ".eslintrc.{js,cjs}"
+      ],
+      "parserOptions": {
+        "sourceType": "script"
+      }
+    }
+  ],
+  "parserOptions": {
+    "ecmaVersion": "latest",
+    "sourceType": "module"
+  },
+  "rules": {
+    "indent": ["error", 2, { "SwitchCase": 1 }],
+    "no-empty-pattern": "off",
+    "comma-dangle": ["error", "never"],
+    "curly": ["error"],
+    "brace-style": "error"
+  }
+}

package/.gitlab-ci.yml

@@ -0,0 +1,163 @@
+image: repository.desk.csez.zohocorpin.com/base-image/testing-framework-gitlab-runne-base:v3
+
+workflow:
+  rules:
+    - if: $CI_PIPELINE_SOURCE == "merge_request_event"
+      when: always
+    - if: $CI_PIPELINE_SOURCE == "web"
+      when: always
+
+stages:
+  - build
+  - unit
+  - uat
+
+default:
+  cache:
+    key: build-cache
+    paths:
+      - node_modules
+      - build
+      - npm-shrinkwrap.json
+
+# Install dependencies stage
+build:
+  stage: build
+  script:
+    - npm -v
+    - node -v
+    - npm install --ignore-scripts
+    - npm run build
+    - npm install
+    - npm shrinkwrap
+    - npm run build
+
+# Unit tests stage
+unit:
+  stage: unit
+  script:
+    - npm run test
+  artifacts:
+    when: always
+    paths:
+      - unit_reports
+
+# UAT tests stage
+uat-auth:
+  stage: uat
+  script:
+    - cd examples
+    - npm install $(npm pack ../../testing-framework | tail -1)
+    - output=$(npm run uatauth)
+    - echo "$output"
+    - node ../ValidateUATReport.js examples
+
+  artifacts:
+    when: always
+    paths:
+      - examples/uat/playwright-report
+
+uat-noauth:
+  stage: uat
+  script:
+    - cd examples
+    - npm install $(npm pack ../../testing-framework | tail -1)
+    - output=$(npm run uatnoauth)
+    - echo "$output"
+    - node ../ValidateUATReport.js examples
+
+  artifacts:
+    when: always
+    paths:
+      - examples/uat/playwright-report
+    
+uat-profile:
+  stage: uat
+  script:
+    - cd examples
+    - npm install $(npm pack ../../testing-framework | tail -1)
+    - output=$(npm run uatprofile)
+    - echo "$output"
+    - node ../ValidateUATReport.js examples
+
+  artifacts:
+    when: always
+    paths:
+      - examples/uat/playwright-report 
+
+
+uat-unauth:
+  stage: uat
+  script:
+    - cd examples
+    - npm install $(npm pack ../../testing-framework | tail -1)
+    - output=$(npm run uatunauth)
+    - echo "$output"
+    - node ../ValidateUATReport.js examples
+
+
+  artifacts:
+    when: always
+    paths:
+      - examples/uat/playwright-report 
+
+uat-nobdd:
+  stage: uat
+  script:
+    - cd nobdd
+    - npm install $(npm pack ../../testing-framework | tail -1)
+    - output=$(npm run uatnobdd -- --headless)
+    - echo "$output"
+    - node ../ValidateUATReport.js nobdd
+
+
+  artifacts:
+    when: always
+    paths:
+      - nobdd/uat/playwright-report
+
+
+uatmodule:
+  stage: uat
+  script:
+    - cd examples
+    - npm install $(npm pack ../../testing-framework | tail -1)
+    - output=$(npm run uatmodule)
+    - echo "$output"
+    - node ../ValidateUATReport.js examples
+
+
+  artifacts:
+    when: always
+    paths:
+      - examples/uat/playwright-report
+
+uatconfigmodule:
+  stage: uat
+  script:
+    - cd examples
+    - npm install $(npm pack ../../testing-framework | tail -1)
+    - output=$(npm run uatconfigmodule)
+    - echo "$output"
+    - node ../ValidateUATReport.js examples
+
+  artifacts:
+    when: always
+    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/.prettierrc

@@ -0,0 +1,6 @@
+{
+  "trailingComma": "none",
+  "singleQuote": true,
+  "arrowParens": "avoid",
+  "jsxSingleQuote": true
+}

package/README.md

@@ -15,4 +15,84 @@
   ### Generate Report
 
      - npm run report
-    
+
+## Version History
+
+### v0.2.8 - 26-09-2024
+
+#### Feature
+  - Added support for writing unitcases for framework implementations
+
+### 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. 
+
+
+## Version History
+
+### v3.0.8 - 25-12-2024
+
+#### Enhancement
+  - Added support to disable headless mode using command line arguments
+  - Proper validation added for node 14 build process
+  - Removed unwanted uat.config.js files in test projects (examples / nobdd)
+
+### v0.2.9.2 - 22-11-2024   
+
+#### BugFix
+  - Implemented synchronization for the login process. This fix will help avoid login session-related failures in UAT.
+  
+### v0.3.1 - 13-11-2024
+
+#### Issue Fix
+- Adding bddmode to get the fixtures.
+
+### v0.2.9.1 - 14-11-2024
+
+#### Enhancement
+   - Beta feature Actors and edition configurations are unified 
+
+### v0.2.9 - 25-10-2024
+
+#### Feature
+  - Added support for scenario level tag support
+  - Added a new cli optin like uat-validate to validate the feature files using playwright-bdd
+  - Mode based configuration implementations
+  - @only option enabled in dev pipeline
+  - Latest setup related configuration changed for init option
+
+### v0.3.0 - 25-10-2024
+
+#### Features
+  - Added support for scenario level tag support
+  - Updated the configuration for `video` and `trace` to accept Playwright-specific values instead of boolean values.
+  - Below package versions are updated in this release. 
+    - playwright - 1.48.0, 
+    - playwright-bdd - 7.5.0,
+    - @playwright/test - 1.48.0,
+    - @cucumber/cucumber - 11.0.1
+  - From this version, We adopt the playwright-bdd as library instead of modified source
+  - Published on 11-11-2024
+  
+#### 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'`.
+
+### v0.3.1 - 13-11-2024
+
+#### Issue Fix
+- Adding bddmode to get the fixtures.
+
+### v0.3.3 - 27-11-2024
+
+#### Feature
+- Custom report integration support (ReportPortal)
+
+### v0.2.9.1 - 14-11-2024
+
+#### Enhancement
+   - Beta feature Actors and edition configurations are unified 
+
+### v0.2.9.2 - 22-11-2024   
+
+#### BugFix
+    - Implemented synchronization for the login process. This fix will help avoid login session-related failures in UAT.

package/bin/cli.js

@@ -1,3 +1,3 @@
 #!/usr/bin/env node
 
-require('../src/lib/cli');
+require('../build/lib/cli');

package/bin/postinstall.js

@@ -1,16 +1 @@
-const path = require('path');
-const { spawn } = require('child_process');
-const { Logger } = require('../src/utils/logger');
-const getFilePathWithExtension = require('../src/utils/getFilePath');
-
-const playwrightPath = path.resolve('node_modules', '.bin', getFilePathWithExtension('playwright'));
-const command = playwrightPath;
-const args = ['install'];
-
-Logger.log(Logger.INFO_TYPE, 'Downloading browsers for running tests');
-
-const childProcess = spawn(command, args, { stdio: 'inherit' });
-
-childProcess.on('error', (error) => {
-  Logger.log(Logger.FAILURE_TYPE, error);
-});
+require('../build/lib/post-install');

package/{src → build}/core/jest/preprocessor/jsPreprocessor.js

@@ -1,9 +1,7 @@
-const babelJest = require('babel-jest');
+"use strict";
 
+const babelJest = require('babel-jest');
 module.exports = babelJest.createTransformer({
-  presets: [
-    require.resolve('@babel/preset-env'),
-    require.resolve('@babel/preset-react')
-  ],
+  presets: [require.resolve('@babel/preset-env'), require.resolve('@babel/preset-react')],
   plugins: [require.resolve('babel-plugin-transform-dynamic-import')]
-});
+});

package/{src → build}/core/jest/runner/jest-runner.js

@@ -1,7 +1,18 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = createJestRunner;
+var _child_process = require("child_process");
+var _path = _interopRequireDefault(require("path"));
+var _rootPath = require("../../../utils/rootPath");
+/* eslint-disable no-unused-vars */
 // import { run } from 'jest';
 
 // function createJestRunner() {
-//   let config = require('../configs/jest.config');
+//   let config  from '../configs/jest.config');
 
 //   let argv = process.argv.slice(2);
 
@@ -9,25 +20,19 @@
 //   run(argv);
 // }
 
-
 // export default createJestRunner;
 
-const { spawn } = require('child_process');
-const path = require('path');
-const { getExecutableBinaryPath } = require('../../../utils/rootPath');
-
-const jestPath = path.resolve(getExecutableBinaryPath('jest'));
+const jestPath = _path.default.resolve((0, _rootPath.getExecutableBinaryPath)('jest'));
 
 // Command and arguments for npx playwright test
 const command = jestPath;
 const args = ['--config', require.resolve('../../../../jest.config.js')];
-
-
 function createJestRunner() {
   // Spawn the child process
 
-  const childProcess = spawn(command, args, { stdio: 'inherit' });
-
+  const childProcess = (0, _child_process.spawn)(command, args, {
+    stdio: 'inherit'
+  });
 
   // Handling the 'exit' event of the child process
   // childProcess.on('exit', (code, signal) => {
@@ -38,7 +43,4 @@ function createJestRunner() {
   // childProcess.on('error', (err) => {
   //   console.error(`Error while spawning child process: ${err.message}`);
   // });
-}
-
-
-module.exports = createJestRunner;
+}

package/build/core/jest/setup/index.js

@@ -0,0 +1,3 @@
+"use strict";
+
+require("@testing-library/jest-dom/extend-expect");

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

@@ -0,0 +1,19 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+var _default = exports.default = {
+  addTags: [async ({
+    $tags
+  }, use, testInfo) => {
+    testInfo.annotations.push({
+      type: 'tags',
+      description: $tags.join(', ')
+    });
+    await use();
+  }, {
+    auto: true
+  }]
+};

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

@@ -0,0 +1,13 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+const cacheMap = new Map();
+var _default = exports.default = {
+  // eslint-disable-next-line no-empty-pattern
+  cacheLayer: async ({}, use) => {
+    await use(cacheMap);
+  }
+};

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

@@ -0,0 +1,32 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+var _readConfigFile = require("../readConfigFile");
+const {
+  testSetup
+} = (0, _readConfigFile.generateConfigFromFile)();
+async function performDefaultContextSteps({
+  context
+}) {
+  if (testSetup.context && typeof testSetup.context === 'function') {
+    await testSetup.context({
+      context
+    });
+  }
+}
+var _default = exports.default = {
+  context: async ({
+    context
+  }, use) => {
+    await context.addInitScript(() =>
+    // eslint-disable-next-line no-undef
+    window.localStorage.setItem('isDnBannerHide', true));
+    await performDefaultContextSteps({
+      context
+    });
+    await use(context);
+  }
+};

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

@@ -0,0 +1,17 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+var _page = require("./page");
+var _default = exports.default = {
+  executionContext: async ({
+    $tags
+  }, use) => {
+    let testPortalActorDetails = {
+      actorInfo: (0, _page.getCustomAccountDetails)($tags)
+    };
+    await use(testPortalActorDetails);
+  }
+};

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

@@ -0,0 +1,41 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+/* eslint-disable no-undef */
+/* eslint-disable no-param-reassign */
+
+// Note: We are duplicating below method from @zohodesk/i18n. We are not importing it as react package not yet availble in test environment.
+function replaceI18NValuesWithRegex(i18nStr, values) {
+  if (typeof values !== 'undefined') {
+    if (Array.isArray(values)) {
+      for (let i = 0; i < values.length; i++) {
+        i18nStr = i18nStr.replace(new RegExp(`\\{${i}\\}`, 'g'), values[i]);
+      }
+    } else {
+      i18nStr = i18nStr.replace(new RegExp('\\{0\\}', 'g'), values);
+    }
+  }
+  return i18nStr;
+}
+async function isI18NKeyDefined(key) {
+  return new Promise(resolve => {
+    if (typeof window.i18n[key] !== 'undefined') {
+      resolve();
+    }
+  });
+}
+var _default = exports.default = {
+  i18N: async ({
+    page
+  }, use) => {
+    await use(async (key, values) => {
+      await page.waitForFunction(isI18NKeyDefined(key));
+      const i18nValue = await page.evaluate(i18nKey => window.i18n[i18nKey], key);
+      const i18nStr = replaceI18NValuesWithRegex(i18nValue, values);
+      return i18nStr;
+    });
+  }
+};

package/build/core/playwright/builtInFixtures/index.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 _page = _interopRequireDefault(require("./page"));
+var _context = _interopRequireDefault(require("./context"));
+var _cacheLayer = _interopRequireDefault(require("./cacheLayer"));
+var _addTags = _interopRequireDefault(require("./addTags"));
+var _i18N = _interopRequireDefault(require("./i18N"));
+var _unauthenticatedPage = _interopRequireDefault(require("./unauthenticatedPage"));
+var _executionContext = _interopRequireDefault(require("./executionContext"));
+function extractTagsFromTitle(text) {
+  return text.match(/@\w+/g) || [];
+}
+function getBuiltInFixtures(bddMode) {
+  let builtInFixtures = {
+    ..._page.default,
+    ..._context.default,
+    ..._cacheLayer.default,
+    ..._i18N.default,
+    ..._unauthenticatedPage.default,
+    ..._executionContext.default
+  };
+  if (bddMode) {
+    builtInFixtures = {
+      ...builtInFixtures,
+      ..._addTags.default
+    };
+  } else {
+    builtInFixtures = {
+      ...builtInFixtures,
+      $tags: async ({}, use, testInfo) => {
+        // Extract only the elements after the "@" symbol as tags
+        const tags = testInfo.title ? extractTagsFromTitle(testInfo.title) : [];
+        await use(tags);
+      }
+    };
+  }
+  return builtInFixtures;
+}
+var _default = exports.default = getBuiltInFixtures;

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

@@ -0,0 +1,101 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+exports.getCustomAccountDetails = getCustomAccountDetails;
+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;
+  if (selectedTag) {
+    tagInput = selectedTag.split(`${inputString}_`).pop().toLowerCase();
+  }
+  return tagInput;
+}
+function getCustomAccountDetails(tags) {
+  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');
+    const betaFeature = getTagInputFromSelectedTags(filteredTags, '@beta');
+    const profileInfo = getTagInputFromSelectedTags(filteredTags, '@profile');
+    const editionInfo = getTagInputFromSelectedTags(filteredTags, '@edition');
+    const user = (0, _auth.getUserForSelectedEditionAndProfile)(editionInfo, profileInfo, betaFeature, portalInfo);
+    return user;
+  }
+  return (0, _auth.getDefaultActor)();
+}
+const {
+  testSetup
+} = (0, _readConfigFile.generateConfigFromFile)();
+async function loginSteps(pageDetail) {
+  const {
+    page
+  } = pageDetail;
+  if (testSetup.loginSteps && typeof testSetup.loginSteps === 'function') {
+    return await testSetup.loginSteps(pageDetail);
+  } else {
+    await page.goto(process.env.domain);
+  }
+}
+async function performDefaultPageSteps(testInfo) {
+  if (testSetup.page && typeof testSetup.page === 'function') {
+    await testSetup.page(testInfo);
+  }
+}
+async function verifyPageIsLoaded(testInfo) {
+  if (testSetup.validateLogin && typeof testSetup.validateLogin === 'function') {
+    return await testSetup.validateLogin(testInfo);
+  }
+  return true;
+}
+var _default = exports.default = {
+  page: async ({
+    context,
+    $tags,
+    page,
+    executionContext
+  }, use, testInfo) => {
+    let testPortalDetails = executionContext.actorInfo;
+    let testDetails = {
+      page,
+      $tags,
+      context,
+      ...testPortalDetails
+    };
+    try {
+      //This block is used to skip the login process if the @unauthenticated tag is added to the script
+      if ($tags.includes('@unauthenticated')) {
+        await context.clearCookies();
+        return;
+      }
+      const {
+        isAuthMode
+      } = (0, _readConfigFile.generateConfigFromFile)();
+      if (!isAuthMode) {
+        return;
+      }
+      const projectName = testInfo.project.name;
+      if (testPortalDetails && projectName !== 'setup' && projectName !== 'cleanup') {
+        await context.clearCookies();
+        await (0, _auth.performLoginSteps)(testDetails, async testInfo => {
+          return await verifyPageIsLoaded(testInfo);
+        }, loginSteps);
+        process.env.actorInfo = JSON.stringify(testPortalDetails);
+      }
+    } catch (e) {
+      console.error('Error during page', e);
+    } finally {
+      await performDefaultPageSteps(testDetails);
+      await use(page);
+      await context.close();
+    }
+  }
+};