artes 1.2.23 → 1.2.25

package/README.md

@@ -122,7 +122,7 @@ npx artes [options]
 | 🕶️ `--headless`           | Run browser in headless mode                                                       | `artes --headless`                                                    |
 | ⚡ `--parallel`           | Run tests in parallel mode                                                         | `artes --parallel 2`                                                  |
 | 🔁 `--retry`              | Retry failed tests                                                                 | `artes --retry 3`                                                     |
-| 🔁 `--rerun`              | Rerun only the failed tests from previous run                                                                 | `artes --rerun @rerun.txt`|
+| 🔁 `--rerun`              | Rerun only the failed tests from previous run                                      | `artes --rerun @rerun.txt`                                            |
 | 🎭 `--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`                                            |

package/cucumber.config.js

@@ -90,11 +90,15 @@ module.exports = {
       ? true
       : artesConfig.reportSuccess || false, // Include successful tests in report
 
-    trace: process.env.TRACE === "true" ? process.env.TRACE : artesConfig.trace || false, // Enable tracing
-
-    reportWithTrace: process.env.REPORT_WITH_TRACE === "true"
-      ? process.env.REPORT_WITH_TRACE
-      : artesConfig.reportWithTrace || false, // Include trace in report
+    trace:
+      process.env.TRACE === "true"
+        ? process.env.TRACE
+        : artesConfig.trace || false, // Enable tracing
+
+    reportWithTrace:
+      process.env.REPORT_WITH_TRACE === "true"
+        ? process.env.REPORT_WITH_TRACE
+        : artesConfig.reportWithTrace || false, // Include trace in report
 
     format: finalFormats, // Formatter names/paths
     formatOptions: artesConfig.formatOptions || {

package/docs/functionDefinitions.md

@@ -434,6 +434,7 @@ await getURL();
 ```
 
 - **Returns**:
+
   - _(string)_: The current page URL.
 
   ***
@@ -655,6 +656,7 @@ await shouldHaveId("#element-id", "unique-id");
 ```
 
 - **Parameters**:
+
   - `id` _(string)_: The expected ID.
 
   Got it! Here’s the refined format for the assertion methods:
@@ -1542,6 +1544,7 @@ await shouldObjectContaining(".element", { key: "value" });
 ```
 
 - **Parameters**:
+
   - `selector` _(string)_: The CSS selector for the element.
   - `properties` _(object)_: The object properties to check for.
 

package/executer.js

@@ -111,7 +111,7 @@ flags.parallel ? (process.env.PARALLEL = parallel) : "";
 
 flags.retry ? (process.env.RETRY = retry) : "";
 
-flags.rerun ? ( process.env.RERUN = rerun) : "";
+flags.rerun ? (process.env.RERUN = rerun) : "";
 
 flags.dryRun ? (process.env.DRYRUN = flags.dryRun) : "";
 

package/package.json

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

package/src/helper/executers/projectCreator.js

@@ -23,7 +23,7 @@ function createProject(createYes, noDeps) {
   });
 
   if (!noDeps) {
-    execSync("npm i artes", { cwd: projectDir, stdio: "inherit" });
+    execSync("npm i artes@latest", { cwd: projectDir, stdio: "inherit" });
     console.log("📦 Setting up browsers...");
     execSync("npx playwright install", { cwd: projectDir, stdio: "inherit" });
   }
@@ -40,10 +40,6 @@ function createProject(createYes, noDeps) {
     testWithReport: "npx artes -r",
   };
 
-  packageJson.dependencies = {
-    artes: "1.2.21",
-  };
-
   fs.writeFileSync(packageJsonPath, JSON.stringify(packageJson, null, 2));
 
   const config = `module.exports = {

package/src/helper/executers/reportGenerator.js

@@ -29,7 +29,6 @@ function generateReport() {
       `📋 Report generated successfully in ${moduleConfig.reportPath}!`,
     );
 
-
     if (fs.existsSync(moduleConfig.reportPath) && process.env.ZIP === "true") {
       console.log(`🗜️ Zipping report folder`);
 
@@ -61,8 +60,7 @@ function generateReport() {
 
       console.log(`🗜️ Zipped in ${moduleConfig.reportPath}/report.zip!`);
       if (error) throw error;
-    } 
-    
+    }
   } catch (err) {
     console.error("❌ Report generation failed:", err);
     process.env.EXIT_CODE = 1;

package/src/helper/executers/testRunner.js

@@ -8,17 +8,24 @@ function runTests() {
     process.env.FORCE_COLOR = "1";
     process.env.FORCE_STDIO_TTY = "1";
 
-    spawnSync("cucumber-js", ["--config=cucumber.config.js", `${process.env.RERUN ? path.join("../../", process.env.RERUN) : ""}`], {
-      cwd: moduleConfig.modulePath,
-      stdio: "inherit",
-      shell: true,
-      env: {
-        ...process.env,
-        FORCE_TTY: "1",
-        FORCE_COLOR: "1",
-        CI: "false",
+    spawnSync(
+      "cucumber-js",
+      [
+        "--config=cucumber.config.js",
+        `${process.env.RERUN ? path.join("../../", process.env.RERUN) : ""}`,
+      ],
+      {
+        cwd: moduleConfig.modulePath,
+        stdio: "inherit",
+        shell: true,
+        env: {
+          ...process.env,
+          FORCE_TTY: "1",
+          FORCE_COLOR: "1",
+          CI: "false",
+        },
       },
-    });
+    );
     console.log("✅ Tests running completed successfully!");
   } catch (error) {
     console.error("❌ Test execution failed:", error);

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 testsStatus EXIT_CODE.txt",
+    "allure-result allure-results test-results @rerun.txt testsStatus EXIT_CODE.txt",
 };
 
 module.exports = {

package/src/helper/stepFunctions/APIActions.js

@@ -28,6 +28,58 @@ function getMimeType(filePath) {
   return mimeTypes[ext] || "application/octet-stream";
 }
 
+function curlExtractor(url, method, headers, body, requestDataType) {
+  let curlCommand = `curl -X ${method} '${url}'`;
+
+  if (headers && Object.keys(headers).length > 0) {
+    for (const [key, value] of Object.entries(headers)) {
+      curlCommand += ` \\\n  -H '${key}: ${value}'`;
+    }
+  }
+
+  if (body && Object.keys(body).length > 0) {
+    switch (requestDataType) {
+      case "multipart":
+        for (const [key, value] of Object.entries(body)) {
+          if (typeof value === "object" && value.buffer) {
+            curlCommand += ` \\\n  -F '${key}=@${value.name}'`;
+          } else {
+            curlCommand += ` \\\n  -F '${key}=${value}'`;
+          }
+        }
+        break;
+
+      case "urlencoded":
+      case "application/x-www-form-urlencoded":
+        const urlEncodedData = new URLSearchParams(body).toString();
+        curlCommand += ` \\\n  --data-urlencode '${urlEncodedData}'`;
+        break;
+
+      case "form":
+        for (const [key, value] of Object.entries(body)) {
+          curlCommand += ` \\\n  -F '${key}=${value}'`;
+        }
+        break;
+
+      default:
+        const hasContentType =
+          headers &&
+          Object.keys(headers).some(
+            (key) => key.toLowerCase() === "content-type",
+          );
+
+        if (!hasContentType) {
+          curlCommand += ` \\\n  -H 'Content-Type: application/json'`;
+        }
+
+        curlCommand += ` \\\n  --data-raw '${JSON.stringify(body)}'`;
+        break;
+    }
+  }
+
+  return curlCommand;
+}
+
 function processForm(requestBody) {
   let formData = {};
   for (const [key, value] of Object.entries(requestBody)) {
@@ -108,7 +160,7 @@ async function requestMaker(headers, data, requestDataType) {
   return request;
 }
 
-async function responseMaker(request, response, duration) {
+async function responseMaker(request, response, duration, curlCommand) {
   const responseObject = {};
 
   response &&
@@ -139,6 +191,8 @@ async function responseMaker(request, response, duration) {
     }
   }
 
+  curlCommand && Object.assign(responseObject, { "cURL Command": curlCommand });
+
   return responseObject;
 }
 
@@ -157,7 +211,15 @@ const api = {
 
     const duration = performance.now() - requestStarts;
 
-    const response = responseMaker(payloadJSON, res, duration);
+    const curlCommand = curlExtractor(
+      res.url(),
+      "GET",
+      payloadJSON?.headers || {},
+      null,
+      null,
+    );
+
+    const response = responseMaker(payloadJSON, res, duration, curlCommand);
 
     context.response = await response;
   },
@@ -170,7 +232,9 @@ const api = {
 
     const duration = performance.now() - requestStarts;
 
-    const response = responseMaker(payloadJSON, res, duration);
+    const curlCommand = curlExtractor(res.url(), "HEAD", {}, null, null);
+
+    const response = responseMaker(null, res, duration, curlCommand);
 
     context.response = await response;
   },
@@ -181,6 +245,7 @@ const api = {
     const payloadJSON = (await resolvedPayload) && JSON.parse(resolvedPayload);
 
     let req;
+    let bodyForCurl = payloadJSON?.body || {};
 
     switch (requestDataType) {
       case "multipart":
@@ -191,6 +256,7 @@ const api = {
           formRequest || {},
           requestDataType,
         );
+        bodyForCurl = formRequest;
         break;
       case "urlencoded":
       case "application/x-www-form-urlencoded":
@@ -223,7 +289,20 @@ const api = {
 
     const duration = performance.now() - requestStarts;
 
-    const response = await responseMaker(payloadJSON, res, duration);
+    const curlCommand = curlExtractor(
+      res.url(),
+      "POST",
+      req.headers,
+      bodyForCurl,
+      requestDataType,
+    );
+
+    const response = await responseMaker(
+      payloadJSON,
+      res,
+      duration,
+      curlCommand,
+    );
 
     context.response = response;
   },
@@ -234,6 +313,7 @@ const api = {
     const payloadJSON = (await resolvedPayload) && JSON.parse(resolvedPayload);
 
     let req;
+    let bodyForCurl = payloadJSON?.body || {};
 
     switch (requestDataType) {
       case "multipart":
@@ -244,6 +324,7 @@ const api = {
           formRequest || {},
           requestDataType,
         );
+        bodyForCurl = formRequest;
         break;
       case "urlencoded":
       case "application/x-www-form-urlencoded":
@@ -276,7 +357,20 @@ const api = {
 
     const duration = performance.now() - requestStarts;
 
-    const response = await responseMaker(payloadJSON, res, duration);
+    const curlCommand = curlExtractor(
+      res.url(),
+      "PUT",
+      req.headers,
+      bodyForCurl,
+      requestDataType,
+    );
+
+    const response = await responseMaker(
+      payloadJSON,
+      res,
+      duration,
+      curlCommand,
+    );
 
     context.response = response;
   },
@@ -287,6 +381,7 @@ const api = {
     const payloadJSON = (await resolvedPayload) && JSON.parse(resolvedPayload);
 
     let req;
+    let bodyForCurl = payloadJSON?.body || {};
 
     switch (requestDataType) {
       case "multipart":
@@ -297,6 +392,7 @@ const api = {
           formRequest || {},
           requestDataType,
         );
+        bodyForCurl = formRequest;
         break;
       case "urlencoded":
       case "application/x-www-form-urlencoded":
@@ -329,7 +425,20 @@ const api = {
 
     const duration = performance.now() - requestStarts;
 
-    const response = await responseMaker(payloadJSON, res, duration);
+    const curlCommand = curlExtractor(
+      res.url(),
+      "PATCH",
+      req.headers,
+      bodyForCurl,
+      requestDataType,
+    );
+
+    const response = await responseMaker(
+      payloadJSON,
+      res,
+      duration,
+      curlCommand,
+    );
 
     context.response = response;
   },
@@ -350,7 +459,15 @@ const api = {
 
     const duration = performance.now() - requestStarts;
 
-    const response = responseMaker(payloadJSON, res, duration);
+    const curlCommand = curlExtractor(
+      res.url(),
+      "DELETE",
+      payloadJSON?.headers || {},
+      payloadJSON?.body || {},
+      null,
+    );
+
+    const response = responseMaker(payloadJSON, res, duration, curlCommand);
 
     context.response = await response;
   },

package/src/hooks/hooks.js

@@ -103,7 +103,7 @@ Before(async function () {
 
   await context.page.setDefaultTimeout(cucumberConfig.default.timeout);
 
-  if ( cucumberConfig.default.reportWithTrace || cucumberConfig.default.trace) {
+  if (cucumberConfig.default.reportWithTrace || cucumberConfig.default.trace) {
     await browserContext.tracing.start({
       sources: true,
       screenshots: true,
@@ -142,10 +142,9 @@ After(async function ({ pickle, result }) {
   }
 
   const shouldReport =
-    (cucumberConfig.default.successReport ||
-      result?.status !== Status.PASSED) 
+    cucumberConfig.default.successReport || result?.status !== Status.PASSED;
 
-  if (shouldReport) {
+  if (shouldReport & (context.page.url() !== "about:blank")) {
     const screenshotPath = path.join(
       "test-results",
       "visualReport",
@@ -164,16 +163,17 @@ After(async function ({ pickle, result }) {
   }
 
   saveTestStatus(result, pickle);
-if((cucumberConfig.default.reportWithTrace || cucumberConfig.default.trace)){
-  var tracePath = path.join(
-    moduleConfig.projectPath,
-    `./traces/${pickle.name.replaceAll(" ", "_")}.zip`,
-  );
-}
-
+  if (cucumberConfig.default.reportWithTrace || cucumberConfig.default.trace) {
+    var tracePath = path.join(
+      moduleConfig.projectPath,
+      `./traces/${pickle.name.replaceAll(" ", "_")}.zip`,
+    );
+  }
 
   if (
-    (cucumberConfig.default.reportWithTrace || cucumberConfig.default.trace) && shouldReport && context.page.url() !== "about:blank"
+    (cucumberConfig.default.reportWithTrace || cucumberConfig.default.trace) &&
+    shouldReport &&
+    context.page.url() !== "about:blank"
   ) {
     await context.browserContext.tracing.stop({
       path: tracePath,
@@ -188,11 +188,19 @@ if((cucumberConfig.default.reportWithTrace || cucumberConfig.default.trace)){
       });
 
       if (!cucumberConfig.default.trace) {
-        spawnSync("npx", ["rimraf", "--no-glob", path.join(moduleConfig.projectPath, "./traces")], {
-          cwd: moduleConfig.projectPath,
-          stdio: "inherit",
-          shell: false,
-        });
+        spawnSync(
+          "npx",
+          [
+            "rimraf",
+            "--no-glob",
+            path.join(moduleConfig.projectPath, "./traces"),
+          ],
+          {
+            cwd: moduleConfig.projectPath,
+            stdio: "inherit",
+            shell: false,
+          },
+        );
       }
     }
   }
@@ -204,7 +212,11 @@ if((cucumberConfig.default.reportWithTrace || cucumberConfig.default.trace)){
   await context.browser?.close();
   await context.request?.dispose();
 
-  if (shouldReport && context.page.video) {
+  if (
+    shouldReport &&
+    context.page.video &&
+    context.page.url() !== "about:blank"
+  ) {
     const video = context.page.video();
     if (video) {
       const videoPath = await video.path();
@@ -236,22 +248,27 @@ AfterAll(async () => {
 
   const failed = files.filter((f) => f.split("-")[0] === "FAILED").length;
 
-  if (failed  > 0 ){
+  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 !== undefined) {
-    const meetsThreshold = successPercentage >= cucumberConfig.default.testPercentage;
+    const meetsThreshold =
+      successPercentage >= cucumberConfig.default.testPercentage;
 
     if (meetsThreshold) {
-      console.log(`✅ Tests passed required ${cucumberConfig.default.testPercentage}% success rate with ${successPercentage.toFixed(2)}%!`);
+      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)}%!`,);
+    } 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");
     }
   }

package/src/stepDefinitions/API.steps.js

@@ -7,7 +7,6 @@ const {
   random,
 } = require("../helper/imports/commons");
 const { api } = require("../helper/stepFunctions/exporter");
-const Ajv = require("ajv");
 
 When("User sends GET request to {string}", async function (url) {
   await api.get(url);