ortoni-report 1.1.5 → 1.1.6

package/dist/ortoni-report.d.ts

@@ -1,13 +1,22 @@
-import { TestStep, Reporter, FullConfig, Suite, TestCase, TestResult, FullResult } from '@playwright/test/reporter';
-
+import { Reporter, FullConfig, Suite, TestCase, TestResult, FullResult } from '@playwright/test/reporter';
+
 interface OrtoniReportConfig {
     projectName?: string;
     authorName?: string;
     testType?: string;
     preferredTheme?: 'light' | 'dark';
-}
-
+    base64Image?: boolean;
+}
+
+interface Steps {
+    snippet: string | undefined;
+    title: string;
+    location: string;
+}
 interface TestResultData {
+    suiteTags: string[];
+    testTags: string[];
+    location: string;
     retry: string;
     isRetry: number;
     projectName: any;
@@ -17,14 +26,18 @@ interface TestResultData {
     flaky: string;
     duration: string;
     errors: any[];
-    steps: TestStep[];
+    steps: Steps[];
     logs: string;
-    screenshotPath: string | null;
-    filePath: any;
+    screenshotPath?: string | null | undefined;
+    filePath: string;
     projects: Set<string>;
-}
-
+    tracePath?: string;
+    videoPath?: string;
+    base64Image: boolean | undefined;
+}
+
 declare class OrtoniReport implements Reporter {
+    private projectRoot;
     private results;
     private groupedResults;
     private suiteName;
@@ -33,9 +46,10 @@ declare class OrtoniReport implements Reporter {
     onBegin(config: FullConfig, suite: Suite): void;
     onTestBegin(test: TestCase, result: TestResult): void;
     private projectSet;
+    private tagsSet;
     onTestEnd(test: TestCase, result: TestResult): void;
     onEnd(result: FullResult): void;
     generateHTML(filteredResults: TestResultData[], totalDuration: string): string;
-}
-
-export { OrtoniReportConfig, OrtoniReport as default };
+}
+
+export { OrtoniReportConfig, OrtoniReport as default };

package/dist/ortoni-report.js

