testcafe-reporter-testit 2.2.2 → 2.2.3

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 (2) hide show
  1. package/README.md +19 -23
  2. package/package.json +2 -2
package/README.md CHANGED
@@ -10,29 +10,22 @@ npm install testcafe-reporter-testit
10
10
 
11
11
  ## Configuration
12
12
 
13
- | Description | File property | Environment variable |
14
- |------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------|-----------------------------------|
15
- | Location of the TMS instance | url | TMS_URL |
16
- | API secret key <br/>[How to getting API secret key?](https://github.com/testit-tms/.github/tree/main/configuration#privatetoken) | privateToken | TMS_PRIVATE_TOKEN |
17
- | ID of project in TMS instance <br/>[How to getting project ID?](https://github.com/testit-tms/.github/tree/main/configuration#projectid) | projectId | TMS_PROJECT_ID |
18
- | ID of configuration in TMS instance <br/>[How to getting configuration ID?](https://github.com/testit-tms/.github/tree/main/configuration#configurationid) | configurationId | TMS_CONFIGURATION_ID |
19
- | ID of the created test run in TMS instance.<br/>It's necessary for **adapterMode** 0 or 1 | testRunId | TMS_TEST_RUN_ID |
20
- | Parameter for specifying the name of test run in TMS instance (**It's optional**). <br/>If it is not provided, it is created automatically | testRunName | TMS_TEST_RUN_NAME |
21
- | Adapter mode * | adapterMode | TMS_ADAPTER_MODE |
22
- | Mode of automatic creation test cases ** (**It's optional**). | automaticCreationTestCases | TMS_AUTOMATIC_CREATION_TEST_CASES |
23
-
24
- *The adapter supports following modes:
25
- * 0 - in this mode, the adapter filters tests by external id and sends the results to the test run. **Default value**.
26
- * 1 - in this mode, the adapter sends all results to the test run without filtering
27
- * 2 - in this mode, the adapter creates a new test run and sends results to the new test run
28
-
29
- **The adapter supports following modes:
30
- * true - in this mode, the adapter will create a test case linked to the created autotest (not to the updated autotest)
31
- * false - in this mode, the adapter will not create a test case. **Default value**.
13
+ | Description | File property | Environment variable |
14
+ |----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------|--------------------------------------------|
15
+ | Location of the TMS instance | url | TMS_URL |
16
+ | API secret key [How to getting API secret key?](https://github.com/testit-tms/.github/tree/main/configuration#privatetoken) | privateToken | TMS_PRIVATE_TOKEN |
17
+ | 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 |
18
+ | 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 |
19
+ | ID of the created test run in TMS instance.<br/>It's necessary for **adapterMode** 0 or 1 | testRunId | TMS_TEST_RUN_ID |
20
+ | 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 |
21
+ | Adapter mode. Default value - 0. The adapter supports following modes:<br/>0 - in this mode, the adapter filters tests by test run ID and configuration ID, and sends the results to the test run<br/>1 - in this mode, the adapter sends all results to the test run without filtering<br/>2 - in this mode, the adapter creates a new test run and sends results to the new test run | adapterMode | TMS_ADAPTER_MODE |
22
+ | It enables/disables certificate validation (**It's optional**). Default value - true | certValidation | TMS_CERT_VALIDATION |
23
+ | 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 |
24
+ | 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 |
32
25
 
33
26
  ### File
34
27
 
35
- 1. Adapter configuration file: `tms.config.json`
28
+ 1. Create file config with default name tms.config.json in the root directory of the project
36
29
 
37
30
  ```json
38
31
  {
@@ -41,8 +34,10 @@ npm install testcafe-reporter-testit
41
34
  "projectId": "PROJECT_ID",
42
35
  "configurationId": "CONFIGURATION_ID",
43
36
  "testRunId": "TEST_RUN_ID",
44
- "adapterMode": 0,
45
- "automaticCreationTestCases": false
37
+ "testRunName": "TEST_RUN_NAME",
38
+ "adapterMode": ADAPTER_MODE,
39
+ "automaticCreationTestCases": AUTOMATIC_CREATION_TEST_CASES,
40
+ "automaticUpdationLinksToTestCases": AUTOMATIC_UPDATION_LINKS_TO_TEST_CASES
46
41
  }
47
42
  ```
48
43
 
@@ -58,6 +53,7 @@ TMS_TEST_RUN_NAME=TestRunName; # optional
58
53
  TMS_ADAPTER_MODE=0; # or 1, or 2
59
54
  TMS_CONFIG_FILE=pathToAnotherConfigFile; #optional
60
55
  TMS_AUTOMATIC_CREATION_TEST_CASES=false; # or true, optional
56
+ TMS_AUTOMATIC_UPDATION_LINKS_TO_TEST_CASES=false; # or true, optional
61
57
  ```
62
58
 
63
59
  ### Parallel run
@@ -87,7 +83,7 @@ Methods and properties can be used to specify information about autotest.
87
83
  ### Properties
88
84
 
89
85
  Description of metadata properties:
90
- - `workItemsIds` - a method that links autotests with manual tests. Receives the array of manual tests' IDs
86
+ - `workItemIds` - a method that links autotests with manual tests. Receives the array of manual tests' IDs
91
87
  - `displayName` - internal autotest name (used in Test IT)
92
88
  - `externalId` - unique internal autotest ID (used in Test IT)
93
89
  - `title` - autotest name specified in the autotest card. If not specified, the name from the displayName method is used
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "testcafe-reporter-testit",
3
- "version": "2.2.2",
3
+ "version": "2.2.3",
4
4
  "description": "TestCafe adapter for Test IT",
5
5
  "keywords": [],
6
6
  "author": {
@@ -41,6 +41,6 @@
41
41
  "testcafe": "^3.0.1"
42
42
  },
43
43
  "dependencies": {
44
- "testit-js-commons": "~2.2.2"
44
+ "testit-js-commons": "~2.2.3"
45
45
  }
46
46
  }