artes 1.5.9 → 1.5.11

package/README.md

@@ -115,9 +115,14 @@ npx artes [options]
 | `-rwt, --reportWithTrace` | Add trace to the report                                                            | `artes -rwt` or `artes --reportWithTrace`                             |
 | `--singleFileReport`      | Generate single file allure report                                                 | `artes -r --singleFileReport`                                         |
 | `--zip`                   | Zip the report folder after generation                                             | `artes -r --zip`                                                      |
+| `--uploadReport`          | Upload the generated report to Artes Reporting System                              | `artes --uploadReport --reporterURL "https://example.com"`            |
+| `--reporterURL`           | URL of the Artes Reporting System to upload the report                             | `artes --uploadReport --reporterURL "https://example.com"`            |
+| `--projectName`           | Name of the project in the Artes Reporting System (default: `"Artes Report"`)     | `artes --uploadReport --reporterURL "https://example.com" --projectName "My Project"` |
+| `--projectType`           | Type of the project for reporting purposes (default: `"Artes"`)                   | `artes --uploadReport --reporterURL "https://example.com" --projectType "API"` |
+| `--reportPath`            | Path to the report zip file to upload (default: `./report.zip`)                   | `artes --uploadReport --reporterURL "https://example.com" --reportPath "./my_report.zip"` |
 | 🖼️ `--logo`               | Set a custom logo in the report sidebar. Accepts an absolute path, a relative path, or a direct image URL | `artes --logo /abs/path/logo.png`<br>`artes --logo logo.png`<br>`artes --logo 'https://example.com/logo.png'` |
 | 🏢 `--brandName`          | Set the brand name displayed next to the logo in the report sidebar                | `artes --brandName 'My Company'`                                      |
-| 📄 `--reportName`         | Set the report name displayed on the summary widget                                | `artes --reportName 'Alma UI'`  
+| 📄 `--reportName`         | Report name displayed on the summary widget and in the Artes Reporting System                       | `artes --reportName 'Alma UI'`  
 | 📁 `--features`           | Specify one or more feature files' relative paths to run (comma-separated)         | `artes --features "tests/features/Alma,tests/features/Banan.feature"` |
 | 📜 `--stepDef`            | Specify one or more step definition files' relative paths to use (comma-separated) | `artes --stepDef "tests/steps/login.js,tests/steps/home.js"`          |
 | 🔖 `--tags`               | Run tests with specified Cucumber tags                                             | `artes --tags "@smoke or @wip"`                                       |
@@ -615,13 +620,26 @@ Artes supports environment-specific configurations through environment variables
 
 | Option        | Default Value                  | Description                                            |
 | ------------- | ------------------------------ | ------------------------------------------------------ |
-| `device`      | `""`                     | [Device List](./docs/emulationDevicesList.md) |
+| `device`      | `""`                           | [Device List](./docs/emulationDevicesList.md)          |
 
 
-## 📊 Report Generation
+## 📊 Reporting
 
 Artes can generate Allure reports. After running tests with the `-r` flag, the reports will be stored in the `report` folder in HTML format. You can view them in your browser after the tests complete.
 
+## 📊 Integration with Artes Reporting System
+
+Artes has a built-in integration with the Artes Reporting System. By configuring the options below, you can automatically upload your test reports and keep your pipeline stages clean and organized.
+
+| **Option**       | **Default Value**             | **Description**                                                        |
+| ---------------- | ----------------------------- | ---------------------------------------------------------------------- |
+| `uploadReport`   | `false`                       | Automatically upload the report to Artes Reporting System after tests. |
+| `reporterURL`    | `""`                          | URL of the Artes Reporting System instance to upload the report to.    |
+| `projectName`    | `"Artes Report"`              | Name of the project in the Artes Reporting System.                     |
+| `projectType`    | `"Artes"`                     | Type/category of the project (e.g., UI, API).                          |
+| `reportName`     | `"Artes Report"`              | Display name of the report in the Artes Reporting System.              |
+| `reportPath`     | `"./report.zip"`              | Path to the report zip file to be uploaded.                            |
+
 ---
 
 ## 🐳 Docker Image for CI/CD

package/cucumber.config.js

