artes 1.5.10 → 1.6.0

package/README.md

@@ -115,9 +115,14 @@ npx artes [options]
 | `-rwt, --reportWithTrace` | Add trace to the report                                                            | `artes -rwt` or `artes --reportWithTrace`                             |
 | `--singleFileReport`      | Generate single file allure report                                                 | `artes -r --singleFileReport`                                         |
 | `--zip`                   | Zip the report folder after generation                                             | `artes -r --zip`                                                      |
+| `--uploadReport`          | Upload the generated report to Artes Reporting System                              | `artes --uploadReport --reporterURL "https://example.com"`            |
+| `--reporterURL`           | URL of the Artes Reporting System to upload the report                             | `artes --uploadReport --reporterURL "https://example.com"`            |
+| `--projectName`           | Name of the project in the Artes Reporting System (default: `"Artes Report"`)     | `artes --uploadReport --reporterURL "https://example.com" --projectName "My Project"` |
+| `--projectType`           | Type of the project for reporting purposes (default: `"Artes"`)                   | `artes --uploadReport --reporterURL "https://example.com" --projectType "API"` |
+| `--reportPath`            | Path to the report zip file to upload (default: `./report.zip`)                   | `artes --uploadReport --reporterURL "https://example.com" --reportPath "./my_report.zip"` |
 | 🖼️ `--logo`               | Set a custom logo in the report sidebar. Accepts an absolute path, a relative path, or a direct image URL | `artes --logo /abs/path/logo.png`<br>`artes --logo logo.png`<br>`artes --logo 'https://example.com/logo.png'` |
 | 🏢 `--brandName`          | Set the brand name displayed next to the logo in the report sidebar                | `artes --brandName 'My Company'`                                      |
-| 📄 `--reportName`         | Set the report name displayed on the summary widget                                | `artes --reportName 'Alma UI'`  
+| 📄 `--reportName`         | Report name displayed on the summary widget and in the Artes Reporting System                       | `artes --reportName 'Alma UI'`  
 | 📁 `--features`           | Specify one or more feature files' relative paths to run (comma-separated)         | `artes --features "tests/features/Alma,tests/features/Banan.feature"` |
 | 📜 `--stepDef`            | Specify one or more step definition files' relative paths to use (comma-separated) | `artes --stepDef "tests/steps/login.js,tests/steps/home.js"`          |
 | 🔖 `--tags`               | Run tests with specified Cucumber tags                                             | `artes --tags "@smoke or @wip"`                                       |
@@ -615,13 +620,26 @@ Artes supports environment-specific configurations through environment variables
 
 | Option        | Default Value                  | Description                                            |
 | ------------- | ------------------------------ | ------------------------------------------------------ |
-| `device`      | `""`                     | [Device List](./docs/emulationDevicesList.md) |
+| `device`      | `""`                           | [Device List](./docs/emulationDevicesList.md)          |
 
 
-## 📊 Report Generation
+## 📊 Reporting
 
 Artes can generate Allure reports. After running tests with the `-r` flag, the reports will be stored in the `report` folder in HTML format. You can view them in your browser after the tests complete.
 
+### Integration with Artes Reporting System
+
+Artes has a built-in integration with the Artes Reporting System. By configuring the options below, you can automatically upload your test reports and keep your pipeline stages clean and organized.
+
+| **Option**       | **Default Value**             | **Description**                                                        |
+| ---------------- | ----------------------------- | ---------------------------------------------------------------------- |
+| `uploadReport`   | `false`                       | Automatically upload the report to Artes Reporting System after tests. |
+| `reporterURL`    | `""`                          | URL of the Artes Reporting System instance to upload the report to.    |
+| `projectName`    | `"Artes Report"`              | Name of the project in the Artes Reporting System.                     |
+| `projectType`    | `"Artes"`                     | Type/category of the project (e.g., UI, API).                          |
+| `reportName`     | `"Artes Report"`              | Display name of the report in the Artes Reporting System.              |
+| `reportPath`     | `"./report.zip"`              | Path to the report zip file to be uploaded.                            |
+
 ---
 
 ## 🐳 Docker Image for CI/CD
