transit-core-taf 1.0.21 → 1.0.23

package/dist/global-setup.js

@@ -1,67 +1,6 @@
 "use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
-    Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
-    o["default"] = v;
-});
-var __importStar = (this && this.__importStar) || (function () {
-    var ownKeys = function(o) {
-        ownKeys = Object.getOwnPropertyNames || function (o) {
-            var ar = [];
-            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
-            return ar;
-        };
-        return ownKeys(o);
-    };
-    return function (mod) {
-        if (mod && mod.__esModule) return mod;
-        var result = {};
-        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
-        __setModuleDefault(result, mod);
-        return result;
-    };
-})();
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
 Object.defineProperty(exports, "__esModule", { value: true });
-const dotenv = __importStar(require("dotenv"));
-const path_1 = __importDefault(require("path"));
-const fs = __importStar(require("fs"));
-// Function to find the project root
-const findProjectRoot = (startPath) => {
-    let currentPath = startPath;
-    while (currentPath !== path_1.default.parse(currentPath).root) {
-        if (fs.existsSync(path_1.default.join(currentPath, 'package.json'))) {
-            return currentPath;
-        }
-        currentPath = path_1.default.dirname(currentPath);
-    }
-    return startPath; // Fallback to the original directory if not found
-};
 async function globalSetup() {
-    const env = process.env.ENV || 'stage';
-    const projectRoot = path_1.default.resolve(__dirname, '..');
-    const envPath = path_1.default.join(projectRoot, `.env.${env}`);
-    // Load env file
-    if (fs.existsSync(envPath)) {
-        dotenv.config({ path: envPath, override: true });
-        console.log(`✅ Loaded ${envPath} from project root ${projectRoot} ✅`);
-    }
-    else {
-        throw new Error(`❌ Environment file .env.${env} not found in project root ${projectRoot} ❌`);
-    }
     const argv = process.argv;
     // Find all arguments related to project selection
     const projectArgs = argv.map((arg, i) => {

package/dist/index.d.ts

@@ -6,10 +6,10 @@ export * from './baseui/commonpagevalidations';
 export * from './baseui/commonpagewaits';
 export * from './baseui/logger';
 export * from './utils/Utils';
+export * from './utils/excel/excel-utils';
 export * from './baseapi/baseapihelpers';
 export * from './baseapi/apiutils';
 export * from './constants/test-tags';
-export * from './utils/testrail/client';
+export { TestRailClient, TestRailClientOptions, TestRailResult, } from './utils/testrail/client';
 export * from './utils/testrail-importer';
 export { default as TestRailReporter } from './reporters/testrail-reporter';
-export type { TestRailReporterOptions } from './reporters/testrail-reporter';

package/dist/index.js

@@ -17,7 +17,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.TestRailReporter = void 0;
+exports.TestRailReporter = exports.TestRailClient = void 0;
 __exportStar(require("./baseui/basepagevalidations"), exports);
 __exportStar(require("./baseui/basepageactions"), exports);
 __exportStar(require("./baseui/basepagewaits"), exports);
@@ -26,10 +26,12 @@ __exportStar(require("./baseui/commonpagevalidations"), exports);
 __exportStar(require("./baseui/commonpagewaits"), exports);
 __exportStar(require("./baseui/logger"), exports);
 __exportStar(require("./utils/Utils"), exports);
+__exportStar(require("./utils/excel/excel-utils"), exports);
 __exportStar(require("./baseapi/baseapihelpers"), exports);
 __exportStar(require("./baseapi/apiutils"), exports);
 __exportStar(require("./constants/test-tags"), exports);
-__exportStar(require("./utils/testrail/client"), exports);
+var client_1 = require("./utils/testrail/client");
+Object.defineProperty(exports, "TestRailClient", { enumerable: true, get: function () { return client_1.TestRailClient; } });
 __exportStar(require("./utils/testrail-importer"), exports);
 var testrail_reporter_1 = require("./reporters/testrail-reporter");
 Object.defineProperty(exports, "TestRailReporter", { enumerable: true, get: function () { return __importDefault(testrail_reporter_1).default; } });

package/dist/reporters/testrail-reporter.d.ts

@@ -1,14 +1,10 @@
 import { Reporter, FullConfig, Suite, FullResult } from '@playwright/test/reporter';
 import { TestRailJunitImporterOptions } from '../utils/testrail-importer';
-export interface TestRailReporterOptions extends Omit<TestRailJunitImporterOptions, 'junitPath' | 'onstart' | 'onend'> {
-    outputFile?: string;
-}
 declare class TestRailReporter implements Reporter {
     private options;
-    private config;
-    constructor(options: TestRailReporterOptions);
+    private runId;
+    constructor(options: TestRailJunitImporterOptions);
     onBegin(config: FullConfig, suite: Suite): void;
     onEnd(result: FullResult): Promise<void>;
-    private getJunitReporter;
 }
 export default TestRailReporter;

package/dist/reporters/testrail-reporter.js

@@ -3,51 +3,33 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const testrail_importer_1 = require("../utils/testrail-importer");
 class TestRailReporter {
     options;
-    config;
+    runId;
     constructor(options) {
         if (!options.runId) {
             throw new Error('TestRail Reporter requires a `runId` to be specified.');
         }
         this.options = options;
+        this.runId = options.runId;
         console.log('Initialized TestRail Reporter.');
     }
     onBegin(config, suite) {
-        this.config = config;
         console.log(`Starting the run with ${suite.allTests().length} tests`);
     }
     async onEnd(result) {
         console.log(`Run finished with status: ${result.status}`);
-        if (process.env.EXEC_ENVIRONMENT !== 'remote') {
-            console.log('Skipping TestRail results upload for non-remote execution.');
-            return;
+        if (this.options.junitPath) {
+            try {
+                await (0, testrail_importer_1.uploadJunitToTestRail)({
+                    ...this.options,
+                    runId: this.runId,
+                    junitPath: this.options.junitPath,
+                });
+                console.log('Successfully uploaded test results to TestRail.');
+            }
+            catch (error) {
+                console.error('Failed to upload results to TestRail:', error);
+            }
         }
-        // Find the JUnit reporter's output file path from the Playwright config
-        const junitReporter = this.getJunitReporter(this.config);
-        if (!junitReporter) {
-            console.error('Error: JUnit reporter not found in Playwright config. The TestRail reporter depends on the output of the JUnit reporter.');
-            return;
-        }
-        const junitPath = junitReporter.outputFile || junitReporter._outputFile;
-        if (!junitPath) {
-            console.error('Error: Could not determine the output file path for the JUnit reporter.');
-            return;
-        }
-        console.log(`Using JUnit report from: ${junitPath}`);
-        try {
-            await (0, testrail_importer_1.uploadJunitToTestRail)({
-                ...this.options,
-                junitPath,
-            });
-            console.log('Successfully uploaded test results to TestRail.');
-        }
-        catch (error) {
-            console.error('Failed to upload results to TestRail:', error);
-        }
-    }
-    getJunitReporter(config) {
-        // Playwright wraps reporters in an array, e.g., ['junit', { outputFile: 'results.xml' }]
-        const reporter = config.reporter.find((r) => r[0] === 'junit');
-        return reporter ? reporter[1] : undefined;
     }
 }
 exports.default = TestRailReporter;

package/dist/specs/excel-utils.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/specs/excel-utils.spec.js

@@ -0,0 +1,51 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+const test_1 = require("@playwright/test");
+const excel_utils_1 = require("../utils/excel/excel-utils");
+const path = __importStar(require("path"));
+const testDataPath = path.resolve(process.cwd(), 'src/testdata/bookTripData.xlsx');
+test_1.test.describe('Excel Utility Tests', () => {
+    (0, test_1.test)('should read test data from an Excel file', () => {
+        const testData = (0, excel_utils_1.getTestDataFromExcel)(testDataPath, 'TripData');
+        (0, test_1.expect)(testData).toBeInstanceOf(Array);
+        (0, test_1.expect)(testData.length).toBeGreaterThan(0);
+        console.log(JSON.stringify(testData, null, 2));
+        // Example of a more specific assertion
+        const firstRecord = testData[0];
+        (0, test_1.expect)(firstRecord).toHaveProperty('execute');
+        (0, test_1.expect)(firstRecord).toHaveProperty('testCaseName');
+    });
+});

package/dist/utils/excel/excel-utils.d.ts

@@ -0,0 +1,25 @@
+/**
+ * A generic interface for a row of test data.
+ * It allows for any number of properties of any type.
+ */
+interface TestDataRow {
+    [key: string]: any;
+}
+/**
+ * An interface for test data grouped by TestCaseId.
+ * The key is the TestCaseId (string), and the value is an array of test data rows.
+ */
+interface GroupedTestData {
+    [testCaseId: string]: TestDataRow[];
+}
+/**
+ * Reads an Excel file and returns the test data grouped by TestCaseId.
+ * The column headers are sanitized by removing non-alphanumeric characters and converting to camel case.
+ * e.g., "Pickup location" becomes "pickupLocation", "FundingSource" becomes "fundingSource".
+ *
+ * @param filePath - The path to the Excel file.
+ * @param sheetName - The name of the sheet to read from.
+ * @returns An object with TestCaseId as the key and an array of test data rows as the value.
+ */
+export declare function getTestDataFromExcel(filePath: string, sheetName: string): GroupedTestData;
+export {};

package/dist/utils/excel/excel-utils.js

@@ -0,0 +1,87 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getTestDataFromExcel = getTestDataFromExcel;
+const xlsx = __importStar(require("xlsx"));
+/**
+ * Reads an Excel file and returns the test data grouped by TestCaseId.
+ * The column headers are sanitized by removing non-alphanumeric characters and converting to camel case.
+ * e.g., "Pickup location" becomes "pickupLocation", "FundingSource" becomes "fundingSource".
+ *
+ * @param filePath - The path to the Excel file.
+ * @param sheetName - The name of the sheet to read from.
+ * @returns An object with TestCaseId as the key and an array of test data rows as the value.
+ */
+function getTestDataFromExcel(filePath, sheetName) {
+    const workbook = xlsx.readFile(filePath);
+    const worksheet = workbook.Sheets[sheetName];
+    if (!worksheet) {
+        throw new Error(`Sheet "${sheetName}" not found in the Excel file.`);
+    }
+    const jsonData = xlsx.utils.sheet_to_json(worksheet, {
+        // This will ensure that if a column is empty, it will be blank instead of being undefined
+        defval: '',
+    });
+    const groupedData = jsonData.reduce((acc, row) => {
+        const testCaseIdKey = Object.keys(row).find(key => key.toLowerCase().replace(/[^a-z0-9]/gi, '') === 'testcaseid');
+        if (!testCaseIdKey) {
+            console.warn('Row does not have a TestCaseId column, skipping.', row);
+            return acc;
+        }
+        const testCaseId = row[testCaseIdKey];
+        if (!testCaseId) {
+            return acc;
+        }
+        const sanitizedRow = {};
+        for (const key in row) {
+            if (Object.prototype.hasOwnProperty.call(row, key)) {
+                // Sanitize key to camelCase
+                const sanitizedKey = key
+                    .trim()
+                    .replace(/[^a-zA-Z0-9\s]/g, '') // remove special chars except space
+                    .replace(/\s(.)/g, (_match, group1) => group1.toUpperCase())
+                    .replace(/\s/g, '')
+                    .replace(/^(.)/, (match) => match.toLowerCase());
+                sanitizedRow[sanitizedKey] = row[key];
+            }
+        }
+        if (!acc[testCaseId]) {
+            acc[testCaseId] = [];
+        }
+        acc[testCaseId].push(sanitizedRow);
+        return acc;
+    }, {});
+    return groupedData;
+}

package/dist/utils/testrail/client.d.ts

@@ -6,6 +6,7 @@ export interface TestRailClientOptions {
     password?: string;
 }
 export interface TestRailResult {
+    case_id: number;
     status_id: number;
     comment?: string;
     version?: string;
@@ -22,6 +23,6 @@ export declare class TestRailClient {
     constructor(options: TestRailClientOptions);
     private apiPost;
     createTestRun(suiteId: number, name: string, description: string): Promise<any>;
-    loadJunitReport(runId: number, xmlContent: string): Promise<any>;
+    addResultsForCases(runId: number, results: TestRailResult[]): Promise<any>;
     addResultForCase(runId: number, caseId: number, result: TestRailResult): Promise<any>;
 }

package/dist/utils/testrail/client.js

@@ -61,15 +61,18 @@ class TestRailClient {
         console.log(`Successfully created Test Run with ID: ${run.id}. View at: ${run.url}`);
         return run;
     }
-    async loadJunitReport(runId, xmlContent) {
-        console.log(`Uploading JUnit report to TestRail for run ID: ${runId}...`);
-        const base64Content = Buffer.from(xmlContent).toString('base64');
-        const data = {
-            junit_report: base64Content,
-        };
-        const result = await this.apiPost(`load_junit/${runId}`, data);
-        console.log(`Successfully uploaded JUnit report to TestRail.`);
-        return result;
+    async addResultsForCases(runId, results) {
+        const endpoint = `add_results_for_cases/${runId}`;
+        console.log(`Adding ${results.length} results to Test Run ID: ${runId}`);
+        try {
+            const response = await this.apiPost(endpoint, { results });
+            console.log(`Successfully added ${results.length} results.`);
+            return response;
+        }
+        catch (error) {
+            console.error(`Failed to add results for Test Run ID: ${runId}.`, error);
+            throw error;
+        }
     }
     async addResultForCase(runId, caseId, result) {
         const endpoint = `add_result_for_case/${runId}/${caseId}`;

package/dist/utils/testrail-importer.d.ts

@@ -4,13 +4,12 @@ export interface TestRailJunitImporterOptions extends TestRailClientOptions {
     junitPath: string;
     onstart?: () => void;
     onend?: () => void;
+    statusMap?: {
+        [key: string]: number;
+    };
 }
 /**
- * Uploads a JUnit XML report to a specified TestRail test run.
- *
- * IMPORTANT: For this to work correctly, your test names must include the TestRail Case ID.
- * The TestRail JUnit parser uses the test name to map results to cases.
- * Example: test('C12345 My test description', async ({ page }) => { ... });
+ * Parses a JUnit XML report, extracts test results, and uploads them to a TestRail test run.
  *
  * @param options - The configuration options for the TestRail client and the JUnit import.
  */

package/dist/utils/testrail-importer.js

@@ -36,17 +36,20 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.uploadJunitToTestRail = uploadJunitToTestRail;
 const fs = __importStar(require("fs"));
 const client_1 = require("./testrail/client");
+const xmlJs = __importStar(require("xml-js"));
+const defaultStatusMap = {
+    passed: 1,
+    failed: 5,
+    skipped: 2, // Mapped to 'Blocked'
+};
+const caseIdRegex = /C(\d+)/g;
 /**
- * Uploads a JUnit XML report to a specified TestRail test run.
- *
- * IMPORTANT: For this to work correctly, your test names must include the TestRail Case ID.
- * The TestRail JUnit parser uses the test name to map results to cases.
- * Example: test('C12345 My test description', async ({ page }) => { ... });
+ * Parses a JUnit XML report, extracts test results, and uploads them to a TestRail test run.
  *
  * @param options - The configuration options for the TestRail client and the JUnit import.
  */
 async function uploadJunitToTestRail(options) {
-    const { host, user, projectId, token, password, runId, junitPath, onstart, onend } = options;
+    const { host, user, projectId, token, password, runId, junitPath, onstart, onend, statusMap = defaultStatusMap, } = options;
     onstart?.();
     if (!fs.existsSync(junitPath)) {
         throw new Error(`JUnit report not found at path: ${junitPath}`);
@@ -55,8 +58,48 @@ async function uploadJunitToTestRail(options) {
     try {
         console.log(`Reading JUnit report from: ${junitPath}`);
         const xmlContent = fs.readFileSync(junitPath, 'utf-8');
-        await client.loadJunitReport(runId, xmlContent);
-        console.log('Successfully completed JUnit report upload to TestRail.');
+        const report = xmlJs.xml2js(xmlContent, { compact: true });
+        const results = [];
+        const testsuites = Array.isArray(report.testsuites.testsuite)
+            ? report.testsuites.testsuite
+            : [report.testsuites.testsuite];
+        for (const testsuite of testsuites) {
+            if (!testsuite.testcase)
+                continue;
+            const testcases = Array.isArray(testsuite.testcase)
+                ? testsuite.testcase
+                : [testsuite.testcase];
+            for (const testcase of testcases) {
+                const caseIds = testcase._attributes.name.match(caseIdRegex);
+                if (!caseIds)
+                    continue;
+                const statusName = testcase.failure
+                    ? 'failed'
+                    : testcase.skipped
+                        ? 'skipped'
+                        : 'passed';
+                const statusId = statusMap[statusName];
+                if (statusId === undefined)
+                    continue;
+                const comment = testcase.failure
+                    ? `Test failed: ${testcase.failure._attributes.message}`
+                    : `Test ${statusName}`;
+                for (const caseId of caseIds) {
+                    results.push({
+                        case_id: parseInt(caseId.substring(1), 10),
+                        status_id: statusId,
+                        comment,
+                    });
+                }
+            }
+        }
+        if (results.length > 0) {
+            await client.addResultsForCases(runId, results);
+            console.log('Successfully uploaded test results to TestRail.');
+        }
+        else {
+            console.log('No test results with case IDs found in the JUnit report.');
+        }
     }
     catch (error) {
         console.error('Failed to upload JUnit report to TestRail.', error);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "transit-core-taf",
-  "version": "1.0.21",
+  "version": "1.0.23",
   "description": "Transit Core Automation Framework",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -24,7 +24,9 @@
     "xlsx": "^0.18.5"
   },
   "dependencies": {
-    "axios": "^1.7.2"
+    "@types/xml-js": "^0.9.0",
+    "axios": "^1.7.2",
+    "xml-js": "^1.6.11"
   },
   "peerDependencies": {
     "playwright": "^1.54.1"
@@ -35,4 +37,4 @@
   },
   "author": "Transit Core",
   "license": "ISC"
-}
+}