@uuv/cypress 1.3.3 → 1.4.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (3) hide show
  1. package/CHANGELOG.md +14 -0
  2. package/README.md +108 -24
  3. package/package.json +2 -2
package/CHANGELOG.md CHANGED
@@ -1,3 +1,17 @@
1
+ # [1.4.0](https://github.com/e2e-test-quest/uuv/compare/runner-cypress-v1.3.3...runner-cypress-v1.4.0) (2023-05-16)
2
+
3
+
4
+ ### Bug Fixes
5
+
6
+ * **runner-commons:** restructure documentation, [#112](https://github.com/e2e-test-quest/uuv/issues/112) ([f5db612](https://github.com/e2e-test-quest/uuv/commit/f5db612da3c31d2e6f4a3f647546167ebcbddaa5))
7
+ * **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))
8
+ * **runner-cypress:** restructure documentation, [#112](https://github.com/e2e-test-quest/uuv/issues/112) ([43353a8](https://github.com/e2e-test-quest/uuv/commit/43353a88499e3270fa64c518b7332541e3a01652))
9
+
10
+
11
+ ### Features
12
+
13
+ * **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))
14
+
1
15
  ## [1.3.3](https://github.com/e2e-test-quest/uuv/compare/runner-cypress-v1.3.2...runner-cypress-v1.3.3) (2023-05-15)
2
16
 
3
17
 
package/README.md CHANGED
@@ -1,3 +1,4 @@
1
+
1
2
  # @uuv/runner-cypress
2
3
  <p align="center">
3
4
  <a href="https://e2e-test-quest.github.io/uuv/">
@@ -6,9 +7,6 @@
6
7
  </picture>
7
8
  </a>
8
9
  </p>
9
- <p align="center">
10
- <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>
11
- </p>
12
10
 
13
11
  <h3 align="center">
14
12
  Test as final user
@@ -33,22 +31,40 @@ Make test writing fast, understandable by any human understanding English or Fre
33
31
  </a><br />
34
32
  </p>
35
33
 
36
- <div align="center">
37
- <h4>
38
- Demo in english
39
- </h4>
40
- <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">
41
- <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%">
42
- </a>
43
- <h4>
44
- Demo in french
45
- </h4>
46
- <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">
47
- <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%">
48
- </a>
49
- </div>
50
-
51
- ## What is @uuv/cypress ?
34
+ ## Benefits
35
+ - If used correctly, integrates accessibility from the development stage
36
+ - 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
37
+ - A wizard that facilitates the writing of tests by suggesting the most accessible sentences
38
+ - Integrates several runtime engines: Cypress / Playwright
39
+ - User-friendly and standardized execution report
40
+ ### <u>Comparison</u>
41
+ | Criteria | Cypress | Playwright | Testing library | UUV |
42
+ |:-: |:-: |:-: |:-: |:-: |
43
+ | User centrism | :x: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: |
44
+ | Native accessibility | :x: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: |
45
+ | Easy setup configuration for BDD test | :warning: | :warning: | :heavy_minus_sign: | :heavy_check_mark: |
46
+ | Understandable by everyone <br> (included non dev) | :x: | :x: | :x: | :heavy_check_mark: |
47
+
48
+ ### <u>Syntax example</u>
49
+ With this dom example :
50
+ ```html
51
+ <body>
52
+ <h1>Result<h1>
53
+ </body>
54
+ ```
55
+ we see that the sentence proposed by **UUV is the most understandable** of all
56
+ | Library | Syntax |
57
+ |:--|:--|
58
+ | Cypress | cy.get('result').should('exist') |
59
+ | Playwright| await expect(page.getByTitle('Result')).toHaveCount(1) |
60
+ | Testing library | expect(screen.getByTitle(/Result/i)).toBeTruthy() |
61
+ | UUV | Then I should see a title named "Result"|
62
+
63
+
64
+ ## Documentation
65
+ <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>
66
+
67
+ ## What is @uuv/cypress?
52
68
 
53
69
  <p align="center">
54
70
 
