{
  "markdown": "<p align=\"center\">  \r\n<a href=\"https://e2e-test-quest.github.io/uuv/\">  \r\n<picture>  \r\n<img alt=\"UUV Logo\" src=\"https://e2e-test-quest.github.io/uuv/img/uuv.png\">  \r\n</picture>  \r\n</a>  \r\n</p>  \r\n\r\n# UUV - User centric Usecases Validator\r\n<h3 align=\"center\">  \r\nDiscovering your application by usecase validation  \r\n</h3>  \r\n\r\n<p align=\"center\">  \r\nMake test writing fast, understandable by any human understanding English or French.  \r\n</p>  \r\n\r\n## Benefits\r\n- If used correctly, integrates accessibility from the development stage\r\n- A living documentation is possible because we propose an unified language for developers and non-developers with a [rich dictionary](https://e2e-test-quest.github.io/uuv/docs/category/step-definition) of ready-to-use sentences\r\n- [@uuv/assistant](https://e2e-test-quest.github.io/uuv/docs/tools/uuv-assistant) that facilitates the writing of tests by suggesting the most accessible sentences\r\n- [JetBrains Plugin](https://e2e-test-quest.github.io/uuv/docs/tools/uuv-jetbrains-plugin) that helps you to write and execute your UUV E2E tests from JetBrains IDEs\r\n- Integrates several runtime engines: Cypress / Playwright\r\n- User friendly and standardized execution report([example](https://e2e-test-quest.github.io/kata-e2e-uuv/06-go-further/))\r\n  ### <u>Comparison</u>\r\n| Criteria | Cypress | Playwright | Testing library | UUV |  \r\n|:-: |:-: |:-: |:-: |:-: |  \r\n| User centrism | :x: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: |  \r\n| Native accessibility | :x: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: |  \r\n| Easy setup configuration for BDD test | :warning: | :warning: | :heavy_minus_sign: | :heavy_check_mark: |  \r\n| Understandable by everyone <br> (included non dev) | :x: | :x: | :x: | :heavy_check_mark: |  \r\n\r\n### <u>Syntax example</u>\r\nWith this dom example :\r\n  ```html\r\n  <body>\r\n  <h1>Result<h1>\r\n  </body>\r\n```\r\nwe see that the sentence proposed by **UUV is the most understandable** of all\r\n| Library | Syntax |\r\n|:--|:--|\r\n| Cypress  | cy.get('h1').contains('Result') |\r\n| Playwright| await expect(page.getByTitle('Result')).toHaveCount(1) |\r\n| Testing library  | expect(screen.getByTitle(/Result/i)).toBeTruthy() |\r\n| UUV | Then I should see a title named \"Result\"|\r\n\r\n## Documentation\r\n<a href=\"https://e2e-test-quest.github.io/uuv/\"><img src=\"https://img.shields.io/badge/documentation-black?&style=for-the-badge&logo=github&logoColor=white\" alt=\"documentation\"/></a>\r\n\r\n## Libraries\r\n<a href=\"https://www.npmjs.com/package/@uuv/a11y\"><img src=\"https://img.shields.io/badge/@uuv/a11y-uuv library to perform a11y checks-brown?logo=npm\" alt=\"UUV a11y npm library\"/></a>  \r\n<a href=\"https://www.npmjs.com/package/@uuv/assistant\"><img src=\"https://img.shields.io/badge/@uuv/assistant-Help module that generates the most accessible sentences based on a DOM element selection-yellow?logo=npm\" alt=\"UUV assistant npm library\"/></a>  \r\n<a href=\"https://www.npmjs.com/package/@uuv/cypress\"><img src=\"https://img.shields.io/badge/@uuv/cypress-Cypress engine to run uuv test-04C38E?logo=npm\" alt=\"UUV cypress npm library\"/></a>  \r\n<a href=\"https://www.npmjs.com/package/@uuv/playwright\"><img src=\"https://img.shields.io/badge/@uuv/playwright-Playwright engine to run uuv test-1dbb68?logo=npm\" alt=\"UUV playwright npm library\"/></a>  \r\n<a href=\"https://www.npmjs.com/package/@uuv/runner-commons\"><img src=\"https://img.shields.io/badge/@uuv/commons-shared library to use uuv-blue?logo=npm\" alt=\"UUV commons npm library\"/></a>\r\n\r\n## Concepts\r\n\r\nThe `@uuv` library (User centric Usecases Validator) is an ecosystem that simplifies the writing of End to End tests in a BDD approach and a user-centric way.\r\n\r\n### The problem\r\n\r\nAutomated software testing is a growing practice. It adds a better  \r\nlevel of quality on the code of an application by verifying non-regression or validating use cases.\r\n\r\n\r\nThe `End to End test` is a technique used to verify if an application (web,  \r\nmobile...) behaves as expected, from start to finish. It consists in verifying that the end user can complete the main usage scenarios of the application.\r\n\r\nUnlike `unit test` which only aims to verifying the behavior of a function, or  \r\nthe `integration test` which consists in making several modules of the application interact with each other in order to see their good cooperation, the `End to End test` allows to check from a browser (for example for web applications) the behavior of your application according to a set of use cases.\r\n\r\n> During the `E2E test`, the validations consist most of the time in checking the elements returned to the user via the web browser ([DOM](https://developer.mozilla.org/fr/docs/Web/API/Document_Object_Model))\r\n\r\nTherefore, several additional questions arise:\r\n\r\n- How to clearly express use cases?\r\n- For omnichannel applications, how to check your application on different browsers and devices?  \r\n  For omnichannel applications, how do you check your application on different browsers and devices?**\r\n- How to perform relevant DOM checks from a user perspective\r\n\r\n### Our solution\r\n\r\nTo answer the above issues and many others, our solution is to set up a coherent ecosystem based on tools that are references in their field.\r\n\r\n![Ecosystème UUV](./packages/docs/static/img/docs/ecosystem-uuv.png)\r\n\r\n\r\n## License\r\n\r\n[<a href=\"https://github.com/e2e-test-quest/uuv/blob/main/LICENSE\">  \r\n<img src=\"https://img.shields.io/badge/license-MIT-blue\" alt=\"MIT license\"/>  \r\n</a>](https://spdx.org/licenses/MIT.html)\r\n\r\nThis project is licensed under the terms of the [MIT license](https://github.com/e2e-test-quest/uuv/blob/main/LICENSE).\r\n\r\n## Sponsorship & Funding\r\nWe thank the following parties for sponsoring this project:\r\n\r\n<table>\r\n  <tr>\r\n    <td align=\"center\" width=\"200px\">\r\n      <a href=\"https://www.jetbrains.com/\">\r\n        <img src=\"https://resources.jetbrains.com/storage/products/company/brand/logos/jetbrains.png\" alt=\"JetBrains\">\r\n      </a>\r\n      <br>\r\n      <strong>JetBrains</strong>\r\n      <br>\r\n      Providing free open-source licenses for IntelliJ.\r\n    </td>\r\n    <td align=\"center\" width=\"200px\">\r\n      <!-- Placeholder for future sponsor -->\r\n    </td>\r\n    <td align=\"center\" width=\"200px\">\r\n      <!-- Placeholder for future sponsor -->\r\n    </td>\r\n  </tr>\r\n</table>\r\n\r\n### Support UUV through Open Collective\r\n\r\nIf you want to help UUV grow, you can fund the project directly via [Open Collective](https://opencollective.com/uuv).  \r\nEvery contribution helps us dedicate more time and energy to improving this open-source tool.\r\n\r\n<a href=\"https://opencollective.com/uuv/contribute\" target=\"_blank\">\r\n  <img src=\"https://opencollective.com/uuv/contribute/button@2x.png?color=blue\" width=300 />\r\n</a>\r\n\r\n\r\nInterested in becoming a sponsor?  \r\nWe welcome sponsorships of all sizes!  \r\nContact us via [GitHub](https://github.com/e2e-test-quest/uuv/discussions) or through [Open Collective](https://opencollective.com/uuv) to discuss opportunities.\r\n\r\n## Authors\r\n\r\n- [@luifr10](https://github.com/luifr10)\r\n- [@stanlee974](https://github.com/stanlee974)\r\n\r\n",
  "bytes": 7093,
  "sha": "7daf5a683f7651f7899aab8bff77db27b34717d96423edef2d28860b29ff2d21",
  "repo_slug": "e2e-test-quest/uuv",
  "fonte": "repo",
  "truncated": false,
  "api": "https://agentalog.com/api/listings/plg_e2e_test_quest_uuv_36e83c79/readme"
}