artes 1.0.78 → 1.0.79

package/README.md

@@ -56,7 +56,7 @@ npx artes [options]
 | ⚡ `--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               | `artes --percentage 85`                            |
 
 \*\* To just run the tests: <br>
 Globally: artes <br>

package/cucumber.config.js

@@ -17,6 +17,7 @@ try {
 module.exports = {
   default: {
     // File paths and patterns
+    testPercentage: process.env.PERCENTAGE ? process.env.PERCENTAGE : artesConfig.testPercentage || 0, // number - Percentage of tests to run (0-100)
     timeout: artesConfig.timeout || 30, // Default timeout in milliseconds
     paths: process.env.FEATURES
       ? [path.join(moduleConfig.projectPath, process.env.FEATURES)]
@@ -47,8 +48,12 @@ module.exports = {
     }, // Formatter options
 
     // Execution options
-    parallel: process.env.PARALLEL ? JSON.parse(process.env.PARALLEL) : artesConfig.parallel || 1, // Number of parallel workers
-    dryRun: process.env.DRYRUN ? JSON.parse(process.env.DRYRUN) : artesConfig.dryRun || false, // Prepare test run without execution
+    parallel: process.env.PARALLEL
+      ? JSON.parse(process.env.PARALLEL)
+      : artesConfig.parallel || 1, // Number of parallel workers
+    dryRun: process.env.DRYRUN
+      ? JSON.parse(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
     strict: artesConfig.strict || true, // Fail on pending steps
@@ -67,7 +72,9 @@ module.exports = {
     requireModule: artesConfig.requireModule || [], // Transpilation module names
 
     // Retry logic
-    retry: process.env.RETRY ? JSON.parse(process.env.RETRY) : artesConfig.retry || 0, // Retry attempts for failing tests
+    retry: process.env.RETRY
+      ? JSON.parse(process.env.RETRY)
+      : artesConfig.retry || 0, // Retry attempts for failing tests
     retryTagFilter: artesConfig.retryTagFilter || "", // Tag expression for retries
 
     // Publishing

package/docs/functionDefinitions.md

@@ -3,7 +3,14 @@
 If you don't want to deal with Playwright methods directly, you can simply use the following predefined actions methods by import them:
 
 ```javascript
-const { mouse, keyboard, frame, elementInteractions, page, api } = require("artes");
+const {
+  mouse,
+  keyboard,
+  frame,
+  elementInteractions,
+  page,
+  api,
+} = require("artes");
 ```
 
 - **Mouse Actions:**  
@@ -2114,16 +2121,21 @@ The `api` object provides methods for making HTTP requests with automatic URL re
 Makes a GET request to the specified URL.
 
 **Parameters:**
+
 - `url` (string): The target URL (supports variable resolution)
 - `payload` (string, optional): JSON string containing headers and other request options
 
 **Returns:** Promise that resolves when the request completes
 
 **Example:**
+
 ```javascript
-await api.get("https://api.example.com/users", JSON.stringify({
-  headers: { "Authorization": "Bearer {{token}}" }
-}));
+await api.get(
+  "https://api.example.com/users",
+  JSON.stringify({
+    headers: { Authorization: "Bearer {{token}}" },
+  }),
+);
 ```
 
 ### `api.head(url)`
@@ -2131,11 +2143,13 @@ await api.get("https://api.example.com/users", JSON.stringify({
 Makes a HEAD request to the specified URL.
 
 **Parameters:**
+
 - `url` (string): The target URL (supports variable resolution)
 
 **Returns:** Promise that resolves when the request completes
 
 **Example:**
+
 ```javascript
 await api.head("https://api.example.com/status");
 ```
@@ -2145,6 +2159,7 @@ await api.head("https://api.example.com/status");
 Makes a POST request to the specified URL.
 
 **Parameters:**
+
 - `url` (string): The target URL (supports variable resolution)
 - `payload` (string): JSON string containing headers, body, and other request options
 - `requestDataType` (string, optional): Request data type ("multipart" for form data, default for JSON)
@@ -2152,18 +2167,26 @@ Makes a POST request to the specified URL.
 **Returns:** Promise that resolves when the request completes
 
 **Example:**
+
 ```javascript
 // Regular POST request
-await api.post("https://api.example.com/users", JSON.stringify({
-  headers: { "Content-Type": "application/json" },
-  body: { name: "John", email: "john@example.com" }
-}));
+await api.post(
+  "https://api.example.com/users",
+  JSON.stringify({
+    headers: { "Content-Type": "application/json" },
+    body: { name: "John", email: "john@example.com" },
+  }),
+);
 
 // Multipart form data
