@sentinelqa/playwright 0.1.1 → 0.1.5

package/README.md

@@ -16,6 +16,12 @@ import { withSentinel } from "@sentinelqa/playwright";
 
 export default withSentinel(
   defineConfig({
+    reporter: [
+      ["line"],
+      ["json", { outputFile: "test-results/report.json" }],
+      ["html", { outputFolder: "playwright-report", open: "never" }]
+    ],
+    outputDir: "test-results",
     use: {
       trace: "retain-on-failure",
       screenshot: "only-on-failure",
@@ -48,9 +54,10 @@ npx playwright test
 
 ## What it does
 
-- Ensures a Playwright JSON report is written
-- Ensures the Playwright HTML report is written
-- Uploads `playwright-report/` and `test-results/` to Sentinel after the run
+- Preserves existing Playwright JSON and HTML report paths if you already configured them
+- Injects JSON and HTML reporters only when they are missing
+- Uses your configured `outputDir` for test results when present
+- Uploads the detected report and test result paths to Sentinel after the run
 - Preserves the same Sentinel link output as the uploader CLI
 
 ## Notes

package/dist/env.d.ts

@@ -0,0 +1 @@
+export declare const loadSentinelEnv: () => void;

package/dist/env.js

@@ -0,0 +1,45 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.loadSentinelEnv = void 0;
+const fs_1 = __importDefault(require("fs"));
+const path_1 = __importDefault(require("path"));
+const parseLine = (line) => {
+    const trimmed = line.trim();
+    if (!trimmed || trimmed.startsWith("#"))
+        return null;
+    const eqIndex = trimmed.indexOf("=");
+    if (eqIndex === -1)
+        return null;
+    const key = trimmed.slice(0, eqIndex).trim();
+    if (!key)
+        return null;
+    let value = trimmed.slice(eqIndex + 1).trim();
+    if ((value.startsWith('"') && value.endsWith('"')) ||
+        (value.startsWith("'") && value.endsWith("'"))) {
+        value = value.slice(1, -1);
+    }
+    return { key, value };
+};
+const loadSentinelEnv = () => {
+    const candidates = [".env", ".env.local"];
+    for (const candidate of candidates) {
+        const fullPath = path_1.default.resolve(process.cwd(), candidate);
+        if (!fs_1.default.existsSync(fullPath))
+            continue;
+        if (!fs_1.default.statSync(fullPath).isFile())
+            continue;
+        const raw = fs_1.default.readFileSync(fullPath, "utf8");
+        for (const line of raw.split(/\r?\n/)) {
+            const parsed = parseLine(line);
+            if (!parsed)
+                continue;
+            if (typeof process.env[parsed.key] === "undefined") {
+                process.env[parsed.key] = parsed.value;
+            }
+        }
+    }
+};
+exports.loadSentinelEnv = loadSentinelEnv;

package/dist/index.d.ts

@@ -10,12 +10,20 @@ type PlaywrightConfig = {
     use?: PlaywrightUseOptions;
     [key: string]: unknown;
 };
+export type SentinelResolvedPaths = {
+    playwrightJsonPath: string;
+    playwrightReportDir: string;
+    testResultsDir: string;
+    artifactDirs: string[];
+};
 export type SentinelPlaywrightOptions = {
     project?: string;
     playwrightJsonPath?: string;
     playwrightReportDir?: string;
     testResultsDir?: string;
     artifactDirs?: string[];
+    verbose?: boolean;
 };
 export declare function withSentinel(config: PlaywrightConfig, options?: SentinelPlaywrightOptions): PlaywrightConfig;
+export declare function resolveSentinelPaths(config: PlaywrightConfig, options?: SentinelPlaywrightOptions): SentinelResolvedPaths;
 export {};

package/dist/index.js

@@ -4,6 +4,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.withSentinel = withSentinel;
+exports.resolveSentinelPaths = resolveSentinelPaths;
 const path_1 = __importDefault(require("path"));
 const DEFAULT_REPORT_DIR = "playwright-report";
 const DEFAULT_TEST_RESULTS_DIR = "test-results";
@@ -33,6 +34,14 @@ const normalizeReporter = (reporter) => {
 const getReporterName = (entry) => {
     return Array.isArray(entry) ? entry[0] : entry;
 };
+const getReporterOptions = (entry) => {
+    if (!entry || !Array.isArray(entry))
+        return {};
+    return entry[1] || {};
+};
+const normalizePath = (value) => {
+    return value.replace(/\\/g, "/");
+};
 const setReporterOptions = (reporters, name, options) => {
     const index = reporters.findIndex((entry) => getReporterName(entry) === name);
     if (index === -1) {
@@ -56,11 +65,24 @@ function withSentinel(config, options = {}) {
             video: config.use?.video || "retain-on-failure"
         }
     };
+    const reporters = normalizeReporter(config.reporter);
+    const existingJsonReporter = reporters.find((entry) => getReporterName(entry) === "json");
+    const existingHtmlReporter = reporters.find((entry) => getReporterName(entry) === "html");
+    const existingJsonOutputFile = getReporterOptions(existingJsonReporter).outputFile;
+    const existingHtmlOutputFolder = getReporterOptions(existingHtmlReporter).outputFolder;
     const testResultsDir = options.testResultsDir || config.outputDir || DEFAULT_TEST_RESULTS_DIR;
-    const playwrightReportDir = options.playwrightReportDir || DEFAULT_REPORT_DIR;
-    const playwrightJsonPath = options.playwrightJsonPath || path_1.default.join(playwrightReportDir, "report.json");
+    const playwrightReportDir = options.playwrightReportDir ||
+        (typeof existingHtmlOutputFolder === "string"
+            ? existingHtmlOutputFolder
+            : DEFAULT_REPORT_DIR);
+    const playwrightJsonPath = options.playwrightJsonPath ||
+        (typeof existingJsonOutputFile === "string"
+            ? existingJsonOutputFile
+            : path_1.default.join(playwrightReportDir, "report.json"));
+    const artifactDirs = Array.from(new Set((options.artifactDirs || [])
+        .filter(Boolean)
+        .map((entry) => normalizePath(entry))));
     nextConfig.outputDir = testResultsDir;
-    const reporters = normalizeReporter(config.reporter);
     setReporterOptions(reporters, "json", { outputFile: playwrightJsonPath });
     setReporterOptions(reporters, "html", {
         outputFolder: playwrightReportDir,
@@ -72,7 +94,8 @@ function withSentinel(config, options = {}) {
         playwrightJsonPath,
         playwrightReportDir,
         testResultsDir,
-        artifactDirs: options.artifactDirs || []
+        artifactDirs,
+        verbose: options.verbose ?? true
     };
     const sentinelIndex = reporters.findIndex((entry) => getReporterName(entry) === sentinelReporterPath);
     if (sentinelIndex !== -1) {
@@ -82,3 +105,28 @@ function withSentinel(config, options = {}) {
     nextConfig.reporter = reporters;
     return nextConfig;
 }
+function resolveSentinelPaths(config, options = {}) {
+    const reporters = normalizeReporter(config.reporter);
+    const existingJsonReporter = reporters.find((entry) => getReporterName(entry) === "json");
+    const existingHtmlReporter = reporters.find((entry) => getReporterName(entry) === "html");
+    const existingJsonOutputFile = getReporterOptions(existingJsonReporter).outputFile;
+    const existingHtmlOutputFolder = getReporterOptions(existingHtmlReporter).outputFolder;
+    const testResultsDir = options.testResultsDir || config.outputDir || DEFAULT_TEST_RESULTS_DIR;
+    const playwrightReportDir = options.playwrightReportDir ||
+        (typeof existingHtmlOutputFolder === "string"
+            ? existingHtmlOutputFolder
+            : DEFAULT_REPORT_DIR);
+    const playwrightJsonPath = options.playwrightJsonPath ||
+        (typeof existingJsonOutputFile === "string"
+            ? existingJsonOutputFile
+            : path_1.default.join(playwrightReportDir, "report.json"));
+    const artifactDirs = Array.from(new Set((options.artifactDirs || [])
+        .filter(Boolean)
+        .map((entry) => normalizePath(entry))));
+    return {
+        playwrightJsonPath: normalizePath(playwrightJsonPath),
+        playwrightReportDir: normalizePath(playwrightReportDir),
+        testResultsDir: normalizePath(testResultsDir),
+        artifactDirs
+    };
+}

package/dist/reporter.d.ts

@@ -4,6 +4,7 @@ type ReporterOptions = {
     playwrightReportDir: string;
     testResultsDir: string;
     artifactDirs?: string[];
+    verbose?: boolean;
 };
 declare class SentinelReporter {
     private failedCount;

package/dist/reporter.js

@@ -1,5 +1,6 @@
 "use strict";
 const node_1 = require("@sentinelqa/uploader/node");
+const env_1 = require("./env");
 const pluralize = (count, singular, plural) => {
     return count === 1 ? singular : plural;
 };
@@ -7,6 +8,7 @@ class SentinelReporter {
     constructor(options) {
         this.failedCount = 0;
         this.totalCount = 0;
+        (0, env_1.loadSentinelEnv)();
         this.options = options;
     }
     onBegin(config, suite) {
@@ -14,6 +16,16 @@ class SentinelReporter {
         if (config?.projects?.length && !this.options.project) {
             this.options.project = config.projects[0]?.name || null;
         }
+        if (this.options.verbose !== false) {
+            console.log("Sentinel detected Playwright artifact paths:");
+            console.log(`- JSON report: ${this.options.playwrightJsonPath}`);
+            console.log(`- HTML report: ${this.options.playwrightReportDir}`);
+            console.log(`- Test results: ${this.options.testResultsDir}`);
+            for (const dir of this.options.artifactDirs || []) {
+                console.log(`- Extra artifacts: ${dir}`);
+            }
+            console.log("");
+        }
     }
     onTestEnd(_test, result) {
         if (!result)
@@ -26,6 +38,8 @@ class SentinelReporter {
         console.log("Playwright run finished");
         console.log(`${this.failedCount} ${pluralize(this.failedCount, "test", "tests")} failed`);
         if (!process.env.SENTINEL_TOKEN) {
+            console.log("");
+            console.log("Sentinel upload disabled. Set SENTINEL_TOKEN to enable uploads.");
             return;
         }
         const hasCiEnv = (0, node_1.hasSupportedCiEnv)(process.env);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sentinelqa/playwright",
-  "version": "0.1.1",
+  "version": "0.1.5",
   "private": false,
   "description": "Playwright config wrapper and reporter for SentinelQA",
   "license": "MIT",