artes 1.4.4 → 1.4.5

package/README.md

@@ -119,6 +119,7 @@ npx artes [options]
 | 📜 `--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"`                                       |
 | 🌐 `--env`                | Set the environment for the test run                                               | `artes --env "dev"`                                                   |
+| `--saveVar`              |  Set the variables from CLI                                                         | `artes --saveVar '{"armud":20,"banana":200}'` |  
 | 🕶️ `--headless`           | Run browser in headless mode                                                       | `artes --headless`                                                    |
 | ⚡ `--parallel`           | Run tests in parallel mode                                                         | `artes --parallel 2`                                                  |
 | 🔁 `--retry`              | Retry failed tests                                                                 | `artes --retry 3`                                                     |
@@ -482,23 +483,34 @@ You can configure Artes by editing the `artes.config.js` file. Below are the def
 
 | **Option**        | **Default Value**                                                            | **Description**                                               |
 | ----------------- | ---------------------------------------------------------------------------- | ------------------------------------------------------------- |
+| `headless`        | `false`                                                                      | Run browser in headless mode.                                 |
+| `env`             | `""`                                                                         | Environment name for tests.                                   |
+| `variables`       | `{}`                                                                         | Variables for tests.                                          |
+| `baseURL`         | `""`                                                                         | Base URL for API or web tests.                                |
 | `timeout`         | `30`                                                                         | Default timeout in seconds.                                   |
-| `slowMo`          | `0`                                                                          | Default slow motion in seconds                                |
+| `slowMo`          | `0`                                                                          | Default slow motion in seconds.                               |
 | `paths`           | `[moduleConfig.featuresPath]`                                                | Paths to feature files.                                       |
 | `require`         | `[moduleConfig.stepsPath, "src/stepDefinitions/*.js", "src/hooks/hooks.js"]` | Support code paths (CommonJS).                                |
 | `pomPath`         | `moduleConfig.pomPath`                                                       | Path to Page Object Models.                                   |
 | `import`          | `[]`                                                                         | Support code paths.                                           |
 | `testPercentage`  | `0`                                                                          | Define test coverage percentage                               |
 | `report`          | `false`                                                                      | Generate report                                               |
-| `reportSuccess`   | `false`                                                                      | Add screenshots and video records for also success test cases |
-| `trace`           | `false`                                                                      | Enable trace                                                  |
-| `reportWithTrace` | `false`                                                                      | Add trace to the report                                       |
+| `zip`             |  `false`                                                                     | Generate zip of report |
+| `reportSuccess`   | `false`                                                                      | Add screenshots and video records also for success test cases |
+| `trace`           | `false`                                                                      | Enable tracing                                                |
+| `reportWithTrace` | `false`                                                                      | Include trace in report                                       |
 | `format`          | `["rerun:@rerun.txt", "allure-cucumberjs/reporter"]`                         | Formatter names/paths.                                        |
 | `formatOptions`   | `{ "resultsDir": "allure-result" }`                                          | Formatter options.                                            |
 | `parallel`        | `1`                                                                          | Number of parallel workers.                                   |
+| `browser`         | `"chrome"`                                                                   | Browser to use: "chrome", "firefox", "webkit".                |
+| `offline`         | `false`                                                                      | Run browser in offline mode.                                  |
+| `device`          | `""`                                                                         | Emulate specific device (e.g., "iPhone 13").                  |
+| `width`           | `1280`                                                                       | Browser width in pixels.                                      |
+| `height`          | `720`                                                                        | Browser height in pixels.                                     |
+| `maximizeScreen`  | `true`                                                                       | Maximize browser window on start.                             |
 | `dryRun`          | `false`                                                                      | Prepare test run without execution.                           |
 | `failFast`        | `false`                                                                      | Stop on first test failure.                                   |
-| `forceExit`       | `false`                                                                      | Force `process.exit()` after tests.                           |
+| `forceExit`       | `false`                                                                      | Force `process.exit()` after tests                            |
 | `strict`          | `true`                                                                       | Fail on pending steps.                                        |
 | `backtrace`       | `false`                                                                      | Show full backtrace for errors.                               |
 | `tags`            | `""`                                                                         | Tag expression to filter scenarios.                           |

package/cucumber.config.js

@@ -51,6 +51,25 @@ function resolveEnv(artesConfig) {
 }
 const env = resolveEnv(artesConfig);
 