-await api.post("https://api.example.com/upload", JSON.stringify({
-  headers: {},
-  body: { file: "/path/to/file.pdf", description: "Document upload" }
-}), "multipart");
+await api.post(
+  "https://api.example.com/upload",
+  JSON.stringify({
+    headers: {},
+    body: { file: "/path/to/file.pdf", description: "Document upload" },
+  }),
+  "multipart",
+);
 ```
 
 ### `api.put(url, payload, requestDataType)`
@@ -2171,6 +2194,7 @@ await api.post("https://api.example.com/upload", JSON.stringify({
 Makes a PUT request to the specified URL.
 
 **Parameters:**
+
 - `url` (string): The target URL (supports variable resolution)
 - `payload` (string): JSON string containing headers, body, and other request options
 - `requestDataType` (string, optional): Request data type ("multipart" for form data, default for JSON)
@@ -2178,11 +2202,15 @@ Makes a PUT request to the specified URL.
 **Returns:** Promise that resolves when the request completes
 
 **Example:**
+
 ```javascript
-await api.put("https://api.example.com/users/{{userId}}", JSON.stringify({
-  headers: { "Content-Type": "application/json" },
-  body: { name: "Updated Name" }
-}));
+await api.put(
+  "https://api.example.com/users/{{userId}}",
+  JSON.stringify({
+    headers: { "Content-Type": "application/json" },
+    body: { name: "Updated Name" },
+  }),
+);
 ```
 
 ### `api.patch(url, payload, requestDataType)`
@@ -2190,6 +2218,7 @@ await api.put("https://api.example.com/users/{{userId}}", JSON.stringify({
 Makes a PATCH request to the specified URL.
 
 **Parameters:**
+
 - `url` (string): The target URL (supports variable resolution)
 - `payload` (string): JSON string containing headers, body, and other request options
 - `requestDataType` (string, optional): Request data type ("multipart" for form data, default for JSON)
@@ -2197,11 +2226,15 @@ Makes a PATCH request to the specified URL.
 **Returns:** Promise that resolves when the request completes
 
 **Example:**
+
 ```javascript
-await api.patch("https://api.example.com/users/{{userId}}", JSON.stringify({
-  headers: { "Content-Type": "application/json" },
-  body: { email: "newemail@example.com" }
-}));
+await api.patch(
+  "https://api.example.com/users/{{userId}}",
+  JSON.stringify({
+    headers: { "Content-Type": "application/json" },
+    body: { email: "newemail@example.com" },
+  }),
+);
 ```
 
 ### `api.delete(url, payload)`
@@ -2209,16 +2242,21 @@ await api.patch("https://api.example.com/users/{{userId}}", JSON.stringify({
 Makes a DELETE request to the specified URL.
 
 **Parameters:**
+
 - `url` (string): The target URL (supports variable resolution)
 - `payload` (string, optional): JSON string containing headers and other request options
 
 **Returns:** Promise that resolves when the request completes
 
 **Example:**
+
 ```javascript
-await api.delete("https://api.example.com/users/{{userId}}", JSON.stringify({
-  headers: { "Authorization": "Bearer {{token}}" }
-}));
+await api.delete(
+  "https://api.example.com/users/{{userId}}",
+  JSON.stringify({
+    headers: { Authorization: "Bearer {{token}}" },
+  }),
+);
 ```
 
 ### `api.vars()`
@@ -2228,12 +2266,12 @@ Returns the current context variables object.
 **Returns:** Object containing all stored variables
 
 **Example:**
+
 ```javascript
 const currentVars = api.vars();
 console.log(currentVars); // { token: "abc123", userId: "user456" }
 ```
 
-
 ## Static Methods
 
 ### `extractVarsFromResponse(object, vars, customVarName)`
@@ -2241,15 +2279,18 @@ console.log(currentVars); // { token: "abc123", userId: "user456" }
 Extracts variables from the response body using dot notation paths.
 
 **Parameters:**
+
 - `vars` (string): Comma-separated list of dot notation paths (e.g., "user.id,user.name")
 - `customVarName` (string, optional): Custom variable name to use instead of auto-generated names
 
 **Behavior:**
+
 - Extracts values from `context.response.responseBody` using specified paths
 - Saves extracted values as variables using `saveVar()`
 - If `customVarName` is provided, uses it; otherwise generates camelCase names
 
 **Example:**
+
 ```javascript
 // Response body: { user: { id: 123, profile: { name: "John" } } }
 extractVarsFromResponse(object, "user.id,user.profile.name");