@@ -14,7 +14,11 @@ try {
   console.log("Proceeding with default config.");
 }
 
-const defaultFormats = ["rerun:@rerun.txt",  "progress-bar", './src/helper/controller/status-formatter.js:null'];
+const defaultFormats = [
+  "rerun:@rerun.txt",
+  "progress-bar",
+  "./src/helper/controller/status-formatter.js:null",
+];
 
 const userFormatsFromEnv = process.env.REPORT_FORMAT
   ? JSON.parse(process.env.REPORT_FORMAT)
@@ -52,7 +56,6 @@ function resolveEnv(artesConfig) {
 const env = resolveEnv(artesConfig);
 
 function loadVariables(cliVariables, artesConfigVariables) {
-
   if (cliVariables) {
     try {
       cliVariables = JSON.parse(cliVariables);
@@ -72,13 +75,12 @@ function loadVariables(cliVariables, artesConfigVariables) {
 
 const resolveFeaturePaths = (basePath, value) => {
   return value
-    .split(',')
-    .map(p => p.trim())
+    .split(",")
+    .map((p) => p.trim())
     .filter(Boolean)
-    .map(p => path.join(basePath, p));
+    .map((p) => path.join(basePath, p));
 };
 
-
 module.exports = {
   default: {
     // File paths and patterns
@@ -88,13 +90,13 @@ module.exports = {
     timeout: process.env.TIMEOUT
       ? Number(process.env.TIMEOUT) * 1000
       : artesConfig.timeout * 1000 || 30 * 1000, // Default timeout in seconds
-      paths: process.env.RERUN
+    paths: process.env.RERUN
       ? [path.join("../../", process.env.RERUN)]
       : process.env.FEATURES
         ? resolveFeaturePaths(moduleConfig.projectPath, process.env.FEATURES)
         : artesConfig.features
           ? resolveFeaturePaths(moduleConfig.projectPath, artesConfig.features)
-          : [moduleConfig.featuresPath], // Paths to feature files    
+          : [moduleConfig.featuresPath], // Paths to feature files
     require: [
       process.env.STEP_DEFINITIONS
         ? [path.join(moduleConfig.projectPath, process.env.STEP_DEFINITIONS)]
@@ -173,14 +175,14 @@ module.exports = {
   },
   report: {
     logo: process.env.LOGO
-    ? process.env.LOGO
-    : artesConfig?.logo || "./logo.png",
-      brandName: process.env.BRAND_NAME
+      ? 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",
+    reportName: process.env.REPORT_NAME
+      ? process.env.REPORT_NAME
+      : artesConfig?.reportName || "ARTES REPORT",
     singleFileReport:
       process.env.SINGLE_FILE_REPORT == "true"
         ? true

package/executer.js

@@ -10,10 +10,15 @@ const {
 const { logPomWarnings } = require("./src/helper/controller/pomCollector");
 const fs = require("fs");
 const path = require("path");
-const { testCoverageCalculator } = require("./src/helper/controller/testCoverageCalculator");
+const {
+  testCoverageCalculator,
+} = require("./src/helper/controller/testCoverageCalculator");
 const { getExecutor } = require("./src/helper/controller/getExecutor");
-const { findDuplicateTestNames } = require("./src/helper/controller/findDuplicateTestNames");
+const {
+  findDuplicateTestNames,
+} = require("./src/helper/controller/findDuplicateTestNames");
 const { getEnvInfo } = require("artes/src/helper/controller/getEnvInfo");
+const { uploadReport } = require("./src/helper/controller/reportUploader");
 
 
 const artesConfigPath = path.resolve(process.cwd(), "artes.config.js");
@@ -43,9 +48,14 @@ const flags = {
   reportWithTrace: args.includes("-rwt") || args.includes("--reportWithTrace"),
   singleFileReport: args.includes("--singleFileReport"),
   customLogo: args.includes("--logo"),
-  customBrandName:args.includes("--brandName"),
-  customReportName:args.includes("--reportName"),
+  customBrandName: args.includes("--brandName"),
+  customReportName: args.includes("--reportName"),
   zip: args.includes("--zip"),
+  uploadReport: args.includes("--uploadReport"),
+  reporterURL: args.includes("--reporterURL"),
+  projectName: args.includes("--projectName"),
+  projectType: args.includes("--projectType"),
+  reportPath: args.includes("--reportPath"),
   features: args.includes("--features"),
   stepDef: args.includes("--stepDef"),
   tags: args.includes("--tags"),
@@ -68,9 +78,12 @@ const flags = {
   slowMo: args.includes("--slowMo"),
 };
 
-
 const env = getArgValue("--env");
 const vars = getArgValue("--saveVar");
+const reporterURL = getArgValue("--reporterURL");
+const projectType = getArgValue("--projectType");
+const projectName = getArgValue("--projectName");
+const reportPath = getArgValue("--reportPath");
 const logo = getArgValue("--logo");
 const brandName = getArgValue("--brandName");
 const reportName = getArgValue("--reportName");
@@ -90,7 +103,6 @@ const height = getArgValue("--height");
 const timeout = getArgValue("--timeout");
 const slowMo = getArgValue("--slowMo");
 
-
 flags.env ? (process.env.ENV = env) : "";
 
 vars ? (process.env.VARS = vars) : "";
@@ -172,9 +184,7 @@ flags.timeout ? (process.env.TIMEOUT = timeout) : "";
 
 flags.slowMo ? (process.env.SLOWMO = slowMo) : "";
 
-
-
-function main() {
+async function main() {
   if (flags.help) return showHelp();
   if (flags.version) return showVersion();
   if (flags.create) return createProject(flags.createYes, flags.noDeps);
@@ -185,57 +195,72 @@ function main() {
 
   findDuplicateTestNames();
 
-  const testCoverage = testCoverageCalculator()
+  const testCoverage = testCoverageCalculator();
 
-  const testPercentage = (process.env.PERCENTAGE  ? Number(process.env.PERCENTAGE)  : artesConfig.testPercentage || 0)
+  const testPercentage = process.env.PERCENTAGE
+    ? Number(process.env.PERCENTAGE)
+    : artesConfig.testPercentage || 0;
 
   if (testPercentage > 0) {
-
-    const meetsThreshold = testCoverage.percentage >= testPercentage
+    const meetsThreshold = testCoverage.percentage >= testPercentage;
 
     if (meetsThreshold) {
       console.log(
-        `✅ Tests passed required ${testPercentage}% success rate with ${testCoverage.percentage.toFixed(2)}%!`,
+        `\x1b[32mTests passed required ${testPercentage}% success rate with ${testCoverage.percentage.toFixed(2)}%!\x1b[0m`,
       );
       process.env.EXIT_CODE = parseInt(0, 10);
     } else {
       console.log(
-        `❌ Tests failed required ${testPercentage}% success rate with ${testCoverage.percentage.toFixed(2)}%!`,
+        `\x1b[31mTests failed required ${testPercentage}% success rate with ${testCoverage.percentage.toFixed(2)}%!\x1b[0m`,
       );
       process.env.EXIT_CODE = parseInt(1, 10);
     }
   }
 
+  const source = path.join(
+    process.cwd(),
+    "node_modules",
+    "artes",
+    "@rerun.txt",
+  );
+  const destination = path.join(process.cwd(), "@rerun.txt");
 
-const source = path.join(process.cwd(), "node_modules", "artes", "@rerun.txt");
-const destination = path.join(process.cwd(), "@rerun.txt");
-
-if (fs.existsSync(source)) {
-  fs.renameSync(source, destination);
-}
+  if (fs.existsSync(source)) {
+    fs.renameSync(source, destination);
+  }
 
   if (
     flags.reportWithTrace ||
     artesConfig.reportWithTrace ||
     flags.report ||
     artesConfig.report
-  ){
-
+  ) {
     getExecutor();
-    getEnvInfo()
+    getEnvInfo();
     generateReport();
-
   }
 
-    if (!( process.env.TRACE === "true"
+  if (
+    !(process.env.TRACE === "true"
       ? process.env.TRACE
-      : artesConfig.trace || false)) {
-          fs.rmSync(path.join(process.cwd(), "traces"), {
-            recursive: true,
-            force: true,
-          });
-    }
-    
+      : artesConfig.trace || false)
+  ) {
+    fs.rmSync(path.join(process.cwd(), "traces"), {
+      recursive: true,
+      force: true,
+    });
+  }
+
+  if (flags.uploadReport || artesConfig.uploadReport) {
+  await uploadReport({
+    reporterURL:  reporterURL  || artesConfig.reporterURL,
+    projectName:  projectName  || artesConfig.projectName || "Artes Report",
+    projectType:  projectType  || artesConfig.projectType || "Artes",
+    reportName:   reportName   || artesConfig.reportName  || "Artes Report",
+    reportPath:   reportPath   || artesConfig.reportPath  || path.join(process.cwd(), "report.zip")
+  });
+}
+
   cleanUp();
   process.exit(process.env.EXIT_CODE);
 }

package/package.json

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

package/src/helper/controller/elementController.js

@@ -38,9 +38,8 @@ function selectorSeparator(element) {
   }
 }
 
- function getSelector(element) {
-
-  element = resolveVariable(element)
+function getSelector(element) {
+  element = resolveVariable(element);
 
   const selector =
     elements?.[element]?.selector || elements?.[element] || element;
@@ -94,9 +93,7 @@ function getElement(element) {
   return locator;
 }
 
-
 function extractVarsFromResponse(responseBody, vars, customVarNames) {
-
   function getValueByPath(obj, path) {
     const keys = path.split(".");
     let current = obj;
@@ -124,13 +121,13 @@ function extractVarsFromResponse(responseBody, vars, customVarNames) {
       .join("");
   }
 
-  const varPaths = vars.split(",").map(v => v.trim());
+  const varPaths = vars.split(",").map((v) => v.trim());
   let customNames = [];
 
   if (!customVarNames) {
     customNames = varPaths.map(pathToCamelCase);
   } else if (typeof customVarNames === "string") {
-    customNames = customVarNames.split(",").map(n => n.trim());
+    customNames = customVarNames.split(",").map((n) => n.trim());
   } else if (Array.isArray(customVarNames)) {
     customNames = customVarNames;
   } else {

package/src/helper/controller/findDuplicateTestNames.js

@@ -2,53 +2,67 @@ const fs = require("fs");
 const path = require("path");
 
 function findDuplicateTestNames() {
-    const testStatusFile = path.join(process.cwd(), "node_modules", "artes" , "test-status", 'test-status.txt');
-    
-    if (!fs.existsSync(testStatusFile)) {
-      console.error('test-status.txt not found');
-      return;
+  const testStatusFile = path.join(
+    process.cwd(),
+    "node_modules",
+    "artes",
+    "test-status",
+    "test-status.txt",
+  );
+
+  if (!fs.existsSync(testStatusFile)) {
+    console.error("test-status.txt not found");
+    return;
+  }
+
+  const content = fs.readFileSync(testStatusFile, "utf8");
+  const lines = content.split("\n").filter((line) => line.trim());
+
+  const testNameToEntries = {};
+
+  lines.forEach((line) => {
+    const parts = line.split(" | ");
+    if (parts.length < 5) return;
+
+    const testName = parts[2].trim();
+    const filePath = parts[4].trim();
+    const uuid = parts[3].trim();
+
+    if (!testNameToEntries[testName]) {
+      testNameToEntries[testName] = [];
     }
-  
-    const content = fs.readFileSync(testStatusFile, 'utf8');
-    const lines = content.split('\n').filter(line => line.trim());
-  
-    const testNameToFiles = {};
-  
-    lines.forEach(line => {
-      const parts = line.split(' | ');
-      if (parts.length < 5) return;
-  
-      const testName = parts[2].trim();
-      const filePath = parts[4].trim();
-  
-      if (!testNameToFiles[testName]) {
-        testNameToFiles[testName] = new Set();
-      }
-      
-      testNameToFiles[testName].add(filePath);
-    });
-  
-    const duplicates = {};
-    
-    Object.entries(testNameToFiles).forEach(([testName, files]) => {
-      if (files.size > 1) {
-        duplicates[testName] = Array.from(files);
-      }
-    });
-  
-    if (Object.keys(duplicates).length > 0) {
-      console.warn('\n\x1b[33m[WARNING] Duplicate scenarios names found: This will effect your reporting');    
-      Object.entries(duplicates).forEach(([testName, files]) => {
-        console.log(`\x1b[33m"${testName}" exists in:`);
-        files.forEach(file => {
-          console.log(`  - ${file}`);
-        });
-        console.log('');
+
+    const alreadyExists = testNameToEntries[testName].some(
+      (e) => e.uuid === uuid,
+    );
+    if (!alreadyExists) {
+      testNameToEntries[testName].push({ filePath, uuid });
+    }
+  });
+
+  const duplicates = {};
+
+  Object.entries(testNameToEntries).forEach(([testName, entries]) => {
+    if (entries.length > 1) {
+      duplicates[testName] = entries.map((e) => e.filePath);
+    }
+  });
+
+  if (Object.keys(duplicates).length > 0) {
+    console.warn(
+      "\n\x1b[33m[WARNING] Duplicate scenario names found: This will affect your reporting",
+    );
+    Object.entries(duplicates).forEach(([testName, files]) => {
+      console.log(`\x1b[33m"${testName}" exists in:`);
+      files.forEach((file) => {
+        console.log(`  - ${file}`);
       });
-      console.log("\x1b[0m");
-    } 
-  
-    return duplicates;
+      console.log("");
+    });
+    console.log("\x1b[0m");
   }
 
-module.exports = {findDuplicateTestNames}
+  return duplicates;
+}
+
+module.exports = { findDuplicateTestNames };

package/src/helper/controller/getEnvInfo.js

@@ -3,71 +3,84 @@ const fs = require("fs");
 const path = require("path");
 const { moduleConfig } = require("artes/src/helper/imports/commons");
 
-
 async function getEnvInfo() {
-  
-    delete require.cache[require.resolve("../../../cucumber.config.js")];
-    const cucumberConfig = require("../../../cucumber.config.js");
-  
-        if (fs.existsSync(path.join(moduleConfig.modulePath, "browser-info.json"))) {
-          browserInfo = JSON.parse(fs.readFileSync(path.join(moduleConfig.modulePath, "browser-info.json"), "utf8"));
-        }
-
-    const environment = {
-      // ── System ──────────────────────────────
-      "OS_Name":         os.type(),                          
-      "OS_Version":      os.release(),                   
-      "OS_Platform":     process.platform,                 
-      "OS_Arch":         os.arch(),               
-      "CPU_Cores":       os.cpus().length,
-      "CPU_Model":       os.cpus()[0]?.model ?? "N/A",
-      "RAM_Total":       `${(os.totalmem() / 1024 / 1024 / 1024).toFixed(2)} GB`,
-      "RAM_Free":        `${(os.freemem() / 1024 / 1024 / 1024).toFixed(2)} GB`,
-      "Hostname":        os.hostname(),
-  
-      // ── Node ────────────────────────────────
-      "Node_Version":    process.version,
-      "NPM_Version":     process.env.npm_config_user_agent ?? "N/A",
-      "Working_Dir":     process.cwd(),
-  
-      // ── Browser ─────────────────────────────
-      "Browser_Name":    cucumberConfig.browser.browserType,
-      "Browser_Version": browserInfo.BROWSER_VERSION,
-      "Screen_Size":     `w: ${browserInfo.BROWSER_WIDTH}px h:${browserInfo.BROWSER_HEIGHT}px`,
-      "Headless":        cucumberConfig.browser.headless ?? "N/A",
-  
-      // ── Test Config ─────────────────────────
-      "Base_URL":        cucumberConfig.baseURL ||  "N/A",
-      "Environment":     cucumberConfig.env ||  "local",
-      "Timeout":         cucumberConfig.default.timeout ?? "N/A",
-  
-      // ── Git ─────────────────────────────────
-      "Git_Branch":      process.env.GIT_BRANCH  ?? process.env.BRANCH_NAME ?? "N/A",
-      "Git_Commit":      process.env.GIT_COMMIT  ?? process.env.GIT_SHA     ?? "N/A",
-      "Git_Author":      process.env.GIT_AUTHOR  ?? "N/A",
-  
-      // ── Timestamps ──────────────────────────
-      "Run_Date":        new Date().toLocaleDateString(),
-      "Run_Time":        new Date().toLocaleTimeString(),
-      "Timezone":        Intl.DateTimeFormat().resolvedOptions().timeZone,
-    };
-  
-    const allureResultsDir = path.join(moduleConfig.modulePath, "allure-result");
-  
-    if (!fs.existsSync(allureResultsDir)) {
-      fs.mkdirSync(allureResultsDir, { recursive: true });
-    }
-  
-    const propertiesContent = Object.entries(environment)
-      .map(([key, value]) => `${key}=${value}`)
-      .join("\n");
-  
-    fs.writeFileSync(
-      path.join(allureResultsDir, "environment.properties"),
-      propertiesContent
+  delete require.cache[require.resolve("../../../cucumber.config.js")];
+  const cucumberConfig = require("../../../cucumber.config.js");
+
+  let baseURL = "";
+
+  if (typeof cucumberConfig.baseURL === "object") {
+    const env = (cucumberConfig.env || "").trim();
+    baseURL = cucumberConfig.baseURL[env];
+  } else {
+    baseURL = cucumberConfig.baseURL;
+  }
+
+  if (fs.existsSync(path.join(moduleConfig.modulePath, "browser-info.json"))) {
+    browserInfo = JSON.parse(
+      fs.readFileSync(
+        path.join(moduleConfig.modulePath, "browser-info.json"),
+        "utf8",
+      ),
     );
-  
-    return environment;
   }
 
-  module.exports ={getEnvInfo}
+  const environment = {
+    // ── System ──────────────────────────────
+    OS_Name: os.type(),
+    OS_Version: os.release(),
+    OS_Platform: process.platform,
+    OS_Arch: os.arch(),
+    CPU_Cores: os.cpus().length,
+    CPU_Model: os.cpus()[0]?.model ?? "N/A",
+    RAM_Total: `${(os.totalmem() / 1024 / 1024 / 1024).toFixed(2)} GB`,
+    RAM_Free: `${(os.freemem() / 1024 / 1024 / 1024).toFixed(2)} GB`,
+    Hostname: os.hostname(),
+
+    // ── Node ────────────────────────────────
+    Node_Version: process.version,
+    NPM_Version: process.env.npm_config_user_agent ?? "N/A",
+    Working_Dir: process.cwd(),
+
+    // ── Browser ─────────────────────────────
+    Browser_Name: cucumberConfig.browser.browserType,
+    Browser_Version: browserInfo.BROWSER_VERSION,
+    Screen_Size: `w: ${browserInfo.BROWSER_WIDTH}px h:${browserInfo.BROWSER_HEIGHT}px`,
+    Headless: cucumberConfig.browser.headless ?? "N/A",
+
+    // ── Test Config ─────────────────────────
+    Base_URL: baseURL || "N/A",
+    Environment: cucumberConfig.env || "local",
+    Parallel_Runner: cucumberConfig.default.parallel,
+    Timeout: cucumberConfig.default.timeout ?? "N/A",
+
+    // ── Git ─────────────────────────────────
+    Git_Branch: process.env.GIT_BRANCH ?? process.env.BRANCH_NAME ?? "N/A",
+    Git_Commit: process.env.GIT_COMMIT ?? process.env.GIT_SHA ?? "N/A",
+    Git_Author: process.env.GIT_AUTHOR ?? "N/A",
+
+    // ── Timestamps ──────────────────────────
+    Run_Date: new Date().toLocaleDateString(),
+    Run_Time: new Date().toLocaleTimeString(),
+    Timezone: Intl.DateTimeFormat().resolvedOptions().timeZone,
+  };
+
+  const allureResultsDir = path.join(moduleConfig.modulePath, "allure-result");
+
+  if (!fs.existsSync(allureResultsDir)) {
+    fs.mkdirSync(allureResultsDir, { recursive: true });
+  }
+
+  const propertiesContent = Object.entries(environment)
+    .map(([key, value]) => `${key}=${value}`)
+    .join("\n");
+
+  fs.writeFileSync(
+    path.join(allureResultsDir, "environment.properties"),
+    propertiesContent,
+  );
+
+  return environment;
+}
+
+module.exports = { getEnvInfo };