From 185852385432c7260087e717fc9093fb2aad09d8 Mon Sep 17 00:00:00 2001 From: Alastair Mucklow Date: Wed, 8 Jul 2020 11:19:44 +0100 Subject: [PATCH 1/6] Amend element name --- docs/test/annotations.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/test/annotations.md b/docs/test/annotations.md index 4e9194bb0..8fdcd2240 100644 --- a/docs/test/annotations.md +++ b/docs/test/annotations.md @@ -112,7 +112,7 @@ Attribute|Type|Use ### severity -The `` element is an implementation of a [`@Severity`] Allure tag; Metadata for report. +The `` element is an implementation of a [`@Severity`] Allure tag; Metadata for report. Attribute|Type|Use|Acceptable values ---|---|---|--- From 1941831d7d9e44b91843b5260ad8f1d434e910de Mon Sep 17 00:00:00 2001 From: Alastair Mucklow Date: Wed, 8 Jul 2020 11:45:40 +0100 Subject: [PATCH 2/6] Replace broken devhub.io/zh paths with github.com paths --- docs/test/annotations.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/test/annotations.md b/docs/test/annotations.md index 8fdcd2240..055ca9450 100644 --- a/docs/test/annotations.md +++ b/docs/test/annotations.md @@ -213,14 +213,14 @@ Attribute|Type|Use -[`@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 From 30f2c653c669c98e116e6bde77b7692d5a97b4e0 Mon Sep 17 00:00:00 2001 From: Alastair Mucklow Date: Wed, 8 Jul 2020 12:22:27 +0100 Subject: [PATCH 3/6] Make intro text clearer and more accurate --- docs/test/annotations.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/test/annotations.md b/docs/test/annotations.md index 055ca9450..d61565aec 100644 --- a/docs/test/annotations.md +++ b/docs/test/annotations.md @@ -112,7 +112,7 @@ Attribute|Type|Use ### severity -The `` element is an implementation of a [`@Severity`] Allure tag; Metadata for report. +The `` element is an implementation of the [`@Severity`] Allure annotation, which is used to prioritise test methods by severity. Attribute|Type|Use|Acceptable values ---|---|---|--- From ffbcac774edec1d9f718ef4c0de8b80d861fbb3a Mon Sep 17 00:00:00 2001 From: Alastair Mucklow Date: Wed, 8 Jul 2020 12:22:42 +0100 Subject: [PATCH 4/6] Fix order (Blocker is the most severe) --- docs/test/annotations.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/test/annotations.md b/docs/test/annotations.md index d61565aec..69c75a2d0 100644 --- a/docs/test/annotations.md +++ b/docs/test/annotations.md @@ -116,7 +116,7 @@ The `` element is an implementation of the [`@Severity`] Allure annota Attribute|Type|Use|Acceptable values ---|---|---|--- -`value`|string|required|`MINOR`, `AVERAGE`, `MAJOR`, `BLOCKER`, `CRITICAL` +`value`|string|required|`MINOR`, `AVERAGE`, `MAJOR`, `CRITICAL`, `BLOCKER` #### Example From a0a966fdcc4b17b8245a4c0e119c67cfa2d40409 Mon Sep 17 00:00:00 2001 From: Alastair Mucklow Date: Wed, 8 Jul 2020 12:23:14 +0100 Subject: [PATCH 5/6] Add usage guidelines table outlining the difference between levels --- docs/test/annotations.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/docs/test/annotations.md b/docs/test/annotations.md index 69c75a2d0..1e2e50f58 100644 --- a/docs/test/annotations.md +++ b/docs/test/annotations.md @@ -124,6 +124,16 @@ Attribute|Type|Use|Acceptable values ``` +#### 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 `` element to skip a test. From f958045af0dcef47ca75fdf2adc81bf4bb418829 Mon Sep 17 00:00:00 2001 From: Alastair Mucklow Date: Wed, 8 Jul 2020 12:34:24 +0100 Subject: [PATCH 6/6] Trim text --- docs/test/annotations.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/test/annotations.md b/docs/test/annotations.md index 1e2e50f58..79cc00e80 100644 --- a/docs/test/annotations.md +++ b/docs/test/annotations.md @@ -112,7 +112,7 @@ Attribute|Type|Use ### severity -The `` element is an implementation of the [`@Severity`] Allure annotation, which is used to prioritise test methods by severity. +The `` element is an implementation of the [`@Severity`] Allure annotation, which is used to prioritise tests by severity. Attribute|Type|Use|Acceptable values ---|---|---|---