@devassure/tpp-engine 0.0.0-stage → 1.8.0

package/README.md

@@ -1,3 +1,19 @@
-# Temporary Holding Version
+# tpp-engine
+NPM module which provides interface for all the automation methods.
+This package is tightly coupled to the tpp-cli. The CLI translates the tpp files to the methods defined in the tpp-engine.
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+## To Test the engine changes:
+```
+npm pack
+#Copy the path of the tgz from the project root
+#Go to io.testpp.at/.target/<project_id>/
+npm install <path of tgz>
+```
+
+## To Publish the package to private github:
+  ```
+  npm login --scope=@test-plus-plus --auth-type=legacy --registry=https://npm.pkg.github.com
+  # Use the personal access token with write access
+  # Replace the GITHUB_PERSONAL_TOKEN with your token in .npmrc
+  npm publish
+  ```

package/index.js

@@ -0,0 +1,121 @@
+const { test, chromium } = require('@playwright/test');
+const fs = require('fs');
+const { Actions } = require('./src/actions');
+const { NetworkLogManager } = require('./src/network-log/network-log-manager');
+const { ConsoleLogManager } = require('./src/console-log/console-log-manager');
+const { DownloadsManager } = require('./src/downloads/downloads-manager');
+const { getAppiumConfig } = require('./src/mobile/appium/appium-manager');
+const { MobileActions } = require('./src/mobile/mobile-actions');
+const getSelectorScript = require('@test-plus-plus/tpp-locator');
+
+const tppTest = test.extend({
+    context: async ({ context: originalContext }, use, testInfo) => {
+      let playwrightConfig;
+      if(testInfo?.config?.configFile) {
+        playwrightConfig = require(testInfo.config.configFile);
+      }
+      if(!playwrightConfig?.customConfig?.chromeExtension) {
+        await use(originalContext);
+      } else {
+        const pathToExtension = playwrightConfig.customConfig.chromeExtension;
+        const contextPath = `temp_context_data/${testInfo.title.replace(/[^a-zA-Z0-9]/g, "_")}-${Date.now()}`;
+        const context = await chromium.launchPersistentContext(contextPath, {
+          headless: false,
+          screen: testInfo?.project?.use?.viewport,
+          args: [
+            ...(testInfo?.project?.use?.launchOptions?.args || []),
+            `--disable-extensions-except=${pathToExtension}`,
+            `--load-extension=${pathToExtension}`,
+          ],
+        });
+
+        await use(context);
+        //Will be run at the end of the test
+        !!contextPath && fs.rmSync(contextPath, { recursive: true, force: true });
+      }
+    },
+    actions: async ({ page, request, context }, use, testInfo) => {
+      let playwrightConfig;
+      if(testInfo?.config?.configFile) {
+        playwrightConfig = require(testInfo.config.configFile);
+      }
+
+      const { cssSelector: cssSelectorGeneratorScript, finder: finderScript } = getSelectorScript();
+      for (const page of context.pages()) {
+        await page.addInitScript(finderScript);
+        await page.addInitScript(cssSelectorGeneratorScript);
+      }
+      context.on('page', async (page) => {
+        await page.addInitScript(finderScript);
+        await page.addInitScript(cssSelectorGeneratorScript);
+      });
+
+      let webComponents;
+      if(!playwrightConfig?.customConfig?.testType || playwrightConfig.customConfig.testType === 'web') {
+        const networkLogManager = new NetworkLogManager(playwrightConfig?.customConfig?.networkLogTracing, page);
+        const consoleLogManager = new ConsoleLogManager(playwrightConfig?.customConfig?.consoleLogTracing, page);
+        const downloadsManager = new DownloadsManager(playwrightConfig?.customConfig?.downloadsConfig, page);
+        let extensionId = undefined;
+        if(playwrightConfig?.customConfig?.chromeExtension) {
+          extensionId = await getExtension(context);
+        }
+        webComponents = {
+          networkLogManager: networkLogManager,
+          consoleLogManager: consoleLogManager,
+          downloadsManager: downloadsManager,
+          extensionId: extensionId,
+        }
+      }
+
+      let mobileActions;
+      if(playwrightConfig?.customConfig?.testType === 'mobile') {
+        const projectInfo = playwrightConfig.daProjectInfo;
+        let mobileConfig = playwrightConfig.customConfig.mobileConfig || {};
+        mobileConfig.parallelIndex = testInfo.parallelIndex || 0;
+        mobileConfig.appium = getAppiumConfig();
+        mobileConfig.appium.pid = mobileConfig.appium?.pids?.at(mobileConfig.parallelIndex);
+        mobileConfig.appium.port = mobileConfig.appium?.ports?.at(mobileConfig.parallelIndex);
+        mobileConfig.device = mobileConfig.devices?.at(mobileConfig.parallelIndex);
+        mobileConfig.cloudDevice = mobileConfig.cloudDevices?.at(mobileConfig.parallelIndex);
+        mobileActions = new MobileActions(mobileConfig, testInfo.retry, testInfo.project?.retries || 0, projectInfo, playwrightConfig?.customConfig?.timeouts);
+      }
+
+      let customConfig = playwrightConfig?.customConfig || {};
+      customConfig.testInfo = {
+        retry: testInfo.retry,
+        maxRetries: testInfo.project?.retries || 0,
+        threadIndex: testInfo.parallelIndex || 0,
+        status: 'running',
+        environment: customConfig?.environment || 'default',
+      };
+
+      const actions = new Actions(page, request, undefined, testInfo.retry, testInfo.project?.retries || 0, playwrightConfig?.customConfig, webComponents, mobileActions);
+      await use(actions);
+    },
+});
+
+const getExtension = async (context) => {
+  let [background] = context.serviceWorkers();
+  if (!background)
+    [background] = context.backgroundPages();
+  if (!background) {
+    try {
+      background = await context.waitForEvent('serviceworker', {timeout: 2000});
+    } catch(ex) {}
+  }
+  if (!background) {
+    try {
+      background = await context.waitForEvent('backgroundpage', {timeout: 2000});
+    } catch(ex) {}
+  }
+  if(context.pages().length > 1) {
+    await context.pages()[0].close();
+  }
+
+  if(!background) {
+    return 'TPP_EXTN_NOT_LOADED';
+  }
+  return background.url().split('/')[2];
+}
+
+exports.tppTest = tppTest;

