Fixed issue with latest pytest+pytest-xdist versions: pytest_harvest_xdist_worker_dump hook is now called correctly. Fixes #48

Author: Sylvain MARIE

pytest_harvest/plugin.py

@@ -18,7 +18,7 @@
 from pytest_harvest.common import HARVEST_PREFIX
 from pytest_harvest.results_bags import create_results_bag_fixture
 from pytest_harvest.results_session import get_session_synthesis_dct, get_persistable_session_items
-from pytest_harvest.xdist_api import _is_xdist_master, _is_xdist_worker, get_xdist_worker_id
+from pytest_harvest.xdist_api import is_xdist_master, is_xdist_worker, get_xdist_worker_id
 
 
 @pytest.hookimpl(tryfirst=True, hookwrapper=True)
@@ -437,8 +437,8 @@ def pytest_configure(config):
 
 @pytest.hookimpl(tryfirst=True)
 def pytest_sessionstart(session):
-    """ This should run first as it creates the temporary filder when run on the xdist master."""
-    if _is_xdist_master(session):
+    """ This should run first as it creates the temporary folder when run on the xdist master."""
+    if is_xdist_master(session):
         # perform cleanup
         session.config.hook.pytest_harvest_xdist_init()
 
@@ -449,14 +449,14 @@ def pytest_sessionstart(session):
 @pytest.hookimpl(trylast=True)
 def pytest_sessionfinish(session):
     """ This should run last as it deletes the persisted items when run on the xdist master."""
-    if _is_xdist_worker(session):
+    if is_xdist_worker(session):
         # persist fixture store and report items in a pickle file with this id
         wid = get_xdist_worker_id(session)
         session_items = get_persistable_session_items(session)
         session.config.hook.pytest_harvest_xdist_worker_dump(worker_id=wid, session_items=session_items,
                                                              fixture_store=FIXTURE_STORE)
 
-    elif _is_xdist_master(session):
+    elif is_xdist_master(session):
         # final master cleanup
         session.config.hook.pytest_harvest_xdist_cleanup()
 
@@ -471,7 +471,7 @@ def possibly_restore_xdist_workers_structs(session):
     :param session:
     :return:
     """
-    if _is_xdist_master(session) and hasattr(FIXTURE_STORE, 'disabled'):
+    if is_xdist_master(session) and hasattr(FIXTURE_STORE, 'disabled'):
         # load saved session items and fixtures
         workers_saved_material = session.config.hook.pytest_harvest_xdist_load()
 

pytest_harvest/results_session.py

@@ -582,7 +582,11 @@ def __init__(self, item):
             self.callspec = _MinimalCallSpec(params=item.callspec.params)
 
         # convert these to simple tuples just in case pytest-cases is around and has messed with fixturenames.
-        self.funcargnames = tuple(item.funcargnames)  # not needed but we can keep it
+        try:
+            # This attribute does not seem to exist in latest pytest
+            self.funcargnames = tuple(item.funcargnames)  # not needed but we can keep it
+        except AttributeError:
+            pass
         self.fixturenames = tuple(item.fixturenames)
 
         # We do not store the session object so everything that depends on it should be retrieved:

pytest_harvest/xdist_api.py

@@ -4,10 +4,10 @@
     from xdist import __version__ as xdist_version
 except ImportError:
     # no xdist installed - create a substitute API
-    def _is_xdist_worker(session):
+    def is_xdist_worker(session):
         return False
 
-    def _is_xdist_master(session):
+    def is_xdist_master(session):
         return False
 
     def is_main_process(session):
@@ -16,45 +16,49 @@ def is_main_process(session):
     def get_xdist_worker_id(request_or_session):
         return "master"  # for consistency with the original method
 else:
-    # if LooseVersion(xdist_version) <= LooseVersion("1.31.0"):
-    # old xdist with no api
-    def _is_xdist_worker(request_or_session):
-        """Return `True` if this is a xdist worker, `False` otherwise
+    try:
+        # our PR has been accepted in pytest-xdist so we can use these in latest versions
+        from xdist import is_xdist_worker, is_xdist_master, get_xdist_worker_id
+    except ImportError:
+        # if LooseVersion(xdist_version) <= LooseVersion("1.31.0"):
+        # old xdist with no api
+        def is_xdist_worker(request_or_session):
+            """Return `True` if this is a xdist worker, `False` otherwise
 
-        :param request_or_session: the `pytest` `request` or `session` object
-        :return:
-        """
-        return hasattr(request_or_session.config, "workerinput")
+            :param request_or_session: the `pytest` `request` or `session` object
+            :return:
+            """
+            return hasattr(request_or_session.config, "workerinput")
 
-    def _is_xdist_master(request_or_session):
-        """Return `True` if this is the xdist master, `False` otherwise
+        def is_xdist_master(request_or_session):
+            """Return `True` if this is the xdist master, `False` otherwise
 
-        Note: this method returns `False` when distribution has not been activated
-        at all.
+            Note: this method returns `False` when distribution has not been activated
+            at all.
 
-        :param request_or_session: the `pytest` `request` or `session` object
-        :return:
-        """
-        return (not _is_xdist_worker(request_or_session)
-                and getattr(request_or_session.config.option, 'dist', 'no') != "no")
+            :param request_or_session: the `pytest` `request` or `session` object
+            :return:
+            """
+            return (not is_xdist_worker(request_or_session)
+                    and getattr(request_or_session.config.option, 'dist', 'no') != "no")
 
-    def get_xdist_worker_id(request_or_session):
-        """Return the id of the current worker ('gw0', 'gw1', etc) or None
-        if running on the master node.
-
-        :param request_or_session: the `pytest` `request` or `session` object
-        :return:
-        """
-        if hasattr(request_or_session.config, "workerinput"):
-            return request_or_session.config.workerinput["workerid"]
-        else:
-            # TODO shall we raise an exception if dist is not enabled ?
-            #  i.e. `not is_xdist_master(request_or_session)` ?
-            return "master"
+        def get_xdist_worker_id(request_or_session):
+            """Return the id of the current worker ('gw0', 'gw1', etc) or None
+            if running on the master node.
+
+            :param request_or_session: the `pytest` `request` or `session` object
+            :return:
+            """
+            if hasattr(request_or_session.config, "workerinput"):
+                return request_or_session.config.workerinput["workerid"]
+            else:
+                # TODO shall we raise an exception if dist is not enabled ?
+                #  i.e. `not is_xdist_master(request_or_session)` ?
+                return "master"
     # else:
     #     from xdist import (get_xdist_worker_id as get_xdist_worker_id,
-    #                        is_xdist_master as _is_xdist_master,
-    #                        is_xdist_worker as _is_xdist_worker)
+    #                        is_xdist_master as is_xdist_master,
+    #                        is_xdist_worker as is_xdist_worker)
 
     def is_main_process(session):
-        return not _is_xdist_worker(session)
+        return not is_xdist_worker(session)