Skip to content

Outlining the difference between Allure severity levels #750

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 7 commits into from
Jul 24, 2020
Merged

Outlining the difference between Allure severity levels #750

Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
1858523
Amend element name
sta1r Jul 8, 2020
1941831
Replace broken devhub.io/zh paths with github.com paths
sta1r Jul 8, 2020
30f2c65
Make intro text clearer and more accurate
sta1r Jul 8, 2020
ffbcac7
Fix order (Blocker is the most severe)
sta1r Jul 8, 2020
a0a966f
Add usage guidelines table outlining the difference between levels
sta1r Jul 8, 2020
f958045
Trim text
sta1r Jul 8, 2020
c996fb4
Merge branch 'develop' into AM/severity-levels
tomreece Jul 24, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 17 additions & 7 deletions docs/test/annotations.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -112,18 +112,28 @@ Attribute|Type|Use

### severity

The `<return>` element is an implementation of a [`@Severity`] Allure tag; Metadata for report.
The `<severity>` element is an implementation of the [`@Severity`] Allure annotation, which is used to prioritise tests by severity.

Attribute|Type|Use|Acceptable values
---|---|---|---
`value`|string|required|`MINOR`, `AVERAGE`, `MAJOR`, `BLOCKER`, `CRITICAL`
`value`|string|required|`MINOR`, `AVERAGE`, `MAJOR`, `CRITICAL`, `BLOCKER`

#### Example

```xml
<severity value="CRITICAL"/>
```

#### Usage guidelines

Severity Level|Usage
---|---
`BLOCKER`|If this test fails, the customer is completely blocked from purchasing a product.
`CRITICAL`|This is a serious problem impacting conversion, or affecting the operation of the store.
`MAJOR`|Store conversion rate is reduced owing to this issue. For example, something is broken or missing that impacts checkout frequency or cart volume.
`AVERAGE`|A fault on the storefront that can negatively impact conversion rate (like UI errors or omissions), or problems with Magento admin functionality.
`MINOR`|An application or configuration fault that has no impact on conversion rate.

### skip

Use the `<skip>` element to skip a test.
Expand Down Expand Up @@ -213,14 +223,14 @@ Attribute|Type|Use

<!-- Link definitions -->

[`@Description`]: https://devhub.io/zh/repos/allure-framework-allure-phpunit#extended-test-class-or-test-method-description
[`@Features`]: https://devhub.io/zh/repos/allure-framework-allure-phpunit#map-test-classes-and-test-methods-to-features-and-stories
[`@Description`]: https://github.com/allure-framework/allure-phpunit#extended-test-class-or-test-method-description
[`@Features`]: https://github.com/allure-framework/allure-phpunit#map-test-classes-and-test-methods-to-features-and-stories
[`@group`]: http://codeception.com/docs/07-AdvancedUsage#Groups
[`@return`]: http://codeception.com/docs/07-AdvancedUsage#Examples
[`@Severity`]: https://devhub.io/zh/repos/allure-framework-allure-phpunit#set-test-severity
[`@Stories`]: https://devhub.io/zh/repos/allure-framework-allure-phpunit#map-test-classes-and-test-methods-to-features-and-stories
[`@Severity`]: https://github.com/allure-framework/allure-phpunit#set-test-severity
[`@Stories`]: https://github.com/allure-framework/allure-phpunit#map-test-classes-and-test-methods-to-features-and-stories
[`@TestCaseId`]: https://github.com/allure-framework/allure1/wiki/Test-Case-ID
[`@Title`]: https://devhub.io/zh/repos/allure-framework-allure-phpunit#human-readable-test-class-or-test-method-title
[`@Title`]: https://github.com/allure-framework/allure-phpunit#human-readable-test-class-or-test-method-title
[description]: #description
[features]: #features
[group]: #group
Expand Down