Merge pull request #52 from ramriddick/xdist_fix

Xdist fix for issue #29

Author: Yury Krasouski

README.rst

@@ -69,35 +69,39 @@ Examples
 
 For logging of the test item flow to Report Portal, please, use the python
 logging handler provided by plugin like bellow:
-
+in conftest.py:
 .. code-block:: python
 
-    import logging
-    # Import Report Portal logger and handler to the test module.
-    from pytest_reportportal import RPLogger, RPLogHandler
-    # Setting up a logging.
-    logging.setLoggerClass(RPLogger)
-    logger = logging.getLogger(__name__)
-    logger.setLevel(logging.DEBUG)
-    # Create handler for Report Portal.
-    rp_handler = RPLogHandler()
-    # Set INFO level for Report Portal handler.
-    rp_handler.setLevel(logging.INFO)
-    # Add handler to the logger.
-    logger.addHandler(rp_handler)
-
+    @pytest.fixture(scope="function")
+    def rp_logger(request):
+        import logging
+        # Import Report Portal logger and handler to the test module.
+        from pytest_reportportal import RPLogger, RPLogHandler
+        # Setting up a logging.
+        logging.setLoggerClass(RPLogger)
+        logger = logging.getLogger(__name__)
+        logger.setLevel(logging.DEBUG)
+        # Create handler for Report Portal.
+        rp_handler = RPLogHandler(request.node.config.py_test_service)
+        # Set INFO level for Report Portal handler.
+        rp_handler.setLevel(logging.INFO)
+        # Add handler to the logger.
+        logger.addHandler(rp_handler)
+        return logger
+in tests:
+.. code-block:: python
 
     # In this case only INFO messages will be sent to the Report Portal.
-    def test_one():
-        logger.info("Case1. Step1")
+    def test_one(rp_logger):
+        rp_logger.info("Case1. Step1")
         x = "this"
-        logger.info("x is: %s", x)
+        rp_logger.info("x is: %s", x)
         assert 'h' in x
 
         # Message with an attachment.
         import subprocess
         free_memory = subprocess.check_output("free -h".split())