@@ -638,7 +656,7 @@ 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
 ```
 
-### 🔬 CI/CD Executor on Report
+### CI/CD Executor on Report
 
 Artes automatically detects your CI/CD environment and displays executor information — pipeline name, build number, and a direct link to the build — on the generated report.
 

package/docs/stepDefinitions.md

@@ -4,6 +4,7 @@
 
 - [Mouse Actions](#mouse-actions)
 - [Keyboard Actions](#keyboard-actions)
+- [Browser Actions](#browser-actions)
 - [Page Actions](#page-actions)
 - [Frame Actions](#frame-actions)
 - [API Actions](#api-actions)
@@ -107,6 +108,30 @@
 - User releases `{string}`
 - User presses `{string}`
 
+# Browser Actions
+
+## Cookie Actions
+
+- User sets `{string}` cookies
+
+## Accessibility Actions
+
+### Full Page Checks
+- User checks accessibility of current page
+- User checks accessibility of `{string}` page
+
+### Element Checks
+- User checks accessibility of `{string}` element
+- User checks accessibility of `{string}` element on the `{string}` page
+
+### WCAG-Specific Checks
+> For valid WCAG tags, refer to the [axe-core Tags Documentation](https://www.deque.com/axe/core-documentation/api-documentation/#axecore-tags)
+
+- User checks accessibility of current page due to `{string}` WCAG
+- User checks accessibility of `{string}` page due to `{string}` WCAG
+- User checks accessibility of `{string}` element due to `{string}` WCAG
+- User checks accessibility of `{string}` element on the `{string}` page due to `{string}` WCAG
+
 ---
 
 # Page Actions

package/executer.js

@@ -18,6 +18,8 @@ const {
   findDuplicateTestNames,
 } = require("./src/helper/controller/findDuplicateTestNames");
 const { getEnvInfo } = require("artes/src/helper/controller/getEnvInfo");
+const { uploadReport } = require("./src/helper/controller/reportUploader");
+
 
 const artesConfigPath = path.resolve(process.cwd(), "artes.config.js");
 
@@ -49,6 +51,11 @@ const flags = {
   customBrandName: args.includes("--brandName"),
   customReportName: args.includes("--reportName"),
   zip: args.includes("--zip"),
+  uploadReport: args.includes("--uploadReport"),
+  reporterURL: args.includes("--reporterURL"),
+  projectName: args.includes("--projectName"),
+  projectType: args.includes("--projectType"),
+  reportPath: args.includes("--reportPath"),
   features: args.includes("--features"),
   stepDef: args.includes("--stepDef"),
   tags: args.includes("--tags"),
@@ -73,6 +80,10 @@ const flags = {
 
 const env = getArgValue("--env");
 const vars = getArgValue("--saveVar");
+const reporterURL = getArgValue("--reporterURL");
+const projectType = getArgValue("--projectType");
+const projectName = getArgValue("--projectName");
+const reportPath = getArgValue("--reportPath");
 const logo = getArgValue("--logo");
 const brandName = getArgValue("--brandName");
 const reportName = getArgValue("--reportName");
@@ -173,7 +184,7 @@ flags.timeout ? (process.env.TIMEOUT = timeout) : "";
 
 flags.slowMo ? (process.env.SLOWMO = slowMo) : "";
 
-function main() {
+async function main() {
   if (flags.help) return showHelp();
   if (flags.version) return showVersion();
   if (flags.create) return createProject(flags.createYes, flags.noDeps);
@@ -240,6 +251,16 @@ function main() {
     });
   }
 
+  if (flags.uploadReport || artesConfig.uploadReport) {
+  await uploadReport({
+    reporterURL:  reporterURL  || artesConfig.reporterURL,
+    projectName:  projectName  || artesConfig.projectName || "Artes Report",
+    projectType:  projectType  || artesConfig.projectType || "Artes",
+    reportName:   reportName   || artesConfig.reportName  || "Artes Report",
+    reportPath:   reportPath   || artesConfig.reportPath  || path.join(process.cwd(), "report.zip")
+  });
+}
+
   cleanUp();
   process.exit(process.env.EXIT_CODE);
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "artes",
-  "version": "1.5.10",
+  "version": "1.6.0",
   "description": "The simplest way to automate UI and API tests using Cucumber-style steps.",
   "main": "index.js",
   "scripts": {
@@ -29,6 +29,7 @@
     "dayjs": "1.11.13",
     "deasync": "^0.1.31",
     "playwright": "^1.58.2",
+    "@axe-core/playwright": "^4.11.1",
     "ffmpeg-static": "^5.3.0",
     "ffprobe-static": "^3.1.0",
     "pixelmatch": "^5.3.0",

package/src/helper/controller/reportUploader.js

@@ -0,0 +1,33 @@
+const fs = require("fs");
+
+async function uploadReport({ 
+  reporterURL, 
+  projectName,
+  projectType, 
+  reportName, 
+  reportPath
+}) {
+  
+  const formData = new FormData();
+
+  const fileBuffer = fs.readFileSync(reportPath);
+  const fileBlob = new Blob([fileBuffer], { type: "application/x-zip-compressed" });
+  formData.append("file", fileBlob, "report.zip");
+  formData.append("name", reportName);
+  formData.append("project", projectName);
+  formData.append("type", projectType);
+
+  const response = await fetch(`${reporterURL}/api/report`, {
+    method: "POST",
+    body: formData,
+  });
+
+  const data = await response.json();
+  console.log("Report URL:", data.report.report_url);
+
+  return data;
+}
+
+module.exports = {
+  uploadReport
+};

package/src/helper/controller/validateWCAGTags .js

@@ -0,0 +1,52 @@
+const EXACT_TAGS = new Set([
+  'wcag2a', 'wcag2aa', 'wcag2aaa',
+  'wcag21a', 'wcag21aa',
+  'wcag22aa',
+  'best-practice',
+  'wcag2a-obsolete',
+  'ACT',
+  'section508',
+  'TTv5',
+  'EN-301-549',
+  'RGAAv4',
+  'experimental'
+]);
+
+const PATTERN_TAGS = [
+  /^wcag\d{3,}$/,       
+  /^section508\.\d+\.\d+$/, 
+  /^TT\d+\.\d+$/,       
+  /^EN-9\.\d+(\.\d+)*$/, 
+  /^RGAA-\d+\.\d+\.\d+$/, 
+  /^cat\..+$/           
+];
+
+const isValidTag = (tag) => {
+  if (EXACT_TAGS.has(tag)) return true;
+  return PATTERN_TAGS.some(pattern => pattern.test(tag));
+};
+
+const validateWCAGTags = (tags) => {
+  const normalized = tags.split(",").map(tag => tag.trim());
+
+  if (normalized.length === 0) {
+    throw new Error('At least one WCAG tag must be provided.');
+  }
+
+  const invalid = normalized.filter(tag => !isValidTag(tag));
+
+  if (invalid.length > 0) {
+    throw new Error(
+      `Invalid WCAG tag(s): "${invalid.join('", "')}"\n` +
+      `Valid tags: wcag2a, wcag2aa, wcag2aaa, wcag21a, wcag21aa, wcag22aa, ` +
+      `best-practice, wcag2a-obsolete, wcag111 (SC pattern), ACT, section508, ` +
+      `section508.x.x, TTv5, TT*.*, EN-301-549, EN-9.*, RGAAv4, RGAA-*.*.*, ` +
+      `experimental, cat.* `+
+      `For more information: https://www.deque.com/axe/core-documentation/api-documentation/#axecore-tags`
+    );
+  }
+
+  return normalized;
+};
+
+module.exports = { validateWCAGTags };

