Orange-OpenSource / uuv

Solution to facilitate the writing and execution of E2E tests understandable by any human
https://orange-opensource.github.io/uuv/
MIT License
101 stars 16 forks source link
a11y a11y-testing accessibility accessibility-testing bdd cucumber cypress e2e e2e-testing e2e-tests end-to-end end-to-end-testing gherkin hacktoberfest playwright tdd test test-automation testing-library uuv

UUV Logo

# UUV - User centric Usecases Validator

Discovering your application by usecase validation

Make test writing fast, understandable by any human understanding English or French.

## Benefits - If used correctly, integrates accessibility from the development stage - A living documentation is possible because we propose an unified language for developers and non-developers with a [rich dictionary](https://orange-opensource.github.io/uuv/docs/category/step-definition) of ready-to-use sentences - [@uuv/assistant](https://orange-opensource.github.io/uuv/docs/tools/uuv-assistant) that facilitates the writing of tests by suggesting the most accessible sentences - [JetBrains Plugin](https://orange-opensource.github.io/uuv/docs/tools/uuv-jetbrains-plugin) that helps you to write and execute your UUV E2E tests from JetBrains IDEs - Integrates several runtime engines: Cypress / Playwright - User friendly and standardized execution report([example](https://e2e-test-quest.github.io/kata-e2e-uuv/06-go-further/)) ### Comparison | Criteria | Cypress | Playwright | Testing library | UUV | |:-: |:-: |:-: |:-: |:-: | | User centrism | :x: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | | Native accessibility | :x: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | | Easy setup configuration for BDD test | :warning: | :warning: | :heavy_minus_sign: | :heavy_check_mark: | | Understandable by everyone
(included non dev) | :x: | :x: | :x: | :heavy_check_mark: | ### Syntax example With this dom example : ```html

Result

``` we see that the sentence proposed by **UUV is the most understandable** of all | Library | Syntax | |:--|:--| | Cypress | cy.get('h1').contains('Result') | | Playwright| await expect(page.getByTitle('Result')).toHaveCount(1) | | Testing library | expect(screen.getByTitle(/Result/i)).toBeTruthy() | | UUV | Then I should see a title named "Result"| ## Documentation documentation ## Libraries UUV a11y npm library UUV assistant npm library UUV cypress npm library UUV playwright npm library UUV commons npm library ## Concepts The `@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. ### The problem Automated software testing is a growing practice. It adds a better level of quality on the code of an application by verifying non-regression or validating use cases. The `End to End test` is a technique used to verify if an application (web, mobile...) behaves as expected, from start to finish. It consists in verifying that the end user can complete the main usage scenarios of the application. Unlike `unit test` which only aims to verifying the behavior of a function, or the `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. > 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)) Therefore, several additional questions arise: - How to clearly express use cases? - For omnichannel applications, how to check your application on different browsers and devices? For omnichannel applications, how do you check your application on different browsers and devices?** - How to perform relevant DOM checks from a user perspective ### Our solution To 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. ![Ecosystème UUV](./packages/docs/static/img/docs/ecosystem-uuv.png) ## License [ MIT license ](https://spdx.org/licenses/MIT.html) This project is licensed under the terms of the [MIT license](https://github.com/Orange-OpenSource/uuv/blob/main/LICENSE). ## Authors - [@luifr10](https://github.com/luifr10) - [@stanlee974](https://github.com/stanlee974)