Integration tests use pytest

Author: jfhbrook

justfile

@@ -81,17 +81,17 @@ check:
 
 # Run tests with pytest
 test:
-  uv run pytest -vvv ./tests
+  uv run pytest -vvv ./tests --ignore=./tests/test_integration.py
   @just clean-test
 
 # Update snapshots
 snap:
   uv run pytest --snapshot-update ./tests
   @just clean-test
 
-# Run integration tests (for what they are)
+# Run integration tests
 integration:
-  uv run python ./tests/integration.py
+  uv run pytest ./tests/test_integration.py
 
 clean-test:
   rm -f pytest_runner-*.egg

tests/conftest.py

@@ -2,9 +2,11 @@
 
 import os
 import os.path
+from typing import Callable, Never
 from unittest.mock import Mock
 
 import pytest
+from rich.prompt import Prompt
 
 from plusdeck.client import Client, State
 import plusdeck.config
@@ -49,3 +51,78 @@ def default_port() -> str:
     monkeypatch.setattr(plusdeck.config, "default_port", default_port)
 
     return port
+
+
+#
+# Integration test fixtures
+#
+
+
+class AbortError(AssertionError):
+    """
+    A manual testing step has been aborted.
+    """
+
+    pass
+
+
+@pytest.fixture
+def abort() -> Callable[[], Never]:
+    """
+    Abort a GAK test.
+    """
+
+    def _abort() -> Never:
+        raise AbortError("Aborted.")
+
+    return _abort
+
+
+@pytest.fixture
+def confirm(abort, capsys) -> Callable[[str], None]:
+    """
+    Manually confirm an expected state.
+    """
+
+    def _confirm(text: str) -> None:
+        with capsys.disabled():
+            res = Prompt.ask(text, choices=["confirm", "abort"])
+
+        if res == "abort":
+            abort()
+
+    return _confirm
+
+
+@pytest.fixture
+def take_action(abort, capsys) -> Callable[[str], None]:
+    """
+    Take a manual action before continuing.
+    """
+
+    def _take_action(text: str) -> None:
+        with capsys.disabled():
+            res = Prompt.ask(text, choices=["continue", "abort"])
+
+        if res == "abort":
+            abort()
+
+    return _take_action
+
+
+@pytest.fixture
+def check(abort, capsys) -> Callable[[str, str], None]:
+    """
+    Manually check whether or not an expected state is so.
+    """
+
+    def _check(text: str, expected: str) -> None:
+        with capsys.disabled():
+            res = Prompt.ask(text, choices=["yes", "no", "abort"])
+
+        if res == "abort":
+            abort()
+
+        assert res == "yes", expected
+
+    return _check

tests/integration.py tests/test_integration.pytests/integration.py renamed to tests/test_integration.py

@@ -1,13 +1,16 @@
+import pytest
+
 from plusdeck.client import Command, create_connection, State
 from plusdeck.config import Config
-from plusdeck.test import check, confirm, run_tests, skip, take_action
 
 CONFIG = Config.from_environment()
 
 
-@skip
-async def test_manual_no_events():
-    """Plus Deck plays tapes manually without state subscription."""
+@pytest.mark.skip
+async def test_manual_no_events(check, confirm, take_action) -> None:
+    """
+    Plus Deck plays tapes manually without state subscription.
+    """
 
     confirm("There is NO tape in the deck")
 
@@ -33,8 +36,11 @@ def unexpected_state(state: State):
     client.close()
 
 
-async def test_commands_and_events():
-    """Plus Deck plays tapes with commands when subscribed."""
+@pytest.mark.asyncio
+async def test_commands_and_events(check, confirm, take_action) -> None:
+    """
+    Plus Deck plays tapes with commands when subscribed.
+    """
 
     confirm("There is NO tape in the deck")
 
@@ -107,7 +113,3 @@ def log_state(state: State) -> None:
     client.events.remove_listener("state", log_state)
 
     client.close()
-
-
-if __name__ == "__main__":
-    run_tests(__name__)