@uuv/cypress 1.3.3 → 1.4.1

package/CHANGELOG.md

@@ -1,3 +1,24 @@
+## [1.4.1](https://github.com/e2e-test-quest/uuv/compare/runner-cypress-v1.4.0...runner-cypress-v1.4.1) (2023-05-19)
+
+
+### Bug Fixes
+
+* **assistant:** fix assistant css problem, [#120](https://github.com/e2e-test-quest/uuv/issues/120) ([026d66a](https://github.com/e2e-test-quest/uuv/commit/026d66ad6ad7e9090282f1734335c5a7b1e417c6))
+* release 1.4.0 package.json and rchangelog was not updated, [#117](https://github.com/e2e-test-quest/uuv/issues/117) ([cd7723d](https://github.com/e2e-test-quest/uuv/commit/cd7723d6d790dd5fd928a5d9d41bfd075159378a))
+* remove explicit plugin @semantic-release/git and just set commit message, [#117](https://github.com/e2e-test-quest/uuv/issues/117) ([ac1f818](https://github.com/e2e-test-quest/uuv/commit/ac1f8188cccbcb224acb15180cd0bd131aaa6cd1))
+
+# [1.4.0](https://github.com/e2e-test-quest/uuv/compare/runner-cypress-v1.3.3...runner-cypress-v1.4.0) (2023-05-16)
+
+### Bug Fixes
+
+* **runner-commons:** restructure documentation, [#112](https://github.com/e2e-test-quest/uuv/issues/112) ([f5db612](https://github.com/e2e-test-quest/uuv/commit/f5db612da3c31d2e6f4a3f647546167ebcbddaa5))
+* **runner-cypress:** add benefit block [#112](https://github.com/e2e-test-quest/uuv/issues/112) ([04cf36f](https://github.com/e2e-test-quest/uuv/commit/04cf36fd0e43614ae801bb08bf514a4ba3cca975))
+* **runner-cypress:** restructure documentation, [#112](https://github.com/e2e-test-quest/uuv/issues/112) ([43353a8](https://github.com/e2e-test-quest/uuv/commit/43353a88499e3270fa64c518b7332541e3a01652))
+
+### Features
+
+* **runner-playwright:** add error details and screenshot to report, fixes [#110](https://github.com/e2e-test-quest/uuv/issues/110) ([3c4a3cd](https://github.com/e2e-test-quest/uuv/commit/3c4a3cd192b90242dd07bbdc4bb3ece780ee0c40))
+
 ## [1.3.3](https://github.com/e2e-test-quest/uuv/compare/runner-cypress-v1.3.2...runner-cypress-v1.3.3) (2023-05-15)
 
 

package/README.md

@@ -1,4 +1,5 @@
-# @uuv/runner-cypress
+
+# @uuv/cypress
 <p align="center">  
 <a href="https://e2e-test-quest.github.io/uuv/">  
 <picture>  
@@ -6,9 +7,6 @@
 </picture>  
 </a>  
 </p>  
-<p align="center">  
-<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>  
-</p>  
 
 <h3 align="center">  
 Test as final user  
@@ -33,22 +31,40 @@ Make test writing fast, understandable by any human understanding English or Fre
 </a><br />  
 </p>  
 
-<div align="center">  
-<h4>  
-Demo in english 
-</h4>
-<a href="https://player.vimeo.com/video/822253247?texttrack=en&h=617306172d&amp;badge=0&amp;autopause=0&amp;player_id=0&amp;app_id=58479" rel="nofollow">
-    <img alt="runner-cypress in english" src="https://e2e-test-quest.github.io/uuv/img/cypress/screenshot.png" style="max-width: 100%;" width="75%" height="75%">
-  </a>
-<h4>  
-Demo in french 
-</h4>
-<a href="https://player.vimeo.com/video/822253247?texttrack=fr&h=617306172d&amp;badge=0&amp;autopause=0&amp;player_id=0&amp;app_id=58479" rel="nofollow">
-    <img alt="runner-cypress in french" src="https://e2e-test-quest.github.io/uuv/img/cypress/screenshot.png" style="max-width: 100%;" width="75%" height="75%">
-  </a>
-</div> 
-
-## What is @uuv/cypress ?
+## 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 of ready-to-use sentences
+- A wizard that facilitates the writing of tests by suggesting the most accessible sentences
+- Integrates several runtime engines: Cypress / Playwright
+- User-friendly and standardized execution report
+  ### <u>Comparison</u>
+| 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 <br> (included non dev) | :x: | :x: | :x: | :heavy_check_mark: |  
+
+### <u>Syntax example</u>
+With this dom example :
+  ```html
+  <body>
+  <h1>Result<h1>
+  </body>
+```
+we see that the sentence proposed by **UUV is the most understandable** of all
+| Library | Syntax |
+|:--|:--|
+| Cypress  | cy.get('result').should('exist') |
+| 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
+<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>
+
+## What is @uuv/cypress?
 
 <p align="center">  
 
@@ -56,20 +72,89 @@ The `@uuv` library (User centric Usecases Validator) is an ecosystem that simpli
 We can use the cypress engine to run test or playwright with [@uuv/playwright](https://www.npmjs.com/package/@uuv/playwright)
 </p>  
 
-## Installing
+## Demonstration
+
+### Demo in english
+<a href="https://player.vimeo.com/video/822253247?texttrack=en&h=617306172d&amp;badge=0&amp;autopause=0&amp;player_id=0&amp;app_id=58479" rel="nofollow">  
+<img alt="runner-cypress in english" src="https://e2e-test-quest.github.io/uuv/img/cypress/screenshot.png" style="max-width: 100%;" width="75%" height="75%" />  
+</a>  
+
+### Demo in french
+<a href="https://player.vimeo.com/video/822253247?texttrack=fr&h=617306172d&amp;badge=0&amp;autopause=0&amp;player_id=0&amp;app_id=58479" rel="nofollow">  
+<img alt="runner-cypress in french" src="https://e2e-test-quest.github.io/uuv/img/cypress/screenshot.png" style="max-width: 100%;" width="75%" height="75%" />  
+</a>   
 
-<a href="https://e2e-test-quest.github.io/uuv/docs/getting-started/installation#cypress"><img src="https://img.shields.io/badge/Install%20Cypress%20doc-red?&style=for-the-badge&logo=github&logoColor=white" alt="documentation for install uuv cypress"/></a>
+## Installation
 
+```bash  
+npm install --save-dev @uuv/cypress
+```  
+or
+```bash  
+yarn add -D @uuv/cypress
+``` 
+## Configuration  (optional)
 <a href="https://e2e-test-quest.github.io/uuv/docs/getting-started/configuration"><img src="https://img.shields.io/badge/Configure%20cypress%20doc-red?&style=for-the-badge&logo=github&logoColor=white" alt="documentation for configure uuv cypress"/></a>
 
+## Usage
+### Scenarios example
+You can find test examples here : [google.feature](https://github.com/e2e-test-quest/uuv/example/google.fr.feature)
+
+### Write test
+To write your first test, create the file `uuv/e2e/first-test.feature` in the project root with the following content :
+  ```gherkin
+  Feature: Hello World
+
+  Scenario: Search - Successful case
+    When I visit path "/"
+    Then I should see an element with role "heading" and name "My app title"
+  ```
+
+For more details, please go to the documentation:
 <a href="https://e2e-test-quest.github.io/uuv/docs/test/first-test"><img src="https://img.shields.io/badge/Write%20test%20doc-red?&style=for-the-badge&logo=github&logoColor=white" alt="documentation for write test"/></a>
 
+### Run test
+
+#### browser mode
+```bash  
+npx uuv open
+```  
+or
+```bash  
+yarn uuv open
+``` 
+
+#### headless mode
+##### without args
+```bash  
+npx uuv e2e
+```  
+or
+```bash  
+yarn uuv e2e
+```
+##### with args
+```bash  
+npx uuv e2e --browser=edge --env="{'TAGS':'@mobile'}" --generateHtmlReport
+```
+or
+```bash  
+yarn uuv e2e --browser=edge --env="{'TAGS':'@mobile'}" --generateHtmlReport
+```
+
+For more details, please go to the documentation:
 <a href="https://e2e-test-quest.github.io/uuv/docs/test/running-test"><img src="https://img.shields.io/badge/Run%20test%20doc-red?&style=for-the-badge&logo=github&logoColor=white" alt="documentation for run test"/></a>
 
 ## License
 
-[<a href="https://www.npmjs.com/package/@uuv/cypress">  
-<img src="https://img.shields.io/badge/license-Apache%202.0-blue" alt="npm"/>  
+[<a href="https://github.com/e2e-test-quest/uuv/blob/main/LICENSE">  
+<img src="https://img.shields.io/badge/license-Apache%202.0-blue" alt="apache license"/>  
 </a>](https://www.apache.org/licenses/LICENSE-2.0)
 
-This project is licensed under the terms of the [Apache 2.0 license](https://www.apache.org/licenses/LICENSE-2.0).
+This project is licensed under the terms of the [Apache 2.0 license](https://github.com/e2e-test-quest/uuv/blob/main/LICENSE).
+
+## Authors
+
+- [@luifr10](https://github.com/luifr10)
+- [@stanlee974](https://github.com/stanlee974)
+

package/dist/lib/uuv-cli.js

@@ -130,7 +130,7 @@ async function main() {
         return command;
     }
     function printBanner(getCurrentVersion) {
-        console.log(chalk_1.default.blueBright(figlet_1.default.textSync("UUV", {
+        console.log(chalk_1.default.blueBright(figlet_1.default.textSync("UUV - Cypress", {
             font: "Big",
             horizontalLayout: "default",
             verticalLayout: "default",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@uuv/cypress",
-  "version": "1.3.3",
+  "version": "1.4.1",
   "type": "commonjs",
   "author": "Louis Fredice NJAKO MOLOM (https://github.com/luifr10) & Stanley SERVICAL (https://github.com/stanlee974)",
   "description": "A solution to run E2E tests written in cucumber(BDD) with cypress.",
@@ -15,18 +15,22 @@
   },
   "keywords": [
     "uuv",
-    "UUV",
-    "E2E",
-    "end-to-end",
+    "e2e",
+    "end2end",
+    "end 2 end",
     "test",
     "testing",
-    "cypress",
-    "testing-library",
     "accessibility",
     "accessibilite",
     "a11y",
+    "cypress",
+    "playwright",
+    "testing-library",
     "cucumber",
-    "gherkin"
+    "gherkin",
+    "bdd",
+    "tdd",
+    "acceptance"
   ],
   "scripts": {
     "generate:step-definitions": "ts-node generate-step-definitions.ts",
@@ -42,7 +46,7 @@
     "@badeball/cypress-cucumber-preprocessor": "16.0.3",
     "@cypress/webpack-preprocessor": "5.17.0",
     "@testing-library/cypress": "9.0.0",
-    "@uuv/runner-commons": "1.3.3",
+    "@uuv/runner-commons": "1.4.1",
     "axe-core": "4.7.0",
     "chalk": "4.1.2",
     "cucumber-json-report-formatter": "0.1.4",