Move Plugin Fixtures

Author: Behemyth

cppython/plugins/cmake/plugin.py

@@ -60,14 +60,17 @@ def sync(self, sync_data: SyncData) -> None:
         Args:
             sync_data: The input data
         """
-        if isinstance(sync_data, CMakeSyncData):
-            self._cppython_preset_directory.mkdir(parents=True, exist_ok=True)
-            self._provider_directory.mkdir(parents=True, exist_ok=True)
+        match sync_data:
+            case CMakeSyncData():
+                self._cppython_preset_directory.mkdir(parents=True, exist_ok=True)
+                self._provider_directory.mkdir(parents=True, exist_ok=True)
 
-            self.builder.write_provider_preset(self._provider_directory, sync_data)
+                self.builder.write_provider_preset(self._provider_directory, sync_data)
 
-            cppython_preset_file = self.builder.write_cppython_preset(
-                self._cppython_preset_directory, self._provider_directory, sync_data
-            )
+                cppython_preset_file = self.builder.write_cppython_preset(
+                    self._cppython_preset_directory, self._provider_directory, sync_data
+                )
 
-            self.builder.write_root_presets(self.data.preset_file, cppython_preset_file)
+                self.builder.write_root_presets(self.data.preset_file, cppython_preset_file)
+            case _:
+                raise ValueError('Unsupported sync data type')

tests/conftest.py

@@ -1,4 +1,4 @@
-"""Data variations for testing"""
+"""Global fixtures for the test suite"""
 
 # from pathlib import Path
 from pathlib import Path
@@ -28,7 +28,6 @@
     PyProject,
     ToolData,
 )
-from cppython.plugins.cmake.schema import CMakeConfiguration
 from cppython.test.pytest.variants import (
     cppython_global_variants,
     cppython_local_variants,
@@ -37,22 +36,6 @@
 )
 
 
-def _cmake_data_list() -> list[CMakeConfiguration]:
-    """Creates a list of mocked configuration types
-
-    Returns:
-        A list of variants to test
-    """
-    variants = []
-
-    # Default
-    variants.append(CMakeConfiguration(configuration_name='default'))
-
-    # variants.append(CMakeConfiguration(preset_file=Path("inner/CMakePresets.json"), configuration_name="default"))
-
-    return variants
-
-
 @pytest.fixture(
     name='install_path',
     scope='session',
@@ -311,23 +294,6 @@ def fixture_project(
     return PyProject(project=pep621_configuration, tool=tool)
 
 
-@pytest.fixture(
-    name='cmake_data',
-    scope='session',
-    params=_cmake_data_list(),
-)
-def fixture_cmake_data(request: pytest.FixtureRequest) -> CMakeConfiguration:
-    """A fixture to provide a list of configuration types
-
-    Args:
-        request: Parameterization list
-
-    Returns:
-        A configuration type instance
-    """
-    return cast(CMakeConfiguration, request.param)
-
-
 def pytest_generate_tests(metafunc: pytest.Metafunc) -> None:
     """Provides custom parameterization for dynamic fixture names.
 

tests/fixtures/__init__.py

@@ -0,0 +1,10 @@
+"""Fixtures for tests.
+
+`pytest_plugins` is the preferred way to load fixtures, to prevent the overhead of a large root conftest file.
+The plugins must be defined at the test module's global scope and not in non-root conftest files.
+
+ex.
+```
+pytest_plugins = ['fixtures.fixture_name']
+```
+"""

tests/fixtures/cmake.py

@@ -0,0 +1,40 @@
+"""Fixtures for the cmake plugin"""
+
+from typing import cast
+
+import pytest
+
+from cppython.plugins.cmake.schema import CMakeConfiguration
+
+
+def _cmake_data_list() -> list[CMakeConfiguration]:
+    """Creates a list of mocked configuration types
+
+    Returns:
+        A list of variants to test
+    """
+    variants = []
+
+    # Default
+    variants.append(CMakeConfiguration(configuration_name='default'))
+
+    # variants.append(CMakeConfiguration(preset_file=Path("inner/CMakePresets.json"), configuration_name="default"))
+
+    return variants
+
+
+@pytest.fixture(
+    name='cmake_data',
+    scope='session',
+    params=_cmake_data_list(),
+)
+def fixture_cmake_data(request: pytest.FixtureRequest) -> CMakeConfiguration:
+    """A fixture to provide a list of configuration types
+
+    Args:
+        request: Parameterization list
+
+    Returns:
+        A configuration type instance
+    """
+    return cast(CMakeConfiguration, request.param)

tests/integration/plugins/cmake/test_generator.py

@@ -8,6 +8,8 @@
 from cppython.plugins.cmake.schema import CMakeConfiguration
 from cppython.test.pytest.tests import GeneratorIntegrationTests
 
+pytest_plugins = ['tests.fixtures.cmake']
+
 
 class TestCPPythonGenerator(GeneratorIntegrationTests[CMakeGenerator]):
     """The tests for the CMake generator"""

tests/unit/plugins/cmake/test_generator.py

@@ -16,6 +16,8 @@
 from cppython.test.pytest.tests import GeneratorUnitTests
 from cppython.utility.utility import TypeName
 
+pytest_plugins = ['tests.fixtures.cmake']
+
 
 class TestCPPythonGenerator(GeneratorUnitTests[CMakeGenerator]):
     """The tests for the CMake generator"""