testit-adapter-cypress 3.7.5 → 3.7.6
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.
- package/README.md +240 -240
- package/package.json +50 -50
package/README.md
CHANGED
|
@@ -1,240 +1,240 @@
|
|
|
1
|
-
# Test IT TMS adapters for Cypress
|
|
2
|
-

|
|
3
|
-
|
|
4
|
-
## Getting Started
|
|
5
|
-
|
|
6
|
-
### Installation
|
|
7
|
-
```
|
|
8
|
-
npm install testit-adapter-cypress
|
|
9
|
-
```
|
|
10
|
-
|
|
11
|
-
## Usage
|
|
12
|
-
|
|
13
|
-
### Configuration
|
|
14
|
-
|
|
15
|
-
| Description | File property | Environment variable |
|
|
16
|
-
|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------|--------------------------------------------|
|
|
17
|
-
| Location of the TMS instance | url | TMS_URL |
|
|
18
|
-
| API secret key [How to getting API secret key?](https://github.com/testit-tms/.github/tree/main/configuration#privatetoken) | privateToken | TMS_PRIVATE_TOKEN |
|
|
19
|
-
| ID of project in TMS instance [How to getting project ID?](https://github.com/testit-tms/.github/tree/main/configuration#projectid) | projectId | TMS_PROJECT_ID |
|
|
20
|
-
| ID of configuration in TMS instance [How to getting configuration ID?](https://github.com/testit-tms/.github/tree/main/configuration#configurationid) | configurationId | TMS_CONFIGURATION_ID |
|
|
21
|
-
| ID of the created test run in TMS instance.<br/>It's necessary for **adapterMode** 1 | testRunId | TMS_TEST_RUN_ID |
|
|
22
|
-
| Parameter for specifying the name of test run in TMS instance (**It's optional**). If it is not provided, it is created automatically | testRunName | TMS_TEST_RUN_NAME |
|
|
23
|
-
| Adapter mode. Default value - 1. The adapter supports following modes:<br>1 - in this mode, the adapter sends all results to the test run without filtering or [with filtering CLI](#run-with-filter)<br/>2 - in this mode, the adapter creates a new test run and sends results to the new test run | adapterMode | TMS_ADAPTER_MODE |
|
|
24
|
-
| It enables/disables certificate validation (**It's optional**). Default value - true | certValidation | TMS_CERT_VALIDATION |
|
|
25
|
-
| Mode of automatic creation test cases (**It's optional**). Default value - false. The adapter supports following modes:<br/>true - in this mode, the adapter will create a test case linked to the created autotest (not to the updated autotest)<br/>false - in this mode, the adapter will not create a test case | automaticCreationTestCases | TMS_AUTOMATIC_CREATION_TEST_CASES |
|
|
26
|
-
| Mode of automatic updation links to test cases (**It's optional**). Default value - false. The adapter supports following modes:<br/>true - in this mode, the adapter will update links to test cases<br/>false - in this mode, the adapter will not update link to test cases | automaticUpdationLinksToTestCases | TMS_AUTOMATIC_UPDATION_LINKS_TO_TEST_CASES |
|
|
27
|
-
|
|
28
|
-
Add Adapter to Cypress file configuration:
|
|
29
|
-
|
|
30
|
-
```ts
|
|
31
|
-
import { tmsCypress } from "testit-adapter-cypress/reporter";
|
|
32
|
-
|
|
33
|
-
export default {
|
|
34
|
-
e2e: {
|
|
35
|
-
setupNodeEvents(on, config) {
|
|
36
|
-
tmsCypress(on, config);
|
|
37
|
-
|
|
38
|
-
return config;
|
|
39
|
-
},
|
|
40
|
-
},
|
|
41
|
-
};
|
|
42
|
-
```
|
|
43
|
-
|
|
44
|
-
Add Adapter to `cypress/support/e2e.js`:
|
|
45
|
-
```ts
|
|
46
|
-
import "testit-adapter-cypress";
|
|
47
|
-
```
|
|
48
|
-
|
|
49
|
-
#### File
|
|
50
|
-
|
|
51
|
-
Create .env config or file config with default name tms.config.json in the root directory of the project
|
|
52
|
-
|
|
53
|
-
```json
|
|
54
|
-
{
|
|
55
|
-
"url": "URL",
|
|
56
|
-
"privateToken": "USER_PRIVATE_TOKEN",
|
|
57
|
-
"projectId": "PROJECT_ID",
|
|
58
|
-
"configurationId": "CONFIGURATION_ID",
|
|
59
|
-
"testRunId": "TEST_RUN_ID",
|
|
60
|
-
"testRunName": "TEST_RUN_NAME",
|
|
61
|
-
"adapterMode": "ADAPTER_MODE",
|
|
62
|
-
"automaticCreationTestCases": "AUTOMATIC_CREATION_TEST_CASES",
|
|
63
|
-
"automaticUpdationLinksToTestCases": "AUTOMATIC_UPDATION_LINKS_TO_TEST_CASES"
|
|
64
|
-
}
|
|
65
|
-
```
|
|
66
|
-
|
|
67
|
-
#### Parallel run
|
|
68
|
-
To create and complete TestRun you can use the Test IT CLI (use adapterMode 1 for parallel run):
|
|
69
|
-
|
|
70
|
-
```
|
|
71
|
-
$ export TMS_TOKEN=<YOUR_TOKEN>
|
|
72
|
-
$ testit testrun create
|
|
73
|
-
--url https://tms.testit.software \
|
|
74
|
-
--project-id 5236eb3f-7c05-46f9-a609-dc0278896464 \
|
|
75
|
-
--testrun-name "New test run" \
|
|
76
|
-
--output tmp/output.txt
|
|
77
|
-
|
|
78
|
-
$ export TMS_TEST_RUN_ID=$(cat tmp/output.txt)
|
|
79
|
-
|
|
80
|
-
$ npx cypress run
|
|
81
|
-
|
|
82
|
-
$ testit testrun complete
|
|
83
|
-
--url https://tms.testit.software \
|
|
84
|
-
--testrun-id $(cat tmp/output.txt)
|
|
85
|
-
```
|
|
86
|
-
|
|
87
|
-
#### Run with filter
|
|
88
|
-
It is necessary to use test filtering in cypress. This example uses the "@cypress/grep" plugin.
|
|
89
|
-
To create filter by autotests you can use the Test IT CLI (use adapterMode 1 for run with filter):
|
|
90
|
-
|
|
91
|
-
```
|
|
92
|
-
$ export TMS_TOKEN=<YOUR_TOKEN>
|
|
93
|
-
$ testit autotests_filter
|
|
94
|
-
--url https://tms.testit.software \
|
|
95
|
-
--configuration-id 5236eb3f-7c05-46f9-a609-dc0278896464 \
|
|
96
|
-
--testrun-id 6d4ac4b7-dd67-4805-b879-18da0b89d4a8 \
|
|
97
|
-
--framework cypress \
|
|
98
|
-
--output tmp/filter.txt
|
|
99
|
-
|
|
100
|
-
$ export TMS_TEST_RUN_ID=6d4ac4b7-dd67-4805-b879-18da0b89d4a8
|
|
101
|
-
$ export TMS_ADAPTER_MODE=1
|
|
102
|
-
|
|
103
|
-
$ npx cypress run --expose grep="$(cat tmp/filter.txt)"
|
|
104
|
-
```
|
|
105
|
-
|
|
106
|
-
#### Launch using GitLab repository
|
|
107
|
-
To run your Cypress test's from GitLab to TestIT or in reverse order using "testit-adapter-cypress", you can take this .gitlab-ci.yml file example:
|
|
108
|
-
|
|
109
|
-
```
|
|
110
|
-
image: node:latest
|
|
111
|
-
|
|
112
|
-
stages:
|
|
113
|
-
- run
|
|
114
|
-
|
|
115
|
-
first-job:
|
|
116
|
-
stage: run
|
|
117
|
-
script:
|
|
118
|
-
- npm install
|
|
119
|
-
- npx cypress run
|
|
120
|
-
artifacts:
|
|
121
|
-
paths:
|
|
122
|
-
- node_modules/
|
|
123
|
-
```
|
|
124
|
-
|
|
125
|
-
|
|
126
|
-
### Methods
|
|
127
|
-
|
|
128
|
-
Methods can be used to specify information about autotest.
|
|
129
|
-
|
|
130
|
-
Description of methods:
|
|
131
|
-
- `tms.addWorkItemIds` - a dynamic method that links autotests with manual tests. Receives the array of manual tests' IDs
|
|
132
|
-
- `tms.addDisplayName` - a dynamic method for adding internal autotest name (used in Test IT)
|
|
133
|
-
- `tms.addTitle` - a dynamic method for adding autotest name specified in the autotest card. If not specified, the name from the displayName method is used
|
|
134
|
-
- `tms.addDescription` - a dynamic method for adding autotest description specified in the autotest card
|
|
135
|
-
- `tms.addLabels` - a dynamic method for adding labels listed in the autotest card
|
|
136
|
-
- `tms.addTags` - a dynamic method for adding tags listed in the autotest card
|
|
137
|
-
- `tms.addLinks` - links in the autotest result
|
|
138
|
-
- `tms.addAttachments` - uploading files in the autotest result
|
|
139
|
-
- `tms.addMessage` - information about autotest in the autotest result
|
|
140
|
-
- `tms.addNameSpace` - a dynamic method for adding directory in the TMS system (default - file's name of test)
|
|
141
|
-
- `tms.addClassName` - a dynamic method for adding subdirectory in the TMS system (default - class's name of test)
|
|
142
|
-
- `tms.addParameter` - a dynamic method for adding parameter in the autotest result
|
|
143
|
-
- `tms.step` - usage in the "with" construct to designation a step in the body of the test
|
|
144
|
-
|
|
145
|
-
### Examples
|
|
146
|
-
|
|
147
|
-
#### Simple test
|
|
148
|
-
```ts
|
|
149
|
-
import { getTestRuntime } from "testit-adapter-cypress/runtime";
|
|
150
|
-
|
|
151
|
-
describe('example to-do app', () => {
|
|
152
|
-
it('displays two todo items by default', () => {
|
|
153
|
-
const tms = getTestRuntime();
|
|
154
|
-
|
|
155
|
-
tms.addWorkItemIds('123', '321');
|
|
156
|
-
tms.addDisplayName('display name');
|
|
157
|
-
tms.addTitle('test title');
|
|
158
|
-
tms.addDescription('Test description');
|
|
159
|
-
tms.addLabels('label1', 'label2');
|
|
160
|
-
tms.addTags('tag1', 'tag2');
|
|
161
|
-
tms.addLinks([
|
|
162
|
-
{
|
|
163
|
-
url: 'https://www.google.com',
|
|
164
|
-
title: 'Google',
|
|
165
|
-
description: 'This is a link to Google',
|
|
166
|
-
type: 'Related',
|
|
167
|
-
},
|
|
168
|
-
]);
|
|
169
|
-
tms.addParameter("name", "value");
|
|
170
|
-
tms.addNameSpace("namespace");
|
|
171
|
-
tms.addClassName("classname");
|
|
172
|
-
|
|
173
|
-
tms.step("step title", () => {
|
|
174
|
-
// ...
|
|
175
|
-
}).then((user) => {
|
|
176
|
-
tms.step("inner step title", () => {
|
|
177
|
-
// ...
|
|
178
|
-
});
|
|
179
|
-
});
|
|
180
|
-
});
|
|
181
|
-
});
|
|
182
|
-
```
|
|
183
|
-
|
|
184
|
-
### Parameterized test
|
|
185
|
-
|
|
186
|
-
> [!WARNING]
|
|
187
|
-
> When linking a parameterized autotest to a parameterized test case, please consider the problematic points:
|
|
188
|
-
> - In TMS test cases have a table with parameters, but autotests do not. They are not equal entities, so there may be incompatibility in terms of parameters
|
|
189
|
-
> - Running a parameterized test case, TMS expects the results of all related autotests with all the parameters specified in the test case table
|
|
190
|
-
> - In TMS, the parameters are limited to the string type, so the adapter transmits absolutely all the autotest parameters as a string. This implies the following problematic point for the test case table
|
|
191
|
-
> - TMS expects a complete **textual** match of the name and value of the parameters of the test case table with the autotest parameters
|
|
192
|
-
|
|
193
|
-
```ts
|
|
194
|
-
import { getTestRuntime } from "testit-adapter-cypress/runtime";
|
|
195
|
-
|
|
196
|
-
describe('example to-do app', () => {
|
|
197
|
-
const tests = [2, 3, "string", false];
|
|
198
|
-
|
|
199
|
-
tests.forEach((value) => {
|
|
200
|
-
it(`3 is ${value}`, () => {
|
|
201
|
-
const tms = getTestRuntime();
|
|
202
|
-
|
|
203
|
-
tms.addParameter("name", value);
|
|
204
|
-
// ...
|
|
205
|
-
});
|
|
206
|
-
});
|
|
207
|
-
});
|
|
208
|
-
```
|
|
209
|
-
|
|
210
|
-
#### Content types
|
|
211
|
-
```
|
|
212
|
-
TEXT = "text/plain",
|
|
213
|
-
XML = "application/xml",
|
|
214
|
-
HTML = "text/html",
|
|
215
|
-
CSV = "text/csv",
|
|
216
|
-
TSV = "text/tab-separated-values",
|
|
217
|
-
CSS = "text/css",
|
|
218
|
-
URI = "text/uri-list",
|
|
219
|
-
SVG = "image/svg+xml",
|
|
220
|
-
PNG = "image/png",
|
|
221
|
-
JSON = "application/json",
|
|
222
|
-
ZIP = "application/zip",
|
|
223
|
-
WEBM = "video/webm",
|
|
224
|
-
JPEG = "image/jpeg",
|
|
225
|
-
MP4 = "video/mp4",
|
|
226
|
-
```
|
|
227
|
-
|
|
228
|
-
# Contributing
|
|
229
|
-
|
|
230
|
-
You can help to develop the project. Any contributions are **greatly appreciated**.
|
|
231
|
-
|
|
232
|
-
* If you have suggestions for adding or removing projects, feel free to [open an issue](https://github.com/testit-tms/adapters-js/issues/new) to discuss it, or directly create a pull request after you edit the *README.md* file with necessary changes.
|
|
233
|
-
* Please make sure you check your spelling and grammar.
|
|
234
|
-
* Create individual PR for each suggestion.
|
|
235
|
-
* Please also read through the [Code Of Conduct](https://github.com/testit-tms/adapters-js/blob/master/CODE_OF_CONDUCT.md) before posting your first idea as well.
|
|
236
|
-
|
|
237
|
-
# License
|
|
238
|
-
|
|
239
|
-
Distributed under the Apache-2.0 License. See [LICENSE](https://github.com/testit-tms/adapters-js/blob/master/LICENSE.md) for more information.
|
|
240
|
-
|
|
1
|
+
# Test IT TMS adapters for Cypress
|
|
2
|
+

|
|
3
|
+
|
|
4
|
+
## Getting Started
|
|
5
|
+
|
|
6
|
+
### Installation
|
|
7
|
+
```
|
|
8
|
+
npm install testit-adapter-cypress
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
## Usage
|
|
12
|
+
|
|
13
|
+
### Configuration
|
|
14
|
+
|
|
15
|
+
| Description | File property | Environment variable |
|
|
16
|
+
|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------|--------------------------------------------|
|
|
17
|
+
| Location of the TMS instance | url | TMS_URL |
|
|
18
|
+
| API secret key [How to getting API secret key?](https://github.com/testit-tms/.github/tree/main/configuration#privatetoken) | privateToken | TMS_PRIVATE_TOKEN |
|
|
19
|
+
| ID of project in TMS instance [How to getting project ID?](https://github.com/testit-tms/.github/tree/main/configuration#projectid) | projectId | TMS_PROJECT_ID |
|
|
20
|
+
| ID of configuration in TMS instance [How to getting configuration ID?](https://github.com/testit-tms/.github/tree/main/configuration#configurationid) | configurationId | TMS_CONFIGURATION_ID |
|
|
21
|
+
| ID of the created test run in TMS instance.<br/>It's necessary for **adapterMode** 1 | testRunId | TMS_TEST_RUN_ID |
|
|
22
|
+
| Parameter for specifying the name of test run in TMS instance (**It's optional**). If it is not provided, it is created automatically | testRunName | TMS_TEST_RUN_NAME |
|
|
23
|
+
| Adapter mode. Default value - 1. The adapter supports following modes:<br>1 - in this mode, the adapter sends all results to the test run without filtering or [with filtering CLI](#run-with-filter)<br/>2 - in this mode, the adapter creates a new test run and sends results to the new test run | adapterMode | TMS_ADAPTER_MODE |
|
|
24
|
+
| It enables/disables certificate validation (**It's optional**). Default value - true | certValidation | TMS_CERT_VALIDATION |
|
|
25
|
+
| Mode of automatic creation test cases (**It's optional**). Default value - false. The adapter supports following modes:<br/>true - in this mode, the adapter will create a test case linked to the created autotest (not to the updated autotest)<br/>false - in this mode, the adapter will not create a test case | automaticCreationTestCases | TMS_AUTOMATIC_CREATION_TEST_CASES |
|
|
26
|
+
| Mode of automatic updation links to test cases (**It's optional**). Default value - false. The adapter supports following modes:<br/>true - in this mode, the adapter will update links to test cases<br/>false - in this mode, the adapter will not update link to test cases | automaticUpdationLinksToTestCases | TMS_AUTOMATIC_UPDATION_LINKS_TO_TEST_CASES |
|
|
27
|
+
|
|
28
|
+
Add Adapter to Cypress file configuration:
|
|
29
|
+
|
|
30
|
+
```ts
|
|
31
|
+
import { tmsCypress } from "testit-adapter-cypress/reporter";
|
|
32
|
+
|
|
33
|
+
export default {
|
|
34
|
+
e2e: {
|
|
35
|
+
setupNodeEvents(on, config) {
|
|
36
|
+
tmsCypress(on, config);
|
|
37
|
+
|
|
38
|
+
return config;
|
|
39
|
+
},
|
|
40
|
+
},
|
|
41
|
+
};
|
|
42
|
+
```
|
|
43
|
+
|
|
44
|
+
Add Adapter to `cypress/support/e2e.js`:
|
|
45
|
+
```ts
|
|
46
|
+
import "testit-adapter-cypress";
|
|
47
|
+
```
|
|
48
|
+
|
|
49
|
+
#### File
|
|
50
|
+
|
|
51
|
+
Create .env config or file config with default name tms.config.json in the root directory of the project
|
|
52
|
+
|
|
53
|
+
```json
|
|
54
|
+
{
|
|
55
|
+
"url": "URL",
|
|
56
|
+
"privateToken": "USER_PRIVATE_TOKEN",
|
|
57
|
+
"projectId": "PROJECT_ID",
|
|
58
|
+
"configurationId": "CONFIGURATION_ID",
|
|
59
|
+
"testRunId": "TEST_RUN_ID",
|
|
60
|
+
"testRunName": "TEST_RUN_NAME",
|
|
61
|
+
"adapterMode": "ADAPTER_MODE",
|
|
62
|
+
"automaticCreationTestCases": "AUTOMATIC_CREATION_TEST_CASES",
|
|
63
|
+
"automaticUpdationLinksToTestCases": "AUTOMATIC_UPDATION_LINKS_TO_TEST_CASES"
|
|
64
|
+
}
|
|
65
|
+
```
|
|
66
|
+
|
|
67
|
+
#### Parallel run
|
|
68
|
+
To create and complete TestRun you can use the Test IT CLI (use adapterMode 1 for parallel run):
|
|
69
|
+
|
|
70
|
+
```
|
|
71
|
+
$ export TMS_TOKEN=<YOUR_TOKEN>
|
|
72
|
+
$ testit testrun create
|
|
73
|
+
--url https://tms.testit.software \
|
|
74
|
+
--project-id 5236eb3f-7c05-46f9-a609-dc0278896464 \
|
|
75
|
+
--testrun-name "New test run" \
|
|
76
|
+
--output tmp/output.txt
|
|
77
|
+
|
|
78
|
+
$ export TMS_TEST_RUN_ID=$(cat tmp/output.txt)
|
|
79
|
+
|
|
80
|
+
$ npx cypress run
|
|
81
|
+
|
|
82
|
+
$ testit testrun complete
|
|
83
|
+
--url https://tms.testit.software \
|
|
84
|
+
--testrun-id $(cat tmp/output.txt)
|
|
85
|
+
```
|
|
86
|
+
|
|
87
|
+
#### Run with filter
|
|
88
|
+
It is necessary to use test filtering in cypress. This example uses the "@cypress/grep" plugin.
|
|
89
|
+
To create filter by autotests you can use the Test IT CLI (use adapterMode 1 for run with filter):
|
|
90
|
+
|
|
91
|
+
```
|
|
92
|
+
$ export TMS_TOKEN=<YOUR_TOKEN>
|
|
93
|
+
$ testit autotests_filter
|
|
94
|
+
--url https://tms.testit.software \
|
|
95
|
+
--configuration-id 5236eb3f-7c05-46f9-a609-dc0278896464 \
|
|
96
|
+
--testrun-id 6d4ac4b7-dd67-4805-b879-18da0b89d4a8 \
|
|
97
|
+
--framework cypress \
|
|
98
|
+
--output tmp/filter.txt
|
|
99
|
+
|
|
100
|
+
$ export TMS_TEST_RUN_ID=6d4ac4b7-dd67-4805-b879-18da0b89d4a8
|
|
101
|
+
$ export TMS_ADAPTER_MODE=1
|
|
102
|
+
|
|
103
|
+
$ npx cypress run --expose grep="$(cat tmp/filter.txt)"
|
|
104
|
+
```
|
|
105
|
+
|
|
106
|
+
#### Launch using GitLab repository
|
|
107
|
+
To run your Cypress test's from GitLab to TestIT or in reverse order using "testit-adapter-cypress", you can take this .gitlab-ci.yml file example:
|
|
108
|
+
|
|
109
|
+
```
|
|
110
|
+
image: node:latest
|
|
111
|
+
|
|
112
|
+
stages:
|
|
113
|
+
- run
|
|
114
|
+
|
|
115
|
+
first-job:
|
|
116
|
+
stage: run
|
|
117
|
+
script:
|
|
118
|
+
- npm install
|
|
119
|
+
- npx cypress run
|
|
120
|
+
artifacts:
|
|
121
|
+
paths:
|
|
122
|
+
- node_modules/
|
|
123
|
+
```
|
|
124
|
+
|
|
125
|
+
|
|
126
|
+
### Methods
|
|
127
|
+
|
|
128
|
+
Methods can be used to specify information about autotest.
|
|
129
|
+
|
|
130
|
+
Description of methods:
|
|
131
|
+
- `tms.addWorkItemIds` - a dynamic method that links autotests with manual tests. Receives the array of manual tests' IDs
|
|
132
|
+
- `tms.addDisplayName` - a dynamic method for adding internal autotest name (used in Test IT)
|
|
133
|
+
- `tms.addTitle` - a dynamic method for adding autotest name specified in the autotest card. If not specified, the name from the displayName method is used
|
|
134
|
+
- `tms.addDescription` - a dynamic method for adding autotest description specified in the autotest card
|
|
135
|
+
- `tms.addLabels` - a dynamic method for adding labels listed in the autotest card
|
|
136
|
+
- `tms.addTags` - a dynamic method for adding tags listed in the autotest card
|
|
137
|
+
- `tms.addLinks` - links in the autotest result
|
|
138
|
+
- `tms.addAttachments` - uploading files in the autotest result
|
|
139
|
+
- `tms.addMessage` - information about autotest in the autotest result
|
|
140
|
+
- `tms.addNameSpace` - a dynamic method for adding directory in the TMS system (default - file's name of test)
|
|
141
|
+
- `tms.addClassName` - a dynamic method for adding subdirectory in the TMS system (default - class's name of test)
|
|
142
|
+
- `tms.addParameter` - a dynamic method for adding parameter in the autotest result
|
|
143
|
+
- `tms.step` - usage in the "with" construct to designation a step in the body of the test
|
|
144
|
+
|
|
145
|
+
### Examples
|
|
146
|
+
|
|
147
|
+
#### Simple test
|
|
148
|
+
```ts
|
|
149
|
+
import { getTestRuntime } from "testit-adapter-cypress/runtime";
|
|
150
|
+
|
|
151
|
+
describe('example to-do app', () => {
|
|
152
|
+
it('displays two todo items by default', () => {
|
|
153
|
+
const tms = getTestRuntime();
|
|
154
|
+
|
|
155
|
+
tms.addWorkItemIds('123', '321');
|
|
156
|
+
tms.addDisplayName('display name');
|
|
157
|
+
tms.addTitle('test title');
|
|
158
|
+
tms.addDescription('Test description');
|
|
159
|
+
tms.addLabels('label1', 'label2');
|
|
160
|
+
tms.addTags('tag1', 'tag2');
|
|
161
|
+
tms.addLinks([
|
|
162
|
+
{
|
|
163
|
+
url: 'https://www.google.com',
|
|
164
|
+
title: 'Google',
|
|
165
|
+
description: 'This is a link to Google',
|
|
166
|
+
type: 'Related',
|
|
167
|
+
},
|
|
168
|
+
]);
|
|
169
|
+
tms.addParameter("name", "value");
|
|
170
|
+
tms.addNameSpace("namespace");
|
|
171
|
+
tms.addClassName("classname");
|
|
172
|
+
|
|
173
|
+
tms.step("step title", () => {
|
|
174
|
+
// ...
|
|
175
|
+
}).then((user) => {
|
|
176
|
+
tms.step("inner step title", () => {
|
|
177
|
+
// ...
|
|
178
|
+
});
|
|
179
|
+
});
|
|
180
|
+
});
|
|
181
|
+
});
|
|
182
|
+
```
|
|
183
|
+
|
|
184
|
+
### Parameterized test
|
|
185
|
+
|
|
186
|
+
> [!WARNING]
|
|
187
|
+
> When linking a parameterized autotest to a parameterized test case, please consider the problematic points:
|
|
188
|
+
> - In TMS test cases have a table with parameters, but autotests do not. They are not equal entities, so there may be incompatibility in terms of parameters
|
|
189
|
+
> - Running a parameterized test case, TMS expects the results of all related autotests with all the parameters specified in the test case table
|
|
190
|
+
> - In TMS, the parameters are limited to the string type, so the adapter transmits absolutely all the autotest parameters as a string. This implies the following problematic point for the test case table
|
|
191
|
+
> - TMS expects a complete **textual** match of the name and value of the parameters of the test case table with the autotest parameters
|
|
192
|
+
|
|
193
|
+
```ts
|
|
194
|
+
import { getTestRuntime } from "testit-adapter-cypress/runtime";
|
|
195
|
+
|
|
196
|
+
describe('example to-do app', () => {
|
|
197
|
+
const tests = [2, 3, "string", false];
|
|
198
|
+
|
|
199
|
+
tests.forEach((value) => {
|
|
200
|
+
it(`3 is ${value}`, () => {
|
|
201
|
+
const tms = getTestRuntime();
|
|
202
|
+
|
|
203
|
+
tms.addParameter("name", value);
|
|
204
|
+
// ...
|
|
205
|
+
});
|
|
206
|
+
});
|
|
207
|
+
});
|
|
208
|
+
```
|
|
209
|
+
|
|
210
|
+
#### Content types
|
|
211
|
+
```
|
|
212
|
+
TEXT = "text/plain",
|
|
213
|
+
XML = "application/xml",
|
|
214
|
+
HTML = "text/html",
|
|
215
|
+
CSV = "text/csv",
|
|
216
|
+
TSV = "text/tab-separated-values",
|
|
217
|
+
CSS = "text/css",
|
|
218
|
+
URI = "text/uri-list",
|
|
219
|
+
SVG = "image/svg+xml",
|
|
220
|
+
PNG = "image/png",
|
|
221
|
+
JSON = "application/json",
|
|
222
|
+
ZIP = "application/zip",
|
|
223
|
+
WEBM = "video/webm",
|
|
224
|
+
JPEG = "image/jpeg",
|
|
225
|
+
MP4 = "video/mp4",
|
|
226
|
+
```
|
|
227
|
+
|
|
228
|
+
# Contributing
|
|
229
|
+
|
|
230
|
+
You can help to develop the project. Any contributions are **greatly appreciated**.
|
|
231
|
+
|
|
232
|
+
* If you have suggestions for adding or removing projects, feel free to [open an issue](https://github.com/testit-tms/adapters-js/issues/new) to discuss it, or directly create a pull request after you edit the *README.md* file with necessary changes.
|
|
233
|
+
* Please make sure you check your spelling and grammar.
|
|
234
|
+
* Create individual PR for each suggestion.
|
|
235
|
+
* Please also read through the [Code Of Conduct](https://github.com/testit-tms/adapters-js/blob/master/CODE_OF_CONDUCT.md) before posting your first idea as well.
|
|
236
|
+
|
|
237
|
+
# License
|
|
238
|
+
|
|
239
|
+
Distributed under the Apache-2.0 License. See [LICENSE](https://github.com/testit-tms/adapters-js/blob/master/LICENSE.md) for more information.
|
|
240
|
+
|
package/package.json
CHANGED
|
@@ -1,50 +1,50 @@
|
|
|
1
|
-
{
|
|
2
|
-
"name": "testit-adapter-cypress",
|
|
3
|
-
"version": "3.7.
|
|
4
|
-
"description": "Cypress adapter for Test IT",
|
|
5
|
-
"license": "Apache-2.0",
|
|
6
|
-
"author": {
|
|
7
|
-
"name": "Integration team",
|
|
8
|
-
"email": "integrations@testit.software"
|
|
9
|
-
},
|
|
10
|
-
"repository": {
|
|
11
|
-
"type": "git",
|
|
12
|
-
"url": "git+https://github.com/testit-tms/adapters-js.git"
|
|
13
|
-
},
|
|
14
|
-
"keywords": [],
|
|
15
|
-
"main": "./dist/index.js",
|
|
16
|
-
"types": "./dist/index.d.ts",
|
|
17
|
-
"exports": {
|
|
18
|
-
".": {
|
|
19
|
-
"types": "./dist/index.d.ts",
|
|
20
|
-
"default": "./dist/index.js"
|
|
21
|
-
},
|
|
22
|
-
"./reporter": {
|
|
23
|
-
"types": "./dist/reporter.d.ts",
|
|
24
|
-
"default": "./dist/reporter.js"
|
|
25
|
-
},
|
|
26
|
-
"./runtime": {
|
|
27
|
-
"types": "./dist/browser/runtime.d.ts",
|
|
28
|
-
"default": "./dist/browser/runtime.js"
|
|
29
|
-
}
|
|
30
|
-
},
|
|
31
|
-
"scripts": {
|
|
32
|
-
"clean": "rimraf ./dist ./out",
|
|
33
|
-
"prebuild": "npm --prefix ../testit-js-commons run build && npm link ../testit-js-commons",
|
|
34
|
-
"build": "tsc -p tsconfig.json"
|
|
35
|
-
},
|
|
36
|
-
"devDependencies": {
|
|
37
|
-
"cypress": "14.2.0",
|
|
38
|
-
"typescript": "^5.2.2",
|
|
39
|
-
"esbuild": "^0.27.0",
|
|
40
|
-
"eslint": "^8.57.0",
|
|
41
|
-
"@types/eslint": "^8.56.11",
|
|
42
|
-
"@types/node": "^20.14.2"
|
|
43
|
-
},
|
|
44
|
-
"dependencies": {
|
|
45
|
-
"testit-js-commons": "3.7.
|
|
46
|
-
},
|
|
47
|
-
"files": [
|
|
48
|
-
"dist"
|
|
49
|
-
]
|
|
50
|
-
}
|
|
1
|
+
{
|
|
2
|
+
"name": "testit-adapter-cypress",
|
|
3
|
+
"version": "3.7.6",
|
|
4
|
+
"description": "Cypress adapter for Test IT",
|
|
5
|
+
"license": "Apache-2.0",
|
|
6
|
+
"author": {
|
|
7
|
+
"name": "Integration team",
|
|
8
|
+
"email": "integrations@testit.software"
|
|
9
|
+
},
|
|
10
|
+
"repository": {
|
|
11
|
+
"type": "git",
|
|
12
|
+
"url": "git+https://github.com/testit-tms/adapters-js.git"
|
|
13
|
+
},
|
|
14
|
+
"keywords": [],
|
|
15
|
+
"main": "./dist/index.js",
|
|
16
|
+
"types": "./dist/index.d.ts",
|
|
17
|
+
"exports": {
|
|
18
|
+
".": {
|
|
19
|
+
"types": "./dist/index.d.ts",
|
|
20
|
+
"default": "./dist/index.js"
|
|
21
|
+
},
|
|
22
|
+
"./reporter": {
|
|
23
|
+
"types": "./dist/reporter.d.ts",
|
|
24
|
+
"default": "./dist/reporter.js"
|
|
25
|
+
},
|
|
26
|
+
"./runtime": {
|
|
27
|
+
"types": "./dist/browser/runtime.d.ts",
|
|
28
|
+
"default": "./dist/browser/runtime.js"
|
|
29
|
+
}
|
|
30
|
+
},
|
|
31
|
+
"scripts": {
|
|
32
|
+
"clean": "rimraf ./dist ./out",
|
|
33
|
+
"prebuild": "npm --prefix ../testit-js-commons run build && npm link ../testit-js-commons",
|
|
34
|
+
"build": "tsc -p tsconfig.json"
|
|
35
|
+
},
|
|
36
|
+
"devDependencies": {
|
|
37
|
+
"cypress": "14.2.0",
|
|
38
|
+
"typescript": "^5.2.2",
|
|
39
|
+
"esbuild": "^0.27.0",
|
|
40
|
+
"eslint": "^8.57.0",
|
|
41
|
+
"@types/eslint": "^8.56.11",
|
|
42
|
+
"@types/node": "^20.14.2"
|
|
43
|
+
},
|
|
44
|
+
"dependencies": {
|
|
45
|
+
"testit-js-commons": "3.7.6"
|
|
46
|
+
},
|
|
47
|
+
"files": [
|
|
48
|
+
"dist"
|
|
49
|
+
]
|
|
50
|
+
}
|