WIP

Signed-off-by: jamshale <[email protected]>

.github/workflows/integration-tests.yml

@@ -45,6 +45,7 @@ jobs:
           git clone https://github.com/Indicio-tech/acapy-minimal-example.git
           # Copy custom integration tests to acapy-minimal-example
           cp -TRv integration-tests/examples acapy-minimal-example/examples
+          cp -f integration-tests/conftest.py acapy-minimal-example/conftest.py
           # Build the docker image for testing
           docker build -t acapy-test -f docker/Dockerfile.run .
           cd acapy-minimal-example

integration-tests/conftest.py

@@ -0,0 +1,126 @@
+"""Pytest fixtures and configuration."""
+
+import subprocess
+from pathlib import Path
+
+import pytest
+from pytest import Session
+
+EXAMPLES_DIR = Path(__file__).parent / "examples"
+
+
+class ExampleFailedException(Exception):
+    """Raised when an example fails."""
+
+    def __init__(self, message: str, exit_status: int):
+        """Initialize ExampleFailedException."""
+
+        super().__init__(message)
+        self.exit_status = exit_status
+
+
+class ExampleRunner:
+    """Run the docker-compose of a given example."""
+
+    def __init__(self, compose_file: str):
+        """Initialize ExampleRunner."""
+
+        self.compose_file = compose_file
+
+    def compose(self, *command: str) -> int:
+        """Runs docker-compose using subprocess with the given command.
+
+        Returns exit status and output.
+        """
+        try:
+            subprocess.run(
+                ["docker compose", "-f", self.compose_file, *command],
+                check=True,
+            )
+            return 0
+        except subprocess.CalledProcessError as e:
+            return e.returncode
+
+    def cleanup(self):
+        """Runs docker-compose down -v for cleanup."""
+        exit_status = self.compose("down", "-v")
+        if exit_status != 0:
+            raise ExampleFailedException(
+                f"Cleanup failed with exit status {exit_status}", exit_status
+            )
+
+    def handle_run(self, *command: str):
+        """Handles the run of docker-compose/.
+
+        raises exception if exit status is non-zero.
+        """
+        try:
+            exit_status = self.compose(*command)
+            if exit_status != 0:
+                raise ExampleFailedException(
+                    f"Command failed with exit status: {exit_status}",
+                    exit_status=exit_status,
+                )
+        finally:
+            self.cleanup()
+
+
+def pytest_collect_file(parent: Session, path):
+    """Pytest collection hook.
+
+    This will collect the docker-compose.yml files from the examples and create
+    pytest items to run them.
+    """
+    file = Path(str(path))
+
+    # Skip certain examples
+    if (file.parent / "__skip__").exists():
+        return
+
+    if file.suffix == ".yml" and file.parent.parent == EXAMPLES_DIR:
+        return ExampleFile.from_parent(parent, path=file.parent)
+
+
+class ExampleFile(pytest.File):
+    """Pytest file for example."""
+
+    def collect(self):
+        """Collect tests from example file."""
+        path = Path(self.fspath)
+        item = ExampleItem.from_parent(
+            self, name=path.name, compose_file=str(path / "docker-compose.yml")
+        )
+        item.add_marker(pytest.mark.examples)
+        yield item
+
+
+class ExampleItem(pytest.Item):
+    """Example item.
+
+    Runs the docker-compose.yml file of the example and reports failure if the
+    exit status is non-zero.
+    """
+
+    def __init__(self, name: str, parent: pytest.File, compose_file: str):
+        """Initialize ExampleItem."""
+        super().__init__(name, parent)
+        self.compose_file = compose_file
+
+    def runtest(self) -> None:
+        """Run the test."""
+        ExampleRunner(self.compose_file).handle_run("run", "example")
+
+    def repr_failure(self, excinfo):
+        """Called when self.runtest() raises an exception."""
+        if isinstance(excinfo.value, ExampleFailedException):
+            return "\n".join(
+                [
+                    "Example failed!",
+                    f"    {excinfo.value}",
+                ]
+            )
+        return f"Some other exectpion happened: {excinfo.value}"
+
+    def reportinfo(self):
+        """Report info about the example."""
+        return self.fspath, 0, f"example: {self.name}"