-        logger.info(
+        rp_logger.info(
             "Case1. Memory consumption",
             attachment={
                 "name": "free_memory.txt",
@@ -107,7 +111,7 @@ logging handler provided by plugin like bellow:
         )
 
         # This debug message will not be sent to the Report Portal.
-        logger.debug("Case1. Debug message")
+        rp_logger.debug("Case1. Debug message")
 
 Plugin can report doc-strings of tests as :code:`descriptions`:
 

pytest_reportportal/__init__.py

@@ -1,3 +1,5 @@
 from .rp_logging import RPLogger, RPLogHandler
 
 __all__ = ['RPLogger', 'RPLogHandler']
+
+LAUNCH_WAIT_TIMEOUT = 10

pytest_reportportal/listener.py

@@ -2,7 +2,6 @@
 import pytest
 import logging
 
-from .service import PyTestService
 
 try:
     # This try/except can go away once we support pytest >= 3.3
@@ -14,16 +13,17 @@
 
 
 class RPReportListener(object):
-    def __init__(self, log_level=logging.NOTSET):
+    def __init__(self, py_test_service, log_level=logging.NOTSET):
         # Test Item result
+        self.PyTestService = py_test_service
         self.result = None
         self._log_level = log_level
         if PYTEST_HAS_LOGGING_PLUGIN:
             self._log_handler = RPLogHandler(log_level, filter_reportportal_client_logs=True)
 
     @pytest.hookimpl(hookwrapper=True)
     def pytest_runtest_protocol(self, item):
-        PyTestService.start_pytest_item(item)
+        self.PyTestService.start_pytest_item(item)
         if PYTEST_HAS_LOGGING_PLUGIN:
             # This check can go away once we support pytest >= 3.3
             with patching_logger_class():
@@ -32,14 +32,14 @@ def pytest_runtest_protocol(self, item):
                     yield
         else:
             yield
-        PyTestService.finish_pytest_item(self.result or 'SKIPPED')
+        self.PyTestService.finish_pytest_item(self.result or 'SKIPPED')
 
     @pytest.hookimpl(hookwrapper=True)
     def pytest_runtest_makereport(self):
         report = (yield).get_result()
 
         if report.longrepr:
-            PyTestService.post_log(
+            self.PyTestService.post_log(
                 # Used for support python 2.7
                 cgi.escape(report.longreprtext),
                 loglevel='ERROR',

pytest_reportportal/plugin.py

@@ -2,8 +2,11 @@
 # and/or modify it under the terms of the GPL licence
 
 import logging
-
-from .service import PyTestService
+import dill as pickle
+import pytest
+import time
+from pytest_reportportal import LAUNCH_WAIT_TIMEOUT
+from .service import PyTestServiceClass
 from .listener import RPReportListener
 
 try:
@@ -14,24 +17,48 @@
     PYTEST_HAS_LOGGING_PLUGIN = False
 
 
+def is_master(config):
+    """
+    True if the code running the given pytest.config object is running in a xdist master
+    node or not running xdist at all.
+    """
+    return not hasattr(config, 'slaveinput')
+
+
+@pytest.mark.optionalhook
+def pytest_configure_node(node):
+    node.slaveinput['py_test_service'] = pickle.dumps(node.config.py_test_service)
+
+
 def pytest_sessionstart(session):
     if session.config.getoption('--collect-only', default=False) is True:
         return
 
-    PyTestService.init_service(
-        project=session.config.getini('rp_project'),
-        endpoint=session.config.getini('rp_endpoint'),
-        uuid=session.config.getini('rp_uuid'),
-        log_batch_size=int(session.config.getini('rp_log_batch_size')),
-        ignore_errors=bool(session.config.getini('rp_ignore_errors')),
-        ignored_tags=session.config.getini('rp_ignore_tags'),
-    )
+    if is_master(session.config):
+        session.config.py_test_service.init_service(
+            project=session.config.getini('rp_project'),
+            endpoint=session.config.getini('rp_endpoint'),
+            uuid=session.config.getini('rp_uuid'),
+            log_batch_size=int(session.config.getini('rp_log_batch_size')),
+            ignore_errors=bool(session.config.getini('rp_ignore_errors')),
+            ignored_tags=session.config.getini('rp_ignore_tags'),
+        )
+
+        session.config.py_test_service.start_launch(
+            session.config.option.rp_launch,
+            tags=session.config.getini('rp_launch_tags'),
+            description=session.config.getini('rp_launch_description'),
+        )
+        if session.config.pluginmanager.hasplugin('xdist'):
+            wait_launch(session.config.py_test_service.RP.rp_client)
 
-    PyTestService.start_launch(
-        session.config.option.rp_launch,
-        tags=session.config.getini('rp_launch_tags'),
-        description=session.config.option.rp_launch_description,
-    )
+
+def wait_launch(rp_client):
+    timeout = time.time() + LAUNCH_WAIT_TIMEOUT
+    while not rp_client.launch_id:
+        if time.time() > timeout:
+            raise Exception("Launch not found")
+        time.sleep(1)
 
 
 def pytest_sessionfinish(session):
@@ -40,7 +67,8 @@ def pytest_sessionfinish(session):
 
     # FixMe: currently method of RP api takes the string parameter
     # so it is hardcoded
-    PyTestService.finish_launch(status='RP_Launch')
+    if is_master(session.config):
+        session.config.py_test_service.finish_launch(status='RP_Launch')
 
 
 def pytest_configure(config):
@@ -49,30 +77,33 @@ def pytest_configure(config):
     if not config.option.rp_launch_description:
         config.option.rp_launch_description = config.getini('rp_launch_description')
 
-    if config.pluginmanager.hasplugin('xdist'):
-        raise Exception(
-            "pytest report portal is not compatible with 'xdist' plugin.")
+    if is_master(config):
+        config.py_test_service = PyTestServiceClass()
+    else:
+        config.py_test_service = pickle.loads(config.slaveinput['py_test_service'])
+        config.py_test_service.RP.listener.start()
 
     # set Pytest_Reporter and configure it
 
     if PYTEST_HAS_LOGGING_PLUGIN:
         # This check can go away once we support pytest >= 3.3
         try:
             config._reporter = RPReportListener(
+                config.py_test_service,
                 _pytest.logging.get_actual_log_level(config, 'rp_log_level')
             )
         except TypeError:
             # No log level set either in INI or CLI
-            config._reporter = RPReportListener()
+            config._reporter = RPReportListener(config.py_test_service)
     else:
-        config._reporter = RPReportListener()
+        config._reporter = RPReportListener(config.py_test_service)
 
     if hasattr(config, '_reporter'):
         config.pluginmanager.register(config._reporter)
 
 
 def pytest_unconfigure(config):
-    PyTestService.terminate_service()
+    config.py_test_service.terminate_service()
 
     if hasattr(config, '_reporter'):
         reporter = config._reporter

pytest_reportportal/rp_logging.py

@@ -4,8 +4,6 @@
 from functools import wraps
 from six import PY2
 
-from .service import PyTestService
-
 
 class RPLogger(logging.getLoggerClass()):
     def __init__(self, name, level=0):
@@ -62,10 +60,11 @@ class RPLogHandler(logging.Handler):
     }
     _sorted_levelnos = sorted(_loglevel_map.keys(), reverse=True)
 
-    def __init__(self, level=logging.NOTSET,
+    def __init__(self, py_test_service, level=logging.NOTSET,
                  filter_reportportal_client_logs=False):
         super(RPLogHandler, self).__init__(level)
         self.filter_reportportal_client_logs = filter_reportportal_client_logs
+        self.py_test_service = py_test_service
 
     def filter(self, record):
         if self.filter_reportportal_client_logs is False:
@@ -90,7 +89,7 @@ def emit(self, record):
             if level <= record.levelno:
                 break
 
-        return PyTestService.post_log(
+        return self.py_test_service.post_log(
             msg,
             loglevel=self._loglevel_map[level],
             attachment=record.__dict__.get('attachment', None),

pytest_reportportal/service.py

@@ -179,6 +179,3 @@ def _get_description(test_item):
         except AttributeError:
             # doctest has no `function` attribute
             return test_item.reportinfo()[2]
-
-
-PyTestService = PyTestServiceClass()

setup.py

@@ -12,9 +12,10 @@ def read_file(fname):
 
 
 requirements = [
-    'reportportal-client>=3.0.0',
+    'reportportal-client>=3.1.0',
     'pytest>=3.0.7',
     'six>=1.10.0',
+    'dill>=0.2.7.1',
 ]