Example Runner

Author: Behemyth

tests/fixtures/cli.py

@@ -0,0 +1,15 @@
+"""Fixtures for interfacing with the CLI."""
+
+import pytest
+from typer.testing import CliRunner
+
+
+@pytest.fixture(
+    name='typer_runner',
+    scope='session',
+)
+def fixture_typer_runner() -> CliRunner:
+    """Returns a runner setup for the CPPython interface"""
+    runner = CliRunner()
+
+    return runner

tests/fixtures/example.py

@@ -1,10 +1,15 @@
 """Fixtures for the cmake plugin"""
 
 import os
+import shutil
+from collections.abc import Generator
 from pathlib import Path
 from typing import cast
 
 import pytest
+from typer.testing import CliRunner
+
+pytest_plugins = ['tests.fixtures.cli']
 
 
 def _examples() -> list[Path]:
@@ -35,3 +40,36 @@ def fixture_example_directory(
     """
     directory = cast(Path, request.param)
     return directory
+
+
+@pytest.fixture(
+    name='example_runner',
+)
+def fixture_example_runner(
+    request: pytest.FixtureRequest, typer_runner: CliRunner, tmp_path: Path
+) -> Generator[CliRunner]:
+    """TODO"""
+    prev_cwd = os.getcwd()
+
+    # Get the root directory of the project
+    root_directory = Path(__file__).parent.parent.parent.absolute()
+
+    # Remove the file extension and required 'test_' prefix from the test's file name
+    file_name = request.node.fspath.basename[:-3].replace('test_', '')
+
+    # Get the test function name and remove the required 'test_' prefix
+    test_name = request.node.name.replace('test_', '')
+
+    # Generate the example path from the pytest file and test name
+    example_path = root_directory / 'examples' / file_name / test_name
+
+    try:
+        with typer_runner.isolated_filesystem(tmp_path) as temp_directory:
+            os.chdir(temp_directory)
+
+            # Copy the example directory to the temporary directory
+            shutil.copytree(example_path, Path(), dirs_exist_ok=True)
+
+            yield typer_runner
+    finally:
+        os.chdir(prev_cwd)

tests/integration/examples/test_examples.py

@@ -8,7 +8,7 @@
 pytest_plugins = ['tests.fixtures.example']
 
 
-class TestSetup:
+class TestExamples:
     """Verification that the example directory is setup correctly"""
 
     @staticmethod

tests/integration/examples/test_pdm_vcpkg_cmake.py

@@ -1,10 +1,13 @@
-"""Example folder tests.
+"""TODO"""
 
-All examples can be run with the CPPython entry-point, and we use the examples as the test data for the CLI.
-"""
+from typer.testing import CliRunner
 
-pytest_plugins = ['tests.fixtures.cmake']
+pytest_plugins = ['tests.fixtures.example']
 
 
-class TestSetup:
-    """Verification that the example directory is setup correctly"""
+class TestPdmVcpkgCMake:
+    """TODO"""
+
+    @staticmethod
+    def test_simple(example_runner: CliRunner) -> None:
+        """Verify that the fixture is returning the right data"""