@uuv/cypress 2.0.3 → 2.2.0

package/CHANGELOG.md

@@ -1,3 +1,17 @@
+## [2.2.0](https://github.com/Orange-OpenSource/uuv/compare/runner-cypress-v2.1.0...runner-cypress-v2.2.0) (2024-01-08)
+
+
+### Features
+
+* **a11y:** initialize @uuv/a11y lib, [#330](https://github.com/Orange-OpenSource/uuv/issues/330) ([3c27ac5](https://github.com/Orange-OpenSource/uuv/commit/3c27ac5a1698a407289123aac85e500508e2d8c6))
+
+# [2.1.0](https://github.com/Orange-OpenSource/uuv/compare/runner-cypress-v2.0.3...runner-cypress-v2.1.0) (2023-12-28)
+
+
+### Features
+
+* **runner-playwright:** add tags option for runner-playwright, [#416](https://github.com/Orange-OpenSource/uuv/issues/416) ([8787581](https://github.com/Orange-OpenSource/uuv/commit/87875818114bbf77ff4b35ff8ccb26d525eba450))
+
 ## [2.0.3](https://github.com/Orange-OpenSource/uuv/compare/runner-cypress-v2.0.2...runner-cypress-v2.0.3) (2023-12-21)
 
 ## [2.0.2](https://github.com/Orange-OpenSource/uuv/compare/runner-cypress-v2.0.1...runner-cypress-v2.0.2) (2023-12-19)

package/README.md

@@ -44,6 +44,10 @@ A solution to facilitate the writing and execution of E2E tests understandable b
     <img alt="@uuv/assistant npm library download count"
          src="https://img.shields.io/npm/dt/%40uuv/assistant?logo=npm&label=%40uuv%2Fassistant"></img>
 </a>
+<a href="https://www.npmjs.com/package/@uuv/a11y" target="_blank">
+    <img alt="@uuv/a11y npm library download count"
+         src="https://img.shields.io/npm/dt/%40uuv/a11y?logo=npm&label=%40uuv%2Fa11y"></img>
+</a>
 <a href="https://plugins.jetbrains.com/plugin/22437-uuv" target="_blank">
     <img alt="JetBrains Plugin Downloads" src="https://img.shields.io/jetbrains/plugin/d/22437-uuv?logo=jetbrains&label=UUV%20plugin"></img>
 </a>

package/dist/cucumber/step_definitions/cypress/_.common.d.ts

@@ -12,8 +12,6 @@
 * Software description: Make test writing fast, understandable by any human
 * understanding English or French.
 */
-/// <reference types="cypress" />
-/// <reference types="cypress" />
 import { ByRoleOptions } from "@testing-library/cypress";
 import { Context } from "./_context";
 import Chainable = Cypress.Chainable;

package/dist/cucumber/step_definitions/cypress/_context.d.ts

@@ -12,8 +12,6 @@
 * Software description: Make test writing fast, understandable by any human
 * understanding English or French.
 */
-/// <reference types="cypress" />
-/// <reference types="cypress" />
 import { IContext } from "@uuv/runner-commons";
 export declare class Context implements IContext {
     focusedElement?: Cypress.Chainable<JQuery<HTMLElement>>;

package/dist/cucumber/step_definitions/cypress/a11y-engine.d.ts

@@ -0,0 +1,17 @@
+/**
+* Software Name : UUV
+*
+* SPDX-FileCopyrightText: Copyright (c) 2022-2023 Orange
+* SPDX-License-Identifier: MIT
+*
+* This software is distributed under the MIT License,
+* the text of which is available at https://spdx.org/licenses/MIT.html
+* or see the "LICENSE" file for more details.
+*
+* Authors: NJAKO MOLOM Louis Fredice & SERVICAL Stanley
+* Software description: Make test writing fast, understandable by any human
+* understanding English or French.
+*/
+import { A11yReferenceEnum } from "@uuv/a11y";
+export declare const injectUvvA11y: () => void;
+export declare const checkUvvA11y: (reference: A11yReferenceEnum, expectedResult?: any) => void;

package/dist/cucumber/step_definitions/cypress/a11y-engine.js

@@ -0,0 +1,127 @@
+"use strict";
+/**
+* Software Name : UUV
+*
+* SPDX-FileCopyrightText: Copyright (c) 2022-2023 Orange
+* SPDX-License-Identifier: MIT
+*
+* This software is distributed under the MIT License,
+* the text of which is available at https://spdx.org/licenses/MIT.html
+* or see the "LICENSE" file for more details.
+*
+* Authors: NJAKO MOLOM Louis Fredice & SERVICAL Stanley
+* Software description: Make test writing fast, understandable by any human
+* understanding English or French.
+*/
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.checkUvvA11y = exports.injectUvvA11y = void 0;
+// eslint-disable-next-line @nrwl/nx/enforce-module-boundaries
+const a11y_1 = require("@uuv/a11y");
+const rxjs_1 = require("rxjs");
+const jquery_1 = __importDefault(require("jquery"));
+const injectUvvA11y = () => {
+    const fileName = typeof require?.resolve === "function"
+        ? require.resolve("@uuv/a11y/bundle")
+        : "node_modules/@uuv/a11y/bundle/uuv-a11y.bundle.js";
+    cy.readFile(fileName).then((source) => cy.window({ log: false }).then((window) => {
+        window.eval(source);
+    }));
+};
+exports.injectUvvA11y = injectUvvA11y;
+const checkUvvA11y = (reference, expectedResult) => {
+    cy.window({ log: false })
+        .then((win) => {
+        const url = win.location.href;
+        const rgaaChecker = getA11yCheckerForReference(win, reference, url);
+        assert.isDefined(rgaaChecker, "A11y reference not found");
+        return rgaaChecker?.validate()
+            .pipe((0, rxjs_1.tap)((result) => {
+            logAllA11yRuleResult(result);
+            assertWithExpectedResult(expectedResult, result);
+        }))
+            .toPromise();
+    });
+};
+exports.checkUvvA11y = checkUvvA11y;
+function getA11yCheckerForReference(win, reference, url) {
+    let rgaaChecker;
+    switch (reference) {
+        case a11y_1.A11yReferenceEnum.WCAG_WEB:
+            break;
+        case a11y_1.A11yReferenceEnum.WCAG_ANDROID:
+            break;
+        case a11y_1.A11yReferenceEnum.WCAG_IOS:
+            break;
+        case a11y_1.A11yReferenceEnum.RGAA:
+        default:
+            rgaaChecker = new win.uuvA11y.RgaaChecker(url);
+            break;
+    }
+    return rgaaChecker;
+}
+function assertWithExpectedResult(expectedResult, result) {
+    if (expectedResult) {
+        assert.deepEqual(result.summary(), expectedResult, "A11y validation failed");
+    }
+    else {
+        assert.notEqual(result.status, a11y_1.A11yResultStatus.ERROR, "A11y validation failed");
+        assert.notEqual(result.status, a11y_1.A11yResultStatus.UNKNOWN, "A11y validation failed");
+    }
+}
+function logAllA11yRuleResult(result) {
+    result.ruleResults.forEach(ruleResult => {
+        // logValidatingA11yRule(result.reference, ruleResult);
+        logA11yRuleResult(result.reference, ruleResult);
+    });
+}
+function logA11yRuleResult(reference, ruleResult) {
+    switch (ruleResult.status) {
+        case a11y_1.A11yResultStatus.ERROR:
+            logNonCompliantNode(reference, ruleResult);
+            break;
+        case a11y_1.A11yResultStatus.MANUAL:
+            logNodeToCheckManually(reference, ruleResult);
+            break;
+        case a11y_1.A11yResultStatus.UNKNOWN:
+            break;
+        case a11y_1.A11yResultStatus.SUCCESS:
+            break;
+    }
+}
+function buildCypressLog(name, message, consoleLog) {
+    return Cypress.log({
+        name: name,
+        displayName: name,
+        message: message,
+        consoleProps() {
+            return consoleLog ? consoleLog : {};
+        }
+    });
+}
+function logNonCompliantNode(reference, ruleResult) {
+    const errorNodes = ruleResult.getErrorNodes();
+    const log = buildCypressLog(`${reference.name} error !`, `criteria ${ruleResult.rule.criterion} on ${errorNodes.length} nodes`, getConsoleDetails(reference, ruleResult, errorNodes));
+    errorNodes.forEach(nonCompliantNode => log.set({ $el: (0, jquery_1.default)(nonCompliantNode.node) }).snapshot());
+    log.error(new Error(`Validation failed on ${errorNodes.length} nodes`));
+}
+function logNodeToCheckManually(reference, ruleResult) {
+    const nodesToCheckManually = ruleResult.getNodesToCheckManually();
+    const log = buildCypressLog(`${reference.name} to validate manually !`, `criteria ${ruleResult.rule.criterion} on ${nodesToCheckManually.length} nodes`, getConsoleDetails(reference, ruleResult, nodesToCheckManually));
+    nodesToCheckManually.forEach(nodeToCheck => log.set({ $el: (0, jquery_1.default)(nodeToCheck.node) }).snapshot());
+    log.finish();
+}
+function getConsoleDetails(reference, ruleResult, nodes) {
+    return {
+        Id: ruleResult.rule.id,
+        WCAG: ruleResult.rule.wcag,
+        targetUrl: ruleResult.url,
+        Criteria: ruleResult.rule.criterion,
+        "Element type": ruleResult.rule.elementType,
+        Description: ruleResult.rule.description,
+        Help: `${ruleResult.rule.help}, ${reference.getRuleUrl(ruleResult.rule.id)}`,
+        nodes: nodes
+    };
+}

package/dist/cucumber/step_definitions/cypress/generated/_en-generated-cucumber-steps-definition.js

@@ -22,29 +22,48 @@ const _context_1 = require("../_context");
 require("../../../../cypress/commands");
 const runner_commons_1 = require("@uuv/runner-commons");
 const core_engine_1 = require("../core-engine");
+const a11y_1 = require("@uuv/a11y");
+/**
+ * Navigate to the Uri passed as a argument (full url consisting of the BASE_URL + Uri) or navigate to Url if begin with http:// or https://
+ * */
 (0, cypress_cucumber_preprocessor_1.When)(`I visit path {string}`, function (siteUrl) {
     if (siteUrl.match("^http:\\/\\/|https:\\/\\/")) {
         return cy.visit(`${siteUrl}`);
     }
     return cy.visit(`${Cypress.config().baseUrl}${siteUrl}`);
 });
+/**
+ * Triggers a click on the selected element.<br/>Make sure you've selected an element beforehand with the <strong>within...</strong> phrases.
+ * */
 (0, cypress_cucumber_preprocessor_1.When)(`I click`, function () {
     cy.uuvCheckContextFocusedElement().then(context => {
         context.focusedElement.click();
     });
 });
+/**
+ * Triggers a click on the given button with specific name
+ * */
 (0, cypress_cucumber_preprocessor_1.When)(`I click on button named {string}`, function (name) {
     click("button", name);
 });
+/**
+ * Triggers a click on the element with given role and specific name
+ * */
 (0, cypress_cucumber_preprocessor_1.When)(`I click on element with role {string} and name {string}`, function (role, name) {
     click(role, name);
 });
+/**
+ * Writes the sentence passed as a parameter (useful for example to fill in a form field).<br/>Make sure you've selected an element beforehand with the <strong>within...</strong> phrases.
+ * */
 (0, cypress_cucumber_preprocessor_1.When)(`I type the sentence {string}`, function (textToType) {
     cy.uuvCheckContextFocusedElement().then((context) => {
         context.focusedElement.focus();
         context.focusedElement.type(textToType);
     });
 });
+/**
+ * Press specified key multiple times using | as: num|{key}
+ * */
 (0, cypress_cucumber_preprocessor_1.When)(`I press {int} times on {string}`, function (nbTimes, key) {
     for (let i = 1; i <= nbTimes; i++) {
         cy.uuvCheckContextFocusedElement().then((context) => {
@@ -53,6 +72,9 @@ const core_engine_1 = require("../core-engine");
         });
     }
 });
+/**
+ * Press specified key: <table><thead><tr><th>Key</th><th>Description</th></tr></thead><tbody><tr><td>{tab}</td><td>Tabulation</td></tr><tr><td>{reverseTab}</td><td>Reverse tabulation</td></tr><tr><td>{down}</td><td>Arrow Down</td></tr><tr><td>{right}</td><td>Arrow Right</td></tr><tr><td>{left}</td><td>Arrow Left</td></tr><tr><td>{up}</td><td>Arrow Up</td></tr></tbody></table><br/>Make sure you've selected an element beforehand with the <strong>within...</strong> phrases.
+ * */
 (0, cypress_cucumber_preprocessor_1.When)(`I press {string}`, function (key) {
     cy.uuvCheckContextFocusedElement().then((context) => {
         context.focusedElement.focus();
@@ -62,20 +84,35 @@ const core_engine_1 = require("../core-engine");
 ////////////////////////////////////////////
 // Context ACTIONS
 ////////////////////////////////////////////
+/**
+ * Sets the viewport dimensions with one of the presets defined by your runtime engine as Cypress: [Link](https://docs.cypress.io/api/commands/viewport#Arguments) or Playwright: [Link](https://github.com/microsoft/playwright/blob/main/packages/playwright-core/src/server/deviceDescriptorsSource.json)
+ * */
 (0, cypress_cucumber_preprocessor_1.Given)(`I set viewport to preset {string}`, function (viewportPreset) {
     return cy.viewport(viewportPreset);
 });
+/**
+ * Sets the viewport dimensions to the specified width and length
+ * */
 (0, cypress_cucumber_preprocessor_1.Given)(`I set viewport with width {int} and height {int}`, function (width, height) {
     return cy.viewport(width, height);
 });
+/**
+ * Sets the timeout value (in millisecond) for finding element in the DOM <br />⚠ remember to deselect the element with <b>[I reset context](#i-reset-context)</b> if you're no longer acting on it
+ * */
 (0, cypress_cucumber_preprocessor_1.When)(`I set timeout with value {int}`, function (newTimeout) {
     return cy.uuvPatchContext({
         timeout: newTimeout
     });
 });
+/**
+ * key.when.withinElement.description
+ * */
 (0, cypress_cucumber_preprocessor_1.When)(`within the element with role {string} and name {string}`, function (role, name) {
     return (0, core_engine_1.withinRoleAndName)(role, name);
 });
+/**
+ * Selects the element whose aria-label is specified <br />⚠ remember to deselect the element with <b>[I reset context](#i-reset-context)</b> if you're no longer acting on it
+ * */
 (0, cypress_cucumber_preprocessor_1.When)(`within the element with aria-label {string}`, function (expectedAriaLabel) {
     const foundedElement = cy.uuvFindByLabelText(expectedAriaLabel, {})
         .uuvFoundedElement()
@@ -84,6 +121,9 @@ const core_engine_1 = require("../core-engine");
         focusedElement: foundedElement
     });
 });
+/**
+ * key.when.withinElement.description
+ * */
 (0, cypress_cucumber_preprocessor_1.When)(`within the element with testId {string}`, function (testId) {
     const foundedElement = cy.uuvFindByTestId(testId)
         .uuvFoundedElement()
@@ -92,6 +132,9 @@ const core_engine_1 = require("../core-engine");
         focusedElement: foundedElement
     });
 });
+/**
+ * Selects the element whose selector is specified <br />⚠ remember to deselect the element with <b>[I reset context](#i-reset-context)</b> if you're no longer acting on it
+ * */
 (0, cypress_cucumber_preprocessor_1.When)(`within the element with selector {string}`, function (selector) {
     const foundedElement = cy.uuvGetContext().then(context => {
         const parentElement = context.focusedElement;
@@ -109,9 +152,15 @@ const core_engine_1 = require("../core-engine");
         focusedElement: foundedElement
     });
 });
+/**
+ * Deletes selected element and timeout
+ * */
 (0, cypress_cucumber_preprocessor_1.When)(`I reset context`, function () {
     return cy.wrap(new _context_1.Context()).as("context");
 });
+/**
+ * Mock a named API response with body. <i>If you use Playwright as runtime engine, <b>request</b> and <b>named</b> are unused.</i>
+ * */
 (0, cypress_cucumber_preprocessor_1.When)(`I mock a request {} on url {string} named {string} with content {}`, function (verb, uri, name, body) {
     return cy
         .intercept(verb, uri, {
@@ -119,6 +168,9 @@ const core_engine_1 = require("../core-engine");
     })
         .as(name);
 });
+/**
+ * Mock a named API response with status code
+ * */
 (0, cypress_cucumber_preprocessor_1.When)(`I mock a request {} on url {string} named {string} with status code {int}`, function (verb, uri, name, statusCode) {
     return cy
         .intercept(verb, uri, {
@@ -126,6 +178,9 @@ const core_engine_1 = require("../core-engine");
     })
         .as(name);
 });
+/**
+ * Mock a named API response with file's extension .json, .js, .coffee, .html, .txt, .csv, .png, .jpg, .jpeg, .gif, .tif, .tiff, .zip
+ * */
 (0, cypress_cucumber_preprocessor_1.When)(`I mock a request {} on url {string} named {string} with fixture {}`, function (verb, uri, name, fixture) {
     return cy
         .intercept(verb, uri, {
@@ -136,6 +191,9 @@ const core_engine_1 = require("../core-engine");
 ////////////////////////////////////////////
 // INTERCEPTION
 ////////////////////////////////////////////
+/**
+ * Sets one or more headers to the indicated http request and only for the Http method (GET / POST / etc...) passed as a argument.<i> If you use Playwright as execution engine, <b>method</b> isn't used.</i>
+ * */
 (0, cypress_cucumber_preprocessor_1.When)(`I set header(s) for uri {string} and method {string}`, function (url, method, headersToSet) {
     cy.intercept(method, url, (req) => {
         req.headers = {
@@ -145,6 +203,9 @@ const core_engine_1 = require("../core-engine");
         req.continue();
     });
 });
+/**
+ * Sets one or more headers to the indicated http request
+ * */
 (0, cypress_cucumber_preprocessor_1.When)(`I set header(s) for uri {string}`, function (url, headersToSet) {
     cy.intercept(url, (req) => {
         req.headers = {
@@ -158,50 +219,83 @@ const core_engine_1 = require("../core-engine");
 // VALIDATION
 ////////////////////////////////////////////
 /**
- * Look for an element based on its content
- */
+ * Checks that an Html element exists with the specified content
+ * */
 (0, cypress_cucumber_preprocessor_1.Then)(`I should see an element with content {string}`, async function (textContent) {
     cy.uuvFindByText(textContent, {})
         .uuvFoundedElement()
         .should("exist");
 });
+/**
+ * Checks that an Html element does not exists with the specified content
+ * */
 (0, cypress_cucumber_preprocessor_1.Then)(`I should not see an element with content {string}`, async function (textContent) {
     cy.uuvFindByText(textContent, {})
         .should("not.exist");
 });
+/**
+ * Checks that an Html element exists with the specified data-testid attribute
+ * */
 (0, cypress_cucumber_preprocessor_1.Then)(`I should see an element with testId {string}`, async function (testId) {
     cy.uuvFindByTestId(testId)
         .uuvFoundedElement()
         .should("exist");
 });
+/**
+ * Checks that an Html element does not exists with the specified data-testid attribute
+ * */
 (0, cypress_cucumber_preprocessor_1.Then)(`I should not see an element with testId {string}`, async function (testId) {
     cy.uuvFindByTestId(testId)
         .should("not.exist");
 });
+/**
+ * Checks that an Html element exists with the specified [accessible role](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Roles#aria_role_types) and [name](https://russmaxdesign.github.io/html-elements-names/)
+ * */
 (0, cypress_cucumber_preprocessor_1.Then)(`I should see an element with role {string} and name {string}`, async function (role, name) {
     (0, core_engine_1.findWithRoleAndName)(role, name);
 });
+/**
+ * Checks that an Html element does not exists with the specified [accessible role](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Roles#aria_role_types) and [name](https://russmaxdesign.github.io/html-elements-names/)
+ * */
 (0, cypress_cucumber_preprocessor_1.Then)(`I should not see an element with role {string} and name {string}`, async function (role, name) {
     (0, core_engine_1.notFoundWithRoleAndName)(role, name);
 });
+/**
+ * Checks that an Html element exists with the specified [accessible role](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Roles#aria_role_types), [name](https://russmaxdesign.github.io/html-elements-names/) and content
+ * */
 (0, cypress_cucumber_preprocessor_1.Then)(`I should see an element with role {string} and name {string} and content {string}`, async function (expectedRole, name, expectedTextContent) {
     (0, core_engine_1.findWithRoleAndNameAndContent)(expectedRole, name, expectedTextContent);
 });
+/**
+ * Checks that an Html element exists with the specified [accessible role](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Roles#aria_role_types), [name](https://russmaxdesign.github.io/html-elements-names/) and content, and with the disabled attribute set to true
+ * */
 (0, cypress_cucumber_preprocessor_1.Then)(`I should see an element with role {string} and name {string} and content {string} disabled`, async function (expectedRole, name, expectedTextContent) {
     (0, core_engine_1.findWithRoleAndNameAndContentDisable)(expectedRole, name, expectedTextContent);
 });
+/**
+ * Checks that an Html element exists with the specified [accessible role](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Roles#aria_role_types), [name](https://russmaxdesign.github.io/html-elements-names/) and content, and with the disabled attribute set to false
+ * */
 (0, cypress_cucumber_preprocessor_1.Then)(`I should see an element with role {string} and name {string} and content {string} not disabled`, async function (expectedRole, name, expectedTextContent) {
     (0, core_engine_1.findWithRoleAndNameAndContentEnable)(expectedRole, name, expectedTextContent);
 });
+/**
+ * Checks that an Html element exists with the specified aria-label attribute
+ * */
 (0, cypress_cucumber_preprocessor_1.Then)(`I should see an element with aria-label {string}`, async function (expectedAriaLabel) {
     cy.uuvFindByLabelText(expectedAriaLabel, {})
         .uuvFoundedElement()
         .should("exist");
 });
+/**
+ * Checks that an Html element does not exists with the specified aria-label attribute
+ * */
 (0, cypress_cucumber_preprocessor_1.Then)(`I should not see an element with aria-label {string}`, async function (expectedAriaLabel) {
     cy.uuvFindByLabelText(expectedAriaLabel, {})
         .should("not.exist");
 });
+/**
+ * Checks that an Html element exists with the specified aria-label attribute and content
+ * */
 (0, cypress_cucumber_preprocessor_1.Then)(`I should see an element with aria-label {string} and content {string}`, async function (expectedAriaLabel, expectedTextContent) {
     cy.uuvFindByLabelText(expectedAriaLabel, {})
         .uuvFoundedElement()
@@ -211,12 +305,21 @@ const core_engine_1 = require("../core-engine");
         (0, core_engine_1.assertTextContent)(response, expectedTextContent);
     });
 });
+/**
+ * Wait that a named mock has been consumed until timeout
+ * */
 (0, cypress_cucumber_preprocessor_1.Then)(`I should consume a mock named {string}`, async function (name) {
     cy.wait([`@${name}`]);
 });
+/**
+ * key.when.click.withContext.description
+ * */
 (0, cypress_cucumber_preprocessor_1.Then)(`I wait {int} ms`, async function (ms) {
     cy.wait(ms);
 });
+/**
+ * Checks that there is a list with the specified [name](https://russmaxdesign.github.io/html-elements-names/) and content.<br/> See this <a href='https://github.com/Orange-OpenSource/uuv/blob/9e3c9914420c6d527f7ad8b0017a0f8e26250f86/example/weather-app.feature#L17'>example</a>
+ * */
 (0, cypress_cucumber_preprocessor_1.Then)(`I should see elements of the list with name {string}`, async function (expectedListName, expectedElementsOfList) {
     cy.uuvFindByRole("list", { name: expectedListName })
         .uuvFoundedElement()
@@ -228,10 +331,13 @@ const core_engine_1 = require("../core-engine");
                 foundedElement.push([listitem[i].textContent]);
             }
             assert.equal(listitem.length, expectedElementsOfList.raw().length);
-            assert.deepEqual(foundedElement, expectedElementsOfList.raw(), `expected [${expectedElementsOfList.raw()}] to be [${foundedElement}]`);
+            assert.deepEqual(foundedElement, expectedElementsOfList.raw(), `expected [${foundedElement}] to be [${expectedElementsOfList.raw()}]`);
         });
     });
 });
+/**
+ * Checks Html attributes of the selected element
+ * */
 (0, cypress_cucumber_preprocessor_1.Then)(`I should see these attributes with values`, async function (expectedAttributeList) {
     cy.uuvCheckContextFocusedElement().then((context) => {
         const elementToSelect = context.focusedElement;
@@ -244,26 +350,41 @@ const core_engine_1 = require("../core-engine");
         }
     });
 });
+/**
+ * Checks that an Html element exists with the specified selector
+ * */
 (0, cypress_cucumber_preprocessor_1.Then)(`I should see an element with selector {string}`, async function (selector) {
     cy.get(selector).should("exist");
 });
-(0, cypress_cucumber_preprocessor_1.Then)(`I should not have any accessibility issue`, async function () {
+/**
+ * Check that the current page have no accessibility issue for [axe-core](https://github.com/dequelabs/axe-core/blob/develop/doc/rule-descriptions.md)
+ * */
+(0, cypress_cucumber_preprocessor_1.Then)(`I should not have any axe-core accessibility issue`, async function () {
     cy.injectAxe();
     cy.checkA11y();
 });
-(0, cypress_cucumber_preprocessor_1.Then)(`I should not have any critical accessibility issue`, async function () {
+/**
+ * Check that the current page have not critical accessibility issue for [axe-core](https://github.com/dequelabs/axe-core/blob/develop/doc/rule-descriptions.md)
+ * */
+(0, cypress_cucumber_preprocessor_1.Then)(`I should not have any axe-core critical accessibility issue`, async function () {
     cy.injectAxe();
     cy.checkA11y(undefined, {
         includedImpacts: ["critical"]
     });
 });
-(0, cypress_cucumber_preprocessor_1.Then)(`I should not have any accessibility issue with {} impact(s)`, async function (impacts) {
+/**
+ * Check that the current page have not accessibility issue for [axe-core](https://github.com/dequelabs/axe-core/blob/develop/doc/rule-descriptions.md) with one or more impacts in: 'minor','moderate','serious','critical'
+ * */
+(0, cypress_cucumber_preprocessor_1.Then)(`I should not have any axe-core accessibility issue with {} impact(s)`, async function (impacts) {
     cy.injectAxe();
     cy.checkA11y(undefined, {
         includedImpacts: [impacts]
     });
 });
-(0, cypress_cucumber_preprocessor_1.Then)(`I should not have any accessibility issue with accessibility standard(s) {}`, async function (tags) {
+/**
+ * Check that the current page have not accessibility issue for [axe-core](https://github.com/dequelabs/axe-core/blob/develop/doc/rule-descriptions.md) [with one or more Accessibility Standards](https://github.com/dequelabs/axe-core/blob/HEAD/doc/API.md#axe-core-tags)
+ * */
+(0, cypress_cucumber_preprocessor_1.Then)(`I should not have any axe-core accessibility issue with accessibility standard(s) {}`, async function (tags) {
     cy.injectAxe();
     cy.checkA11y(undefined, {
         runOnly: {
@@ -272,7 +393,10 @@ const core_engine_1 = require("../core-engine");
         }
     });
 });
-(0, cypress_cucumber_preprocessor_1.Then)(`I should not have any accessibility issue with context json fixture {} and option json fixture {}`, async function (context, option) {
+/**
+ * Check that the current page have no accessibility issue for [axe-core](https://github.com/dequelabs/axe-core/blob/develop/doc/rule-descriptions.md) [with an option](https://github.com/dequelabs/axe-core/blob/HEAD/doc/API.md#options-parameter) on the specific [context](https://github.com/dequelabs/axe-core/blob/HEAD/doc/API.md#context-parameter)
+ * */
+(0, cypress_cucumber_preprocessor_1.Then)(`I should not have any axe-core accessibility issue with context json fixture {} and option json fixture {}`, async function (context, option) {
     cy.injectAxe();
     cy.fixture(context).then(context => {
         cy.fixture(option).then(option => {
@@ -280,12 +404,55 @@ const core_engine_1 = require("../core-engine");
         });
     });
 });
-(0, cypress_cucumber_preprocessor_1.Then)(`I should not have any accessibility issue with option json fixture {}`, async function (option) {
+/**
+ * Check that the current page have no accessibility issue for [axe-core](https://github.com/dequelabs/axe-core/blob/develop/doc/rule-descriptions.md) [with an option](https://github.com/dequelabs/axe-core/blob/HEAD/doc/API.md#options-parameter)
+ * */
+(0, cypress_cucumber_preprocessor_1.Then)(`I should not have any axe-core accessibility issue with option json fixture {}`, async function (option) {
     cy.injectAxe();
     cy.fixture(option).then(data => {
         cy.checkA11y(undefined, data);
     });
 });
+/**
+ * Check that the current page have no [accessibility issue](https://accessibilite.numerique.gouv.fr/methode/criteres-et-tests/) with one of reference : RGAA
+ * */
+(0, cypress_cucumber_preprocessor_1.Then)(`I should not have any rgaa accessibility issue`, async function () {
+    cy.injectUvvA11y();
+    cy.checkUvvA11y(a11y_1.A11yReferenceEnum.RGAA);
+    // const versionAlix = "5.2.1";
+    // cy.url().then(async (url) => {
+    // const rgaaChecker = new RgaaChecker(url);
+    // return rgaaChecker.validate()
+    //     .pipe(
+    //         tap((result: A11yResult) => {
+    //             result.ruleResults.forEach(ruleResult => {
+    //                 logValidatingA11yRule(result.reference, ruleResult);
+    //                 logA11yRuleResult(result.reference, ruleResult);
+    //             });
+    //             assert.equal(result.status, A11yResultStatus.SUCCESS, "A11y validation failed");
+    //         })
+    //     )
+    //     .toPromise();
+    // switch (reference) {
+    //     case "RGAA":
+    //         await new RgaaChecker(url, a11yCypressEngine).checkCriteria();
+    //     // new AlixError(versionAlix).checkCriteria();
+    //     // new AlixWarning(versionAlix).checkCriteria();
+    //     // new AlixAdvice(versionAlix).checkCriteria();
+    //     // new AlixObsolete(versionAlix).checkCriteria();
+    //     case "WCAG-WEB":
+    //         break;
+    //     case "WCAG-ANDROID":
+    //         break;
+    //     case "WCAG-IOS":
+    //         break;
+    // }
+    // });
+});
+(0, cypress_cucumber_preprocessor_1.Then)(`I should have the following result based on the rgaa reference`, async function (expectedResult) {
+    cy.injectUvvA11y();
+    cy.checkUvvA11y(a11y_1.A11yReferenceEnum.RGAA, JSON.parse(expectedResult));
+});
 function pressKey(context, key) {
     switch (key) {
         case runner_commons_1.KEY_PRESS.TAB: