artes 1.1.50 → 1.2.0

package/README.md

@@ -266,7 +266,7 @@ For a detailed explanation of each function, please refer to the [function defin
 
 ---
 
-### Example of a Custom Step Definition
+### Example of Custom Step Definition
 
 ```javascript
 const { Given, When, Then, expect, element, page } = require("artes");
@@ -284,6 +284,85 @@ Then("User should see the login form", async () => {
 });
 ```
 
+## 🪝 Hooks (Lifecycle Hooks)
+
+Artes supports **hooks** that allow you to execute custom logic **before and after tests, scenarios, and steps**.
+
+Hooks are **user-defined**.  
+
+---
+
+### 📁 Hooks File Location
+
+Create the following file **inside your project** (optional):
+```
+tests/steps/hooks.js
+```
+
+---
+
+### ✍️ Writing Hooks
+
+You can define **only the hooks you need** in hooks.js under the steps folder.  
+Undefined hooks are automatically skipped.
+```js
+// tests/steps/hooks.js
+
+export function BeforeStep() {
+  console.log("BeforeStep");
+}
+
+export function Before() {
+  console.log("Before");
+}
+
+export function BeforeAll() {
+  console.log("BeforeAll");
+}
+
+export function AfterStep() {
+  console.log("AfterStep");
+}
+
+export function After() {
+  console.log("After");
+}
+
+export function AfterAll() {
+  console.log("AfterAll");
+}
+```
+
+---
+
+### 🔁 Supported Hook Types
+
+| Hook Name    | Execution Time                |
+| ------------ | ----------------------------- |
+| `BeforeAll`  | Once before **all scenarios** |
+| `Before`     | Before **each scenario**      |
+| `BeforeStep` | Before **each step**          |
+| `AfterStep`  | After **each step**           |
+| `After`      | After **each scenario**       |
+| `AfterAll`   | Once after **all scenarios**  |
+
+---
+
+### ▶️ Execution Order Example
+
+For a scenario with steps:
+```
+BeforeAll
+Before
+BeforeStep
+(step executes)
+AfterStep
+After
+AfterAll
+```
+
+---
+
 ## ⚙️ Configuration
 
 You can configure Artes by editing the `artes.config.js` file. Below are the default configuration options with explanations:
@@ -418,12 +497,6 @@ To achieve the best video recording quality, use the following command:
 xvfb-run -a --server-args="-screen 0 3840x1180x24" --auto-servernum npx artes --width 1600 --height 900
 ```
 
-### Playwright Version
-
-The Docker image uses Playwright version `1.52.0`.
-
-This setup ensures smooth execution of tests CI/CD environments.
-
 ---
 
 ## 👍 Good To Use

package/package.json

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

package/src/helper/executers/projectCreator.js

@@ -123,6 +123,32 @@ const {Given,context} = require("artes");
 Given("User is on home page of SauceDemo", async () => {
 await context.page.goto("https://www.saucedemo.com/");
 });
+`;
+
+const hooksContent = `
+export function BeforeStep() {
+    console.log("BeforeStep")
+}
+
+export function Before() {
+    console.log("Before")
+}
+
+export function BeforeAll() {
+    console.log("BeforeAll")
+}
+
+export function AfterStep() {
+    console.log("AfterStep")
+}
+
+export function After() {
+    console.log("After")
+}
+
+export function AfterAll() {
+    console.log("AfterAll")
+}
 `;
 
   const vsCodeExtension = JSON.stringify({
@@ -148,6 +174,7 @@ await context.page.goto("https://www.saucedemo.com/");
   );
   fs.writeFileSync(path.join(srcDir, "POMs", "example.pom.json"), pomContent);
   fs.writeFileSync(path.join(srcDir, "steps", "common.steps.js"), stepsContent);
+  fs.writeFileSync(path.join(srcDir, "steps", "common.steps.js"), hooksContent);
 
   fs.writeFileSync(
     path.join(projectDir, ".vscode", "settings.json"),

package/src/helper/stepFunctions/APIActions.js

@@ -31,6 +31,11 @@ function getMimeType(filePath) {
 function processForm(requestBody) {
   let formData = {};
   for (const [key, value] of Object.entries(requestBody)) {
+    
+    if (value === null || value === undefined) {
+      continue; 
+    }
+
     if (typeof value === "object") {
       if (value.contentType) {
         const content =

package/src/hooks/hooks.js

@@ -46,10 +46,27 @@ function saveTestStatus(result, pickle) {
   );
 }
 
+
+const projectHooksPath = path.resolve(moduleConfig.projectPath, "tests/steps/hooks.js");
+
+let projectHooks = {};
+
+if (fs.existsSync(projectHooksPath)) {
+  try {
+    projectHooks = require(projectHooksPath);
+  } catch (err) {
+    console.warn("⚠️ Failed to load project hooks.js:", err.message);
+  }
+} else {
+  projectHooks = {};
+}
+
 /* ------------------- Hooks ------------------- */
 
 BeforeAll(() => {
   pomCollector();
+  
+  projectHooks.BeforeAll()
 });
 
 Before(async function () {
@@ -92,18 +109,24 @@ Before(async function () {
       snapshots: true,
     });
   }
+
+  projectHooks.Before()
 });
 
 BeforeStep(({ pickleStep }) => {
   if (HTTP_METHODS.some((method) => pickleStep.text.includes(method))) {
     context.response = {};
   }
+
+  projectHooks.BeforeStep()
 });
 
 AfterStep(async function ({ pickleStep }) {
   if (HTTP_METHODS.some((method) => pickleStep.text.includes(method))) {
     await attachResponse(this.attach);
   }
+
+  projectHooks.AfterStep()
 });
 
 After(async function ({ pickle, result }) {
@@ -187,6 +210,8 @@ After(async function ({ pickle, result }) {
       }
     }
   }
+
+  projectHooks.After()
 });
 
 AfterAll(() => {
@@ -213,4 +238,6 @@ AfterAll(() => {
       fs.writeFileSync(path.join(process.cwd(), "EXIT_CODE.txt"), "1");
     }
   }
+
+  projectHooks.AfterAll()
 });