Skip to content
This repository has been archived by the owner on Nov 19, 2024. It is now read-only.

Commit

Permalink
MQE-963: Incorrect Documentation Of Values For Severity Annotation
Browse files Browse the repository at this point in the history
  • Loading branch information
@dshevtsov
dshevtsov committed May 2, 2018
1 parent 2dce366 commit caf4c98
Showing 1 changed file with 15 additions and 13 deletions.
28 changes: 15 additions & 13 deletions guides/v2.2/magento-functional-testing-framework/release-2/test/annotations.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -27,12 +27,11 @@ The following conventions apply to annotations in the Magento Functional Testing
If multiple annotation values are supported and required each value requires a separate annotation.

Recommended use cases of the annotation types:
- **Feature** - Report grouping, a set of tests that verify a feature.
- **Story** - Report grouping, a set of tests that verify a story.
- **Group** - General functionality grouping.
- **Title** - Description of the test purpose.
- **Description** - Description of how the test achieves the purpose defined in the title.
- **Severity** - Available labels are `BLOCKER`, `CRITICAL`, `MAJOR`, `AVERAGE`, and `MINOR`.
- [features] - report grouping, a set of tests that verify a feature.
- [stories] - report grouping, a set of tests that verify a story.
- [group] - reneral functionality grouping.
- [title] - description of the test purpose.
- [description] - description of how the test achieves the purpose defined in the title.

## Example

Expand Down Expand Up @@ -127,7 +126,7 @@ The `<return>` element is an implementation of a [`@Severity`] Allure tag; Metad

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

#### Example

Expand All @@ -138,7 +137,7 @@ Attribute|Type|Use|Acceptable values
### stories

The `<stories>` element is an implementation of a [`@Stories`] Allure tag.
It has the same functionality as [`features`], within the Story report group.
It has the same functionality as [features], within the Story report group.

Attribute|Type|Use
---|---|--
Expand Down Expand Up @@ -197,10 +196,7 @@ Attribute|Type|Use
<title value="Add Catalog"/>
```

<!-- Link deafinitions -->

[`features`]: #features
[test methods](../test.html#test-tag)
<!-- 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
Expand All @@ -210,6 +206,12 @@ Attribute|Type|Use
[`@Stories`]: https://devhub.io/zh/repos/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
[description]: #description
[features]: #features
[group]: #group
[setup instructions in Allure]: https://github.com/allure-framework/allure1/wiki/Test-Case-ID
[severity]: #severity
[stories]: #stories
[suite]: ../suite.html
[tests]: ../test.html
[tests]: ../test.html
[title]: #title

0 comments on commit caf4c98

Please sign in to comment.