artes 1.0.83 → 1.0.85

package/README.md

@@ -42,21 +42,27 @@ npx artes [options]
 
 ### Options
 
-| Option             | Description                                                                | Usage Example                                                          |
-| ------------------ | -------------------------------------------------------------------------- | ---------------------------------------------------------------------- |
-| 🆘 `-h, --help`    | Show the usage options                                                     | `artes -h` or `artes --help`                                           |
-| 🏷️ `-v, --version` | Show the current version of Artes                                          | `artes -v` or `artes --version`                                        |
-| 🏗️ `-c, --create`  | Create an example project with Artes                                       | `artes -c` or `artes --create`                                         |
-| ✅ `-y, --yes`     | Skip the confirmation prompt when creating an example project              | `artes -c -y` or `artes --create --yes`                                |
-| 📊 `-r, --report`  | Run tests and generate Allure report                                       | `artes -r` or `artes --report`                                         |
-| 📁 `--features`    | Specify one or more feature files' relative paths to run (comma-separated) | `artes --features "tests/features/Alma, tests/features/Banan.feature"` |
-| 🔖 `--tags`        | Run tests with specified Cucumber tags                                     | `artes --tags "@smoke or @wip"`                                        |
-| 🌐 `--env`         | Set the environment for the test run                                       | `artes --env "dev"`                                                    |
-| 🕶️ `--headless`    | Run browser in headless mode                                               | `artes --headless`                                                     |
-| ⚡ `--parallel`    | Run tests in parallel mode                                                 | `artes --parallel 2`                                                   |
-| 🔁 `--retry`       | Retry failed tests                                                         | `artes --retry 3`                                                      |
-| 🎭 `--dryrun`      | Perform a dry run without executing tests                                  | `artes --dryrun`                                                       |
-| 📈 `--percentage`  | Set minimum success percentage to pass test run(default is 0)                            | `artes --percentage 85`                                                |
+| Option              | Description                                                                | Usage Example                                                         |
+| ------------------- | -------------------------------------------------------------------------- | --------------------------------------------------------------------- |
+| 🆘 `-h, --help`     | Show the usage options                                                     | `artes -h` or `artes --help`                                          |
+| 🏷️ `-v, --version` | Show the current version of Artes                                          | `artes -v` or `artes --version`                                       |
+| 🏗️ `-c, --create`  | Create an example project with Artes                                       | `artes -c` or `artes --create`                                        |
+| ✅ `-y, --yes`       | Skip the confirmation prompt when creating an example project              | `artes -c -y` or `artes --create --yes`                               |
+| 📊 `-r, --report`   | Run tests and generate Allure report                                       | `artes -r` or `artes --report`                                        |
+| 📁 `--features`     | Specify one or more feature files' relative paths to run (comma-separated) | `artes --features "tests/features/Alma,tests/features/Banan.feature"` |
+| 🔖 `--tags`         | Run tests with specified Cucumber tags                                     | `artes --tags "@smoke or @wip"`                                       |
+| 🌐 `--env`          | Set the environment for the test run                                       | `artes --env "dev"`                                                   |
+| 🕶️ `--headless`    | Run browser in headless mode                                               | `artes --headless`                                                    |
+| ⚡ `--parallel`      | Run tests in parallel mode                                                 | `artes --parallel 2`                                                  |
+| 🔁 `--retry`        | Retry failed tests                                                         | `artes --retry 3`                                                     |
+| 🎭 `--dryrun`       | Perform a dry run without executing tests                                  | `artes --dryrun`                                                      |
+| 📈 `--percentage`   | Set minimum success percentage to pass test run (default is 0)             | `artes --percentage 85`                                               |
+| 🌍 `--browser`      | Specify browser to use (`chromium`, `firefox`, or `webkit`)                | `artes --browser chromium`                                            |
+| 🔗 `--baseURL`      | Set base URL for the tests                                                 | `artes --baseURL "https://example.com"`                               |
+| 🖥️ `--maxScreen`   | Maximize browser window on launch                                          | `artes --maxScreen`                                                   |
+| 📏 `--width`        | Set browser width (default is 1280)                                        | `artes --width 1920`                                                  |
+| 📐 `--height`       | Set browser height (default is 720)                                        | `artes --height 1080`                                                 |
+| ⏱️ `--timeout`      | Set timeout for each test step in seconds (default is 30)                  | `artes --timeout 10`                                                  |
 
 \*\* To just run the tests: <br>
 Globally: artes <br>