@@ -56,20 +72,88 @@ The `@uuv` library (User centric Usecases Validator) is an ecosystem that simpli
56
72
  We can use the cypress engine to run test or playwright with [@uuv/playwright](https://www.npmjs.com/package/@uuv/playwright)
57
73
  </p>
58
74
 
59
- ## Installing
75
+ ## Demonstration
76
+
77
+ ### Demo in english
78
+ <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">
79
+ <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%">
80
+ </a>
81
+
82
+ ### Demo in french
83
+ <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">
84
+ <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%">
85
+ </a>
60
86
 
61
- <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>
62
87
 
88
+ ## Installation
89
+
90
+
91
+ ```bash
92
+ npm install --save-dev @uuv/cypress
93
+ ```
94
+ or
95
+ ```bash
96
+ yarn add -D @uuv/cypress
97
+ ```
98
+ ## Configuration (optional)
63
99
  <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>
64
100
 
101
+ ## Usage
102
+ ### Write test
103
+ To write your first test, create the file `uuv/e2e/first-test.feature` in the project root with the following content :
104
+ ```gherkin
105
+ Feature: Hello World
106
+
107
+ Scenario: Search - Successful case
108
+ When I visit path "/"
109
+ Then I should see an element with role "heading" and name "My app title"
110
+ ```
111
+
112
+ For more details, please go to the documentation:
65
113
  <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>
66
114
 
115
+ ### Run test
116
+
117
+ #### browser mode
118
+ ```bash
119
+ npx uuv open
120
+ ```
121
+ or
122
+ ```bash
123
+ yarn uuv open
124
+ ```
125
+
126
+ #### headless mode
127
+ ##### without args
128
+ ```bash
129
+ npx uuv e2e
130
+ ```
131
+ or
132
+ ```bash
133
+ yarn uuv e2e
134
+ ```
135
+ ##### with args
136
+ ```bash
137
+ npx uuv e2e --browser=edge --env="{'TAGS':'@mobile'}" --generateHtmlReport
138
+ ```
139
+ or
140
+ ```bash
141
+ yarn uuv e2e --browser=edge --env="{'TAGS':'@mobile'}" --generateHtmlReport
142
+ ```
143
+
144
+ For more details, please go to the documentation:
67
145
  <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>
68
146
 
69
147
  ## License
70
148
 
71
- [<a href="https://www.npmjs.com/package/@uuv/cypress">
72
- <img src="https://img.shields.io/badge/license-Apache%202.0-blue" alt="npm"/>
149
+ [<a href="https://github.com/e2e-test-quest/uuv/blob/main/LICENSE">
150
+ <img src="https://img.shields.io/badge/license-Apache%202.0-blue" alt="apache license"/>
73
151
  </a>](https://www.apache.org/licenses/LICENSE-2.0)
74
152
 
75
- This project is licensed under the terms of the [Apache 2.0 license](https://www.apache.org/licenses/LICENSE-2.0).
153
+ This project is licensed under the terms of the [Apache 2.0 license](https://github.com/e2e-test-quest/uuv/blob/main/LICENSE).
154
+
155
+ ## Authors
156
+
157
+ - [@luifr10](https://github.com/luifr10)
158
+ - [@stanlee974](https://github.com/stanlee974)
159
+
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@uuv/cypress",
3
- "version": "1.3.3",
3
+ "version": "1.4.0",
4
4
  "type": "commonjs",
5
5
  "author": "Louis Fredice NJAKO MOLOM (https://github.com/luifr10) & Stanley SERVICAL (https://github.com/stanlee974)",
6
6
  "description": "A solution to run E2E tests written in cucumber(BDD) with cypress.",
@@ -42,7 +42,7 @@
42
42
  "@badeball/cypress-cucumber-preprocessor": "16.0.3",
43
43
  "@cypress/webpack-preprocessor": "5.17.0",
44
44
  "@testing-library/cypress": "9.0.0",
45
- "@uuv/runner-commons": "1.3.3",
45
+ "@uuv/runner-commons": "1.4.0",
46
46
  "axe-core": "4.7.0",
47
47
  "chalk": "4.1.2",
48
48
  "cucumber-json-report-formatter": "0.1.4",