custom suite labels for pytest (fixes #46 via #395)

Author: sseliverstov

allure-pytest/examples/label/suite/custom_suite.rst

@@ -0,0 +1,13 @@
+Custom suite
+____________
+
+
+    >>> import allure
+
+    >>> @allure.parent_suite("parent suite name")
+    >>> @allure.suite("suite name")
+    >>> @allure.sub_suite("sub suite name")
+    ... def test_custom_suite():
+    ...     pass
+
+

allure-pytest/examples/label/suite/module_level_custom_suite.rst

@@ -0,0 +1,10 @@
+Module level custom suite
+-------------------------
+
+    >>> import allure
+
+    >>> pytestmark = allure.suite("module level suite name")
+
+
+    >>> def test_module_level_custom_suite():
+    ...     pass

allure-pytest/src/utils.py

@@ -15,7 +15,14 @@
 ALLURE_DESCRIPTION_HTML = 'allure_description_html'
 ALLURE_LABEL_PREFIX = 'allure_label'
 ALLURE_LINK_PREFIX = 'allure_link'
-ALLURE_UNIQUE_LABELS = ['severity', 'thread', 'host']
+ALLURE_UNIQUE_LABELS = [
+    LabelType.SEVERITY,
+    LabelType.FRAMEWORK,
+    LabelType.HOST,
+    LabelType.SUITE,
+    LabelType.PARENT_SUITE,
+    LabelType.SUB_SUITE
+]
 
 
 def get_marker_value(item, keyword):
@@ -112,8 +119,14 @@ def allure_suite_labels(item):
     file_name, path = islice(chain(reversed(head.rsplit('/', 1)), [None]), 2)
     module = file_name.split('.')[0]
     package = path.replace('/', '.') if path else None
-    pairs = zip([LabelType.PARENT_SUITE, LabelType.SUITE, LabelType.SUB_SUITE], [package, module, clazz])
-    return [(name, value) for name, value in pairs if value is not None]
+    pairs = dict(zip([LabelType.PARENT_SUITE, LabelType.SUITE, LabelType.SUB_SUITE], [package, module, clazz]))
+    labels = dict(allure_labels(item))
+    default_suite_labels = []
+    for suite_label in pairs.keys():
+        if suite_label not in labels.keys():
+            default_suite_labels.append((suite_label, pairs[suite_label]))
+
+    return default_suite_labels
 
 
 def escape_name(name):

allure-pytest/test/acceptance/label/suite/custom_suite.py

@@ -0,0 +1,15 @@
+""" ./examples/label/suite/custom_suite.rst """
+
+from hamcrest import assert_that
+from allure_commons_test.report import has_test_case
+from allure_commons_test.label import has_suite, has_parent_suite, has_sub_suite
+
+
+def test_custom_suite(executed_docstring_path):
+    assert_that(executed_docstring_path.allure_report,
+                has_test_case("test_custom_suite",
+                              has_suite("suite name"),
+                              has_parent_suite("parent suite name"),
+                              has_sub_suite("sub suite name")
+                              )
+                )

allure-pytest/test/acceptance/label/suite/module_level_custom_suite_test.py

@@ -0,0 +1,13 @@
+""" ./examples/label/suite/module_level_custom_suite.rst """
+
+from hamcrest import assert_that
+from allure_commons_test.report import has_test_case
+from allure_commons_test.label import has_suite
+
+
+def test_module_custom_suite(executed_docstring_path):
+    assert_that(executed_docstring_path.allure_report,
+                has_test_case("test_module_level_custom_suite",
+                              has_suite("module level suite name"),
+                              )
+                )

allure-python-commons/allure.py

@@ -3,6 +3,7 @@
 from allure_commons._allure import label
 from allure_commons._allure import severity
 from allure_commons._allure import tag
+from allure_commons._allure import suite, parent_suite, sub_suite
 from allure_commons._allure import epic, feature, story
 from allure_commons._allure import link, issue, testcase
 from allure_commons._allure import Dynamic as dynamic
@@ -18,21 +19,19 @@
     'description_html',
     'label',
     'severity',
+    'suite',
+    'parent_suite',
+    'sub_suite',
     'tag',
     'epic',
     'feature',
     'story',
-
     'link',
     'issue',
     'testcase',
-
     'step',
-
     'dynamic',
-
     'severity_level',
-
     'attach',
     'attachment_type'
 ]

allure-python-commons/src/_allure.py

@@ -47,6 +47,18 @@ def story(*stories):
     return label(LabelType.STORY, *stories)
 
 
+def suite(suite_name):
+    return label(LabelType.SUITE, suite_name)
+
+
+def parent_suite(parent_suite_name):
+    return label(LabelType.PARENT_SUITE, parent_suite_name)
+
+
+def sub_suite(sub_suite_name):
+    return label(LabelType.SUB_SUITE, sub_suite_name)
+
+
 def tag(*tags):
     return label(LabelType.TAG, *tags)