artes 1.0.32 → 1.0.34

package/README.md

@@ -6,11 +6,10 @@
 
 ## 🚀 Summary
 
-Artes is a test runner for Playwright that executes [predefined Cucumber tests](./documents/stepDefinitions.md) and can generate Allure reports for test results. It simplifies setting up Playwright with Cucumber in your automation workflow. With Artes, you can easily run tests without writing step definitions, generate reports, and customize your testing environment.
+Artes is a test runner for Playwright that executes [predefined Cucumber tests](./docs/stepDefinitions.md) and can generate Allure reports for test results. It simplifies setting up Playwright with Cucumber in your automation workflow. With Artes, you can easily run tests without writing step definitions, generate reports, and customize your testing environment.
 
 ![artes demonstration](https://github.com/user-attachments/assets/c46172f7-103d-45d1-a37d-8d4267df0967)
 
-
 ## 🧑‍💻 Installation
 
 You can install **Artes** via npm. To install it globally**(RECOMMENDED)**, run the following command:
@@ -43,14 +42,13 @@ 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`             |
-
+| 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`          |
 
 \*\* To just run the tests: <br>
 Globally: artes <br>
@@ -242,7 +240,7 @@ const { mouse, keyboard, frame, elementInteractions, page } = require("artes");
 
 ---
 
-For a detailed explanation of each function, please refer to the [functionDefinitions.md](./documents/functionDefinitions.md).
+For a detailed explanation of each function, please refer to the [functionDefinitions.md](./docs/functionDefinitions.md).
 
 ---
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "artes",
-  "version": "1.0.32",
+  "version": "1.0.34",
   "description": "The package provide step definitions and user writes feature files, and the package handles automation, with optional POM files and custom step definitions.",
   "main": "index.js",
   "scripts": {

package/src/helper/contextManager/browserManager.js

@@ -18,7 +18,7 @@ const invokeBrowser = async () => {
       : cucumberConfig.browser.viewport,
     recordVideo: {
       dir: "./test-results/visualReport/",
-      size: cucumberConfig.viewport,
+      size: cucumberConfig.browser.viewport,
     },
   };
 

package/src/helper/pomController/elementController.js

@@ -43,34 +43,36 @@ class Elements {
     let locator;
     switch (selector[0]) {
       case "xpath":
-        locator = context.page.locator(`xpath=${selector[1]}`);
+        locator = context.page.locator(`xpath=${selector[1]}`, { exact: true });
         break;
       case "name":
-        locator = context.page.locator(`[name=${selector[1]}]`);
+        locator = context.page.locator(`[name=${selector[1]}]`, {
+          exact: true,
+        });
         break;
       case "placeholder":
-        locator = context.page.getByPlaceholder(selector[1]);
+        locator = context.page.getByPlaceholder(selector[1], { exact: true });
         break;
       case "text":
-        locator = context.page.getByText(selector[1]);
+        locator = context.page.getByText(selector[1], { exact: true });
         break;
       case "label":
-        locator = context.page.getByLabel(selector[1]);
+        locator = context.page.getByLabel(selector[1], { exact: true });
         break;
       case "role":
-        locator = context.page.getByRole(selector[1]);
+        locator = context.page.getByRole(selector[1], { exact: true });
         break;
       case "alt":
-        locator = context.page.getByAltText(selector[1]);
+        locator = context.page.getByAltText(selector[1], { exact: true });
         break;
       case "title":
-        locator = context.page.getByTitle(selector[1]);
+        locator = context.page.getByTitle(selector[1], { exact: true });
         break;
       case "testid":
-        locator = context.page.getByTestId(selector[1]);
+        locator = context.page.getByTestId(selector[1], { exact: true });
         break;
       default:
-        locator = context.page.locator(selector[0]);
+        locator = context.page.locator(selector[0], { exact: true });
         break;
     }
 

package/src/helper/stepFunctions/browserActions.js

@@ -0,0 +1,11 @@
+const { context } = require("../imports/commons");
+
+const browser = {
+  setCookies: async (cookies) => {
+    await context.browser.addCookies([JSON.parse(cookies)]);
+  },
+};
+
+module.exports = {
+  browser,
+};

package/src/helper/stepFunctions/exporter.js

@@ -5,6 +5,7 @@ const { frame } = require("./frameActions");
 const { elementInteractions } = require("./elementInteractions");
 const { page } = require("./pageActions");
 const { api } = require("./APIActions");
+const { browser } = require("./browserActions");
 
 module.exports = {
   assert,
@@ -14,4 +15,5 @@ module.exports = {
   elementInteractions,
   page,
   api,
+  browser,
 };

package/src/helper/stepFunctions/frameActions.js

@@ -14,7 +14,7 @@ const frame = {
     return await element(selector).frameLocator();
   },
   nth: async (selector, index) => {
-    return await element(selector).nth(index);
+    return await element(selector).nth(index - 1);
   },
   first: async (selector) => {
     return await element(selector).first();

package/src/helper/stepFunctions/mouseActions.js

@@ -1,5 +1,6 @@
 const { element } = require("../imports/commons");
 const { frame } = require("../stepFunctions/frameActions");
+
 const mouse = {
   click: async (selector) => {
     await element(selector).click();
@@ -96,10 +97,10 @@ const mouse = {
   },
   selectByValue: async (selector, value) => {
     const valueArray = value.split(",");
-    await element(selector).selectOption(valueArray);
+    value !== "" ? await element(selector).selectOption(valueArray) : "";
   },
   selectByText: async (selector, value) => {
-    await element(selector).selectOption(value);
+    value !== "" ? await element(selector).selectOption(value) : "";
   },
   check: async (selector) => {
     await element(selector).check();

package/src/hooks/context.js

@@ -1,5 +1,6 @@
 class Context {
   constructor() {
+    this.browser = undefined;
     this.page = undefined;
     this.request = undefined;
   }

package/src/hooks/hooks.js

@@ -11,7 +11,6 @@ const { pomCollector } = require("../helper/pomController/pomCollector");
 const cucumberConfig = require("../../cucumber.config");
 const { context } = require("./context");
 const fs = require("fs");
-const { expect } = require("playwright/test");
 const { moduleConfig } = require("artes/src/helper/imports/commons");
 const path = require("path");
 
@@ -28,6 +27,7 @@ Before(async function () {
   browser = await invokeBrowser();
   request = await invokeRequest();
 
+  context.browser = await browser;
   context.page = await browser.newPage();
   await context.page.setDefaultTimeout(cucumberConfig.default.timeout * 1000);
   context.request = await request;

package/src/stepDefinitions/assertions.steps.js

@@ -1,5 +1,10 @@
-const { Then, selector } = require("../helper/imports/commons");
-const { assert } = require("../helper/stepFunctions/exporter");
+const {
+  Then,
+  selector,
+  expect,
+  element,
+} = require("../helper/imports/commons");
+const { assert, frame } = require("../helper/stepFunctions/exporter");
 
 // Check if a selector should be attached
 Then("User expects {string} should be attached", async function (selector) {
@@ -62,6 +67,14 @@ Then(
   },
 );
 
+Then(
+  "User expects default value of {string} should have {string} text",
+  async (selector, text) => {
+    const defaultValue = await element(selector).inputValue();
+    await expect(defaultValue).toContain(text);
+  },
+);
+
 Then(
   "User expects multiple {string} should have {string} text",
   async (elements, expectedText) => {
@@ -795,3 +808,8 @@ Then(
     await assert.shouldNotStringMatching(selector, new RegExp(regex));
   },
 );
+
+Then("User expects should have {int} {string}", async (count, elements) => {
+  const elementCount = await frame.count(elements);
+  expect(elementCount).toEqual(count);
+});

package/src/stepDefinitions/browser.steps.js

@@ -0,0 +1,7 @@
+const { When } = require("../helper/imports/commons");
+const { browser } = require("../helper/stepFunctions/exporter");
+
+// User sets cookies in json format
+When("User sets {string} cookies", async function (cookies) {
+  await browser.setCookies(cookies);
+});

package/src/stepDefinitions/keyboardActions.steps.js

@@ -1,11 +1,19 @@
 const { When } = require("../helper/imports/commons");
-const { keyboard } = require("../helper/stepFunctions/exporter");
+const { keyboard, frame } = require("../helper/stepFunctions/exporter");
 
 // User presses a key on a specific selector
 When("User presses {string} on {string}", async function (key, selector) {
   await keyboard.press(selector, key);
 });
 
+When(
+  "User types {string} in {int} th of {string}",
+  async (text, order, elements) => {
+    const nthElement = await frame.nth(elements, order);
+    await nthElement.fill(text);
+  },
+);
+
 // User presses keys sequentially on a specific selector
 When(
   "User presses keys {string} sequentially on {string}",
@@ -40,8 +48,8 @@ When("User clears {string}", async function (selector) {
 });
 
 // User selects text in a specific selector
-When("User selects text in {string}", async function (selector) {
-  await keyboard.selectText(selector);
+When("User selects {string} text", async function (text) {
+  await keyboard.selectText(text);
 });
 
 // User sets input files for a specific selector

package/src/stepDefinitions/mouseActions.steps.js

@@ -1,11 +1,22 @@
 const { When } = require("../helper/imports/commons");
-const { mouse } = require("../helper/stepFunctions/exporter");
+const { mouse, frame } = require("../helper/stepFunctions/exporter");
 
 // User clicks on a selector
 When("User clicks {string}", async function (selector) {
   await mouse.click(selector);
 });
 
+When("User clicks last of {string}", async (selector) => {
+  const elementCount = await frame.count(selector);
+  const lastElement = await frame.nth(selector, elementCount);
+  await mouse.click(lastElement);
+});
+
+When("User clicks {int} th of {string}", async (order, elements) => {
+  const nthElement = await frame.nth(elements, order);
+  await nthElement.click();
+});
+
 When("User clicks multiple {string}", async (elements) => {
   await mouse.multipleElementClick(elements);
 });