transit-core-taf 1.0.10 → 1.0.12

package/dist/transit-core-taf/index.d.ts

@@ -9,5 +9,5 @@ export * from './utils/Utils';
 export * from './baseapi/baseapihelpers';
 export * from './baseapi/apiutils';
 export * from './constants/test-tags';
-export { default as TestRailReporter, TestRailReporterOptions } from './reporters/testrail-reporter';
 export * from './utils/testrail/client';
+export { uploadJunitToTestRail, TestRailJunitImporterOptions } from './utils/testrail-importer';

package/dist/transit-core-taf/index.js

@@ -13,11 +13,8 @@ var __createBinding = (this && this.__createBinding) || (Object.create ? (functi
 var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
-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.uploadJunitToTestRail = void 0;
 __exportStar(require("./baseui/basepagevalidations"), exports);
 __exportStar(require("./baseui/basepageactions"), exports);
 __exportStar(require("./baseui/basepagewaits"), exports);
@@ -29,6 +26,6 @@ __exportStar(require("./utils/Utils"), exports);
 __exportStar(require("./baseapi/baseapihelpers"), exports);
 __exportStar(require("./baseapi/apiutils"), exports);
 __exportStar(require("./constants/test-tags"), exports);
-var testrail_reporter_1 = require("./reporters/testrail-reporter");
-Object.defineProperty(exports, "TestRailReporter", { enumerable: true, get: function () { return __importDefault(testrail_reporter_1).default; } });
 __exportStar(require("./utils/testrail/client"), exports);
+var testrail_importer_1 = require("./utils/testrail-importer");
+Object.defineProperty(exports, "uploadJunitToTestRail", { enumerable: true, get: function () { return testrail_importer_1.uploadJunitToTestRail; } });

package/dist/transit-core-taf/reporters/testrail-reporter.d.ts

@@ -2,7 +2,8 @@ import { Reporter, FullConfig, Suite, TestCase, TestResult } from '@playwright/t
 export interface TestRailReporterOptions {
     host: string;
     user: string;
-    token: string;
+    token?: string;
+    password?: string;
     projectId: string;
     suiteId: number;
     runName?: string;

package/dist/transit-core-taf/reporters/testrail-reporter.js

@@ -14,12 +14,13 @@ class TestRailReporter {
             try {
                 const host = options?.host ?? process.env.TESTRAIL_HOST;
                 const user = options?.user ?? process.env.TESTRAIL_USER;
-                const token = options?.token ?? process.env.TESTRAIL_PASSWORD;
+                const token = options?.token ?? process.env.TESTRAIL_TOKEN;
+                const password = options?.password ?? process.env.TESTRAIL_PASSWORD;
                 const projectId = options?.projectId ?? process.env.TESTRAIL_PROJECT_ID;
-                if (!host || !user || !token || !projectId) {
-                    throw new Error('TestRail credentials are not fully set in options or environment variables.');
+                if (!host || !user || !(token || password) || !projectId) {
+                    throw new Error('TestRail credentials (host, user, projectId, and token/password) are not fully set in options or environment variables.');
                 }
-                this.client = new client_1.TestRailClient(host, user, token, projectId);
+                this.client = new client_1.TestRailClient({ host, user, projectId, token, password });
                 const suiteIdEnv = options?.suiteId?.toString() ?? process.env.TESTRAIL_SUITE_ID;
                 if (!suiteIdEnv) {
                     throw new Error('TESTRAIL_SUITE_ID is not set in options or environment variables.');

package/dist/transit-core-taf/utils/testrail/client.d.ts

@@ -1,15 +1,17 @@
-declare const statusMap: {
-    [key: string]: number;
-};
+export interface TestRailClientOptions {
+    host: string;
+    user: string;
+    projectId: string;
+    token?: string;
+    password?: string;
+}
 export declare class TestRailClient {
     private host;
     private user;
-    private token;
     private projectId;
     private auth;
-    constructor(host: string, user: string, token: string, projectId: string);
+    constructor(options: TestRailClientOptions);
     private apiPost;
     createTestRun(suiteId: number, name: string, description: string): Promise<any>;
-    addResultForCase(runId: number, caseId: number, status: keyof typeof statusMap, comment?: string): Promise<any>;
+    loadJunitReport(runId: number, xmlContent: string): Promise<any>;
 }
-export {};

package/dist/transit-core-taf/utils/testrail/client.js

@@ -14,18 +14,18 @@ const statusMap = {
 class TestRailClient {
     host;
     user;
-    token;
     projectId;
     auth;
-    constructor(host, user, token, projectId) {
-        if (!host || !user || !token || !projectId) {
-            throw new Error('TestRail host, user, token, or project ID is missing.');
+    constructor(options) {
+        const { host, user, projectId, token, password } = options;
+        if (!host || !user || !projectId || !(token || password)) {
+            throw new Error('TestRail host, user, project ID, and a token or password are required.');
         }
         this.host = host;
         this.user = user;
-        this.token = token;
         this.projectId = projectId;
-        this.auth = `Basic ${Buffer.from(`${this.user}:${this.token}`).toString('base64')}`;
+        const credentials = token ?? password;
+        this.auth = `Basic ${Buffer.from(`${this.user}:${credentials}`).toString('base64')}`;
     }
     async apiPost(endpoint, data) {
         const url = `${this.host}index.php?/api/v2/${endpoint}`;
@@ -55,17 +55,15 @@ class TestRailClient {
         console.log(`Successfully created Test Run with ID: ${run.id}. View at: ${run.url}`);
         return run;
     }
-    async addResultForCase(runId, caseId, status, comment) {
-        const status_id = statusMap[status];
-        if (status_id === undefined) {
-            console.warn(`Unknown test status: ${status}. Skipping TestRail update.`);
-            return;
-        }
-        const data = { status_id };
-        if (comment) {
-            data.comment = comment;
-        }
-        return this.apiPost(`add_result_for_case/${runId}/${caseId}`, data);
+    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;
     }
 }
 exports.TestRailClient = TestRailClient;

package/dist/transit-core-taf/utils/testrail-importer.d.ts

@@ -0,0 +1,15 @@
+import { TestRailClientOptions } from './testrail/client';
+export interface TestRailJunitImporterOptions extends TestRailClientOptions {
+    runId: number;
+    junitPath: string;
+}
+/**
+ * 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 }) => { ... });
+ *
+ * @param options - The configuration options for the TestRail client and the JUnit import.
+ */
+export declare function uploadJunitToTestRail(options: TestRailJunitImporterOptions): Promise<void>;

package/dist/transit-core-taf/utils/testrail-importer.js

@@ -0,0 +1,64 @@
+"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.uploadJunitToTestRail = uploadJunitToTestRail;
+const fs = __importStar(require("fs"));
+const client_1 = require("./testrail/client");
+/**
+ * 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 }) => { ... });
+ *
+ * @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 } = options;
+    if (!fs.existsSync(junitPath)) {
+        throw new Error(`JUnit report not found at path: ${junitPath}`);
+    }
+    const client = new client_1.TestRailClient({ host, user, projectId, token, password });
+    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.');
+    }
+    catch (error) {
+        console.error('Failed to upload JUnit report to TestRail.', error);
+        throw error;
+    }
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "transit-core-taf",
-  "version": "1.0.10",
+  "version": "1.0.12",
   "description": "Transit Core Automation Framework",
   "main": "dist/transit-core-taf/index.js",
   "types": "dist/transit-core-taf/index.d.ts",