tests: fix main tests failing

TestMain are failing due to a clash with the main loop used by  kirk and
initialized in the main.py implementation. Create a new isolated loop
inside test to avoid this issue and fix it for all python versions
including 3.7/9.

This will also fix the github workflows dependencies which were stuck to
old versions of pytest and pytest-asyncio.

Signed-off-by: Andrea Cervesato <andrea.cervesato@suse.com>

Author: acerv

.github/workflows/test_ltx.yml

@@ -4,7 +4,7 @@ name: "Test LTX"
 on: [push, pull_request]
 
 env:
-  PYTHON_PKGS: pytest<8.3.5 pytest-asyncio<1.0 msgpack
+  PYTHON_PKGS: pytest pytest-asyncio msgpack
 
 jobs:
   python3:

.github/workflows/test_ssh.yml

@@ -4,7 +4,7 @@ name: "Test SSH"
 on: push
 
 env:
-  PYTHON_PKGS: pytest<8.3.5 pytest-asyncio<1.0 build asyncssh
+  PYTHON_PKGS: pytest pytest-asyncio build asyncssh
   TEST_SSH_KEY_FILE: /home/runner/.ssh/id_rsa
   TEST_SSH_USERNAME: runner
   TEST_SSH_PASSWORD: password

.github/workflows/tests.yml

@@ -4,7 +4,7 @@ name: "Test packages"
 on: [push, pull_request]
 
 env:
-  PYTHON_PKGS: pytest<8.3.5 pytest-asyncio<1.0 build
+  PYTHON_PKGS: pytest pytest-asyncio build
 
 jobs:
   python3-deprecated:

libkirk/sut.py

@@ -247,8 +247,13 @@ async def get_info(self) -> Dict[str, str]:
 
         return ret
 
-    _tainted_lock = asyncio.Lock()
-    _tainted_status = asyncio.Queue(maxsize=1)
+    # Lazily initialised inside get_tainted_info() so that the
+    # asyncio primitives are always created on the *running* loop.
+    # Class-level assignment would bind them to the loop that was
+    # current at import time, which breaks on Python 3.7-3.9 when
+    # tests run on a different loop than the session loop.
+    _tainted_lock: Optional[asyncio.Lock] = None
+    _tainted_status: Optional[asyncio.Queue] = None
 
     async def get_tainted_info(self) -> Tuple[int, List[str]]:
         """
@@ -261,6 +266,12 @@ async def get_tainted_info(self) -> Tuple[int, List[str]]:
         if not await self.is_running:
             raise SUTError("SUT is not running")
 
+        # Initialise on first use, always inside a running loop.
+        if self._tainted_lock is None:
+            self._tainted_lock = asyncio.Lock()
+        if self._tainted_status is None:
+            self._tainted_status = asyncio.Queue(maxsize=1)
+
         if self._tainted_lock.locked() and self._tainted_status.qsize() > 0:
             status = await self._tainted_status.get()
             return status

libkirk/tests/test_main.py

@@ -2,16 +2,57 @@
 Unittests for main module.
 """
 
+import asyncio
 import json
 import os
 import pwd
 import sys
 
 import pytest
 
-import libkirk.sut
+import libkirk
 import libkirk.com
 import libkirk.main
+import libkirk.sut
+from libkirk.evt import EventsHandler
+
+
+@pytest.fixture(autouse=True)
+def isolated_loop(monkeypatch):
+    """
+    Give every TestMain test its own event loop so that
+    libkirk.main.run() cannot cancel tasks belonging to
+    other (async) tests, and cannot leave the shared
+    session loop in a dirty state.
+    """
+    # Remember which loop the session is using so we can restore it.
+    session_loop = libkirk.get_event_loop()
+
+    loop = asyncio.new_event_loop()
+    asyncio.set_event_loop(loop)
+
+    # Re-discover plugins now that the isolated loop is current, so that
+    # every asyncio.Lock() inside plugin __init__ methods binds to this loop.
+    currdir = os.path.dirname(os.path.realpath(libkirk.com.__file__))
+    libkirk.com.discover(os.path.join(currdir, "channels"), extend=False)
+    libkirk.sut.discover(currdir, extend=False)
+
+    fresh_events = EventsHandler()
+    monkeypatch.setattr(libkirk, "get_event_loop", lambda: loop)
+    monkeypatch.setattr(libkirk, "events", fresh_events)
+
+    yield loop
+
+    # Drain and close the isolated loop.
+    try:
+        libkirk.cancel_tasks(loop)
+        if not loop.is_closed():
+            loop.run_until_complete(fresh_events.stop())
+    finally:
+        if not loop.is_closed():
+            loop.close()
+        # Restore the session loop so subsequent async tests still work.
+        asyncio.set_event_loop(session_loop)
 
 
 class TestMain: