artes 1.7.4 → 1.7.6

package/src/helper/controller/screenComparer.js

@@ -1,108 +1,97 @@
-const path = require("path");
-const fs = require("fs");
-require("allure-cucumberjs");
-const allure = require("allure-js-commons");
-const sharp = require("sharp");
-const pixelmatch = require("pixelmatch");
-const { PNG } = require("pngjs");
-const { moduleConfig } = require("artes/src/helper/imports/commons");
-
-async function screenComparer(baselineFilename, screenshotFn, options = {}) {
-  const { maxDiffPercent = 0.01, threshold = 0.1 } = options;
-
-  const baselinePath = path.join(moduleConfig.projectPath, baselineFilename);
-  const actualPath = path.join(
-    moduleConfig.projectPath,
-    "visualComparison",
-    `actual_${baselineFilename}`,
-  );
-  const diffPath = path.join(
-    moduleConfig.projectPath,
-    "visualComparison",
-    `diff_${baselineFilename}`,
-  );
-
-  await screenshotFn(actualPath);
-
-  const baselineMeta = await sharp(baselinePath).metadata();
-  const actualMeta = await sharp(actualPath).metadata();
-
-  // if (baselineMeta.width !== actualMeta.width || baselineMeta.height !== actualMeta.height) {
-  //   console.warn(`⚠️  Dimension mismatch! Baseline: ${baselineMeta.width}x${baselineMeta.height} | Actual: ${actualMeta.width}x${actualMeta.height}`);
-  // }
-
-  const width = actualMeta.width;
-  const height = actualMeta.height;
-
-  const baselineBuffer = await sharp(baselinePath)
-    .resize(width, height, { fit: "fill" })
-    .ensureAlpha()
-    .raw()
-    .toBuffer();
-
-  const actualBuffer = await sharp(actualPath)
-    .resize(width, height, { fit: "fill" })
-    .ensureAlpha()
-    .raw()
-    .toBuffer();
-
-  const diffImg = new PNG({ width, height });
-
-  const mismatchedPixels = pixelmatch(
-    baselineBuffer,
-    actualBuffer,
-    diffImg.data,
-    width,
-    height,
-    { threshold, includeAA: false },
-  );
-
-  fs.writeFileSync(diffPath, PNG.sync.write(diffImg));
-
-  const totalPixels = width * height;
-  const mismatchRatio = mismatchedPixels / totalPixels;
-
-  const expectedBase64 = (
-    await sharp(baselinePath)
-      .resize(width, height, { fit: "fill" })
-      .png()
-      .toBuffer()
-  ).toString("base64");
-  const actualBase64 = (await sharp(actualPath).png().toBuffer()).toString(
-    "base64",
-  );
-  const diffBase64 = (await sharp(diffPath).png().toBuffer()).toString(
-    "base64",
-  );
-
-  const content = JSON.stringify({
-    expected: `data:image/png;base64,${expectedBase64}`,
-    actual: `data:image/png;base64,${actualBase64}`,
-    diff: `data:image/png;base64,${diffBase64}`,
-  });
-
-  await allure.attachment(
-    "Screenshot diff details",
-    ` Mismatched pixels: ${mismatchedPixels} / ${totalPixels} (${(mismatchRatio * 100).toFixed(2)}%) Max allowed: ${maxDiffPercent * 100}%`,
-    "text/plain",
-  );
-  await allure.attachment(
-    "Screenshot diff",
-    content,
-    "application/vnd.allure.image.diff",
-  );
-
-  if (fs.existsSync(path.join(moduleConfig.projectPath, "visualComparison")))
-    fs.rmSync(path.join(moduleConfig.projectPath, "visualComparison"), {
-      recursive: true,
-      force: true,
-    });
-
-  if (mismatchRatio > maxDiffPercent) {
-    throw new Error(
-      `Screenshot mismatch: ${(mismatchRatio * 100).toFixed(2)}% pixels differ (max allowed: ${maxDiffPercent * 100}%)`,
-    );
-  }
-}
-
-module.exports = { screenComparer };
+const path = require("path");
+const fs = require("fs");
+require("allure-cucumberjs");
+const allure = require("allure-js-commons");
+const sharp = require("sharp");
+const pixelmatch = require("pixelmatch");
+const { PNG } = require("pngjs");
+const { moduleConfig } = require("artes/src/helper/imports/commons");
+
+async function screenComparer(baselineFilename, screenshotFn, options = {}) {
+  const { maxDiffPercent = 0.01, threshold = 0.1, comparePath } = options;
+
+  const baselinePath = path.join(moduleConfig.projectPath, baselineFilename);
+
+  const actualPath = comparePath
+    ? path.join(moduleConfig.projectPath, comparePath)
+    : path.join(moduleConfig.projectPath, "visualComparison", `actual_${baselineFilename}`);
+
+  const diffPath = path.join(
+    moduleConfig.projectPath,
+    "visualComparison",
+    `diff_${baselineFilename}`,
+  );
+
+  const visualComparisonDir = path.join(moduleConfig.projectPath, "visualComparison");
+  if (!fs.existsSync(visualComparisonDir)) {
+    fs.mkdirSync(visualComparisonDir, { recursive: true });
+  }
+
+  if (!comparePath) {
+    await screenshotFn(actualPath);
+  }
+
+  const { width, height } = await sharp(actualPath).metadata();
+
+  const baselineBuffer = await sharp(baselinePath)
+    .resize(width, height, { fit: "fill" })
+    .ensureAlpha()
+    .raw()
+    .toBuffer();
+
+  const actualBuffer = await sharp(actualPath)
+    .resize(width, height, { fit: "fill" })
+    .ensureAlpha()
+    .raw()
+    .toBuffer();
+
+  const diffImg = new PNG({ width, height });
+
+  const mismatchedPixels = pixelmatch(
+    baselineBuffer,
+    actualBuffer,
+    diffImg.data,
+    width,
+    height,
+    { threshold, includeAA: false },
+  );
+
+  fs.writeFileSync(diffPath, PNG.sync.write(diffImg));
+
+  const totalPixels   = width * height;
+  const mismatchRatio = mismatchedPixels / totalPixels;
+
+  const expectedBase64 = (await sharp(baselinePath).resize(width, height, { fit: "fill" }).png().toBuffer()).toString("base64");
+  const actualBase64   = (await sharp(actualPath).png().toBuffer()).toString("base64");
+  const diffBase64     = (await sharp(diffPath).png().toBuffer()).toString("base64");
+
+  const content = JSON.stringify({
+    expected: `data:image/png;base64,${expectedBase64}`,
+    actual:   `data:image/png;base64,${actualBase64}`,
+    diff:     `data:image/png;base64,${diffBase64}`,
+  });
+
+  await allure.attachment(
+    "Screenshot diff details",
+    `Mismatched pixels: ${mismatchedPixels} / ${totalPixels} (${(mismatchRatio * 100).toFixed(2)}%) Max allowed: ${maxDiffPercent * 100}%`,
+    "text/plain",
+  );
+
+  await allure.attachment(
+    "Screenshot diff",
+    content,
+    "application/vnd.allure.image.diff",
+  );
+
+  if (fs.existsSync(visualComparisonDir)) {
+    fs.rmSync(visualComparisonDir, { recursive: true, force: true });
+  }
+
+  if (mismatchRatio > maxDiffPercent) {
+    throw new Error(
+      `Screenshot mismatch: ${(mismatchRatio * 100).toFixed(2)}% pixels differ (max allowed: ${maxDiffPercent * 100}%)`,
+    );
+  }
+}
+
+module.exports = { screenComparer };