@@ -2264,11 +2305,13 @@ extractVarsFromResponse(object, "user.id", "currentUserId");
 Saves a variable to the context with either a custom name or auto-generated camelCase name.
 
 **Parameters:**
+
 - `value` (any): The value to store
 - `customName` (string, optional): Custom variable name
 - `path` (string): Dot notation path used for auto-generating variable name
 
 **Behavior:**
+
 - If `customName` is provided, uses it as the variable name
 - Otherwise, converts dot notation path to camelCase (e.g., "user.profile.name" → "userProfileName")
 
@@ -2277,17 +2320,19 @@ Saves a variable to the context with either a custom name or auto-generated came
 Resolves variable placeholders in template strings using the format `{{variableName}}`.
 
 **Parameters:**
+
 - `template` (string): Template string containing variable placeholders
 
 **Returns:** String with variables resolved, or original value if not a string
 
 **Example:**
+
 ```javascript
 // Assuming context.vars = { userId: "123", token: "abc" }
-resolveVariable("https://api.example.com/users/{{userId}}")
+resolveVariable("https://api.example.com/users/{{userId}}");
 // Returns: "https://api.example.com/users/123"
 
-resolveVariable("Bearer {{token}}")
+resolveVariable("Bearer {{token}}");
 // Returns: "Bearer abc"
 ```
 
@@ -2301,9 +2346,12 @@ context.vars.baseUrl = "https://api.example.com";
 context.vars.token = "your-auth-token";
 
 // Make a GET request
-await api.get("{{baseUrl}}/users", JSON.stringify({
-  headers: { "Authorization": "Bearer {{token}}" }
-}));
+await api.get(
+  "{{baseUrl}}/users",
+  JSON.stringify({
+    headers: { Authorization: "Bearer {{token}}" },
+  }),
+);
 
 // Extract user ID from response
 extractVarsFromResponse("data.0.id", "firstUserId");
@@ -2315,29 +2363,39 @@ await api.get("{{baseUrl}}/users/{{firstUserId}}/profile");
 ### File Upload Example
 
 ```javascript
-await api.post("{{baseUrl}}/upload", JSON.stringify({
-  headers: { "Authorization": "Bearer {{token}}" },
-  body: {
-    file: "/path/to/document.pdf",
-    description: "Important document",
-    metadata: { type: "legal", priority: "high" }
-  }
-}), "multipart");
+await api.post(
+  "{{baseUrl}}/upload",
+  JSON.stringify({
+    headers: { Authorization: "Bearer {{token}}" },
+    body: {
+      file: "/path/to/document.pdf",
+      description: "Important document",
+      metadata: { type: "legal", priority: "high" },
+    },
+  }),
+  "multipart",
+);
 ```
 
 ### Variable Extraction and Chaining
 
 ```javascript
 // Login request
-await api.post("{{baseUrl}}/auth/login", JSON.stringify({
-  body: { username: "user@example.com", password: "password" }
-}));
+await api.post(
+  "{{baseUrl}}/auth/login",
+  JSON.stringify({
+    body: { username: "user@example.com", password: "password" },
+  }),
+);
 
 // Extract token from login response
 extractVarsFromResponse("access_token", "authToken");
 
 // Use token in protected endpoint
-await api.get("{{baseUrl}}/protected-data", JSON.stringify({
-  headers: { "Authorization": "Bearer {{authToken}}" }
-}));
-```
+await api.get(
+  "{{baseUrl}}/protected-data",
+  JSON.stringify({
+    headers: { Authorization: "Bearer {{authToken}}" },
+  }),
+);
+```

package/executer.js

@@ -24,7 +24,8 @@ const flags = {
   headless: args.includes("--headless"),
   parallel: args.includes("--parallel"),
   retry: args.includes("--retry"),
-  dryrun: args.includes("--dryrun")
+  dryrun: args.includes("--dryrun"),
+  percentage: args.includes("--percentage")
 };
 
 function main() {

package/index.js

@@ -11,7 +11,7 @@ const {
   page,
   request,
   random,
-  resolveVariable
+  resolveVariable,
 } = require("./src/helper/imports/commons");
 const {
   keyboard,

package/package.json

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

package/src/helper/contextManager/browserManager.js

@@ -58,13 +58,13 @@ const invokeBrowser = async () => {
   }
 
   const context = await browser.newContext(browserContextOptions);
-  
+
   return {
     browser: browser,
-    context: context
+    context: context,
   };
 };
 
 module.exports = {
   invokeBrowser,
-};
+};

package/src/helper/executers/helper.js

@@ -1,5 +1,5 @@
 function showHelp() {
-    console.log(`
+  console.log(`
         🚀 Artes - Playwright Test Runner
       
         Description:
@@ -45,8 +45,11 @@ function showHelp() {
       
             🎭 --dryrun        Perform a dry run without executing tests
                 Usage:   artes --dryrun
+
+            📈 --percentage    Set minimum success percentage to pass test run
+                Usage:   artes --percentage 85
       `);
