@uuv/cypress 2.3.0 → 2.4.1

package/CHANGELOG.md

@@ -1,3 +1,25 @@
+## [2.4.1](https://github.com/Orange-OpenSource/uuv/compare/runner-cypress-v2.4.0...runner-cypress-v2.4.1) (2024-01-21)
+
+
+### Bug Fixes
+
+* **a11y:** update dependency @testing-library/dom to v9.3.4 ([368b6b4](https://github.com/Orange-OpenSource/uuv/commit/368b6b4210f83d2da7695a0bfedd8ac593df171a))
+* **assistant:** fix assistant and enable uuv test for assistant, [#437](https://github.com/Orange-OpenSource/uuv/issues/437) ([da82e1b](https://github.com/Orange-OpenSource/uuv/commit/da82e1b588a391eb24573ac8c3f2db18cfdbf5a5))
+* **deps:** update dependency @easyops-cn/docusaurus-search-local to v0.40.1 ([d5ed3d7](https://github.com/Orange-OpenSource/uuv/commit/d5ed3d75f44e2b83af81fcd7227521dea00371e6))
+
+## [2.4.0](https://github.com/Orange-OpenSource/uuv/compare/runner-cypress-v2.3.0...runner-cypress-v2.4.0) (2024-01-11)
+
+
+### Features
+
+* **a11y:** add a contains sentence for a11y rgaa, [#424](https://github.com/Orange-OpenSource/uuv/issues/424) ([84d11c4](https://github.com/Orange-OpenSource/uuv/commit/84d11c46858970ce51eae28e8f74190c229c031e))
+* **a11y:** add a contains sentence for a11y rgaa, [#424](https://github.com/Orange-OpenSource/uuv/issues/424) ([297cc33](https://github.com/Orange-OpenSource/uuv/commit/297cc3378798d1eb9c973a2038423ae6f874f70f))
+
+
+### Bug Fixes
+
+* replace cy.uuvFindAllByRole by cy.findAllByRole to find listitem, [#340](https://github.com/Orange-OpenSource/uuv/issues/340) ([31c27cc](https://github.com/Orange-OpenSource/uuv/commit/31c27cc7cdcc81708700df147b7f0196e232e6af))
+
 ## [2.3.0](https://github.com/Orange-OpenSource/uuv/compare/runner-cypress-v2.2.1...runner-cypress-v2.3.0) (2024-01-08)
 
 

package/CONTRIBUTING.md

@@ -1,79 +1,6 @@
 # Contributors guide
 
-**Want to contribute?**
-We try to make it easy, and all contributions, even the smaller ones, are more than welcome.
-This includes bug reports, fixes, documentation, examples...
-But first, read this page (including the small print at the end).
+First, read the general [CONTRIBUTING](../../CONTRIBUTING.md) file
 
-Contributions are available on https://github.com/Orange-OpenSource/uuv
-
-## Legal
-
-All original contributions to _UUV_ are licensed under the
-[MIT License](https://spdx.org/licenses/MIT.html)
-
-All contributions are subject to the [Developer Certificate of Origin](https://developercertificate.org/) (DCO).
-The DCO is a lightweight way for contributors to certify that they wrote or otherwise have the right to submit the code they are contributing to the project.
-The DCO text is also included verbatim in the [DCO.txt](DCO.txt) file in the root directory of the repository.
-
-Contributors **must** _sign-off_ that they adhere to these requirements by adding a `Signed-off-by` line to commit messages, as shown below:
-
-```text
-This is the commit message
-
-Signed-off-by: Joe Dev <joe.dev@developer.example.org>
-```
-
-Git has a handy [`-s` command line option](https://git-scm.com/docs/git-commit#Documentation/git-commit.txt---signoff) to append this automatically to your commit message:
-
-```bash
-$ git commit -s -m 'This is the commit message'
-```
-
-## Reporting an issue
-
-This project uses Github issues to manage the issues.
-
-Before creating an issue:
-
-1. upgrade your project to the latest released template version, and check whether your bug is still present,
-2. have a look in the opened issues if your problem is already known/tracked, and possibly contribute to the thread with your own information.
-
-If none of the above was met, open an issue directly in Github, select the appropriate issue template and fill-in each section when applicable.
-
-## Submitting a code change
-
-### Git Setup
-
-Before contributing, make sure you have set up your Git authorship correctly:
-
-```bash
-git config --global user.name "Your Full Name"
-git config --global user.email your.email@example.com
-```
-
-### Workflow
-
-All submissions, including submissions by project members, need to be reviewed before being merged.
-
-To contribute:
-
-1. Create an issue describing the bug or enhancement you want to propose (select the right issue template).
-2. Make sure the issue has been reviewed and agreed.
-3. Create a Merge Request, from your **own** fork (see [forking workflow](https://docs.github.com/en/get-started/quickstart/fork-a-repo) documentation).
-   Don't hesitate to mark your MR as `Draft` as long as you think it's not ready to be reviewed.
-
-### Git Commit Conventions
-
-In addition to being signed-off according the [Developer Certificate of Origin](https://developercertificate.org/) (see above),
-Git commits in _UUV_ shall be:
-
-1. **atomic** (1 commit `=` 1 and only 1 _thing_),
-2. **semantic** (using [semantic-release commit message syntax](https://semantic-release.gitbook.io/semantic-release/#commit-message-format)).
-3. **pattern**
-   - **SCOPE**: one of (build, chore, ci, docs, feat, fix, perf, refactor, revert, style, test, release)
-   - **PACKAGE** _(optional)_: one of (assistant, assistant-electron, docs, intellij-plugin, runner-commons, runner-cypress, runner-playwright)
-   - **Pattern**: SCOPE(PACKAGE): commit message, #issue_identifier
-   - ```bash
-     perf(runner-cypress): optimize bdd request, #51
-     ```
+## How Contribue to @uuv/runner-cypress ?
+TODO

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

@@ -14,4 +14,4 @@
 */
 import { A11yReferenceEnum } from "@uuv/a11y";
 export declare const injectUvvA11y: () => void;
-export declare const checkUvvA11y: (reference: A11yReferenceEnum, expectedResult?: any) => void;
+export declare const checkUvvA11y: (reference: A11yReferenceEnum, expectedResult?: any, isContainsMode?: boolean) => void;

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

@@ -31,7 +31,7 @@ const injectUvvA11y = () => {
     }));
 };
 exports.injectUvvA11y = injectUvvA11y;
-const checkUvvA11y = (reference, expectedResult) => {
+const checkUvvA11y = (reference, expectedResult, isContainsMode = false) => {
     cy.window({ log: false })
         .then((win) => {
         const url = win.location.href;
@@ -40,7 +40,7 @@ const checkUvvA11y = (reference, expectedResult) => {
         return rgaaChecker?.validate()
             .pipe((0, rxjs_1.tap)((result) => {
             logAllA11yRuleResult(result);
-            assertWithExpectedResult(expectedResult, result);
+            assertWithExpectedResult(result, expectedResult, isContainsMode);
         }))
             .toPromise();
     });
@@ -62,13 +62,20 @@ function getA11yCheckerForReference(win, reference, url) {
     }
     return rgaaChecker;
 }
-function assertWithExpectedResult(expectedResult, result) {
+function assertWithExpectedResult(result, expectedResult, isContainsMode = false) {
+    const validationFailedMessage = "A11y validation failed";
     if (expectedResult) {
-        assert.deepEqual(result.summary(), expectedResult, "A11y validation failed");
+        if (!isContainsMode) {
+            assert.deepEqual(result.summary(), expectedResult, validationFailedMessage);
+        }
+        else {
+            cy.wrap(result.summary())
+                .should("containSubset", expectedResult);
+        }
     }
     else {
-        assert.notEqual(result.status, a11y_1.A11yResultStatus.ERROR, "A11y validation failed");
-        assert.notEqual(result.status, a11y_1.A11yResultStatus.UNKNOWN, "A11y validation failed");
+        assert.notEqual(result.status, a11y_1.A11yResultStatus.ERROR, validationFailedMessage);
+        assert.notEqual(result.status, a11y_1.A11yResultStatus.UNKNOWN, validationFailedMessage);
     }
 }
 function logAllA11yRuleResult(result) {

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

@@ -325,7 +325,7 @@ const a11y_1 = require("@uuv/a11y");
         .uuvFoundedElement()
         .should("exist")
         .within(() => {
-        return cy.uuvFindAllByRole("listitem", {}).then((listitem) => {
+        return cy.findAllByRole("listitem", {}).then((listitem) => {
             const foundedElement = [];
             for (let i = 0; i < listitem.length; i++) {
                 foundedElement.push([listitem[i].textContent]);
@@ -414,45 +414,20 @@ const a11y_1 = require("@uuv/a11y");
     });
 });
 /**
- * Check that the current page have no [accessibility issue](https://accessibilite.numerique.gouv.fr/methode/criteres-et-tests/) with one of reference : RGAA
+ * Check that the current page have no [accessibility issue](https://accessibilite.numerique.gouv.fr/methode/criteres-et-tests/) based on RGAA standards
  * */
 (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));
 });
+(0, cypress_cucumber_preprocessor_1.Then)(`I should have the following partial result based on the rgaa reference`, async function (expectedResult) {
+    cy.injectUvvA11y();
+    cy.checkUvvA11y(a11y_1.A11yReferenceEnum.RGAA, JSON.parse(expectedResult), true);
+});
 function pressKey(context, key) {
     switch (key) {
         case runner_commons_1.KEY_PRESS.TAB:

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

@@ -325,7 +325,7 @@ const a11y_1 = require("@uuv/a11y");
         .uuvFoundedElement()
         .should("exist")
         .within(() => {
-        return cy.uuvFindAllByRole("listitem", {}).then((listitem) => {
+        return cy.findAllByRole("listitem", {}).then((listitem) => {
             const foundedElement = [];
             for (let i = 0; i < listitem.length; i++) {
                 foundedElement.push([listitem[i].textContent]);
@@ -414,45 +414,20 @@ const a11y_1 = require("@uuv/a11y");
     });
 });
 /**
- * Vérifie sur la page courante qu'il n'y a aucune [erreur de conformité d'accessibilité](https://la-va11ydette.orange.com) avec un des référentiels : WCAG-WEB, RGAA et une des versions 4.1
+ * Vérifie sur la page courante qu'il n'y a aucune [erreur de conformité d'accessibilité](https://accessibilite.numerique.gouv.fr/methode/criteres-et-tests) avec un des référentiels : WCAG-WEB, RGAA et une des versions 4.1
  * */
 (0, cypress_cucumber_preprocessor_1.Then)(`je ne dois pas avoir de problèmes d'accessibilité rgaa`, 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)(`je dois avoir les résultats suivants selon le référentiel rgaa`, async function (expectedResult) {
     cy.injectUvvA11y();
     cy.checkUvvA11y(a11y_1.A11yReferenceEnum.RGAA, JSON.parse(expectedResult));
 });
+(0, cypress_cucumber_preprocessor_1.Then)(`je dois avoir les résultats partiels suivants selon le référentiel rgaa`, async function (expectedResult) {
+    cy.injectUvvA11y();
+    cy.checkUvvA11y(a11y_1.A11yReferenceEnum.RGAA, JSON.parse(expectedResult), true);
+});
 function pressKey(context, key) {
     switch (key) {
         case runner_commons_1.KEY_PRESS.TAB:

package/dist/cypress/commands.d.ts

@@ -31,7 +31,7 @@ declare global {
             uuvFindAllByRole(role: string, roleOptions: ByRoleOptions): Cypress.Chainable<JQuery<HTMLElement>>;
             uuvFoundedElement(): Cypress.Chainable<JQuery<HTMLElement>>;
             injectUvvA11y(): Cypress.Chainable<void>;
-            checkUvvA11y(reference: A11yReferenceEnum, expectedResult?: any): Cypress.Chainable<A11yResult>;
+            checkUvvA11y(reference: A11yReferenceEnum, expectedResult?: any, isContainsMode?: boolean): Cypress.Chainable<A11yResult>;
         }
     }
 }

package/dist/cypress/commands.js

@@ -31,3 +31,5 @@ Cypress.Commands.add("uuvFindAllByRole", __common_1.uuvFindAllByRole);
 Cypress.Commands.add("uuvFoundedElement", { prevSubject: true }, __common_1.uuvFoundedElement);
 Cypress.Commands.add("injectUvvA11y", a11y_engine_1.injectUvvA11y);
 Cypress.Commands.add("checkUvvA11y", a11y_engine_1.checkUvvA11y);
+const chaiSubset = require("chai-subset");
+chai.use(chaiSubset);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@uuv/cypress",
-  "version": "2.3.0",
+  "version": "2.4.1",
   "type": "commonjs",
   "author": "Louis Fredice NJAKO MOLOM (https://github.com/luifr10) & Stanley SERVICAL (https://github.com/stanlee974)",
   "description": "A solution to facilitate the writing and execution of E2E tests understandable by any human being using cucumber(BDD) and cypress",
@@ -46,9 +46,10 @@
     "@badeball/cypress-cucumber-preprocessor": "16.0.3",
     "@cypress/webpack-preprocessor": "5.17.1",
     "@testing-library/cypress": "9.0.0",
-    "@uuv/a11y": "1.0.0-beta.3",
-    "@uuv/runner-commons": "2.3.0",
+    "@uuv/a11y": "1.0.0-beta.5",
+    "@uuv/runner-commons": "2.4.1",
     "axe-core": "4.8.2",
+    "chai-subset": "^1.6.0",
     "chalk": "4.1.2",
     "cucumber-json-report-formatter": "0.1.4",
     "cypress": "12.17.4",

package/src/cucumber/step_definitions/cypress/generated/_en-generated-cucumber-steps-definition.ts

@@ -407,7 +407,7 @@ Then(
     .uuvFoundedElement()
     .should("exist")
     .within(() => {
-      return cy.uuvFindAllByRole("listitem", {}).then((listitem) => {
+      return cy.findAllByRole("listitem", {}).then((listitem) => {
         const foundedElement: any[] = [];
         for (let i = 0; i < listitem.length; i++) {
           foundedElement.push([listitem[i].textContent]);
@@ -526,42 +526,13 @@ Then(
 
 
 /**
- * Check that the current page have no [accessibility issue](https://accessibilite.numerique.gouv.fr/methode/criteres-et-tests/) with one of reference : RGAA
+ * Check that the current page have no [accessibility issue](https://accessibilite.numerique.gouv.fr/methode/criteres-et-tests/) based on RGAA standards
  * */
 Then(
  `I should not have any rgaa accessibility issue`,
  async function() {
      cy.injectUvvA11y();
      cy.checkUvvA11y(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;
-        // }
-    // });
  });
 
 Then(
@@ -571,6 +542,13 @@ Then(
         cy.checkUvvA11y(A11yReferenceEnum.RGAA, JSON.parse(expectedResult));
 });
 
+Then(
+    `I should have the following partial result based on the rgaa reference`,
+    async function(expectedResult: string) {
+        cy.injectUvvA11y();
+        cy.checkUvvA11y(A11yReferenceEnum.RGAA, JSON.parse(expectedResult), true);
+    });
+
 function pressKey(context: Cypress.Chainable<JQuery<HTMLElement>>, key: string) {
   switch (key) {
     case KEY_PRESS.TAB:

package/src/cucumber/step_definitions/cypress/generated/_fr-generated-cucumber-steps-definition.ts

@@ -407,7 +407,7 @@ Then(
     .uuvFoundedElement()
     .should("exist")
     .within(() => {
-      return cy.uuvFindAllByRole("listitem", {}).then((listitem) => {
+      return cy.findAllByRole("listitem", {}).then((listitem) => {
         const foundedElement: any[] = [];
         for (let i = 0; i < listitem.length; i++) {
           foundedElement.push([listitem[i].textContent]);
@@ -526,42 +526,13 @@ Then(
 
 
 /**
- * Vérifie sur la page courante qu'il n'y a aucune [erreur de conformité d'accessibilité](https://la-va11ydette.orange.com) avec un des référentiels : WCAG-WEB, RGAA et une des versions 4.1
+ * Vérifie sur la page courante qu'il n'y a aucune [erreur de conformité d'accessibilité](https://accessibilite.numerique.gouv.fr/methode/criteres-et-tests) avec un des référentiels : WCAG-WEB, RGAA et une des versions 4.1
  * */
 Then(
  `je ne dois pas avoir de problèmes d'accessibilité rgaa`,
  async function() {
      cy.injectUvvA11y();
      cy.checkUvvA11y(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;
-        // }
-    // });
  });
 
 Then(
@@ -571,6 +542,13 @@ Then(
         cy.checkUvvA11y(A11yReferenceEnum.RGAA, JSON.parse(expectedResult));
 });
 
+Then(
+    `je dois avoir les résultats partiels suivants selon le référentiel rgaa`,
+    async function(expectedResult: string) {
+        cy.injectUvvA11y();
+        cy.checkUvvA11y(A11yReferenceEnum.RGAA, JSON.parse(expectedResult), true);
+    });
+
 function pressKey(context: Cypress.Chainable<JQuery<HTMLElement>>, key: string) {
   switch (key) {
     case KEY_PRESS.TAB: