User defined labels and links (fixes #82 via #83)

* user defined labels and links, also dynamic define labels and links allowed

* add changes in commons

Author: sseliverstov

allure-pytest/src/helper.py

@@ -17,7 +17,7 @@ def decorate_as_label(self, label_type, labels):
     @allure_commons.hookimpl
     def decorate_as_link(self, url, link_type, name):
         allure_link_marker = u'{prefix}.{link_type}'.format(prefix=ALLURE_LINK_PREFIX, link_type=link_type)
-        pattern = dict(self.config.option.allure_link_pattern).get(str(link_type), u'{}')
+        pattern = dict(self.config.option.allure_link_pattern).get(link_type, u'{}')
         url = pattern.format(url)
         allure_link = getattr(pytest.mark, allure_link_marker)
         return allure_link(url, name=name)

allure-pytest/src/listener.py

@@ -68,8 +68,8 @@ def pytest_runtest_protocol(self, item, nextitem):
 
         yield
 
-        test_case.labels = [Label(name, value) for name, value in allure_labels(item)]
-        test_case.links = [Link(link_type, url, name) for link_type, url, name in allure_links(item)]
+        test_case.labels += [Label(name, value) for name, value in allure_labels(item)]
+        test_case.links += [Link(link_type, url, name) for link_type, url, name in allure_links(item)]
         test_case.fullName = allure_full_name(item.nodeid)
         test_case.historyId = md5(test_case.fullName)
         test_case.labels.append(Label('package', allure_package(item.nodeid)))
@@ -170,6 +170,15 @@ def attach_data(self, body, name, attachment_type, extension):
     def attach_file(self, source, name, attachment_type, extension):
         self.allure_logger.attach_file(uuid4(), source, name=name, attachment_type=attachment_type, extension=extension)
 
+    @allure_commons.hookimpl
+    def add_link(self, url, link_type, name):
+        self.allure_logger.update_test(None, links=[Link(link_type, url, name)])
+
+    @allure_commons.hookimpl
+    def add_label(self, label_type, labels):
+        for label in labels:
+            self.allure_logger.update_test(None, labels=Label(label_type, label))
+
 
 class ItemCache(object):
 

allure-pytest/src/utils.py

@@ -51,11 +51,11 @@ def allure_labels(item):
         if keyword.startswith(ALLURE_LABEL_PREFIX):
             marker = item.get_marker(keyword)
             label_type = marker.kwargs['label_type']
-            if label_type.value in ALLURE_UNIQUE_LABELS:
-                yield (label_type.value, marker.args[0])
+            if label_type in ALLURE_UNIQUE_LABELS:
+                yield (label_type, marker.args[0])
             else:
                 for value in marker.args:
-                    yield (label_type.value, value)
+                    yield (label_type, value)
 
 
 def allure_links(item):

allure-pytest/test/labels/user_label_test.py

@@ -0,0 +1,56 @@
+"""
+>>> allure_report = getfixture('allure_report')
+>>> assert_that(allure_report,
+...             all_of(
+...                 has_property('test_cases', has_length(3)),
+...                 has_property('test_groups', has_length(0))
+...             ))  # doctest: +SKIP
+"""
+
+import allure
+
+
+@allure.label('user_label', 'work', 'cool')
+def test_user_label():
+    """
+    >>> allure_report = getfixture('allure_report')
+    >>> assert_that(allure_report,
+    ...             has_test_case('test_user_label',
+    ...                 all_of(
+    ...                     has_label('user_label', 'work'),
+    ...                     has_label('user_label', 'cool'),
+    ...                 )
+    ...             ))
+    """
+    pass
+
+
+def test_user_dynamic_label():
+    """
+    >>> allure_report = getfixture('allure_report')
+    >>> assert_that(allure_report,
+    ...             has_test_case('test_user_dynamic_label',
+    ...                 all_of(
+    ...                     has_label('user_label', 'work'),
+    ...                     has_label('user_label', 'cool'),
+    ...                 )
+    ...             ))
+    """
+    allure.dynamic.label('user_label', 'work', 'cool')
+    pass
+
+
+@allure.label('user_label', 'work')
+def test_update_labels():
+    """
+    >>> allure_report = getfixture('allure_report')
+    >>> assert_that(allure_report,
+    ...             has_test_case('test_user_dynamic_label',
+    ...                 all_of(
+    ...                     has_label('user_label', 'work'),
+    ...                     has_label('user_label', 'cool'),
+    ...                 )
+    ...             ))
+    """
+    allure.dynamic.label('user_label', 'very cool')
+    pass

allure-python-commons/src/_allure.py

@@ -1,4 +1,3 @@
-from functools import partial
 from functools import wraps
 
 from allure_commons._core import plugin_manager
@@ -24,10 +23,6 @@ def severity(severity_level):
     return label(LabelType.SEVERITY, severity_level)
 
 
-def tag(*tags):
-    return label(LabelType.TAG, *tags)
-
-
 def feature(*features):
     return label(LabelType.FEATURE, *features)
 
@@ -36,6 +31,10 @@ def story(*stories):
     return label(LabelType.STORY, *stories)
 
 
+def tag(*tags):
+    return label(LabelType.TAG, *tags)
+
+
 def link(url, link_type=LinkType.LINK, name=None):
     return safely(plugin_manager.hook.decorate_as_link(url=url, link_type=link_type, name=name))
 
@@ -48,24 +47,39 @@ def testcase(url, name=None):
     return link(url, link_type=LinkType.TEST_CASE, name=name)
 
 
-def add_label(label_type, labels):
-    print("Y"*29)
+class Dynamic(object):
+
+    @staticmethod
+    def label(label_type, *labels):
+        plugin_manager.hook.add_label(label_type=label_type, labels=labels)
 
+    @staticmethod
+    def severity(severity_level):
+        Dynamic.label(LabelType.SEVERITY, severity_level)
 
-def add_link(url, link_type=LinkType.LINK, name=None):
-    print ("X"*23)
+    @staticmethod
+    def feature(*features):
+        Dynamic.label(LabelType.FEATURE, *features)
 
+    @staticmethod
+    def story(*stories):
+        Dynamic.label(LabelType.STORY, *stories)
 
-class Dynamic(object):
-    label = partial(add_label)
-    severity = partial(add_label, LabelType.SEVERITY)
-    tag = partial(add_label, LabelType.TAG)
-    feature = partial(add_label, LabelType.FEATURE)
-    story = partial(add_label, LabelType.STORY)
-
-    link = partial(add_link)
-    issue = partial(add_link, link_type=LinkType.ISSUE)
-    testcase = partial(add_link, link_type=LinkType.TEST_CASE)
+    @staticmethod
+    def tag(*tags):
+        Dynamic.label(LabelType.TAG, *tags)
+
+    @staticmethod
+    def link(url, link_type=LinkType.LINK, name=None):
+        plugin_manager.hook.add_link(url=url, link_type=link_type, name=name)
+
+    @staticmethod
+    def issue(url, name=None):
+        Dynamic.link(url, link_type=LinkType.TEST_CASE, name=name)
+
+    @staticmethod
+    def testcase(url, name=None):
+        Dynamic.link(url, link_type=LinkType.TEST_CASE, name=name)
 
 
 def step(title):

allure-python-commons/src/_hooks.py

@@ -9,11 +9,21 @@ def decorate_as_label(label_type, labels):
     """ label """
 
 
+@hookspec
+def add_label(label_type, labels):
+    """ label """
+
+
 @hookspec
 def decorate_as_link(url, link_type, name):
     """ url """
 
 
+@hookspec
+def add_link(url, link_type, name):
+    """ url """
+
+
 @hookspec
 def start_step(uuid, title, params):
     """ step """

allure-python-commons/src/logger.py

@@ -17,7 +17,7 @@ def __init__(self, report_dir):
             os.makedirs(report_dir)
 
     def _update_item(self, uuid, **kwargs):
-        item = self._items[uuid]
+        item = self._items[uuid] if uuid else self._items[next(reversed(self._items))]
         for name, value in kwargs.items():
             attr = getattr(item, name)
             if isinstance(attr, list):

allure-python-commons/src/types.py

@@ -4,29 +4,20 @@
 
 
 class Severity(str, Enum):
-    def __str__(self):
-        return self.value
-
     BLOCKER = 'blocker'
     CRITICAL = 'critical'
     NORMAL = 'normal'
     MINOR = 'minor'
     TRIVIAL = 'trivial'
 
 
-class LinkType(Enum):
-    def __str__(self):
-        return self.value
-
+class LinkType(object):
     LINK = 'link'
     ISSUE = 'issue'
     TEST_CASE = 'test_case'
 
 
-class LabelType(Enum):
-    def __str__(self):
-        return self.value
-
+class LabelType(str, Enum):
     FEATURE = 'feature'
     STORY = 'story'
     SEVERITY = 'severity'