package/src/helper/controller/status-formatter.js

@@ -1,137 +1,137 @@
-const { Formatter } = require("@cucumber/cucumber");
-const fs = require("fs");
-const path = require("path");
-
-class StatusFormatter extends Formatter {
-  constructor(options) {
-    super(options);
-
-    const outputDir = "./test-status";
-    if (!fs.existsSync(outputDir)) {
-      fs.mkdirSync(outputDir, { recursive: true });
-    }
-
-    const workerId = process.env.CUCUMBER_WORKER_ID || "0";
-    this.workerId = workerId;
-    this.outputFile = path.join(outputDir, `test-results-${workerId}.txt`);
-    this.outputDir = outputDir;
-
-    fs.writeFileSync(this.outputFile, "", "utf8");
-
-    this.pickles = new Map();
-    this.testCases = new Map();
-    this.testCaseStartedIdToAttempt = new Map();
-
-    const { eventBroadcaster } = options;
-
-    eventBroadcaster.on("envelope", (envelope) => {
-      if (envelope.pickle) {
-        this.pickles.set(envelope.pickle.id, envelope.pickle);
-      }
-
-      if (envelope.testCase) {
-        this.testCases.set(envelope.testCase.id, envelope.testCase);
-      }
-
-      if (envelope.testCaseStarted) {
-        this.testCaseStartedIdToAttempt.set(
-          envelope.testCaseStarted.id,
-          envelope.testCaseStarted.testCaseId,
-        );
-      }
-
-      if (envelope.testCaseFinished) {
-        this.handleTestCaseFinished(envelope.testCaseFinished);
-      }
-
-      if (envelope.testRunFinished) {
-        this.handleTestRunFinished();
-      }
-    });
-  }
-
-  getFormattedTimestamp() {
-    const now = new Date();
-    const YYYY = now.getFullYear();
-    const MM = String(now.getMonth() + 1).padStart(2, "0");
-    const DD = String(now.getDate()).padStart(2, "0");
-    const hh = String(now.getHours()).padStart(2, "0");
-    const mm = String(now.getMinutes()).padStart(2, "0");
-    const ss = String(now.getSeconds()).padStart(2, "0");
-    const ms = String(now.getMilliseconds()).padStart(3, "0");
-
-    return `${YYYY}${MM}${DD}-${hh}${mm}${ss}-${ms}`;
-  }
-
-  handleTestCaseFinished(testCaseFinished) {
-    try {
-      const timestamp = this.getFormattedTimestamp();
-
-      const testCaseId = this.testCaseStartedIdToAttempt.get(
-        testCaseFinished.testCaseStartedId,
-      );
-
-      if (!testCaseId) return;
-
-      const testCase = this.testCases.get(testCaseId);
-      if (!testCase) return;
-
-      const pickle = this.pickles.get(testCase.pickleId);
-      if (!pickle) return;
-
-      const testCaseAttempt = this.eventDataCollector.getTestCaseAttempt(
-        testCaseFinished.testCaseStartedId,
-      );
-
-      const status = testCaseAttempt?.worstTestStepResult?.status || "UNKNOWN";
-
-      const info = {
-        name: pickle.name,
-        id: pickle.id,
-        uri: pickle.uri,
-      };
-
-      const line = `${timestamp} | ${status.toUpperCase()} | ${info.name} | ${info.id} | ${info.uri}\n`;
-
-      fs.appendFileSync(this.outputFile, line, "utf8");
-    } catch (error) {
-      console.error("Error in handleTestCaseFinished:", error);
-    }
-  }
-
-  handleTestRunFinished() {
-    if (this.workerId !== "0") {
-      return;
-    }
-
-    setTimeout(() => {
-      this.mergeResults();
-    }, 1000);
-  }
-
-  mergeResults() {
-    try {
-      const testStatusFile = path.join(this.outputDir, "test-status.txt");
-
-      const files = fs
-        .readdirSync(this.outputDir)
-        .filter((f) => f.startsWith("test-results-") && f.endsWith(".txt"))
-        .sort();
-
-      if (files.length === 0) {
-        console.log("No result files found to merge");
-        return;
-      }
-
-      const combined = files
-        .map((f) => fs.readFileSync(path.join(this.outputDir, f), "utf8"))
-        .join("");
-
-      fs.writeFileSync(testStatusFile, combined, "utf8");
-    } catch (error) {
-      console.error("Error merging results:", error);
-    }
-  }
-}
-
-module.exports = StatusFormatter;
+const { Formatter } = require("@cucumber/cucumber");
+const fs = require("fs");
+const path = require("path");
+
+class StatusFormatter extends Formatter {
+  constructor(options) {
+    super(options);
+
+    const outputDir = "./test-status";
+    if (!fs.existsSync(outputDir)) {
+      fs.mkdirSync(outputDir, { recursive: true });
+    }
+
+    const workerId = process.env.CUCUMBER_WORKER_ID || "0";
+    this.workerId = workerId;
+    this.outputFile = path.join(outputDir, `test-results-${workerId}.txt`);
+    this.outputDir = outputDir;
+
+    fs.writeFileSync(this.outputFile, "", "utf8");
+
+    this.pickles = new Map();
+    this.testCases = new Map();
+    this.testCaseStartedIdToAttempt = new Map();
+
+    const { eventBroadcaster } = options;
+
+    eventBroadcaster.on("envelope", (envelope) => {
+      if (envelope.pickle) {
+        this.pickles.set(envelope.pickle.id, envelope.pickle);
+      }
+
+      if (envelope.testCase) {
+        this.testCases.set(envelope.testCase.id, envelope.testCase);
+      }
+
+      if (envelope.testCaseStarted) {
+        this.testCaseStartedIdToAttempt.set(
+          envelope.testCaseStarted.id,
+          envelope.testCaseStarted.testCaseId,
+        );
+      }
+
+      if (envelope.testCaseFinished) {
+        this.handleTestCaseFinished(envelope.testCaseFinished);
+      }
+
+      if (envelope.testRunFinished) {
+        this.handleTestRunFinished();
+      }
+    });
+  }
+
+  getFormattedTimestamp() {
+    const now = new Date();
+    const YYYY = now.getFullYear();
+    const MM = String(now.getMonth() + 1).padStart(2, "0");
+    const DD = String(now.getDate()).padStart(2, "0");
+    const hh = String(now.getHours()).padStart(2, "0");
+    const mm = String(now.getMinutes()).padStart(2, "0");
+    const ss = String(now.getSeconds()).padStart(2, "0");
+    const ms = String(now.getMilliseconds()).padStart(3, "0");
+
+    return `${YYYY}${MM}${DD}-${hh}${mm}${ss}-${ms}`;
+  }
+
+  handleTestCaseFinished(testCaseFinished) {
+    try {
+      const timestamp = this.getFormattedTimestamp();
+
+      const testCaseId = this.testCaseStartedIdToAttempt.get(
+        testCaseFinished.testCaseStartedId,
+      );
+
+      if (!testCaseId) return;
+
+      const testCase = this.testCases.get(testCaseId);
+      if (!testCase) return;
+
+      const pickle = this.pickles.get(testCase.pickleId);
+      if (!pickle) return;
+
+      const testCaseAttempt = this.eventDataCollector.getTestCaseAttempt(
+        testCaseFinished.testCaseStartedId,
+      );
+
+      const status = testCaseAttempt?.worstTestStepResult?.status || "UNKNOWN";
+
+      const info = {
+        name: pickle.name,
+        id: pickle.id,
+        uri: pickle.uri,
+      };
+
+      const line = `${timestamp} | ${status.toUpperCase()} | ${info.name} | ${info.id} | ${info.uri}\n`;
+
+      fs.appendFileSync(this.outputFile, line, "utf8");
+    } catch (error) {
+      console.error("Error in handleTestCaseFinished:", error);
+    }
+  }
+
+  handleTestRunFinished() {
+    if (this.workerId !== "0") {
+      return;
+    }
+
+    setTimeout(() => {
+      this.mergeResults();
+    }, 1000);
+  }
+
+  mergeResults() {
+    try {
+      const testStatusFile = path.join(this.outputDir, "test-status.txt");
+
+      const files = fs
+        .readdirSync(this.outputDir)
+        .filter((f) => f.startsWith("test-results-") && f.endsWith(".txt"))
+        .sort();
+
+      if (files.length === 0) {
+        console.log("No result files found to merge");
+        return;
+      }
+
+      const combined = files
+        .map((f) => fs.readFileSync(path.join(this.outputDir, f), "utf8"))
+        .join("");
+
+      fs.writeFileSync(testStatusFile, combined, "utf8");
+    } catch (error) {
+      console.error("Error merging results:", error);
+    }
+  }
+}
+
+module.exports = StatusFormatter;