-    }
+}
 
 module.exports = {
   showHelp,

package/src/helper/executers/testRunner.js

@@ -11,14 +11,16 @@ function runTests(args, flags) {
   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"
+        "rerun:@rerun.txt",
+        "progress-bar",
+        "allure-cucumberjs/reporter:./allure-results",
       ]))
     : "";
 
@@ -35,6 +37,7 @@ function runTests(args, flags) {
   flags.parallel ? (process.env.PARALLEL = JSON.stringify(parallel)) : "";
   flags.retry ? (process.env.RETRY = JSON.stringify(retry)) : "";
   flags.dryrun ? (process.env.DRYRUN = JSON.stringify(true)) : "";
+  flags.percentage ? (process.env.PERCENTAGE = percentage) : "";
 
   try {
     console.log("🧪 Running tests...");

package/src/helper/pomController/elementController.js

@@ -86,7 +86,6 @@ class Elements {
   }
 
   static extractVarsFromResponse(responseBody, vars, customVarName) {
-
     function getValueByPath(obj, path) {
       const keys = path.split(".");
       let current = obj;

package/src/helper/stepFunctions/APIActions.js

@@ -1,6 +1,11 @@
 const path = require("path");
 const fs = require("fs");
-const { context, selector, resolveVariable, moduleConfig } = require("../imports/commons");
+const {
+  context,
+  selector,
+  resolveVariable,
+  moduleConfig,
+} = require("../imports/commons");
 
 function getMimeType(filePath) {
   const ext = path.extname(filePath).toLowerCase();
@@ -90,11 +95,12 @@ async function requestMaker(headers, data, requestDataType) {
 async function responseMaker(request, response, duration) {
   const responseObject = {};
 
-  response && Object.assign(responseObject, {
-    "Response Params": `URL: ${response.url()}
+  response &&
+    Object.assign(responseObject, {
+      "Response Params": `URL: ${response.url()}
      Response Status: ${await response.status()}
-     Response Time: ${Math.round(duration)} ms`
-  });
+     Response Time: ${Math.round(duration)} ms`,
+    });
 
   request?.headers &&
     Object.assign(responseObject, { "Request Headers": await request.headers });
@@ -117,7 +123,9 @@ async function responseMaker(request, response, duration) {
     }
   }
 
-  Object.assign(responseObject, { "Response Time":  `${Math.round(duration)} ms`});
+  Object.assign(responseObject, {
+    "Response Time": `${Math.round(duration)} ms`,
+  });
 
   return responseObject;
 }
@@ -168,7 +176,7 @@ const api = {
     switch (requestDataType) {
       case "multipart":
         let formData = {};
-        
+
         for (const [key, value] of Object.entries(payloadJSON?.body)) {
           processForm(formData, key, value);
         }
@@ -208,7 +216,7 @@ const api = {
     switch (requestDataType) {
       case "multipart":
         let formData = {};
-        
+
         for (const [key, value] of Object.entries(payloadJSON?.body)) {
           processForm(formData, key, value);
         }
@@ -249,7 +257,7 @@ const api = {
     switch (requestDataType) {
       case "multipart":
         let formData = {};
-        
+
         for (const [key, value] of Object.entries(payloadJSON?.body)) {
           processForm(formData, key, value);
         }

package/src/helper/stepFunctions/browserActions.js

@@ -18,4 +18,4 @@ const browser = {
 
 module.exports = {
   browser,
-};
+};

package/src/hooks/hooks.js

@@ -3,8 +3,10 @@ const {
   Before,
   After,
   Status,
-  setDefaultTimeout, AfterStep,
-  BeforeStep
+  setDefaultTimeout,
+  AfterStep,
+  BeforeStep,
+  AfterAll,
 } = require("@cucumber/cucumber");
 const { invokeBrowser } = require("../helper/contextManager/browserManager");
 const { invokeRequest } = require("../helper/contextManager/requestManager");
@@ -44,33 +46,34 @@ Before(async function () {
 BeforeStep(async function ({ pickleStep }) {
   const stepText = pickleStep.text;
 
-  const methods = ['GET', 'HEAD', 'POST', 'PUT', 'PATCH', 'DELETE'];
+  const methods = ["GET", "HEAD", "POST", "PUT", "PATCH", "DELETE"];
 
-  if( methods.some(method => stepText.includes(method))){
-      context.response = {}
+  if (methods.some((method) => stepText.includes(method))) {
+    context.response = {};
   }
-})
+});
 
-AfterStep(async function ({pickleStep}) {
+AfterStep(async function ({ pickleStep }) {
   const stepText = pickleStep.text;
 
-  const methods = ['GET', 'HEAD', 'POST', 'PUT', 'PATCH', 'DELETE'];
+  const methods = ["GET", "HEAD", "POST", "PUT", "PATCH", "DELETE"];
 
-  if( methods.some(method => stepText.includes(method))){
-  if (await context.response) {
-    for (const [key, value] of Object.entries(context.response)) {
-      let text = `${key}:\n`;
-  
-      if (typeof value === 'object') {
-        text += JSON.stringify(value, null, 2);
-      } else {
-        text += value;
+  if (methods.some((method) => stepText.includes(method))) {
+    if (await context.response) {
+      for (const [key, value] of Object.entries(context.response)) {
+        let text = `${key}:\n`;
+
+        if (typeof value === "object") {
+          text += JSON.stringify(value, null, 2);
+        } else {
+          text += value;
+        }
+
+        await this.attach(text, "text/plain");
       }
-  
-      await this.attach(text, "text/plain");
     }
-  }}
-})
+  }
+});
 
 After(async function ({ pickle, result }) {
   if (result?.status != Status.PASSED) {
@@ -88,33 +91,51 @@ After(async function ({ pickle, result }) {
   if (context.response) {
     for (const [key, value] of Object.entries(context.response)) {
       let text = `${key}:\n`;
-  
-      if (typeof value === 'object') {
+
+      if (typeof value === "object") {
         text += JSON.stringify(value, null, 2);
       } else {
         text += value;
       }
-  
+
       await this.attach(text, "text/plain");
     }
   }
 
   await context.page?.close();
-  
+
   await context.browserContext?.close();
-  
+
   await context.browser?.close();
-  
+
   await context.request?.dispose();
 
   if (result?.status != Status.PASSED && context.page.video()) {
     const videoPath = await context.page.video().path();
-    await new Promise(resolve => setTimeout(resolve, 1000));
-    
+    await new Promise((resolve) => setTimeout(resolve, 1000));
+
     if (fs.existsSync(videoPath)) {
       const webmBuffer = await fs.readFileSync(videoPath);
       await this.attach(webmBuffer, "video/webm");
     }
   }
+});
 
-});
+AfterAll(async function () {
+  const successPercentage = 100 - (testsFailed / totalTests) * 100;
+  const successRate =
+    successPercentage.toFixed(2) >= cucumberConfig.testPercentage;
+  if (!isNaN(successPercentage)) {
+    if (successRate) {
+      console.log(
+        `Tests passed with ${successPercentage.toFixed(2)}% results!`,
+      );
+      process.exit(0);
+    } else {
+      console.log(
+        `Tests failed with ${successPercentage.toFixed(2)}% results!`,
+      );
+      process.exit(1);
+    }
+  }
+});

package/src/stepDefinitions/API.steps.js

@@ -160,7 +160,11 @@ When(
 When(
   "User saves {string} variable from response as {string}",
   async function (vars, customVarName) {
-    await extractVarsFromResponse(context.response["Response Body"], vars, customVarName);
+    await extractVarsFromResponse(
+      context.response["Response Body"],
+      vars,
+      customVarName,
+    );
   },
 );
 

package/src/stepDefinitions/random.steps.js

@@ -18,14 +18,14 @@ Given(
   "User sends GET request to {string} and save {string} variable from {string} array as a {string} randomly",
   async (endPoint, varName, fromArray, variableKey) => {
     await api.get(endPoint);
-    let responseBody
-    if(fromArray=="[]"){
-       responseBody = await context.response["Response Body"]
-    }else{
-       responseBody = await context.response["Response Body"][fromArray]
+    let responseBody;
+    if (fromArray == "[]") {
+      responseBody = await context.response["Response Body"];
+    } else {
+      responseBody = await context.response["Response Body"][fromArray];
     }
     const randomContent =
-    responseBody[random.number.int({ min: 0, max: responseBody.length - 1 })];
+      responseBody[random.number.int({ min: 0, max: responseBody.length - 1 })];
     context.vars[variableKey] = randomContent[varName];
   },
-);
+);