@@ -1,216 +1,242 @@
-"use strict";
-var __create = Object.create;
-var __defProp = Object.defineProperty;
-var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
-var __getOwnPropNames = Object.getOwnPropertyNames;
-var __getProtoOf = Object.getPrototypeOf;
-var __hasOwnProp = Object.prototype.hasOwnProperty;
-var __export = (target, all) => {
-  for (var name in all)
-    __defProp(target, name, { get: all[name], enumerable: true });
-};
-var __copyProps = (to, from, except, desc) => {
-  if (from && typeof from === "object" || typeof from === "function") {
-    for (let key of __getOwnPropNames(from))
-      if (!__hasOwnProp.call(to, key) && key !== except)
-        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
-  }
-  return to;
-};
-var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
-  // If the importer is in node compatibility mode or this is not an ESM
-  // file that has been converted to a CommonJS file using a Babel-
-  // compatible transform (i.e. "__esModule" has not been set), then set
-  // "default" to the CommonJS "module.exports" for node compatibility.
-  isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
-  mod
-));
-var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
-
-// src/ortoni-report.ts
-var ortoni_report_exports = {};
-__export(ortoni_report_exports, {
-  default: () => OrtoniReport
-});
-module.exports = __toCommonJS(ortoni_report_exports);
-var import_fs = __toESM(require("fs"));
-var import_path2 = __toESM(require("path"));
-var import_handlebars = __toESM(require("handlebars"));
-var import_safe = __toESM(require("colors/safe"));
-
-// src/utils/utils.ts
-var import_path = __toESM(require("path"));
-function msToTime(duration) {
-  const milliseconds = Math.floor(duration % 1e3);
-  const seconds = Math.floor(duration / 1e3 % 60);
-  const minutes = Math.floor(duration / (1e3 * 60) % 60);
-  const hours = Math.floor(duration / (1e3 * 60 * 60) % 24);
-  let result = "";
-  if (hours > 0) {
-    result += `${hours}h:`;
-  }
-  if (minutes > 0 || hours > 0) {
-    result += `${minutes < 10 ? "0" + minutes : minutes}m:`;
-  }
-  if (seconds > 0 || minutes > 0 || hours > 0) {
-    result += `${seconds < 10 ? "0" + seconds : seconds}s`;
-  }
-  if (milliseconds > 0 && !(seconds > 0 || minutes > 0 || hours > 0)) {
-    result += `${milliseconds}ms`;
-  } else if (milliseconds > 0) {
-    result += `:${milliseconds < 100 ? "0" + milliseconds : milliseconds}ms`;
-  }
-  return result;
-}
-function normalizeFilePath(filePath) {
-  const normalizedPath = import_path.default.normalize(filePath);
-  return import_path.default.basename(normalizedPath);
-}
-function formatDate(date) {
-  const day = String(date.getDate()).padStart(2, "0");
-  const month = date.toLocaleString("default", { month: "short" });
-  const year = date.getFullYear();
-  const time = date.toLocaleTimeString();
-  return `${day}-${month}-${year} ${time}`;
-}
-
-// src/ortoni-report.ts
-var OrtoniReport = class {
-  constructor(config = {}) {
-    this.results = [];
-    this.projectSet = /* @__PURE__ */ new Set();
-    this.config = config;
-  }
-  onBegin(config, suite) {
-    this.results = [];
-  }
-  onTestBegin(test, result) {
-  }
-  onTestEnd(test, result) {
-    let status = result.status;
-    if (test.outcome() === "flaky") {
-      status = "flaky";
-    }
-    this.projectSet.add(test.titlePath()[1]);
-    const testResult = {
-      retry: result.retry > 0 ? "retry" : "",
-      isRetry: result.retry,
-      projectName: test.titlePath()[1],
-      suite: test.titlePath()[3],
-      title: test.title,
-      status,
-      flaky: test.outcome(),
-      duration: msToTime(result.duration),
-      errors: result.errors.map((e) => import_safe.default.strip(e.message || e.toString())),
-      steps: result.steps.map((step) => ({
-        titlePath: step.titlePath,
-        category: step.category,
-        duration: step.duration,
-        error: step.error,
-        location: step.location,
-        parent: step.parent,
-        startTime: step.startTime,
-        steps: step.steps,
-        title: step.title
-      })),
-      logs: import_safe.default.strip(result.stdout.concat(result.stderr).map((log) => log).join("\n")),
-      screenshotPath: null,
-      filePath: normalizeFilePath(test.titlePath()[2]),
-      projects: this.projectSet
-    };
-    if (result.attachments) {
-      const screenshot = result.attachments.find((attachment) => attachment.name === "screenshot");
-      if (screenshot && screenshot.path) {
-        const screenshotContent = import_fs.default.readFileSync(screenshot.path, "base64");
-        testResult.screenshotPath = screenshotContent;
-      }
-    }
-    this.results.push(testResult);
-  }
-  onEnd(result) {
-    const filteredResults = this.results.filter((r) => r.status !== "skipped" && !r.isRetry);
-    const totalDuration = msToTime(result.duration);
-    this.groupedResults = this.results.reduce((acc, result2, index) => {
-      const filePath = result2.filePath;
-      const suiteName = result2.suite;
-      const projectName = result2.projectName;
-      if (!acc[filePath]) {
-        acc[filePath] = {};
-      }
-      if (!acc[filePath][suiteName]) {
-        acc[filePath][suiteName] = {};
-      }
-      if (!acc[filePath][suiteName][projectName]) {
-        acc[filePath][suiteName][projectName] = [];
-      }
-      acc[filePath][suiteName][projectName].push({ ...result2, index });
-      return acc;
-    }, {});
-    import_handlebars.default.registerHelper("json", function(context) {
-      return safeStringify(context);
-    });
-    import_handlebars.default.registerHelper("eq", function(actualStatus, expectedStatus) {
-      return actualStatus === expectedStatus;
-    });
-    import_handlebars.default.registerHelper("or", () => {
-      var args = Array.prototype.slice.call(arguments);
-      var options = args.pop();
-      for (var i = 0; i < args.length; i++) {
-        if (args[i]) {
-          return options.fn(this);
-        }
-      }
-      return options.inverse(this);
-    });
-    import_handlebars.default.registerHelper("gt", function(a, b) {
-      return a > b;
-    });
-    const html = this.generateHTML(filteredResults, totalDuration);
-    const outputPath = import_path2.default.resolve(process.cwd(), "ortoni-report.html");
-    import_fs.default.writeFileSync(outputPath, html);
-    console.log(`Ortoni HTML report generated at ${outputPath}`);
-  }
-  generateHTML(filteredResults, totalDuration) {
-    const totalTests = filteredResults.length;
-    const passedTests = this.results.filter((r) => r.status === "passed").length;
-    const flakyTests = this.results.filter((r) => r.flaky === "flaky").length;
-    const failed = filteredResults.filter((r) => r.status === "failed" || r.status === "timedOut").length;
-    const successRate = ((passedTests + flakyTests) / totalTests * 100).toFixed(2);
-    const templateSource = import_fs.default.readFileSync(import_path2.default.resolve(__dirname, "report-template.hbs"), "utf-8");
-    const template = import_handlebars.default.compile(templateSource);
-    const data = {
-      totalDuration,
-      suiteName: this.suiteName,
-      results: this.results,
-      retryCount: this.results.filter((r) => r.isRetry).length,
-      passCount: passedTests,
-      failCount: failed,
-      skipCount: this.results.filter((r) => r.status === "skipped").length,
-      flakyCount: flakyTests,
-      totalCount: filteredResults.length,
-      groupedResults: this.groupedResults,
-      projectName: this.config.projectName,
-      authorName: this.config.authorName,
-      testType: this.config.testType,
-      preferredTheme: this.config.preferredTheme,
-      successRate,
-      lastRunDate: formatDate(/* @__PURE__ */ new Date()),
-      projects: this.projectSet
-    };
-    return template(data);
-  }
-};
-function safeStringify(obj, indent = 2) {
-  const cache = /* @__PURE__ */ new Set();
-  const json = JSON.stringify(obj, (key, value) => {
-    if (typeof value === "object" && value !== null) {
-      if (cache.has(value)) {
-        return;
-      }
-      cache.add(value);
-    }
-    return value;
-  }, indent);
-  cache.clear();
-  return json;
-}
+"use strict";
+var __create = Object.create;
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getProtoOf = Object.getPrototypeOf;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
+  // If the importer is in node compatibility mode or this is not an ESM
+  // file that has been converted to a CommonJS file using a Babel-
+  // compatible transform (i.e. "__esModule" has not been set), then set
+  // "default" to the CommonJS "module.exports" for node compatibility.
+  isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
+  mod
+));
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/ortoni-report.ts
+var ortoni_report_exports = {};
+__export(ortoni_report_exports, {
+  default: () => OrtoniReport
+});
+module.exports = __toCommonJS(ortoni_report_exports);
+var import_fs = __toESM(require("fs"));
+var import_path2 = __toESM(require("path"));
+var import_handlebars = __toESM(require("handlebars"));
+var import_safe = __toESM(require("colors/safe"));
+
+// src/utils/utils.ts
+var import_path = __toESM(require("path"));
+function msToTime(duration) {
+  const milliseconds = Math.floor(duration % 1e3);
+  const seconds = Math.floor(duration / 1e3 % 60);
+  const minutes = Math.floor(duration / (1e3 * 60) % 60);
+  const hours = Math.floor(duration / (1e3 * 60 * 60) % 24);
+  let result = "";
+  if (hours > 0) {
+    result += `${hours}h:`;
+  }
+  if (minutes > 0 || hours > 0) {
+    result += `${minutes < 10 ? "0" + minutes : minutes}m:`;
+  }
+  if (seconds > 0 || minutes > 0 || hours > 0) {
+    result += `${seconds < 10 ? "0" + seconds : seconds}s`;
+  }
+  if (milliseconds > 0 && !(seconds > 0 || minutes > 0 || hours > 0)) {
+    result += `${milliseconds}ms`;
+  } else if (milliseconds > 0) {
+    result += `:${milliseconds < 100 ? "0" + milliseconds : milliseconds}ms`;
+  }
+  return result;
+}
+function normalizeFilePath(filePath) {
+  const normalizedPath = import_path.default.normalize(filePath);
+  return import_path.default.basename(normalizedPath);
+}
+function formatDate(date) {
+  const day = String(date.getDate()).padStart(2, "0");
+  const month = date.toLocaleString("default", { month: "short" });
+  const year = date.getFullYear();
+  const time = date.toLocaleTimeString();
+  return `${day}-${month}-${year} ${time}`;
+}
+
+// src/ortoni-report.ts
+var OrtoniReport = class {
+  constructor(config = {}) {
+    this.projectRoot = "";
+    this.results = [];
+    this.projectSet = /* @__PURE__ */ new Set();
+    // TODO: add tags to the filter dropdown
+    this.tagsSet = /* @__PURE__ */ new Set();
+    this.config = config;
+  }
+  onBegin(config, suite) {
+    this.results = [];
+    this.projectRoot = config.rootDir;
+  }
+  onTestBegin(test, result) {
+  }
+  onTestEnd(test, result) {
+    let status = result.status;
+    if (test.outcome() === "flaky") {
+      status = "flaky";
+    }
+    const projectName = test.titlePath()[1];
+    this.projectSet.add(projectName);
+    const location = test.location;
+    const filePath = normalizeFilePath(test.titlePath()[2]);
+    const tagPattern = /@[\w]+/g;
+    const testTags = test.title.match(tagPattern) || [];
+    const title = test.title.replace(tagPattern, "").trim();
+    const suiteTags = test.titlePath()[3].match(tagPattern) || [];
+    const suite = test.titlePath()[3].replace(tagPattern, "").trim();
+    const testResult = {
+      suiteTags,
+      testTags,
+      location: `${filePath}:${location.line}:${location.column}`,
+      retry: result.retry > 0 ? "retry" : "",
+      isRetry: result.retry,
+      projectName,
+      suite,
+      title,
+      status,
+      flaky: test.outcome(),
+      duration: msToTime(result.duration),
+      errors: result.errors.map((e) => import_safe.default.strip(e.message || e.toString())),
+      steps: result.steps.map((step) => {
+        const location2 = step.location ? `${import_path2.default.relative(this.projectRoot, step.location.file)}:${step.location.line}:${step.location.column}` : "";
+        return {
+          snippet: import_safe.default.strip(step.error?.snippet || ""),
+          title: step.title,
+          location: step.error ? location2 : ""
+        };
+      }),
+      logs: import_safe.default.strip(result.stdout.concat(result.stderr).map((log) => log).join("\n")),
+      filePath,
+      projects: this.projectSet,
+      base64Image: this.config.base64Image
+    };
+    if (result.attachments) {
+      const screenshot = result.attachments.find((attachment) => attachment.name === "screenshot");
+      if (this.config.base64Image) {
+        if (screenshot && screenshot.path) {
+          const screenshotContent = import_fs.default.readFileSync(screenshot.path, "base64");
+          testResult.screenshotPath = `data:image/png;base64,${screenshotContent}`;
+        }
+      } else {
+        if (screenshot && screenshot.path) {
+          testResult.screenshotPath = import_path2.default.resolve(screenshot.path);
+        }
+      }
+      const tracePath = result.attachments.find((attachment) => attachment.name === "trace");
+      if (tracePath?.path) {
+        testResult.tracePath = import_path2.default.resolve(__dirname, tracePath.path);
+      }
+      const videoPath = result.attachments.find((attachment) => attachment.name === "video");
+      if (videoPath?.path) {
+        testResult.videoPath = import_path2.default.resolve(__dirname, videoPath.path);
+      }
+    }
+    this.results.push(testResult);
+  }
+  onEnd(result) {
+    const filteredResults = this.results.filter((r) => r.status !== "skipped" && !r.isRetry);
+    const totalDuration = msToTime(result.duration);
+    this.groupedResults = this.results.reduce((acc, result2, index) => {
+      const filePath = result2.filePath;
+      const suiteName = result2.suite;
+      const projectName = result2.projectName;
+      if (!acc[filePath]) {
+        acc[filePath] = {};
+      }
+      if (!acc[filePath][suiteName]) {
+        acc[filePath][suiteName] = {};
+      }
+      if (!acc[filePath][suiteName][projectName]) {
+        acc[filePath][suiteName][projectName] = [];
+      }
+      acc[filePath][suiteName][projectName].push({ ...result2, index });
+      return acc;
+    }, {});
+    import_handlebars.default.registerHelper("json", function(context) {
+      return safeStringify(context);
+    });
+    import_handlebars.default.registerHelper("eq", function(actualStatus, expectedStatus) {
+      return actualStatus === expectedStatus;
+    });
+    import_handlebars.default.registerHelper("or", () => {
+      var args = Array.prototype.slice.call(arguments);
+      var options = args.pop();
+      for (var i = 0; i < args.length; i++) {
+        if (args[i]) {
+          return options.fn(this);
+        }
+      }
+      return options.inverse(this);
+    });
+    import_handlebars.default.registerHelper("gt", function(a, b) {
+      return a > b;
+    });
+    const html = this.generateHTML(filteredResults, totalDuration);
+    const outputPath = import_path2.default.resolve(process.cwd(), "ortoni-report.html");
+    import_fs.default.writeFileSync(outputPath, html);
+    console.log(`Ortoni HTML report generated at ${outputPath}`);
+  }
+  generateHTML(filteredResults, totalDuration) {
+    const totalTests = filteredResults.length;
+    const passedTests = this.results.filter((r) => r.status === "passed").length;
+    const flakyTests = this.results.filter((r) => r.flaky === "flaky").length;
+    const failed = filteredResults.filter((r) => r.status === "failed" || r.status === "timedOut").length;
+    const successRate = ((passedTests + flakyTests) / totalTests * 100).toFixed(2);
+    const templateSource = import_fs.default.readFileSync(import_path2.default.resolve(__dirname, "report-template.hbs"), "utf-8");
+    const template = import_handlebars.default.compile(templateSource);
+    const data = {
+      totalDuration,
+      suiteName: this.suiteName,
+      results: this.results,
+      retryCount: this.results.filter((r) => r.isRetry).length,
+      passCount: passedTests,
+      failCount: failed,
+      skipCount: this.results.filter((r) => r.status === "skipped").length,
+      flakyCount: flakyTests,
+      totalCount: filteredResults.length,
+      groupedResults: this.groupedResults,
+      projectName: this.config.projectName,
+      authorName: this.config.authorName,
+      testType: this.config.testType,
+      preferredTheme: this.config.preferredTheme,
+      successRate,
+      lastRunDate: formatDate(/* @__PURE__ */ new Date()),
+      projects: this.projectSet
+    };
+    return template(data);
+  }
+};
+function safeStringify(obj, indent = 2) {
+  const cache = /* @__PURE__ */ new Set();
+  const json = JSON.stringify(obj, (key, value) => {
+    if (typeof value === "object" && value !== null) {
+      if (cache.has(value)) {
+        return;
+      }
+      cache.add(value);
+    }
+    return value;
+  }, indent);
+  cache.clear();
+  return json;
+}