allure library (fixes #257 closes #258 via #262)

Author: sseliverstov

allure-robotframework/setup.py

@@ -31,8 +31,8 @@ def read(fname):
         description="Allure Robot Framework integration",
         license="Apache-2.0",
         keywords="allure reporting robotframework",
-        packages=['allure_robotframework'],
-        package_dir={"allure_robotframework": "src"},
+        packages=['allure_robotframework', 'AllureLibrary'],
+        package_dir={"allure_robotframework": "src/listener", 'AllureLibrary': 'src/library'},
         install_requires=install_requires,
         py_modules=['allure_robotframework'],
         url="https://github.com/allure-framework/allure-python",

allure-robotframework/src/__init__.py

@@ -0,0 +1,3 @@
+from .allure_library import attach, attach_file
+
+__all__ = ['attach', 'attach_file']

allure-robotframework/src/library/__init__.py

@@ -0,0 +1,19 @@
+import allure
+
+
+__all__ = ['attach', 'attach_file']
+
+
+def _attachment_type(name):
+    try:
+        return allure.attachment_type[name]
+    except KeyError:
+        return name
+
+
+def attach(data, name=None, attachment_type=None, extension=None):
+    allure.attach(data, name=name, attachment_type=_attachment_type(attachment_type), extension=extension)
+
+
+def attach_file(source, name=None, attachment_type=None, extension=None):
+    allure.attach.file(source, name=name, attachment_type=_attachment_type(attachment_type), extension=extension)

allure-robotframework/src/library/allure_library.py

@@ -0,0 +1,3 @@
+from allure_robotframework.robot_listener import allure_robotframework
+
+__all__ = ['allure_robotframework']

allure-robotframework/src/listener/__init__.py

@@ -0,0 +1,15 @@
+import allure_commons
+from allure_commons.utils import uuid4
+
+
+class AllureListener(object):
+    def __init__(self, logger):
+        self.logger = logger
+
+    @allure_commons.hookimpl
+    def attach_data(self, body, name, attachment_type, extension):
+        self.logger.attach_data(uuid4(), body, name=name, attachment_type=attachment_type, extension=extension)
+
+    @allure_commons.hookimpl
+    def attach_file(self, source, name, attachment_type, extension):
+        self.logger.attach_file(uuid4(), source, name=name, attachment_type=attachment_type, extension=extension)

allure-robotframework/src/listener/allure_listener.py

@@ -7,12 +7,13 @@
 from allure_commons.utils import now, uuid4, md5, host_tag
 from allure_commons.logger import AllureFileLogger
 from allure_commons.types import AttachmentType, LabelType, LinkType
-from allure_commons import plugin_manager
 from allure_commons.utils import platform_label
 from robot.libraries.BuiltIn import BuiltIn
-from allure_robotframework.constants import RobotKeywordType, RobotLogLevel
+from allure_robotframework.types import RobotKeywordType, RobotLogLevel
 from allure_robotframework import utils
 import os
+from allure_robotframework.allure_listener import AllureListener
+import allure_commons
 
 
 # noinspection PyPep8Naming
@@ -23,14 +24,17 @@ class allure_robotframework(object):
     FAIL_MESSAGE_FORMAT = '{full_message}<p style="color: red"><b>[{level}]</b> {message}</p>'
 
     def __init__(self, logger_path=DEFAULT_OUTPUT_PATH):
-        self.reporter = AllureReporter()
-        self.logger = AllureFileLogger(logger_path)
         self.stack = []
         self.items_log = {}
         self.pool_id = None
         self.links = OrderedDict()
-        plugin_manager.register(self.reporter)
-        plugin_manager.register(self.logger)
+
+        self.reporter = AllureReporter()
+        self.listener = AllureListener(self.reporter)
+        self.logger = AllureFileLogger(logger_path)
+
+        allure_commons.plugin_manager.register(self.logger)
+        allure_commons.plugin_manager.register(self.listener)
 
     def start_suite(self, name, attributes):
         if not self.pool_id:
@@ -174,3 +178,8 @@ def set_suite_link(self, metadata, uuid):
     def remove_suite_link(self, uuid):
         if self.links.get(uuid):
             self.links.pop(uuid)
+
+    def close(self):
+        for plugin in [self.logger, self.listener]:
+            name = allure_commons.plugin_manager.get_name(plugin)
+            allure_commons.plugin_manager.unregister(name=name)

allure-robotframework/src/listener.py renamed to allure-robotframework/src/listener/robot_listener.py

@@ -1,7 +1,7 @@
 from __future__ import absolute_import
 from allure_commons.model2 import Status, Label, Parameter
 from allure_commons.types import LabelType
-from allure_robotframework.constants import RobotStatus
+from allure_robotframework.types import RobotStatus
 
 
 def get_allure_status(status):

allure-robotframework/src/constants.py renamed to allure-robotframework/src/listener/types.py

@@ -38,6 +38,16 @@ def robot_run_with_allure(work_dir, *args, **kwargs):
     stdout_file = os.path.join(output_dir, 'stdout.txt')
 
     def target(*a, **kw):
+
+        # ToDo: fix it (_core not works correctly with multiprocessing)
+        import six
+        import allure_commons
+        if six.PY2:
+            reload(allure_commons._core)
+        else:
+            import importlib
+            importlib.reload(allure_commons._core)
+
         listener = allure_robotframework(logger_path=allure_dir)
 
         with open(stdout_file, 'w+') as stdout: