artes 1.4.13 → 1.5.0

package/cucumber.config.js

@@ -172,6 +172,15 @@ module.exports = {
     worldParameters: artesConfig.worldParameters || {}, // Custom world parameters
   },
   report: {
+    logo: process.env.LOGO
+    ? process.env.LOGO
+    : artesConfig?.logo || "./logo.png",
+      brandName: process.env.BRAND_NAME
+      ? process.env.BRAND_NAME
+      : artesConfig?.brandName || "ARTES",
+      reportName: process.env.REPORT_NAME
+        ? process.env.REPORT_NAME
+        : artesConfig?.reportName || "ARTES REPORT",
     singleFileReport:
       process.env.SINGLE_FILE_REPORT == "true"
         ? true

package/executer.js

@@ -37,6 +37,9 @@ const flags = {
   trace: args.includes("-t") || args.includes("--trace"),
   reportWithTrace: args.includes("-rwt") || args.includes("--reportWithTrace"),
   singleFileReport: args.includes("--singleFileReport"),
+  customLogo: args.includes("--logo"),
+  customBrandName:args.includes("--brandName"),
+  customReportName:args.includes("--reportName"),
   zip: args.includes("--zip"),
   features: args.includes("--features"),
   stepDef: args.includes("--stepDef"),
@@ -63,6 +66,9 @@ const flags = {
 
 const env = getArgValue("--env");
 const vars = getArgValue("--saveVar");
+const logo = getArgValue("--logo");
+const brandName = getArgValue("--brandName");
+const reportName = getArgValue("--reportName");
 const featureFiles = getArgValue("--features");
 const features = flags.features && featureFiles;
 const stepDef = getArgValue("--stepDef");
@@ -93,6 +99,10 @@ artesConfig.report
     ]))
   : "";
 
+flags.customLogo ? (process.env.LOGO = logo) : "";
+flags.customBrandName ? (process.env.BRAND_NAME = brandName) : "";
+flags.customReportName ? (process.env.REPORT_NAME = reportName) : "";
+
 flags.reportSuccess ? (process.env.REPORT_SUCCESS = true) : "";
 
 flags.tags && console.log("Running tags:", tags);
@@ -443,10 +453,12 @@ if (fs.existsSync(source)) {
   ){
     const executor = getExecutor();
 
+if(fs.existsSync(path.join(process.cwd(), "node_modules", "artes",'allure-result'))){
   fs.writeFileSync(
     path.join(process.cwd(), "node_modules", "artes",'allure-result',"executor.json"),
     JSON.stringify(executor, null, 2)
   );
+}
 
 generateReport();
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "artes",
-  "version": "1.4.13",
+  "version": "1.5.0",
   "description": "The simplest way to automate UI and API tests using Cucumber-style steps.",
   "main": "index.js",
   "scripts": {

package/src/helper/controller/reportCustomizer.js

@@ -0,0 +1,97 @@
+const fs = require("fs");
+const path = require("path");
+
+const CSS_START_MARKER = "/* ARTES_DYNAMIC_START */";
+const CSS_END_MARKER = "/* ARTES_DYNAMIC_END */";
+
+function reportCustomizer() {
+  delete require.cache[require.resolve("../../../cucumber.config.js")];
+  const cucumberConfig = require("../../../cucumber.config.js");
+
+  const report = cucumberConfig.report;
+  const today = new Date().toLocaleDateString("en-US", { month: "numeric", day: "numeric", year: "numeric" });
+  const reportName = typeof report.reportName === "string" ? report.reportName : report.reportName.name || "";
+
+  const logoSrc = path.resolve(process.cwd(), "node_modules", "artes", "assets", path.basename(report.logo));
+  const logoBase64 = fs.readFileSync(logoSrc).toString("base64");
+  const logoExt = path.extname(report.logo).replace(".", "");
+  const logoMime = logoExt === "svg" ? "image/svg+xml" : `image/${logoExt}`;
+  const logoDataUrl = `data:${logoMime};base64,${logoBase64}`;
+
+  if (cucumberConfig.report.singleFileReport) {
+    const htmlPath = path.resolve(__dirname, "../../../../../report/index.html");
+    const srcCssPath = path.resolve(__dirname, "../../../assets/styles.css");
+
+    const dynamicCss = generateCss(report, today, reportName, logoDataUrl);
+    const modifiedCss = injectCssAndReturn(srcCssPath, dynamicCss);
+    const cssBase64 = Buffer.from(modifiedCss).toString("base64");
+    const cssDataUrl = `data:text/css;base64,${cssBase64}`;
+
+    updateSingleFileHtml(htmlPath, report, reportName, logoDataUrl, cssDataUrl);
+
+  } else {
+    const htmlPath = path.resolve(__dirname, "../../../../../report/index.html");
+    const srcCssPath = path.resolve(__dirname, "../../../assets/styles.css");
+    const reportDir = path.resolve(__dirname, "../../../../../report");
+    const reportCssPath = path.join(reportDir, "styles.css");
+
+    const logoDest = path.join(reportDir, "logo.png");
+    fs.copyFileSync(logoSrc, logoDest);
+
+    const dynamicCss = generateCss(report, today, reportName, path.basename(report.logo));
+    injectCss(srcCssPath, dynamicCss);
+    fs.copyFileSync(srcCssPath, reportCssPath);
+
+    updateHtml(htmlPath, report, reportName, logoDataUrl);
+}
+}
+
+function generateCss(report, today, reportName, logoUrl) {
+  return `.side-nav__brand{background:url('${logoUrl}') no-repeat center left !important;background-size:70px 70px !important;height:80px;width:200px;display:flex !important;align-items:center;padding-left:65px}.side-nav__brand img,.side-nav__brand svg{display:none !important}.side-nav__brand-text{font-size:0 !important;display:block !important;padding: 0 8px;}.side-nav__brand-text::after{content:'${report.brandName}';font-size:26px;color:white;}.widget__title{font-weight:lighter;margin-bottom:15px;margin-top:0;text-transform:uppercase}.widget__flex-line:first-child .widget__title{font-size:0}.widget__flex-line:first-child .widget__title::before{content:'${reportName} ${today}';font-size:18px;font-weight:lighter;text-transform:uppercase}.widget__flex-line:first-child .widget__subtitle{font-size:14px}.widget__flex-line:not(:first-child) .widget__title{font-size:inherit;font-weight:lighter}`;
+}
+
+function injectCssAndReturn(cssPath, dynamicCss) {
+  let css = fs.readFileSync(cssPath, "utf8");
+
+  const startIdx = css.indexOf(CSS_START_MARKER);
+  const endIdx = css.indexOf(CSS_END_MARKER);
+  if (startIdx !== -1 && endIdx !== -1) {
+    css = css.slice(0, startIdx) + css.slice(endIdx + CSS_END_MARKER.length);
+  }
+
+  css += `\n${CSS_START_MARKER}\n${dynamicCss}\n${CSS_END_MARKER}`;
+  return css;
+}
+
+function injectCss(cssPath, dynamicCss) {
+  const css = injectCssAndReturn(cssPath, dynamicCss);
+  fs.writeFileSync(cssPath, css, "utf8");
+}
+
+function updateSingleFileHtml(htmlPath, report, reportName, logoDataUrl, cssDataUrl) {
+  let html = fs.readFileSync(htmlPath, "utf8");
+
+  html = html.replace(/<title>.*?<\/title>/, `<title>ARTES REPORT</title>`);
+
+  html = html.replace(
+    /<link rel="icon" href="data:image\/[^"]+"/,
+    `<link rel="icon" href="${logoDataUrl}"`
+  );
+
+  html = html.replace(
+    /<link rel="stylesheet" type="text\/css" href="data:text\/css;base64,[^"]+"/,
+    `<link rel="stylesheet" type="text/css" href="${cssDataUrl}"`
+  );
+
+  fs.writeFileSync(htmlPath, html, "utf8");
+}
+
+function updateHtml(htmlPath, report, reportName, logoDataUrl) {
+    let html = fs.readFileSync(htmlPath, "utf8");
+    html = html.replace(/<title>.*?<\/title>/, `<title>ARTES REPORT</title>`);
+    html = html.replace(/<link rel="icon" href=".*?">/, `<link rel="icon" href="${logoDataUrl}">`);
+    fs.writeFileSync(htmlPath, html, "utf8");
+  }
+
+module.exports = { reportCustomizer };
+

package/src/helper/executers/reportGenerator.js

@@ -3,6 +3,7 @@ const path = require("path");
 const archiver = require("archiver");
 const { spawnSync } = require("child_process");
 const { moduleConfig } = require("../imports/commons");
+const { reportCustomizer } = require("../../helper/controller/reportCustomizer");
 
 function generateReport() {
   try {
@@ -29,6 +30,8 @@ function generateReport() {
       `📋 Report generated successfully in ${moduleConfig.reportPath}!`,
     );
 
+    reportCustomizer();
+
     if (fs.existsSync(moduleConfig.reportPath) && process.env.ZIP === "true") {
       console.log(`🗜️ Zipping report folder...`);