default suite labels (fixes #197 via #275)

Author: sseliverstov

allure-pytest/src/listener.py

@@ -18,6 +18,7 @@
 from allure_pytest.utils import allure_description, allure_description_html
 from allure_pytest.utils import allure_labels, allure_links, pytest_markers
 from allure_pytest.utils import allure_full_name, allure_package, allure_name
+from allure_pytest.utils import allure_suite_labels
 from allure_pytest.utils import get_status, get_status_details
 from allure_pytest.utils import get_outcome_status, get_outcome_status_details
 from allure_pytest.utils import get_pytest_report_status
@@ -100,6 +101,8 @@ def pytest_runtest_teardown(self, item):
         test_result = self.allure_logger.get_test(uuid)
         test_result.labels.extend([Label(name=name, value=value) for name, value in allure_labels(item)])
         test_result.labels.extend([Label(name=LabelType.TAG, value=value) for value in pytest_markers(item)])
+        test_result.labels.extend([Label(name=LabelType.TAG, value=value) for value in pytest_markers(item)])
+        test_result.labels.extend([Label(name=name, value=value) for name, value in allure_suite_labels(item)])
         test_result.labels.append(Label(name=LabelType.HOST, value=self._host))
         test_result.labels.append(Label(name=LabelType.THREAD, value=self._thread))
         test_result.labels.append(Label(name=LabelType.FRAMEWORK, value='pytest'))

allure-pytest/src/utils.py

@@ -3,10 +3,12 @@
 
 import six
 import pytest
+from itertools import chain, islice
 from allure_commons.utils import represent
 from allure_commons.utils import format_exception, format_traceback, escape_non_unicode_symbols
 from allure_commons.model2 import Status
 from allure_commons.model2 import StatusDetails
+from allure_commons.types import LabelType
 
 ALLURE_TITLE = 'allure_title'
 ALLURE_DESCRIPTION = 'allure_description'
@@ -99,6 +101,16 @@ def allure_full_name(item):
     return escape_name(full_name)
 
 
+def allure_suite_labels(item):
+    head, possibly_clazz, tail = islice(chain(item.nodeid.split('::'), [None]), 3)
+    clazz = possibly_clazz if tail else None
+    file_name, path = islice(chain(reversed(head.rsplit('/', 1)), [None]), 2)
+    module = file_name.split('.')[0]
+    package = path.replace('/', '.')
+    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]
+
+
 def escape_name(name):
     if six.PY2:
         try:

allure-pytest/test/labels/suite/__init__.py

@@ -0,0 +1,14 @@
+class TestSuiteClass(object):
+
+    def test_default_suite_class_method(self):
+        """
+        >>> allure_report = getfixture('allure_report')
+        >>> assert_that(allure_report,
+        ...             has_test_case('test_default_suite_class_method',
+        ...                           has_parent_suite('test.labels.suite'),
+        ...                           has_suite('class_suite_test'),
+        ...                           has_sub_suite('TestSuiteClass')
+        ...             )
+        ... )
+
+        """

allure-pytest/test/labels/suite/class_suite_test.py

@@ -0,0 +1,14 @@
+def test_default_suite_function():
+    """
+    >>> from hamcrest import not_, anything
+    >>> allure_report = getfixture('allure_report')
+    >>> assert_that(allure_report,
+    ...             has_test_case('test_default_suite_function',
+    ...                           has_parent_suite('test.labels.suite'),
+    ...                           has_suite('function_suite_test'),
+    ...                           not_(has_sub_suite(anything()))
+    ...             )
+    ... )
+
+    """
+    pass

allure-pytest/test/labels/suite/function_suite_test.py

@@ -34,3 +34,15 @@ def has_tag(tag):
 
 def has_package(package):
     return has_label('package', package)
+
+
+def has_suite(suite):
+    return has_label('suite', suite)
+
+
+def has_parent_suite(parent_suite):
+    return has_label('parentSuite', parent_suite)
+
+
+def has_sub_suite(sub_suite):
+    return has_label('subSuite', sub_suite)

allure-python-commons-test/src/label.py

@@ -21,6 +21,9 @@ class LabelType(str, Enum):
     EPIC = 'epic'
     FEATURE = 'feature'
     STORY = 'story'
+    PARENT_SUITE = 'parentSuite'
+    SUITE = 'suite'
+    SUB_SUITE = 'subSuite'
     SEVERITY = 'severity'
     THREAD = 'thread'
     HOST = 'host'

allure-python-commons/src/types.py

@@ -15,21 +15,22 @@ def get_allure_parameters(parameters):
 def get_allure_suites(longname):
     """
     >>> get_allure_suites('Suite1.Test')
-    [Label(name='suite', value='Suite1')]
-    >>> get_allure_suites('Suite1.Suite2.Test')
-    [Label(name='suite', value='Suite1'), Label(name='subSuite', value='Suite2')]
-    >>> get_allure_suites('Suite1.Suite2.Suite3.Test')  # doctest: +NORMALIZE_WHITESPACE
-    [Label(name='parentSuite', value='Suite1'),
-    Label(name='suite', value='Suite2'),
-    Label(name='subSuite', value='Suite3')]
+    [Label(name=<LabelType.SUITE: 'suite'>, value='Suite1')]
+    >>> get_allure_suites('Suite1.Suite2.Test') # doctest: +NORMALIZE_WHITESPACE
+    [Label(name=<LabelType.SUITE: 'suite'>, value='Suite1'),
+    Label(name=<LabelType.SUB_SUITE: 'subSuite'>, value='Suite2')]
+    >>> get_allure_suites('Suite1.Suite2.Suite3.Test') # doctest: +NORMALIZE_WHITESPACE
+    [Label(name=<LabelType.PARENT_SUITE: 'parentSuite'>, value='Suite1'),
+    Label(name=<LabelType.SUITE: 'suite'>, value='Suite2'),
+    Label(name=<LabelType.SUB_SUITE: 'subSuite'>, value='Suite3')]
     """
     labels = []
     suites = longname.split('.')
     if len(suites) > 3:
-        labels.append(Label('parentSuite', suites.pop(0)))
-    labels.append(Label('suite', suites.pop(0)))
+        labels.append(Label(LabelType.PARENT_SUITE, suites.pop(0)))
+    labels.append(Label(LabelType.SUITE, suites.pop(0)))
     if len(suites) > 1:
-        labels.append(Label('subSuite', '.'.join(suites[:-1])))
+        labels.append(Label(LabelType.SUB_SUITE, '.'.join(suites[:-1])))
     return labels