transit-core-taf 1.0.17 → 1.0.19

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

@@ -11,3 +11,5 @@ export * from './baseapi/apiutils';
 export * from './constants/test-tags';
 export * 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/transit-core-taf/index.js

@@ -13,7 +13,11 @@ 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;
 __exportStar(require("./baseui/basepagevalidations"), exports);
 __exportStar(require("./baseui/basepageactions"), exports);
 __exportStar(require("./baseui/basepagewaits"), exports);
@@ -27,3 +31,5 @@ __exportStar(require("./baseapi/apiutils"), exports);
 __exportStar(require("./constants/test-tags"), exports);
 __exportStar(require("./utils/testrail/client"), exports);
 __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/transit-core-taf/reporters/testrail-reporter.d.ts

@@ -1,23 +1,14 @@
-import { Reporter, FullConfig, Suite, TestCase, TestResult } from '@playwright/test/reporter';
-export interface TestRailReporterOptions {
-    host: string;
-    user: string;
-    token?: string;
-    password?: string;
-    projectId: string;
-    suiteId: number;
-    runName?: string;
-    enabled?: boolean;
+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 client;
-    private runId;
-    private suiteId;
-    private enabled;
-    private runName?;
-    constructor(options?: TestRailReporterOptions);
-    onBegin(config: FullConfig, suite: Suite): Promise<void>;
-    onTestEnd(test: TestCase, result: TestResult): Promise<void>;
-    private getCaseId;
+    private options;
+    private config;
+    constructor(options: TestRailReporterOptions);
+    onBegin(config: FullConfig, suite: Suite): void;
+    onEnd(result: FullResult): Promise<void>;
+    private getJunitReporter;
 }
 export default TestRailReporter;

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

@@ -1,92 +1,53 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-const client_1 = require("../utils/testrail/client");
+const testrail_importer_1 = require("../utils/testrail-importer");
 class TestRailReporter {
-    client = null;
-    runId = null;
-    suiteId = null;
-    enabled = false;
-    runName;
+    options;
+    config;
     constructor(options) {
-        const isEnabled = options?.enabled ?? process.env.TESTRAIL_REPORTER_ENABLED === 'true';
-        if (isEnabled) {
-            this.enabled = true;
-            try {
-                const host = options?.host ?? process.env.TESTRAIL_HOST;
-                const user = options?.user ?? process.env.TESTRAIL_USER;
-                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 || 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, 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.');
-                }
-                this.suiteId = parseInt(suiteIdEnv, 10);
-                if (isNaN(this.suiteId)) {
-                    throw new Error('TESTRAIL_SUITE_ID is not a valid number.');
-                }
-                this.runName = options?.runName;
-            }
-            catch (error) {
-                console.error('Failed to initialize TestRail reporter:', error);
-                this.enabled = false;
-            }
-        }
-        else {
-            console.log("TestRail reporter is disabled. Set TESTRAIL_REPORTER_ENABLED to 'true' or provide enabled:true in options.");
+        if (!options.runId) {
+            throw new Error('TestRail Reporter requires a `runId` to be specified.');
         }
+        this.options = options;
+        console.log('Initialized TestRail Reporter.');
+    }
+    onBegin(config, suite) {
+        this.config = config;
+        console.log(`Starting the run with ${suite.allTests().length} tests`);
     }
-    async onBegin(config, suite) {
-        if (!this.enabled || !this.client || !this.suiteId)
+    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;
-        const timestamp = new Date().toLocaleString();
-        const runName = this.runName ?? `Automated Test Run - ${timestamp}`;
-        const runDescription = `Playwright test run executed on ${timestamp}`;
-        try {
-            const run = await this.client.createTestRun(this.suiteId, runName, runDescription);
-            this.runId = run.id;
         }
-        catch (error) {
-            console.error('Failed to create TestRail test run. Disabling reporter.');
-            this.enabled = false;
+        // 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;
         }
-    }
-    async onTestEnd(test, result) {
-        if (!this.enabled || !this.client || !this.runId)
+        const junitPath = junitReporter.outputFile || junitReporter._outputFile;
+        if (!junitPath) {
+            console.error('Error: Could not determine the output file path for the JUnit reporter.');
             return;
-        const caseId = this.getCaseId(test);
-        if (caseId) {
-            const comment = result.status === 'failed' || result.status === 'timedOut'
-                ? `Test failed with error: ${result.error?.message}`
-                : `Test completed with status: ${result.status}`;
-            try {
-                await this.client.addResultForCase(this.runId, caseId, result.status, comment);
-                console.log(`Successfully reported result for Case C${caseId} to TestRail.`);
-            }
-            catch (error) {
-                console.error(`Failed to report result for Case C${caseId}.`);
-            }
         }
-    }
-    getCaseId(test) {
-        const caseIdRegex = /C(\d+)/;
-        // Check tags first
-        for (const tag of test.tags) {
-            const match = tag.match(caseIdRegex);
-            if (match) {
-                return parseInt(match[1], 10);
-            }
+        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.');
         }
-        // Fallback to title
-        const titleMatch = test.title.match(caseIdRegex);
-        if (titleMatch) {
-            return parseInt(titleMatch[1], 10);
+        catch (error) {
+            console.error('Failed to upload results to TestRail:', error);
         }
-        return null;
+    }
+    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/transit-core-taf/utils/testrail/client.d.ts

@@ -5,6 +5,14 @@ export interface TestRailClientOptions {
     token?: string;
     password?: string;
 }
+export interface TestRailResult {
+    status_id: number;
+    comment?: string;
+    version?: string;
+    elapsed?: string;
+    defects?: string;
+    assignedto_id?: number;
+}
 export declare class TestRailClient {
     private host;
     private user;
@@ -15,4 +23,5 @@ export declare class TestRailClient {
     private apiPost;
     createTestRun(suiteId: number, name: string, description: string): Promise<any>;
     loadJunitReport(runId: number, xmlContent: string): Promise<any>;
+    addResultForCase(runId: number, caseId: number, result: TestRailResult): Promise<any>;
 }

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

@@ -71,5 +71,18 @@ class TestRailClient {
         console.log(`Successfully uploaded JUnit report to TestRail.`);
         return result;
     }
+    async addResultForCase(runId, caseId, result) {
+        const endpoint = `add_result_for_case/${runId}/${caseId}`;
+        console.log(`Adding result for Case ID: ${caseId} in Test Run ID: ${runId}`);
+        try {
+            const response = await this.apiPost(endpoint, result);
+            console.log(`Successfully added result for Case ID: ${caseId}.`);
+            return response;
+        }
+        catch (error) {
+            console.error(`Failed to add result for Case ID: ${caseId}.`, error);
+            throw error;
+        }
+    }
 }
 exports.TestRailClient = TestRailClient;

package/package.json

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