ortoni-report 4.0.0 → 4.0.1-beta.0

package/dist/ortoni-report.d.cts

@@ -0,0 +1,111 @@
+import { Reporter, FullConfig, Suite, TestCase, TestResult, TestError, FullResult } from '@playwright/test/reporter';
+
+/**
+ * Configuration options for OrtoniReport.
+ */
+interface OrtoniReportConfig {
+    /**
+     * Open the report in local host (Trace viewer is accessible only in localhost)
+     * @example "always"| "never"| "on-failure";
+     * @default "never"
+     */
+    open?: "always" | "never" | "on-failure";
+    /**
+     * The title of the HTML report.
+     * @example "Ortoni Playwright Test Report"
+     */
+    title?: string;
+    /**
+     * Add project on the list of the tests? (Filtering projects still works if hidden)
+     * @example true to display, false to hide.
+     * @default false
+     */
+    showProject?: boolean;
+    /**
+     * The name of the project.
+     * @example "Ortoni Project"
+     */
+    projectName?: string;
+    /**
+     * The name of the author.
+     * @example "Koushik Chatterjee"
+     */
+    authorName?: string;
+    /**
+     * The type of tests being run.
+     * @example "Regression"
+     */
+    testType?: string;
+    /**
+     * If true, images will be encoded in base64.
+     * Not recommended to use if many screenshots are present.
+     * @default false
+     * @example true
+     */
+    base64Image?: boolean;
+    /**
+     * The local relative of the logo image.
+     * Recommended to keep within the report genrated folder.
+     * @default "ortoni-report/logo.png"
+     * @example "logo.png"
+     */
+    logo?: string;
+    /**
+     * The filename to the html report.
+     * @example "index.html"
+     * @default "ortoni-report.html"
+     */
+    filename?: string;
+    /**
+     * The folder name.
+     * @example "report"
+     * @default "ortoni-report"
+     */
+    folderPath?: string;
+    /**
+     * Port to connect
+     * @example 3600
+     */
+    port?: number;
+    /**
+     * Display console logs?
+     * @example boolean
+     * @default true
+     */
+    stdIO?: boolean;
+    /**
+     * Metadata for the report. ['Test Cycle': 'Cycle 1', 'Test Environment':'QA', etc]
+     * @example { "key": "value" } as string
+     */
+    meta?: Record<string, string>;
+}
+
+declare class OrtoniReport implements Reporter {
+    private ortoniConfig;
+    private testResultProcessor;
+    private htmlGenerator;
+    private fileManager;
+    private serverManager;
+    private results;
+    private projectSet;
+    private overAllStatus;
+    private folderPath;
+    private outputFilename;
+    private outputPath;
+    private dbManager;
+    private shouldGenerateReport;
+    private showConsoleLogs;
+    private skipTraceViewer;
+    private config;
+    constructor(ortoniConfig?: OrtoniReportConfig);
+    private reportsCount;
+    onBegin(config: FullConfig, _suite: Suite): Promise<void>;
+    onStdOut(chunk: string | Buffer, _test: void | TestCase, _result: void | TestResult): void;
+    onTestEnd(test: TestCase, result: TestResult): void;
+    printsToStdio(): boolean;
+    onError(error: TestError): void;
+    onEnd(result: FullResult): Promise<void>;
+    onExit(): Promise<void>;
+}
+
+export { OrtoniReport, type OrtoniReportConfig, OrtoniReport as default };

package/dist/ortoni-report.d.mts

@@ -96,6 +96,7 @@ declare class OrtoniReport implements Reporter {
     private shouldGenerateReport;
     private showConsoleLogs;
     private skipTraceViewer;
+    private shardConfig;
     constructor(ortoniConfig?: OrtoniReportConfig);
     private reportsCount;
     onBegin(config: FullConfig, _suite: Suite): Promise<void>;

package/dist/ortoni-report.d.ts

@@ -96,6 +96,7 @@ declare class OrtoniReport implements Reporter {
     private shouldGenerateReport;
     private showConsoleLogs;
     private skipTraceViewer;
+    private shardConfig;
     constructor(ortoniConfig?: OrtoniReportConfig);
     private reportsCount;
     onBegin(config: FullConfig, _suite: Suite): Promise<void>;

package/dist/ortoni-report.js

@@ -55,14 +55,20 @@ var FileManager = class {
     }
   }
   writeReportFile(filename, data) {
-    const templatePath = import_path.default.resolve(__dirname, "index.html");
+    const templatePath = import_path.default.join(__dirname, "..", "index.html");
     let html = import_fs.default.readFileSync(templatePath, "utf-8");
     const reportJSON = JSON.stringify({
       data
     });
     html = html.replace("__ORTONI_TEST_REPORTDATA__", reportJSON);
+    import_fs.default.writeFileSync(filename, html);
+    return filename;
+  }
+  writeRawFile(filename, data) {
     const outputPath = import_path.default.join(process.cwd(), this.folderPath, filename);
-    import_fs.default.writeFileSync(outputPath, html);
+    import_fs.default.mkdirSync(import_path.default.dirname(outputPath), { recursive: true });
+    const content = typeof data === "string" ? data : JSON.stringify(data, null, 2);
+    import_fs.default.writeFileSync(outputPath, content, "utf-8");
     return outputPath;
   }
   copyTraceViewerAssets(skip) {
@@ -209,13 +215,11 @@ var HTMLGenerator = class {
         meta: this.ortoniConfig.meta
       },
       preferences: {
-        theme: this.ortoniConfig.preferredTheme,
         logo: this.ortoniConfig.logo || void 0,
         showProject: this.ortoniConfig.showProject || false
       },
       analytics: {
         reportData: await this.getReportData()
-        // chartTrendData: await this.chartTrendData(),
       }
     };
   }