package/package.json

@@ -1,6 +1,32 @@
 {
   "name": "@devassure/tpp-engine",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+  "version": "1.8.0",
+  "description": "Automation library to run TPP tests",
+  "main": "index.js",
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "author": "sandy-tpp",
+  "license": "ISC",
+  "dependencies": {
+    "@axe-core/playwright": "4.10.1",
+    "@playwright/test": "1.60.0",
+    "@test-plus-plus/tpp-locator": "1.0.9",
+    "axios": "^1.7.7",
+    "dayjs": "^1.11.19",
+    "exceljs": "^4.4.0",
+    "expect-axe-playwright": "4.1.2",
+    "fs-extra": "^11.2.0",
+    "lodash": "^4.17.21",
+    "mysql2": "^3.9.1",
+    "neo4j-driver": "^5.28.1",
+    "node-clipboardy": "^1.0.3",
+    "oracledb": "^6.9.0",
+    "otplib": "^12.0.1",
+    "pg": "^8.11.5",
+    "tree-kill": "^1.2.2",
+    "webdriverio": "^8.11.2",
+    "ws": "^8.18.1",
+    "xlsx": "^0.18.5"
+  }
+}

package/src/accessibility/combined-a11y-report.js

@@ -0,0 +1,208 @@
+const fs = require('fs');
+const path = require('path');
+const { FileUtils } = require('../library/file/file-utils');
+const fsExtra = require('fs-extra');
+
+const resultsDir = 'axe-core-results';
+const logoUrl = 'https://www.devassure.io/images/DA-logo.svg';
+
+function accumulateImpactSummary(violations, summary) {
+    violations.forEach((violation) => {
+      if (violation.impact) {
+        summary[violation.impact] = (summary[violation.impact] || 0) + 1;
+      }
+    });
+}
+
+function escapeHtml(html) {
+    return html.replace(/&/g, "&amp;").replace(/</g, "&lt;").replace(/>/g, "&gt;").replace(/"/g, "&quot;").replace(/'/g, "&#039;");
+}
+
+function getImpactColor(impact) {
+    switch (impact) {
+      case 'critical': return '#e63946';
+      case 'serious': return '#f77f00';
+      case 'moderate': return '#dea309';
+      case 'minor': return '#70aa45';
+      default: return '#333';
+    }
+}
+
+function generateCombinedA11yReport() {
+  if(!fs.existsSync(resultsDir)) {
+    return;
+  }
+  const resultFiles = fs.readdirSync(resultsDir).filter((file) => file.endsWith('.json'));
+  if(!resultFiles?.length) {
+    return;
+  }
+
+  let totalImpactSummary = { critical: 0, serious: 0, moderate: 0, minor: 0 };
+  resultFiles.forEach((file) => {
+    const filePath = path.join(resultsDir, file);
+    const data = JSON.parse(fs.readFileSync(filePath, 'utf8'));
+
+    accumulateImpactSummary(data.violations, totalImpactSummary);
+  });
+
+  let htmlContent = `
+    <html>
+      <head>
+        <title>DevAssure Accessibility Report</title>
+        <style>
+          body { font-family: Arial, sans-serif; margin: 0; padding: 20px; background-color: #f4f4f9; }
+          .header { display: flex; align-items: center; justify-content: center; margin-bottom: 20px; }
+          .logo { max-width: 50px; max-height: 50px; position: absolute; left: 20px; }
+          h1 { text-align: center; color: #333; margin: 0; }
+          h3 { margin: 8px; }
+          .summary, .details { margin: 20px 0; padding: 12px; background: #fff; border-radius: 8px; box-shadow: 0 0 10px rgba(0, 0, 0, 0.1); }
+          .impact-summary { display: flex; padding: 10px; }
+          .impact-item { font-size: 18px; padding: 10px; color: #fff; border-radius: 4px; text-align: center; margin-right: 24px; }
+          .impact-critical { background-color: #e63946; }
+          .impact-serious { background-color: #f77f00; }
+          .impact-moderate { background-color: #dea309; }
+          .impact-minor { background-color: #70aa45; }
+          .filter-container { display: flex; justify-content: right; margin-bottom: 20px; align-items: center; }
+          .filter-select { padding: 8px; font-size: 16px; margin-left: 10px; cursor: pointer; }
+          .expand-collapse { cursor: pointer; color: #007bff; text-decoration: underline; margin-left: 16px }
+          .expand-collapse:hover { color: #0056b3; }
+          .collapsible { cursor: pointer; display: flex; justify-content: space-between; align-items: center; padding: 4px 16px; border-radius: 4px; color: #fff; margin-top: 6px; }
+          .collapsible.default { background-color: #457b9d; }
+          .collapsible.no-violations { background-color: #4caf50; }
+          .collapsible:hover { background-color: #1d3557; }
+          .content { display: none; padding: 10px; border-left: 4px solid #ddd; background: #f1faee; margin-top: 5px; border-radius: 0 0 8px 8px; }
+          .violation { margin-top: 10px; border-top: 1px solid #ddd; padding-top: 10px; }
+          .violation h4 { margin: 5px 0; font-size: 20px; }
+          .impact { padding: 4px 8px; border: 1px solid #bbb; border-radius: 4px; width: fit-content; }
+          .element-box { font-family: Consolas, "Courier New", monospace; background-color: #e8e8e8; padding: 5px; border-radius: 4px; margin-top: 5px; color: #333; white-space: pre-wrap; }
+          .failure-message { font-family: Consolas, "Courier New", monospace; color: #e63946; }
+        </style>
+      </head>
+      <body>
+        <div class="header">
+          <img src="${logoUrl}" alt="Logo" class="logo"/>
+          <h1>DevAssure - Accessibility Report</h1>
+        </div>
+        <div class="summary">
+          <h3>Summary</h3>
+          <div class="impact-summary">
+            <div class="impact-item impact-critical">Critical: <span>${totalImpactSummary.critical}</span></div>
+            <div class="impact-item impact-serious">Serious: <span>${totalImpactSummary.serious}</span></div>
+            <div class="impact-item impact-moderate">Moderate: <span>${totalImpactSummary.moderate}</span></div>
+            <div class="impact-item impact-minor">Minor: <span>${totalImpactSummary.minor}</span></div>
+          </div>
+        </div>
+
+        <div class="filter-container">
+          <label for="filter-select">Filter:</label>
+          <select id="filter-select" class="filter-select" onchange="applyFilter()">
+            <option value="all">All</option>
+            <option value="failures">Only Failures</option>
+          </select>
+          <span class="expand-collapse" onclick="collapseAll()">Collapse All</span>
+          <span class="expand-collapse" onclick="expandAll()">Expand All</span>
+        </div>
+  `;
+
+  // Process each JSON file to build the report
+  resultFiles.forEach((file, index) => {
+    const filePath = path.join(resultsDir, file);
+    const data = JSON.parse(fs.readFileSync(filePath, 'utf8'));
+
+    const violationCount = data.violations?.length || 0;
+    const collapsibleClass = violationCount === 0 ? 'no-violations' : 'default';
+
+    htmlContent += `
+      <div class="collapsible ${collapsibleClass}" onclick="toggleSection(this)"
+      data-violations="${violationCount}" id="collapsible-${index}">
+        <span><strong>${data.testId || file}</strong>  ( ${data.url || 'Unknown URL'} )</span>
+        <span class="collapsible">${violationCount} violations</span>
+      </div>
+      <div class="content">
+    `;
+
+    if (!data.violations?.length) {
+      htmlContent += `<p>No violations found.</p>`;
+    } else {
+      data.violations.forEach((violation) => {
+        const impactColor = getImpactColor(violation.impact);
+        htmlContent += `
+          <div class="violation">
+            <h4 style="color: ${impactColor};">${violation.id}: ${violation.help}</h4>
+            <p class="impact">Impact:<strong> ${violation.impact}</strong></p>
+            <p>${violation.description}</p>
+            <ul>
+              ${violation.nodes
+                .map(
+                  (node) => `
+                  <li>
+                    <p>Element:</p>
+                    <div class="element-box">${escapeHtml(node.html)}</div>
+                    <p class="failure-message">${node.failureSummary}</p>
+                  </li>
+                `
+                )
+                .join('')}
+            </ul>
+          </div>
+        `;
+      });
+    }
+
+    htmlContent += `</div>`; // Close the collapsible content div
+  });
+
+  // Add JavaScript for collapsible sections
+  htmlContent += `
+  <script>
+    function toggleSection(element) {
+      const content = element.nextElementSibling;
+      content.style.display = content.style.display === 'block' ? 'none' : 'block';
+    }
+
+    function applyFilter() {
+        const filter = document.getElementById('filter-select').value;
+        const collapsibles = document.querySelectorAll('.collapsible');
+
+        collapsibles.forEach((collapsible) => {
+        const violations = parseInt(collapsible.getAttribute('data-violations'), 10);
+        if (filter === 'failures' && violations === 0) {
+            collapsible.style.display = 'none';
+            collapsible.nextElementSibling.style.display = 'none';
+        } else {
+            collapsible.style.display = 'flex';
+        }
+        });
+    }
+
+    function expandAll() {
+        const contents = document.querySelectorAll('.content');
+        contents.forEach(content => content.style.display = 'block');
+    }
+
+    function collapseAll() {
+        const contents = document.querySelectorAll('.content');
+        contents.forEach(content => content.style.display = 'none');
+    }
+  </script>
+ </body>
+</html>
+`;
+
+  new FileUtils().writeTextContent(path.join("tpp-results", 'combined-accessibility-report.html'), htmlContent)
+
+  fsExtra.removeSync(resultsDir);
+}
+
+function writeAxeResultToFile(axeResult, caller, fileLabel) {
+    const fileName = `da-axe-result-${fileLabel}.json`;
+    const filePath =  path.join(resultsDir, fileName);
+    const data = {
+        testId: caller,
+        ...axeResult,
+    };
+    new FileUtils().writeTextContent(filePath, JSON.stringify(data, null, 4));
+}
+
+exports.generateCombinedA11yReport = generateCombinedA11yReport;
+exports.writeAxeResultToFile = writeAxeResultToFile;

package/src/accessibility/tpp-a11y.js

@@ -0,0 +1,81 @@
+const { expect } = require("@playwright/test");
+const { default: matchers } = require("expect-axe-playwright");
+const { generateRandomString } = require("../utils/common-utils");
+const { default: AxeBuilder } = require("@axe-core/playwright");
+const { writeAxeResultToFile } = require("./combined-a11y-report");
+expect.extend(matchers);
+
+class TppA11y {
+
+  constructor(page, caller, softAssert) {
+    this.page = page;
+    this.caller = caller;
+    this.softAssert = softAssert;
+  }
+
+  async analysePage() {
+    const reportLabel = generateRandomString();
+    let failure = false;
+
+    try {
+      const fileName = `da-a11y-report-${reportLabel}.html`;
+      await expect(this.page).toPassAxe({
+        filename: fileName,
+        runOnly: {
+          type: 'tag',
+          values: ['wcag2a', 'wcag2aa', 'wcag21a', 'wcag21aa']
+        },
+      });
+    } catch (e) {
+      failure = true;
+      const result = await new AxeBuilder({ page: this.page })
+      .withTags(['wcag2a', 'wcag2aa', 'wcag21a', 'wcag21aa'])
+      .include('body')
+      .analyze()
+      writeAxeResultToFile(result, this.caller, reportLabel);
+      this.handleException(e);
+    }
+
+    if(!failure) {
+      const data = {violations: [], url: this.page.url()};
+      writeAxeResultToFile(data, this.caller, reportLabel);
+    }
+  }
+
+  async analyseElement(tppElement) {
+    const locator = tppElement.locator();
+    const fileName = `da-a11y-report-${generateRandomString()}.html`;
+    try {
+      await expect(locator).toPassAxe({filename: fileName});
+    } catch (e) {
+      this.handleException(e);
+    }
+  }
+
+  handleException(ex) {
+    console.log("Accessibility exception: ", ex);
+    if(this.softAssert?.softAssert) {
+      if(this.softAssert?.logMessage) {
+        this.softAssert.logMessage("Soft Assert - Accessibility violations present!");
+      }
+      this.softAssert.softAssert.assertions?.push({ result: false, message: this.softAssert?.assertMessage || 'Accessibility violations present!' });
+    } else {
+      throw {message: 'There are Accessibility violations present!'};
+    }
+  }
+
+}
+
+const checkA11yAttachments = (tppTest, caller) => {
+  const axeReports = tppTest.info()?.attachments?.filter(
+    attachment => attachment.name?.includes('da-a11y-report-') && attachment.name?.includes('.html')
+  );
+  if(!axeReports?.length) return;
+  axeReports.forEach((axeReport, index) => {
+    const log = JSON.stringify({reportPath: axeReport.path, label: axeReport.name, index: index + 1});
+    console.log(`[[TPP]] ${caller} :: [a11y-report] ${log}`);
+  })
+};
+
+exports.TppA11y = TppA11y;
+exports.checkA11yAttachments = checkA11yAttachments;