+function loadVariables(cliVariables, artesConfigVariables) {
+
+  if (cliVariables) {
+    try {
+      cliVariables = JSON.parse(process.env.VARS);
+    } catch (err) {
+      console.error("Invalid JSON in process.env.VARS:", process.env.VARS);
+      envVars = {};
+    }
+  }
+
+  const mergedVars = {
+    ...(artesConfigVariables || {}),
+    ...cliVariables,
+  };
+
+  return mergedVars;
+}
+
 const resolveFeaturePaths = (basePath, value) => {
   return value
     .split(',')
@@ -162,6 +181,7 @@ module.exports = {
     zip: process.env.ZIP == "true" ? true : artesConfig.zip ? true : false,
   },
   env: env,
+  variables: loadVariables(process.env.VARS, artesConfig.variables),
   baseURL: process.env.BASE_URL
     ? JSON.parse(process.env.BASE_URL)
     : artesConfig?.baseURL

package/executer.js

@@ -10,13 +10,14 @@ const {
 const { logPomWarnings } = require("./src/helper/controller/pomCollector");
 const fs = require("fs");
 const path = require("path");
+const { spawnSync } = require("child_process");
 
-const configPath = path.resolve(process.cwd(), "artes.config.js");
+const artesConfigPath = path.resolve(process.cwd(), "artes.config.js");
 
 let artesConfig = {};
 
-if (fs.existsSync(configPath)) {
-  artesConfig = require(configPath);
+if (fs.existsSync(artesConfigPath)) {
+  artesConfig = require(artesConfigPath);
 }
 
 const args = process.argv.slice(2);
@@ -37,6 +38,7 @@ const flags = {
   stepDef: args.includes("--stepDef"),
   tags: args.includes("--tags"),
   env: args.includes("--env"),
+  saveVar: args.includes("--saveVar"),
   headless: args.includes("--headless"),
   parallel: args.includes("--parallel"),
   retry: args.includes("--retry"),
@@ -55,6 +57,7 @@ const flags = {
 };
 
 const env = args[args.indexOf("--env") + 1];
+const vars = args[args.indexOf("--saveVar") + 1]
 const featureFiles = args[args.indexOf("--features") + 1];
 const features = flags.features && featureFiles;
 const stepDef = args[args.indexOf("--stepDef") + 1];
@@ -73,6 +76,8 @@ const slowMo = args[args.indexOf("--slowMo") + 1];
 
 flags.env ? (process.env.ENV = env) : "";
 
+vars ? (process.env.VARS = vars) : "";
+
 flags.reportWithTrace ||
 artesConfig.reportWithTrace ||
 flags.report ||
@@ -146,6 +151,83 @@ flags.timeout ? (process.env.TIMEOUT = timeout) : "";
 
 flags.slowMo ? (process.env.SLOWMO = slowMo) : "";
 
+
+function testCoverageCalculation(testStatusDir){
+  if(fs.existsSync(testStatusDir)){
+    const files = fs.readdirSync(testStatusDir);
+
+    const map = {};
+    const retriedTests = [];
+    const uuidRegex = /[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}/i;
+  
+    files.forEach(file => {
+     const match = file.match(uuidRegex);
+     if (!match) return;
+ 
+     const id = match[0];
+ 
+     const beforeId = file.substring(0, file.indexOf(id) - 1);
+     const afterId = file.substring(file.indexOf(id) + id.length + 1);
+ 
+     const status = beforeId.split('-')[0];
+     const scenario = beforeId.substring(status.length + 1);
+     const timestamp = afterId;
+ 
+     if (!map[id]) {
+       map[id] = {
+         count: 1,
+         latest: { status, scenario, timestamp }
+       };
+     } else {
+       map[id].count++;
+       if (timestamp > map[id].latest.timestamp) {
+         map[id].latest = { status, scenario, timestamp };
+       }
+     }
+   });
+ 
+   let total = 0;
+   let notPassed = 0;
+ 
+   Object.entries(map).forEach(([id, data]) => {
+     total++;
+ 
+     if (data.count > 1) {
+       retriedTests.push({
+         scenario: data.latest.scenario,
+         id,
+         count: data.count
+       });
+     }
+ 
+     if (data.latest.status !== 'PASSED') {
+      notPassed++;
+     }
+   });
+ 
+   if (retriedTests.length > 0) {
+     console.warn('\n\x1b[33mRetried test cases:');
+     retriedTests.forEach(t => {
+       console.warn(`- "${t.scenario}" ran ${t.count} times`);
+     });
+     console.log("\x1b[0m");
+   }
+ 
+   return {
+     percentage : (total - notPassed)/total*100,
+     totalTests: total,
+     notPassed,
+     passed: total - notPassed,
+     latestStatuses: Object.fromEntries(
+       Object.entries(map).map(([id, data]) => [
+         id,
+         data.latest.status
+       ])
+     )
+   };
+  }
+}
+
 function main() {
   if (flags.help) return showHelp();
   if (flags.version) return showVersion();
@@ -155,6 +237,35 @@ function main() {
 
   logPomWarnings();
 
+  const testCoverage = testCoverageCalculation(path.join(process.cwd(), "node_modules", "artes" , "testsStatus"))
+
+  const testPercentage = (process.env.PERCENTAGE  ? Number(process.env.PERCENTAGE)  : artesConfig.testPercentage || 0)
+
+  if (testPercentage > 0) {
+
+    const meetsThreshold = testCoverage.percentage >= testPercentage
+
+    if (meetsThreshold) {
+      console.log(
+        `✅ Tests passed required ${testPercentage}% success rate with ${testCoverage.percentage.toFixed(2)}%!`,
+      );
+      process.env.EXIT_CODE = parseInt(0, 10);
+    } else {
+      console.log(
+        `❌ Tests failed required ${testPercentage}% success rate with ${testCoverage.percentage.toFixed(2)}%!`,
+      );
+      process.env.EXIT_CODE = parseInt(1, 10);
+    }
+  }
+
+if (fs.existsSync(path.join(process.cwd(), "node_modules", "artes" , "@rerun.txt"))) {
+  spawnSync("mv", ["@rerun.txt", process.cwd()], {
+    cwd: path.join(process.cwd(), "node_modules", "artes"),
+    stdio: "inherit",
+    shell: true,
+  });
+}
+
   if (
     flags.reportWithTrace ||
     artesConfig.reportWithTrace ||
@@ -163,18 +274,25 @@ function main() {
   )
     generateReport();
 
-  if (
-    fs.existsSync(
-      path.join(process.cwd(), "node_modules", "artes", "EXIT_CODE.txt"),
-    )
-  ) {
-    const data = fs.readFileSync(
-      path.join(process.cwd(), "node_modules", "artes", "EXIT_CODE.txt"),
-      "utf8",
-    );
-    process.env.EXIT_CODE = parseInt(data, 10);
-  }
 
+    if (!( process.env.TRACE === "true"
+      ? process.env.TRACE
+      : artesConfig.trace || false)) {
+      spawnSync(
+        "npx",
+        [
+          "rimraf",
+          "--no-glob",
+          path.join(process.cwd(), "traces"),
+        ],
+        {
+          cwd: process.cwd(),
+          stdio: "inherit",
+          shell: false,
+        },
+      );
+    }
+    
   cleanUp();
   process.exit(process.env.EXIT_CODE);
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "artes",
-  "version": "1.4.4",
+  "version": "1.4.5",
   "description": "The simplest way to automate UI and API tests using Cucumber-style steps.",
   "main": "index.js",
   "scripts": {
@@ -30,6 +30,7 @@
     "dayjs": "1.11.13",
     "deasync": "^0.1.31",
     "playwright": "^1.58.2",
+    "proper-lockfile": "^4.1.2",
     "rimraf": "6.0.1"
   },
   "repository": {

package/src/helper/executers/helper.js

@@ -54,6 +54,9 @@ function showHelp() {
       
             🌐 --env           Set environment for the test run
                 Usage:   artes --env "dev"
+
+            --saveVar         Set variables from cli
+                        artes --saveVar '{"armud":20,"banana":200}'
       
             🕶️ --headless      Run browser in headless mode
                 Usage:   artes --headless

package/src/helper/executers/projectCreator.js

@@ -47,6 +47,7 @@ function createProject(createYes, noDeps) {
 
     // Configuration options:
     // env: "",                      // string - Environment name for tests
+    // variables: {}                 // object - Variables for tests
     // testPercentage: 0,            // number - Minimum success rate percentage(Default: 0)
     // baseURL: "",                  // string - Base URL for API tests
     // paths: [],                    // string[] - Paths to feature files
@@ -56,6 +57,7 @@ function createProject(createYes, noDeps) {
     // slowMo: 0,                    // number - Slow down test execution (Default: 0 seconds)
     // parallel: 0,                  // number - Number of parallel workers
     // report: true                  // boolean - Generate report
+    // zip: false                    // boolean - Generate zip of report
     // reportSuccess: false,         // boolean - Add screenshots and video records to report also for success test cases
     // trace: false,                 // boolean - Enable tracing
     // reportWithTrace: false,       // boolean - Include trace in report

package/src/helper/imports/commons.js

@@ -35,7 +35,7 @@ const moduleConfig = {
   stepsPath: path.join(projectPath, "/tests/steps/*.js"),
   pomPath: path.join(projectPath, "/tests/POMs"),
   cleanUpPaths:
-    "allure-result allure-results test-results @rerun.txt testsStatus EXIT_CODE.txt pomDuplicateWarnings.json",
+    "allure-result allure-results test-results @rerun.txt testsStatus pomDuplicateWarnings.json",
 };
 
 module.exports = {

package/src/hooks/hooks.js

@@ -8,18 +8,16 @@ const {
   BeforeStep,
   AfterAll,
 } = require("@cucumber/cucumber");
-const { spawnSync } = require("child_process");
 const { invokeBrowser } = require("../helper/contextManager/browserManager");
 const { invokeRequest } = require("../helper/contextManager/requestManager");
 const {
-  pomCollector,
-  logPomWarnings,
+  pomCollector
 } = require("../helper/controller/pomCollector");
 const cucumberConfig = require("../../cucumber.config");
 const { context } = require("./context");
 const fs = require("fs");
 const path = require("path");
-const { moduleConfig } = require("artes/src/helper/imports/commons");
+const { moduleConfig, saveVar } = require("artes/src/helper/imports/commons");
 require("allure-cucumberjs");
 const allure = require("allure-js-commons");
 
@@ -44,11 +42,26 @@ async function attachResponse(attachFn) {
 }
 
 function saveTestStatus(result, pickle) {
+
   fs.mkdirSync(statusDir, { recursive: true });
-  fs.writeFileSync(
-    path.join(statusDir, `${result.status}-${pickle.id}.txt`),
-    "",
-  );
+  
+   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');
+
+   const timestamp = `${YYYY}${MM}${DD}-${hh}${mm}${ss}-${ms}`;
+
+   const fileName = `${result.status}-${pickle.name}-${pickle.id}-${timestamp}.txt`;
+
+   const filePath = path.join(statusDir, fileName);
+
+  fs.writeFileSync(filePath, "");
+
 }
 
 const projectHooksPath = path.resolve(
@@ -81,6 +94,15 @@ BeforeAll(async () => {
 Before(async function ({pickle}) {
   context.vars = {};
 
+  const vars = await cucumberConfig.variables
+
+  if (vars && typeof vars === "object") {
+    for (let [key, value] of Object.entries(vars)) {
+
+       saveVar(value, key);
+    }
+  }
+
   const envFilePath = path.join(
     moduleConfig.projectPath,
     "tests",
@@ -142,7 +164,7 @@ AfterStep(async function ({ pickleStep }) {
   }
 });
 
-After(async function ({ pickle, result }) {
+After(async function ({result, pickle}) {
   if (typeof projectHooks.After === "function") {
     await projectHooks.After();
   }
@@ -156,12 +178,12 @@ After(async function ({ pickle, result }) {
     await allure.attachment("Screenshot", screenshotBuffer, "image/png");
   }
 
-  saveTestStatus(result, pickle);
+  if(cucumberConfig.default.testPercentage>0) saveTestStatus(result, pickle);
 
   if (cucumberConfig.default.reportWithTrace || cucumberConfig.default.trace) {
     var tracePath = path.join(
       moduleConfig.projectPath,
-      `./traces/${pickle.name.replaceAll(" ", "_")}.zip`,
+      `./traces/${pickle.name.replaceAll(" ", "_")}-${pickle.id}.zip`,
     );
   }
 
@@ -212,55 +234,4 @@ AfterAll(async () => {
     await projectHooks.AfterAll();
   }
 
-  logPomWarnings();
-
-  if (!cucumberConfig.default.trace) {
-    spawnSync(
-      "npx",
-      [
-        "rimraf",
-        "--no-glob",
-        path.join(moduleConfig.projectPath, "./traces"),
-      ],
-      {
-        cwd: moduleConfig.projectPath,
-        stdio: "inherit",
-        shell: false,
-      },
-    );
-  }
-
-  if (!fs.existsSync(statusDir)) return;
-
-  const files = fs.readdirSync(statusDir);
-  const passedCount = files.filter((f) => f.split("-")[0] === "PASSED").length;
-  const totalTests = files.length;
-  const successPercentage = (passedCount / totalTests) * 100;
-
-  const failed = files.filter((f) => f.split("-")[0] === "FAILED").length;
-
-  if (failed > 0) {
-    spawnSync("mv", ["@rerun.txt", moduleConfig.projectPath], {
-      cwd: path.join(moduleConfig.projectPath, "node_modules", "artes"),
-      stdio: "ignore",
-      shell: true,
-    });
-  }
-
-  if (cucumberConfig.default.testPercentage > 0) {
-    const meetsThreshold =
-      successPercentage >= cucumberConfig.default.testPercentage;
-
-    if (meetsThreshold) {
-      console.log(
-        `✅ Tests passed required ${cucumberConfig.default.testPercentage}% success rate with ${successPercentage.toFixed(2)}%!`,
-      );
-      fs.writeFileSync(path.join(process.cwd(), "EXIT_CODE.txt"), "0");
-    } else {
-      console.log(
-        `❌ Tests failed required ${cucumberConfig.default.testPercentage}% success rate with ${successPercentage.toFixed(2)}%!`,
-      );
-      fs.writeFileSync(path.join(process.cwd(), "EXIT_CODE.txt"), "1");
-    }
-  }
 });