@@ -1647,7 +1651,7 @@ function startReportServer(reportFolder, reportFilename, port = 2004, open2) {
     try {
       res.sendFile(import_path5.default.resolve(reportFolder, reportFilename));
     } catch (error) {
-      console.error("Ortoni-Report: Error sending report file:", error);
+      console.error("Ortoni Report: Error sending report file:", error);
       res.status(500).send("Error loading report");
     }
   });
@@ -1661,21 +1665,21 @@ Press Ctrl+C to stop.`
         try {
           openBrowser(`http://localhost:${port}`);
         } catch (error) {
-          console.error("Ortoni-Report: Error opening browser:", error);
+          console.error("Ortoni Report: Error opening browser:", error);
         }
       }
     });
     server.on("error", (error) => {
       if (error.code === "EADDRINUSE") {
         console.error(
-          `Ortoni-Report: Port ${port} is already in use. Trying a different port...`
+          `Ortoni Report: Port ${port} is already in use. Trying a different port...`
         );
       } else {
-        console.error("Ortoni-Report: Server error:", error);
+        console.error("Ortoni Report: Server error:", error);
       }
     });
   } catch (error) {
-    console.error("Ortoni-Report: Error starting the server:", error);
+    console.error("Ortoni Report: Error starting the server:", error);
   }
 }
 function openBrowser(url) {
@@ -1693,7 +1697,7 @@ function openBrowser(url) {
       (0, import_child_process.spawn)(command, [url]);
     }
   } catch (error) {
-    console.error("Ortoni-Report: Error opening the browser:", error);
+    console.error("Ortoni Report: Error opening the browser:", error);
   }
 }
 
@@ -2024,6 +2028,7 @@ var OrtoniReport = class {
     await this.dbManager.initialize(
       import_path6.default.join(this.folderPath, "ortoni-data-history.sqlite")
     );
+    this.shardConfig = config?.shard;
   }
   onStdOut(chunk, _test, _result) {
     if (this.reportsCount == 1 && this.showConsoleLogs) {
@@ -2040,7 +2045,7 @@ var OrtoniReport = class {
       );
       this.results.push(testResult);
     } catch (error) {
-      console.error("OrtoniReport: Error processing test end:", error);
+      console.error("Ortoni Report: Error processing test end:", error);
     }
   }
   printsToStdio() {
@@ -2059,6 +2064,28 @@ var OrtoniReport = class {
           (r) => r.status !== "skipped"
         );
         const totalDuration = result.duration;
+        if (this.shardConfig && this.shardConfig.total > 1) {
+          const shard = this.shardConfig;
+          const shardFile = `ortoni-shard-${shard.current}-of-${shard.total}.json`;
+          const shardData = {
+            status: result.status,
+            duration: totalDuration,
+            results: this.results,
+            projectSet: Array.from(this.projectSet),
+            userConfig: {
+              projectName: this.ortoniConfig.projectName,
+              authorName: this.ortoniConfig.authorName,
+              type: this.ortoniConfig.testType,
+              title: this.ortoniConfig.title
+            },
+            userMeta: {
+              meta: this.ortoniConfig.meta
+            }
+          };
+          this.fileManager.writeRawFile(shardFile, shardData);
+          this.shouldGenerateReport = false;
+          return;
+        }
         const runId = await this.dbManager.saveTestRun();
         if (runId !== null) {
           await this.dbManager.saveTestResults(runId, this.results);
@@ -2073,16 +2100,16 @@ var OrtoniReport = class {
             finalReportData
           );
         } else {
-          console.error("OrtoniReport: Error saving test run to database");
+          console.error("Ortoni Report: Error saving test run to database");
         }
       } else {
         console.error(
-          "OrtoniReport: Report generation skipped due to error in Playwright worker!"
+          "Ortoni Report: Report generation skipped due to error in Playwright worker!"
         );
       }
     } catch (error) {
       this.shouldGenerateReport = false;
-      console.error("OrtoniReport: Error generating report:", error);
+      console.error("Ortoni Report: Error generating report:", error);
     }
   }
   async onExit() {
@@ -2090,7 +2117,7 @@ var OrtoniReport = class {
       await this.dbManager.close();
       if (this.shouldGenerateReport) {
         this.fileManager.copyTraceViewerAssets(this.skipTraceViewer);
-        console.info(`Ortoni HTML report generated at ${this.outputPath}`);
+        console.info(`Ortoni Report generated at ${this.outputPath}`);
         this.serverManager.startServer(
           this.folderPath,
           this.outputFilename,
@@ -2100,7 +2127,7 @@ var OrtoniReport = class {
         });
       }
     } catch (error) {
-      console.error("OrtoniReport: Error in onExit:", error);
+      console.error("Ortoni Report: Error in onExit:", error);
     }
   }
 };