package/src/helper/executers/helper.js

@@ -40,16 +40,31 @@ function showHelp() {
             📄 --singleFileReport   Generate single file Allure report
                 Usage:   artes -r --singleFileReport
 
-            🗜️ --zip            Zip the report folder after generation
+           🗜️ --zip            Zip the report folder after generation
                 Usage:   artes -r --zip
 
+            --uploadReport     Upload the generated report to a Artes Reporting System
+                Usage:   artes --uploadReport --reporterURL "https://example.com/upload"
+            
+            --reporterURL      URL of the Artes Reporting System to upload the report
+                Usage:   artes --uploadReport --reporterURL "https://example.com/upload"
+
+            --projectName      Name of the project in the Artes Reporting System (default: "Artes Report")
+                Usage:   artes --uploadReport --reporterURL "https://example.com/upload" --projectName "My Project"
+
+            --projectType      Type of the project (e.g., UI, API) for reporting purposes (default: "Artes")
+                Usage:   artes --uploadReport --reporterURL "https://example.com/upload" --projectType "API"
+
+            --reportPath       Path to the report zip or html file to be uploaded (default: ./report.zip)
+                Usage:   artes --uploadReport --reporterURL "https://example.com/upload" --reportPath "./my_report.zip"
+
             🖼️ --logo           Set a custom logo in the report sidebar  
                 Usage:  artes --logo logo.png
 
             🏢 --brandName      Set the brand name displayed next to the logo in the report sidebar
                 Usage:  artes --brandName 'My Company' 
 
-            📄 --reportName      Set the report name displayed on the summary widget
+            📄 --reportName      Report name displayed on the summary widget and in the Artes Reporting System
                 Usage:  artes --reportName 'Alma UI' 
       
             📁 --features      Specify one or more feature files' relative paths to run (comma-separated)

package/src/helper/executers/projectCreator.js

@@ -43,7 +43,7 @@ function createProject(createYes, noDeps) {
   fs.writeFileSync(packageJsonPath, JSON.stringify(packageJson, null, 2));
 
   const config = `module.exports = {
-    headless: false,                 // Set to true for headless browser mode
+       headless: false,                 // Set to true for headless browser mode
 
     // Configuration options:
     // env: "",                      // string - Environment name for tests
@@ -56,11 +56,16 @@ function createProject(createYes, noDeps) {
     // timeout : 0,                  // number - Test timeout in seconds
     // slowMo: 0,                    // number - Slow down test execution (Default: 0 seconds)
     // parallel: 0,                  // number - Number of parallel workers
-    // report: true                  // boolean - Generate report
-    // zip: false                    // boolean - Generate zip of report
-    // logo: ""                      // string - Custom logo for the report sidebar. Accepts an absolute path, a relative path, or a direct image URL
-    // brandName: ""                 // string - Brand name displayed next to the logo in the report sidebar
-    // reportName: ""                // string - Report name displayed on the summary widget
+    // report: true,                 // boolean - Generate report
+    // zip: false,                   // boolean - Generate zip of report
+    // uploadReport: false,          // boolean - Upload report to Artes Reporting System
+    // reporterURL: "",              // string  - URL of the Artes Reporting System
+    // projectName: "Artes Report",  // string  - Name of the project in the Artes Reporting System
+    // projectType: "Artes",         // string  - Type/category of the project (e.g., UI, API)
+    // reportPath: "./report.zip",   // string  - Path to the report zip file to be uploaded
+    // logo: "",                     // string - Custom logo for the report sidebar. Accepts an absolute path, a relative path, or a direct image URL
+    // brandName: "",                // string - Brand name displayed next to the logo in the report sidebar
+    // reportName: "Artes Report",   // string - Report name displayed on the summary widget and in the Artes Reporting System
     // reportSuccess: false,         // boolean - Add screenshots and video records to report also for success test cases
     // trace: false,                 // boolean - Enable tracing
     // reportWithTrace: false,       // boolean - Include trace in report

package/src/helper/stepFunctions/browserActions.js

@@ -1,4 +1,16 @@
-const { context, selector, resolveVariable } = require("../imports/commons");
+const { page: p } = require("artes/src/helper/stepFunctions/pageActions");
+const {
+  context,
+  resolveVariable,
+  expect,
+  selector,
+} = require("../imports/commons");
+const { AxeBuilder } = require("@axe-core/playwright");
+const {
+  validateWCAGTags,
+} = require("artes/src/helper/controller/validateWCAGTags ");
+require("allure-cucumberjs");
+const allure = require("allure-js-commons");
 
 const browser = {
   setCookies: async (cookies) => {
@@ -15,6 +27,59 @@ const browser = {
 
     await context.browserContext.addCookies(cookieData);
   },
+  checkAccessibilityOfPage: async (page, url, element) => {
+    if (url) {
+      await p.navigateTo(url);
+    }
+
+    if (element) {
+      element = await selector(element);
+      await page.locator(element).waitFor();
+    }
+
+    const accessibilityScanResults = await new AxeBuilder({ page })
+      .include(element)
+      .analyze();
+    await allure.attachment(
+      "Accessibility Results",
+      JSON.stringify(accessibilityScanResults, null, 2),
+      "application/json",
+    );
+
+    try {
+      expect(accessibilityScanResults.violations).toEqual([]);
+    } catch (e) {
+      e.name = "AssertionError";
+      throw e;
+    }
+  },
+  checkAccessibilityOfPageDueToWCAG: async (page, url, element, tags) => {
+    if (url) {
+      await p.navigateTo(url);
+    }
+
+    if (element) {
+      element = await selector(element);
+      await page.locator(element).waitFor();
+    }
+    if (tags) {
+      tags = validateWCAGTags(tags);
+    }
+
+    expect(accessibilityScanResults.violations).toEqual([]);
+    await allure.attachment(
+      "Accessibility Results",
+      JSON.stringify(accessibilityScanResults, null, 2),
+      "application/json",
+    );
+
+    try {
+      expect(accessibilityScanResults.violations).toEqual([]);
+    } catch (e) {
+      e.name = "AssertionError";
+      throw e;
+    }
+  },
 };
 
 module.exports = {

package/src/stepDefinitions/browser.steps.js

@@ -1,7 +1,74 @@
-const { When } = require("../helper/imports/commons");
+const { When, context } = 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);
 });
+
+When("User checks accessibility of current page", async function () {
+  await browser.checkAccessibilityOfPage(context.page, null, null);
+});
+
+When("User checks accessibility of {string} page", async function (url) {
+  await browser.checkAccessibilityOfPage(context.page, url, null);
+});
+
+When("User checks accessibility of {string} element", async function (element) {
+  await browser.checkAccessibilityOfPage(context.page, null, element);
+});
+
+When(
+  "User checks accessibility of {string} element on the {string} page",
+  async function (element, url) {
+    await browser.checkAccessibilityOfPage(context.page, url, element);
+  },
+);
+
+When(
+  "User checks accessibility of current page due to {string} WCAG",
+  async function (wcag) {
+    await browser.checkAccessibilityOfPageDueToWCAG(
+      context.page,
+      null,
+      null,
+      wcag,
+    );
+  },
+);
+
+When(
+  "User checks accessibility of {string} page due to {string} WCAG",
+  async function (url, wcag) {
+    await browser.checkAccessibilityOfPageDueToWCAG(
+      context.page,
+      url,
+      null,
+      wcag,
+    );
+  },
+);
+
+When(
+  "User checks accessibility of {string} element due to {string} WCAG",
+  async function (element, wcag) {
+    await browser.checkAccessibilityOfPageDueToWCAG(
+      context.page,
+      null,
+      element,
+      wcag,
+    );
+  },
+);
+
+When(
+  "User checks accessibility of {string} element on the {string} page due to {string} WCAG",
+  async function (element, url, wcag) {
+    await browser.checkAccessibilityOfPageDueToWCAG(
+      context.page,
+      url,
+      element,
+      wcag,
+    );
+  },
+);