support for Allure links in RobotFramework integration (via #371)

Author: rostrovsky

allure-robotframework/examples/link/link.rst

@@ -0,0 +1,54 @@
+Links
+-----
+
+Issues are supported via tags prefixed with :code:`issue:` :
+
+.. code:: robotframework
+
+    *** Test Cases ***
+    Test Case With Issue Link Without URL
+        [Tags]  issue:ISSUE-1
+        No Operation
+
+
+.. code:: robotframework
+
+    *** Test Cases ***
+    Test Case With Issue Link With URL
+        [Tags]  issue:https://jira.com/browse/ISSUE-1
+        No Operation
+
+TMS links are supported via tags prefixed with :code:`test_case:` :
+
+.. code:: robotframework
+
+    *** Test Cases ***
+    Test Case With TMS Link Without URL
+        [Tags]  test_case:TEST-1
+        No Operation
+
+
+.. code:: robotframework
+
+    *** Test Cases ***
+    Test Case With TMS Link With URL
+        [Tags]  test_case:https://testrail.com/browse/TEST-1
+        No Operation
+
+Ordinary links are supported via tags prefixed with :code:`link:` :
+
+.. code:: robotframework
+
+    *** Test Cases ***
+    Test Case With Unlabeled Link
+        [Tags]  link:https://homepage.com/
+        No Operation
+
+Link label can be specified by text placed in :code:`[square brackets]` :
+
+.. code:: robotframework
+
+    *** Test Cases ***
+    Test Case With Labeled Link
+        [Tags]  link:[Home Page]https://homepage.com/
+        No Operation

allure-robotframework/src/listener/robot_listener.py

@@ -17,7 +17,7 @@
 from allure_robotframework import utils
 from allure_robotframework.allure_listener import AllureListener
 
-from allure_robotframework.utils import allure_tags, allure_labels
+from allure_robotframework.utils import allure_tags, allure_labels, allure_links
 
 
 # noinspection PyPep8Naming
@@ -111,10 +111,10 @@ def stop_current_test(self, name, attributes):
         test.labels.extend(utils.get_allure_suites(attributes.get('longname')))
 
         test.labels.extend(allure_tags(attributes))
-        test.labels.extend(allure_labels(attributes, LabelType.EPIC))
-        test.labels.extend(allure_labels(attributes, LabelType.FEATURE))
-        test.labels.extend(allure_labels(attributes, LabelType.STORY))
-
+        for label_type in (LabelType.EPIC, LabelType.FEATURE, LabelType.STORY):
+            test.labels.extend(allure_labels(attributes, label_type))
+        for link_type in (LinkType.ISSUE, LinkType.TEST_CASE, LinkType.LINK):
+            test.links.extend(allure_links(attributes, link_type))
         test.labels.append(Label(name=LabelType.THREAD, value=self.pool_id))
         test.labels.append(Label(name=LabelType.HOST, value=host_tag()))
         test.labels.append(Label(name=LabelType.FRAMEWORK, value='robotframework'))

allure-robotframework/src/listener/utils.py

@@ -1,5 +1,6 @@
 from __future__ import absolute_import
-from allure_commons.model2 import Status, Label, Parameter
+from re import search
+from allure_commons.model2 import Status, Label, Parameter, Link
 from allure_commons.types import LabelType
 from allure_robotframework.types import RobotStatus
 
@@ -47,3 +48,25 @@ def label_value(label):
         return label.split(':')[1] or 'unknown'
 
     return [Label(name=prefix, value=label_value(tag)) for tag in tags if is_label(tag)]
+
+
+def allure_links(attributes, prefix):
+    tags = attributes.get('tags', ())
+
+    def is_link(link):
+        return link.startswith("{link}:".format(link=prefix))
+
+    def parse_link(link):
+        lnk_val = link.split(':', 1)[1] or 'unknown'
+        lnk_label = search(r'\[.+\]', lnk_val)
+        if lnk_label:
+            lnk_label = lnk_label.group(0)
+            lnk_val = lnk_val.strip(lnk_label)
+            lnk_label = lnk_label.strip('[]')
+        else:
+            lnk_label = lnk_val
+
+        return {'name': lnk_label, 'value': lnk_val}
+
+    return [Link(type=prefix, url=parse_link(tag).get('value'), name=parse_link(tag).get('name')) for tag in tags if
+            is_link(tag)]

allure-robotframework/test/link/link.robot

@@ -0,0 +1,37 @@
+*** Settings ***
+Library     ../run_robot_library.py
+Library     ../test_allure_library.py
+Suite Setup  Run example
+
+
+*** Keywords ***
+Run example
+    ${allure_report}   Run Robot With Allure   examples/link/link.rst
+    Set Suite Variable	${report}   ${allure_report}
+
+
+*** Test Case ***
+Test Case With Issue Link Without URL
+    ${test_case}     Should Has Test Case   ${report}   Test Case With Issue Link Without URL
+    Should Has Link  ${test_case}  ISSUE-1  issue
+
+Test Case With Issue Link With URL
+    ${test_case}     Should Has Test Case   ${report}   Test Case With Issue Link With URL
+    Should Has Link  ${test_case}  https://jira.com/browse/ISSUE-1  issue
+
+Test Case With TMS Link Without URL
+    ${test_case}     Should Has Test Case   ${report}   Test Case With TMS Link Without URL
+    Should Has Link  ${test_case}  TEST-1  test_case
+
+Test Case With TMS Link With URL
+    ${test_case}     Should Has Test Case   ${report}   Test Case With TMS Link With URL
+    Should Has Link  ${test_case}  https://testrail.com/browse/TEST-1  test_case
+
+Test Case With Unlabeled Link
+    ${test_case}     Should Has Test Case   ${report}   Test Case With Unlabeled Link
+    Should Has Link  ${test_case}  https://homepage.com/  link
+
+Test Case With Labeled Link
+    ${test_case}     Should Has Test Case   ${report}   Test Case With Labeled Link
+    Should Has Link  ${test_case}  https://homepage.com/  link  Home Page
+