diff --git a/docs/work-with-reports/HistoryOfLaunches.mdx b/docs/work-with-reports/HistoryOfLaunches.mdx index e66b77b7d..68c733cd1 100644 --- a/docs/work-with-reports/HistoryOfLaunches.mdx +++ b/docs/work-with-reports/HistoryOfLaunches.mdx @@ -1,5 +1,5 @@ --- -sidebar_position: 5 +sidebar_position: 7 sidebar_label: History of launches --- diff --git a/docs/work-with-reports/InvestigationOfFailure.mdx b/docs/work-with-reports/InvestigationOfFailure.mdx index f36901c02..9dbdc8ecb 100644 --- a/docs/work-with-reports/InvestigationOfFailure.mdx +++ b/docs/work-with-reports/InvestigationOfFailure.mdx @@ -1,5 +1,5 @@ --- -sidebar_position: 4 +sidebar_position: 6 sidebar_label: Investigation of failure --- diff --git a/docs/work-with-reports/LaunchesTestItemsAttributes.mdx b/docs/work-with-reports/LaunchesTestItemsAttributes.mdx new file mode 100644 index 000000000..698e43d78 --- /dev/null +++ b/docs/work-with-reports/LaunchesTestItemsAttributes.mdx @@ -0,0 +1,154 @@ +--- +sidebar_position: 4 +sidebar_label: Launches/test items attributes +--- + +# Launches/test items attributes + +For more convenient and effective use of our test report dashboard, we recommend paying attention to attributes. + +Attributes are specific data points that can be included at all levels in ReportPortal: + +**Launch** + + +**Suite** + + +**Test** + + +**Step** + + +**The purposes of attributes are:** + +1. Attributes allow you to categorize, group, or classify tests, making them easier to manage in the future. +2. Attributes are used for filtering. +3. You can create a filter based on the attribute and then build widgets using this filter. + +## Parameters of attributes + +* Format – Key : Value +* Key – any string value, optional field +* Value – any string value, mandatory field +* The maximum limit is 512 symbols each for both key and value. + +:::note +The key and value are separated by a colon, but the colon cannot be part of the key or value. +::: + +Multiple values can be associated with a single key. For example, if we have a `jira_id` key, the value can differ based on the Jira ticket. + + + +## Adding attributes + +Attributes can be added in the following ways: + +1. Via test reporting. + +You can initiate (launch, suite, test, or step) with one set of attributes and finish with a different set. + +Importantly, the new attributes do not overwrite the old ones; instead, they are added. + + + +2. Via UI (manually). + +To add or edit attributes, click on the `pencil` icon next to the desired launch/test item. Then click on the `Add new` link or click on the existing attribute to edit the key and value. + + + + + + + +## Best practices for using attributes + +1. Avoid having too many attributes on a single item. + +When there are too many attributes, they can become unreadable. + +Use attributes that will assist you in grouping tests, debugging them, or constructing widgets. + + + +2. The attribute name should be informative. + +Avoid making the attribute name excessively long, even though the field allows up to 512 characters. The name should be understandable and clearly indicate what the attribute refers to. + +For instance, in the example below, the attribute `v5: beta5_24.1` could have been divided into two separate attributes: `version` and `environment`. + + + +3. Examples of categorizing tests using attributes. + +Below you can find some examples of how attributes can describe launch/test item characteristics: + +* feature: Quality Gates +* feature: login +* feature: notifications +* Epic: @F1_functionality +* Story: @F11_functionality +* Use case: @F11_use_case_111 +* browser: Chrome +* configuration: Chrome desktop +* team: Sirius +* squad: 1 +* run.id: 12345 +* run.type: scheduled +* entity.id: 56789 +* Region: Canada +* test.type: UI +* branch: develop +* build: 3.24.16.17.5 +* priority: critical + + + + + +## Use Case: using attributes for filtering + +Let's consider the following example. In the launch below, there are 31 Failed tests. + + + +It is difficult to identify the most problematic area, so we can use filtering by attribute, for example, by different controller types. + + + + + +As a result of the investigation, we found that the least number of failures occurred with tests using controller type `contr_test_item` (1), and the most failures occurred with tests using controller type `contr_launch` (12). + + + + + +Thus, we understand that we need to focus on tests with controller type `contr_launch`. + +## Use Case: using attributes for creating widgets + +Widgets allow you to visually track metrics for launches. We can define these metrics using filters that can be created based on attributes. For example, to determine the growth trend of summary statistics of launches with the same attribute key, let's construct a [Cumulative trend chart widget](/dashboards-and-widgets/CumulativeTrendChart). + +There are some launches with the `smoke` attribute. + + + +You can create a filter based on this attribute. + + + +Afterwards, create a **Cumulative trend chart widget** using this filter. + + + +On the screenshot below, we can observe a growth in statistics on the platforms from one build to the next. + + + +Therefore, properly using attributes in ReportPortal can greatly optimize test management and assist in providing clearer visualizations of trends through widgets. + +There are also [system attributes](/work-with-reports/SystemAttributes) that allow to extend the functionality of ReportPortal. diff --git a/docs/work-with-reports/SystemAttributes.mdx b/docs/work-with-reports/SystemAttributes.mdx new file mode 100644 index 000000000..5c76cb69a --- /dev/null +++ b/docs/work-with-reports/SystemAttributes.mdx @@ -0,0 +1,26 @@ +--- +sidebar_position: 5 +sidebar_label: System attributes +--- + +# System attributes + +In the ReportPortal, there is an opportunity to influence specific processes and data processing rules. To this end, ReportPortal supports system attributes. These attributes can be applied to the selected test items and trigger ReportPortal to take certain actions. System attributes are not visible on the UI (for that, the attribute should be sent with `system: true`). + +## immediateAutoAnalysis + +If `immediateAutoAnalysis=true`, then each test item will be analyzed right after it is completed, without waiting for the whole launch to finish. + + + +## immediatePatternAnalysis + +When `immediatePatternAnalysis=true`, then each test item will be analyzed right after it is completed, without waiting for the whole launch to finish. + + + +## skippedIsNotIssue + +If `skippedIsNotIssue=true` during launch import, then all test items with the SKIPPED status will be processed without applying a `To Investigate` defect type. + + diff --git a/docs/work-with-reports/TestCaseId.md b/docs/work-with-reports/TestCaseId.md index 561e0948a..d1a99a1d2 100644 --- a/docs/work-with-reports/TestCaseId.md +++ b/docs/work-with-reports/TestCaseId.md @@ -1,5 +1,5 @@ --- -sidebar_position: 6 +sidebar_position: 8 sidebar_label: Test case ID --- diff --git a/docs/work-with-reports/UniqueId.md b/docs/work-with-reports/UniqueId.md index 1025dafc7..a55144e10 100644 --- a/docs/work-with-reports/UniqueId.md +++ b/docs/work-with-reports/UniqueId.md @@ -1,5 +1,5 @@ --- -sidebar_position: 7 +sidebar_position: 9 sidebar_label: Unique ID --- diff --git a/docs/work-with-reports/img/launches-test-items-attributes/Attributes1.png b/docs/work-with-reports/img/launches-test-items-attributes/Attributes1.png new file mode 100644 index 000000000..3f5fa093f Binary files /dev/null and b/docs/work-with-reports/img/launches-test-items-attributes/Attributes1.png differ diff --git a/docs/work-with-reports/img/launches-test-items-attributes/Attributes10.png b/docs/work-with-reports/img/launches-test-items-attributes/Attributes10.png new file mode 100644 index 000000000..65b010717 Binary files /dev/null and b/docs/work-with-reports/img/launches-test-items-attributes/Attributes10.png differ diff --git a/docs/work-with-reports/img/launches-test-items-attributes/Attributes11.png b/docs/work-with-reports/img/launches-test-items-attributes/Attributes11.png new file mode 100644 index 000000000..8600ce1e5 Binary files /dev/null and b/docs/work-with-reports/img/launches-test-items-attributes/Attributes11.png differ diff --git a/docs/work-with-reports/img/launches-test-items-attributes/Attributes12.png b/docs/work-with-reports/img/launches-test-items-attributes/Attributes12.png new file mode 100644 index 000000000..21d71b9a3 Binary files /dev/null and b/docs/work-with-reports/img/launches-test-items-attributes/Attributes12.png differ diff --git a/docs/work-with-reports/img/launches-test-items-attributes/Attributes13.png b/docs/work-with-reports/img/launches-test-items-attributes/Attributes13.png new file mode 100644 index 000000000..6e0da4b21 Binary files /dev/null and b/docs/work-with-reports/img/launches-test-items-attributes/Attributes13.png differ diff --git a/docs/work-with-reports/img/launches-test-items-attributes/Attributes14.png b/docs/work-with-reports/img/launches-test-items-attributes/Attributes14.png new file mode 100644 index 000000000..2dbb24b64 Binary files /dev/null and b/docs/work-with-reports/img/launches-test-items-attributes/Attributes14.png differ diff --git a/docs/work-with-reports/img/launches-test-items-attributes/Attributes15.png b/docs/work-with-reports/img/launches-test-items-attributes/Attributes15.png new file mode 100644 index 000000000..9a6c51c35 Binary files /dev/null and b/docs/work-with-reports/img/launches-test-items-attributes/Attributes15.png differ diff --git a/docs/work-with-reports/img/launches-test-items-attributes/Attributes16.png b/docs/work-with-reports/img/launches-test-items-attributes/Attributes16.png new file mode 100644 index 000000000..75fecae66 Binary files /dev/null and b/docs/work-with-reports/img/launches-test-items-attributes/Attributes16.png differ diff --git a/docs/work-with-reports/img/launches-test-items-attributes/Attributes17.png b/docs/work-with-reports/img/launches-test-items-attributes/Attributes17.png new file mode 100644 index 000000000..fc1198a33 Binary files /dev/null and b/docs/work-with-reports/img/launches-test-items-attributes/Attributes17.png differ diff --git a/docs/work-with-reports/img/launches-test-items-attributes/Attributes18.png b/docs/work-with-reports/img/launches-test-items-attributes/Attributes18.png new file mode 100644 index 000000000..a8fc15346 Binary files /dev/null and b/docs/work-with-reports/img/launches-test-items-attributes/Attributes18.png differ diff --git a/docs/work-with-reports/img/launches-test-items-attributes/Attributes19.png b/docs/work-with-reports/img/launches-test-items-attributes/Attributes19.png new file mode 100644 index 000000000..b2fc69550 Binary files /dev/null and b/docs/work-with-reports/img/launches-test-items-attributes/Attributes19.png differ diff --git a/docs/work-with-reports/img/launches-test-items-attributes/Attributes2.png b/docs/work-with-reports/img/launches-test-items-attributes/Attributes2.png new file mode 100644 index 000000000..4baed4f3d Binary files /dev/null and b/docs/work-with-reports/img/launches-test-items-attributes/Attributes2.png differ diff --git a/docs/work-with-reports/img/launches-test-items-attributes/Attributes20.png b/docs/work-with-reports/img/launches-test-items-attributes/Attributes20.png new file mode 100644 index 000000000..ca0f24ee3 Binary files /dev/null and b/docs/work-with-reports/img/launches-test-items-attributes/Attributes20.png differ diff --git a/docs/work-with-reports/img/launches-test-items-attributes/Attributes21.png b/docs/work-with-reports/img/launches-test-items-attributes/Attributes21.png new file mode 100644 index 000000000..589d344b6 Binary files /dev/null and b/docs/work-with-reports/img/launches-test-items-attributes/Attributes21.png differ diff --git a/docs/work-with-reports/img/launches-test-items-attributes/Attributes22.png b/docs/work-with-reports/img/launches-test-items-attributes/Attributes22.png new file mode 100644 index 000000000..14e7c5c38 Binary files /dev/null and b/docs/work-with-reports/img/launches-test-items-attributes/Attributes22.png differ diff --git a/docs/work-with-reports/img/launches-test-items-attributes/Attributes3.png b/docs/work-with-reports/img/launches-test-items-attributes/Attributes3.png new file mode 100644 index 000000000..4ac0960a2 Binary files /dev/null and b/docs/work-with-reports/img/launches-test-items-attributes/Attributes3.png differ diff --git a/docs/work-with-reports/img/launches-test-items-attributes/Attributes4.png b/docs/work-with-reports/img/launches-test-items-attributes/Attributes4.png new file mode 100644 index 000000000..3c573c7e6 Binary files /dev/null and b/docs/work-with-reports/img/launches-test-items-attributes/Attributes4.png differ diff --git a/docs/work-with-reports/img/launches-test-items-attributes/Attributes5.png b/docs/work-with-reports/img/launches-test-items-attributes/Attributes5.png new file mode 100644 index 000000000..a4604b2cd Binary files /dev/null and b/docs/work-with-reports/img/launches-test-items-attributes/Attributes5.png differ diff --git a/docs/work-with-reports/img/launches-test-items-attributes/Attributes6.png b/docs/work-with-reports/img/launches-test-items-attributes/Attributes6.png new file mode 100644 index 000000000..c4b9ba47b Binary files /dev/null and b/docs/work-with-reports/img/launches-test-items-attributes/Attributes6.png differ diff --git a/docs/work-with-reports/img/launches-test-items-attributes/Attributes7.png b/docs/work-with-reports/img/launches-test-items-attributes/Attributes7.png new file mode 100644 index 000000000..58d038523 Binary files /dev/null and b/docs/work-with-reports/img/launches-test-items-attributes/Attributes7.png differ diff --git a/docs/work-with-reports/img/launches-test-items-attributes/Attributes8.png b/docs/work-with-reports/img/launches-test-items-attributes/Attributes8.png new file mode 100644 index 000000000..90c589cd6 Binary files /dev/null and b/docs/work-with-reports/img/launches-test-items-attributes/Attributes8.png differ diff --git a/docs/work-with-reports/img/launches-test-items-attributes/Attributes9.png b/docs/work-with-reports/img/launches-test-items-attributes/Attributes9.png new file mode 100644 index 000000000..59237c92f Binary files /dev/null and b/docs/work-with-reports/img/launches-test-items-attributes/Attributes9.png differ diff --git a/docs/work-with-reports/img/system-attributes/SystemAttributes1.png b/docs/work-with-reports/img/system-attributes/SystemAttributes1.png new file mode 100644 index 000000000..793ae90a8 Binary files /dev/null and b/docs/work-with-reports/img/system-attributes/SystemAttributes1.png differ diff --git a/docs/work-with-reports/img/system-attributes/SystemAttributes2.png b/docs/work-with-reports/img/system-attributes/SystemAttributes2.png new file mode 100644 index 000000000..80264abe6 Binary files /dev/null and b/docs/work-with-reports/img/system-attributes/SystemAttributes2.png differ diff --git a/docs/work-with-reports/img/system-attributes/SystemAttributes3.png b/docs/work-with-reports/img/system-attributes/SystemAttributes3.png new file mode 100644 index 000000000..af24849df Binary files /dev/null and b/docs/work-with-reports/img/system-attributes/SystemAttributes3.png differ