Repository navigation
Integration requirements
Vadzim Hushchanskou edited this page Jun 23, 2021
·
4 revisions
Dear contributors,
We are really pleased to see you interested in contributing. But to avoid unpleasant end-user experience we have to establish certain requirements for integrations listed on our landing page.
Your integration should support the following properties:
| Property | Aliases | Value | Description |
|---|---|---|---|
| rp.api.key | rp.uuid, RP_UUID | string | Required. API token of user. |
| rp.endpoint | RP_ENDPOINT | string | Required. URL of web service, where requests should be send. |
| rp.launch | RP_LAUNCH | string | Required. The unique name of Launch (Run). Based on that name a history of runs will be created for particular name. |
| rp.project | RP_PROJECT | string. | Required. Project name to identify scope |
| rp.mode | RP_MODE | [DEFAULT, DEBUG] | ReportPortal provides possibility to specify visibility of executing launch. Currently two modes are supported: DEFAULT - all users from project can see this launch; DEBUG - all users except of Customer role can see this launch (in debug sub tab). Note: for all java based clients (TestNG, Junit) mode will be set automatically to "DEFAULT" if it is not specified. |
| rp.skipped.issue | RP_SKIPPED_ISSUE | [true, false] | ReportPortal provides feature to mark skipped tests as not 'To Investigate' items on WS side. Parameter could be equal boolean values: TRUE - skipped tests considered as issues and will be marked as 'To Investigate' on Report Portal. FALSE - skipped tests will not be marked as 'To Investigate' on application. |
| rp.attributes | RP_ATTRIBUTES, RP_LAUNCH_ATTRIBUTES | string | Set of attributes for specifying additional meta information for current launch. Format: key:value;value;build:12345-6. Attributes should be separated by “;”, keys and values - “:”. |
| rp.description | RP_DESCRIPTION, RP_LAUNCH_DOC | string | Launch description. |
If you use our java client in your implementation you don't have to handle these properties by yourself, it already implemented in the client.
To ensure in minimum functioning the following Test Cases should be covered in integration tests and pass on regular basis:
| Number | Preconditions | Test Case Steps | Expected Result |
|---|---|---|---|
| 1 | 1. A user launches a test with a single empty step | 1. A Start Launch Request sent 2. A start item request with type SUITE sent3. A start item request with type TEST sent4. A start item request with type STEP sent5. A finish step request sent with status PASSED6. A finish test request sent 7. A finish suite request sent 8. A finish launch request sent |
|
| 2 | Test from row 1 | 1. A user filled launch description and launched the test | 1. A Start Launch Request sent with Description field |
| 3 | Test from row 1 | 1. A user filled launch attributes and launched the test | 1. A Start Launch Request sent with Attributes field |
| 4 | Test from row 1 | 1. A user set DEBUG launch mode and launched the test |
1. A Start Launch Request sent 2. A start item request with type SUITE sent3. A start item request with type TEST sent4. A start item request with type STEP sent5. A finish step request sent with status FAILED6. A finish test request sent 7. A finish suite request sent 8. A finish launch request sent |
| 6 | 1. User have a test with a "Before test" hook 2.A user launches a test with a single empty step |
1. A Start Launch Request sent 2. A start item request with type SUITE sent3. A start item request with type TEST sent4. A start item request with type BEFORE_TEST sent5. A finish before test item request sent with status PASSED6. A start item request with type STEP sent7. A finish step request sent with status PASSED8. A finish test request sent 9. A finish suite request sent 10. A finish launch request sent |
|
| 7 | 1. User have a test with a "Before test" hook 2.A user launches a test with a single empty step, "Before test" hook fails |
1. A Start Launch Request sent 2. A start item request with type SUITE sent3. A start item request with type TEST sent4. A start item request with type BEFORE_METHOD sent5. A finish before test item request sent with status FAILED6. A start item request with type STEP sent7. A finish step request sent with status SKIPPED8. A finish test request sent 9. A finish suite request sent 10. A finish launch request sent |
|
| 8 | Test from row 7 | 1. User set rp.skipped.issue=True property |
1. A Start Launch Request sent 2. A start item request with type SUITE sent3. A start item request with type TEST sent4. A start item request with type BEFORE_METHOD sent5. A finish before test item request sent with status FAILED6. A start item request with type STEP sent7. A finish step request sent with status SKIPPED and with "issue": {"issueType": "NOT_ISSUE"} field8. A finish test request sent 9. A finish suite request sent 10. A finish launch request sent |
For Gherkin-based frameworks "SUITE" level can be omitted. Use "STORY" item type for feature level and "STEP" for scenario level.
| Number | Preconditions | Test Case Steps | Expected Result |
|---|---|---|---|
| 1 | 1. User have a test with a "Background" keyword 2.A user launches a test with a single empty step |
1. A Start Launch Request sent 2. A start item request with type STORY sent3. A start item request with type BEFORE_METHOD sent4. A finish before test item request sent with status PASSED5. A start item request with type STEP sent6. A finish step request sent with status PASSED7. A finish story request sent 8. A finish launch request sent |
|
| 2 | 1. User have a test with a "Background" keyword 2.A user launches a test with a single empty step, "Background" hook fails |
1. A Start Launch Request sent 2. A start item request with type STORY sent3. A start item request with type BEFORE_METHOD sent4. A finish before test item request sent with status FAILED5. A start item request with type STEP sent6. A finish step request sent with status SKIPPED7. A finish story request sent 8. A finish launch request sent |
|
| 3 | 1. User have a test with a "Background" keyword 2.A user launches a test with a single empty step, "Background" hook fails |
1. A Start Launch Request sent 2. A start item request with type STORY sent3. A start item request with type BEFORE_METHOD sent4. A finish before test item request sent with status FAILED5. A start item request with type STEP sent6. A finish step request sent with status SKIPPED7. A finish story request sent 8. A finish launch request sent |
|
| 4 | Test from row 3 | 1. User set rp.skipped.issue=True property |
1. A Start Launch Request sent 2. A start item request with type STORY sent3. A start item request with type BEFORE_METHOD sent4. A finish before test item request sent with status FAILED5. A start item request with type STEP sent6. A finish step request sent with status SKIPPED and with "issue": {"issueType": "NOT_ISSUE"} field7. A finish story request sent 8. A finish launch request sent |