package/cucumber.config.js

@@ -20,7 +20,9 @@ module.exports = {
     testPercentage: process.env.PERCENTAGE
       ? Number(process.env.PERCENTAGE)
       : artesConfig.testPercentage || 0, // number - Percentage of tests to run (0-100)
-    timeout: artesConfig.timeout || 30, // Default timeout in milliseconds
+    timeout: process.env.TIMEOUT
+      ? Number(process.env.TIMEOUT)
+      : artesConfig.timeout || 30, // Default timeout in milliseconds
     paths: process.env.FEATURES
       ? [path.join(moduleConfig.projectPath, process.env.FEATURES)]
       : artesConfig.features
@@ -54,7 +56,7 @@ module.exports = {
       ? Number(process.env.PARALLEL)
       : artesConfig.parallel || 1, // Number of parallel workers
     dryRun: process.env.DRYRUN
-      ? JSON.parse(process.env.DRYRUN)
+      ? process.env.DRYRUN
       : artesConfig.dryRun || false, // Prepare test run without execution
     failFast: artesConfig.failFast || false, // Stop on first test failure
     forceExit: artesConfig.forceExit || false, // Force process.exit() after tests
@@ -75,7 +77,7 @@ module.exports = {
 
     // Retry logic
     retry: process.env.RETRY
-      ? JSON.parse(process.env.RETRY)
+      ? Number(process.env.RETRY)
       : artesConfig.retry || 0, // Retry attempts for failing tests
     retryTagFilter: artesConfig.retryTagFilter || "", // Tag expression for retries
 
@@ -86,16 +88,27 @@ module.exports = {
     worldParameters: artesConfig.worldParameters || {}, // Custom world parameters
   },
   env: process.env.ENV ? JSON.parse(process.env.ENV) : artesConfig.env || "",
-  baseURL: artesConfig?.baseURL ? artesConfig?.baseURL : "",
+  baseURL: process.env.BASE_URL
+    ? JSON.parse(process.env.BASE_URL)
+    : artesConfig?.baseURL
+      ? artesConfig?.baseURL
+      : "",
 
   browser: {
-    browserType: artesConfig?.browser || "chrome",
+    browserType: process.env.BROWSER
+      ? JSON.parse(process.env.BROWSER)
+      : artesConfig?.browser || "chrome",
     viewport: {
-      width: artesConfig?.width || 1280,
-      height: artesConfig?.height || 720,
+      width: process.env.WIDTH
+        ? Number(process.env.WIDTH)
+        : artesConfig?.width || 1280,
+      height: process.env.HEIGHT
+        ? Number(process.env.HEIGHT)
+        : artesConfig?.height || 720,
     },
-    maximizeScreen:
-      artesConfig?.maximizeScreen !== undefined
+    maximizeScreen: process.env.MAXIMIZE_SCREEN
+      ? JSON.parse(process.env.MAXIMIZE_SCREEN)
+      : artesConfig?.maximizeScreen !== undefined
         ? artesConfig.maximizeScreen
         : true,
     headless: process.env.MODE

package/executer.js

@@ -1,5 +1,4 @@
 #!/usr/bin/env node
-
 const {
   showHelp,
   showVersion,
@@ -26,40 +25,82 @@ const flags = {
   retry: args.includes("--retry"),
   dryrun: args.includes("--dryrun"),
   percentage: args.includes("--percentage"),
+  browser: args.includes("--browser"),
+  baseURL: args.includes("--baseURL"),
+  maximizeScreen: args.includes("--maxScreen"),
+  width: args.includes("--width"),
+  height: args.includes("--height"),
+  timeout: args.includes("--timeout"),
 };
 
+const env = args[args.indexOf("--env") + 1];
+const featureFiles = args[args.indexOf("--features") + 1];
+const features = flags.features && featureFiles;
+const tags = args[args.indexOf("--tags") + 1];
+const parallel = args[args.indexOf("--parallel") + 1];
+const retry = args[args.indexOf("--retry") + 1];
+const percentage = args[args.indexOf("--percentage") + 1];
+const browser = args[args.indexOf("--browser") + 1];
+const baseURL = args[args.indexOf("--baseURL") + 1];
+const width = args[args.indexOf("--width") + 1];
+const height = args[args.indexOf("--height") + 1];
+const timeout = args[args.indexOf("--timeout") + 1];
+
+flags.env && console.log("Running env:", env);
+flags.env ? (process.env.ENV = JSON.stringify(env)) : "";
+
+flags.report
+  ? (process.env.REPORT_FORMAT = JSON.stringify([
+      "rerun:@rerun.txt",
+      "progress-bar",
+      "allure-cucumberjs/reporter:./allure-results",
+    ]))
+  : "";
+
+flags.tags && console.log("Running tags:", tags);
+flags.tags ? (process.env.RUN_TAGS = JSON.stringify(tags)) : "";
+
+flags.features && console.log("Running features:", features);
+flags.features ? (process.env.FEATURES = features) : "";
+
+flags.headless &&
+  console.log("Running mode:", flags.headless ? "headless" : "headed");
+flags.headless ? (process.env.MODE = JSON.stringify(true)) : false;
+
+flags.parallel ? (process.env.PARALLEL = parallel) : "";
+
+flags.retry ? (process.env.RETRY = retry) : "";
+
+flags.dryrun ? (process.env.DRYRUN = flags.dryrun) : "";
+
+flags.percentage ? (process.env.PERCENTAGE = percentage) : "";
+
+flags.browser && console.log("Running browser:", browser);
+flags.browser ? (process.env.BROWSER = JSON.stringify(browser)) : "";
+
+flags.baseURL ? (process.env.BASE_URL = JSON.stringify(baseURL)) : "";
+
+flags.maximizeScreen
+  ? (process.env.MAXIMIZE_SCREEN = flags.maximizeScreen)
+  : "";
+
+flags.width && console.log("Running width:", width);
+flags.width ? (process.env.WIDTH = width) : "";
+
+flags.height && console.log("Running height:", height);
+flags.height ? (process.env.HEIGHT = height) : "";
+
+flags.timeout ? (process.env.TIMEOUT = timeout) : "";
+
 function main() {
-  if (flags.help) {
-    showHelp();
-    return;
-  }
-
-  if (flags.version) {
-    showVersion();
-    return;
-  }
-
-  if (flags.create) {
-    createProject(flags.createYes);
-    return;
-  }
-
-  // if (flags.trace) {
-  //   runTests();
-  //   tracer();
-  //   cleanUp();
-  // }
-
-  if (flags.report) {
-    const result = runTests(args, flags)
-    generateReport();
-    cleanUp();
-    process.exit(result.status);
-} else {
-  const result = runTests(args, flags);
+  if (flags.help) return showHelp();
+  if (flags.version) return showVersion();
+  if (flags.create) return createProject(flags.createYes);
+
+  runTests();
+  if (flags.report) generateReport();
   cleanUp();
-  process.exit(result.status);
-}
+  process.exit(process.env.EXIT_CODE);
 }
 
 main();

package/package.json

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

package/src/helper/executers/cleaner.js

@@ -3,18 +3,14 @@ const { spawnSync } = require("child_process");
 
 function cleanUp() {
   try {
-    const result = spawnSync(
-      "npm",
-      ["run", "clean", moduleConfig.cleanUpPaths],
-      {
-        cwd: moduleConfig.modulePath,
-        stdio: "ignore",
-        shell: true,
-      },
-    );
+    spawnSync("npm", ["run", "clean", moduleConfig.cleanUpPaths], {
+      cwd: moduleConfig.modulePath,
+      stdio: "ignore",
+      shell: true,
+    });
   } catch (error) {
     console.error("❌ Error in cleanup:", error.message);
-    process.exit(1);
+    process.env.EXIT_CODE = 1;
   }
 }
 

package/src/helper/executers/helper.js

@@ -48,6 +48,24 @@ function showHelp() {
 
             📈 --percentage    Set minimum success percentage to pass test run
                 Usage:   artes --percentage 85
+
+            🌐 --browser       Specify browser to use (chromium, firefox, webkit)
+                Usage:   artes --browser chromium
+
+            🌐 --baseURL       Set base URL for the tests
+                Usage:   artes --baseURL "https://example.com"
+
+            📏 --maxScreen     Maximize browser window
+                Usage:   artes --maxScreen
+
+            📐 --width         Set browser width (default: 1280)
+                Usage:   artes --width 1920
+
+            📏 --height        Set browser height (default: 720)
+                Usage:   artes --height 1080
+
+            ⏱️ --timeout       Set timeout for each test step (default: 30 seconds)
+                Usage:   artes --timeout 10
       `);
 }
 

package/src/helper/executers/projectCreator.js

@@ -40,7 +40,7 @@ function createProject(createYes) {
 
     // Configuration options:
     // env: "",                      // string - Environment name for tests
-    //testPercentage: 0, // number - Minimum success rate percentage(Default: 0)
+    // testPercentage: 0, // number - Minimum success rate percentage(Default: 0)
     // baseURL: "",                  // string - Base URL for API tests
     // paths: [],                    // string[] - Paths to feature files
     // steps: "",                    // string - Step definitions files

package/src/helper/executers/reportGenerator.js

@@ -5,22 +5,18 @@ function generateReport() {
   try {
     console.log("📊 Generating report...");
 
-    const result = spawnSync(
-      "npm",
-      ["run", "testWithReport", moduleConfig.reportPath],
-      {
-        cwd: moduleConfig.modulePath,
-        stdio: "ignore",
-        shell: true,
-      },
-    );
+    spawnSync("npm", ["run", "testWithReport", moduleConfig.reportPath], {
+      cwd: moduleConfig.modulePath,
+      stdio: "ignore",
+      shell: true,
+    });
 
     console.log(
       `📋 Report generated successfully in ${moduleConfig.reportPath}!`,
     );
   } catch (error) {
     console.error("❌ Report generation failed:", error);
-    process.exit(1);
+    process.env.EXIT_CODE = 1;
   }
 }
 

package/src/helper/executers/testRunner.js

@@ -1,51 +1,13 @@
 const { spawnSync } = require("child_process");
 const { moduleConfig } = require("../imports/commons");
-const path = require("path");
 
-function runTests(args, flags) {
-  const env = args[args.indexOf("--env") + 1];
-
-  const featureFiles = args[args.indexOf("--features") + 1];
-  const features = flags.features && featureFiles;
-
-  const tags = args[args.indexOf("--tags") + 1];
-  const parallel = args[args.indexOf("--parallel") + 1];
-  const retry = args[args.indexOf("--retry") + 1];
-  const percentage = args[args.indexOf("percentage") + 1];
-
-  flags.env && console.log("Running env:", env);
-  flags.env ? (process.env.ENV = JSON.stringify(env)) : "";
-
-  flags.report
-    ? (process.env.REPORT_FORMAT = JSON.stringify([
-        "rerun:@rerun.txt",
-        "progress-bar",
-        "allure-cucumberjs/reporter:./allure-results",
-      ]))
-    : "";
-
-  flags.tags && console.log("Running tags:", tags);
-  flags.tags ? (process.env.RUN_TAGS = JSON.stringify(tags)) : "";
-
-  flags.features && console.log("Running features:", features);
-  flags.features ? (process.env.FEATURES = features) : "";
-
-  flags.headless &&
-    console.log("Running mode:", flags.headless ? "headless" : "headed");
-  flags.headless ? (process.env.MODE = JSON.stringify(true)) : false;
-
-  flags.parallel ? (process.env.PARALLEL = parallel) : "";
-  flags.retry ? (process.env.RETRY = JSON.stringify(retry)) : "";
-  flags.dryrun ? (process.env.DRYRUN = JSON.stringify(true)) : "";
-  flags.percentage ? (process.env.PERCENTAGE = percentage) : "";
-    
- 
+function runTests() {
   try {
     console.log("🧪 Running tests...");
     process.env.FORCE_COLOR = "1";
     process.env.FORCE_STDIO_TTY = "1";
 
-    const result = spawnSync("cucumber-js", ["--config=cucumber.config.js"], {
+    spawnSync("cucumber-js", ["--config=cucumber.config.js"], {
       cwd: moduleConfig.modulePath,
       stdio: "inherit",
       shell: true,
@@ -57,10 +19,9 @@ function runTests(args, flags) {
       },
     });
     console.log("✅ Tests running completed successfully!");
-    return result;
   } catch (error) {
     console.error("❌ Test execution failed:", error);
-    process.exit(1);
+    process.env.EXIT_CODE = 1;
   }
 }
 

package/src/helper/imports/commons.js

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

package/src/hooks/hooks.js

@@ -17,8 +17,7 @@ const fs = require("fs");
 const { moduleConfig } = require("artes/src/helper/imports/commons");
 const path = require("path");
 
-let totalTests = 0;
-let testsFailed = 0;
+const statusDir = path.join(process.cwd(), "testsStatus");
 
 setDefaultTimeout(cucumberConfig.default.timeout * 1000);
 
@@ -27,7 +26,6 @@ BeforeAll(async function () {
 });
 
 Before(async function () {
-  totalTests++;
   context.vars = {};
 
   const { browser, context: browserContext } = await invokeBrowser();
@@ -81,7 +79,13 @@ AfterStep(async function ({ pickleStep }) {
 
 After(async function ({ pickle, result }) {
   if (result?.status != Status.PASSED) {
-    testsFailed++;
+    fs.mkdirSync(statusDir, { recursive: true });
+
+    fs.writeFileSync(
+      path.join(statusDir, `${result.status}-${pickle.id}.txt`),
+      "",
+    );
+
     let img = await context.page.screenshot({
       path: `./test-results/visualReport/${pickle.name}/${pickle.name}.png`,
       type: "png",
@@ -127,21 +131,27 @@ After(async function ({ pickle, result }) {
 });
 
 AfterAll(async function () {
-  const successPercentage = 100 - (testsFailed / totalTests) * 100;
+  const files = fs.readdirSync(statusDir);
+  const passedCount = files.filter(
+    (file) => file.split("-")[0] === "PASSED",
+  ).length;
+  const totalTests = files.length;
+
+  const successPercentage = (passedCount / totalTests) * 100;
   const successRate =
-    successPercentage.toFixed(2) >= cucumberConfig.default.testPercentage;
+    successPercentage.toFixed(2) > cucumberConfig.default.testPercentage;
 
-    if (!isNaN(successPercentage)) {
+  if (!isNaN(successPercentage)) {
     if (successRate) {
       console.log(
         `Tests passed required ${cucumberConfig.default.testPercentage}% success rate with ${successPercentage.toFixed(2)}% !`,
       );
-      process.exit(0);
+      process.env.EXIT_CODE = 0;
     } else {
       console.log(
         `Tests failed at required ${cucumberConfig.default.testPercentage}% success rate with ${successPercentage.toFixed(2)}%!`,
       );
-      process.exit(1);
+      process.env.EXIT_CODE = 1;
     }
   }
 });