Variant Typing

Author: Behemyth

cppython/test/data/__init__.py

@@ -0,0 +1 @@
+"""Data for testing plugins"""

cppython/test/data/mocks.py

@@ -0,0 +1,57 @@
+"""Mocked types and data for testing plugins"""
+
+from collections.abc import Sequence
+
+from cppython.core.plugin_schema.generator import Generator
+from cppython.core.plugin_schema.provider import Provider
+from cppython.core.plugin_schema.scm import SCM
+from cppython.test.mock.generator import MockGenerator
+from cppython.test.mock.provider import MockProvider
+from cppython.test.mock.scm import MockSCM
+
+
+def _mock_provider_list() -> Sequence[type[Provider]]:
+    """Mocked list of providers
+
+    Returns:
+        A list of mock providers
+    """
+    variants = []
+
+    # Default
+    variants.append(MockProvider)
+
+    return variants
+
+
+def _mock_generator_list() -> Sequence[type[Generator]]:
+    """Mocked list of generators
+
+    Returns:
+        List of mock generators
+    """
+    variants = []
+
+    # Default
+    variants.append(MockGenerator)
+
+    return variants
+
+
+def _mock_scm_list() -> Sequence[type[SCM]]:
+    """Mocked list of SCMs
+
+    Returns:
+        List of mock SCMs
+    """
+    variants = []
+
+    # Default
+    variants.append(MockSCM)
+
+    return variants
+
+
+provider_variants = _mock_provider_list()
+generator_variants = _mock_generator_list()
+scm_variants = _mock_scm_list()

cppython/test/data/variants.py

@@ -0,0 +1,93 @@
+"""Data definitions"""
+
+from pathlib import Path
+
+from cppython.core.schema import (
+    CPPythonGlobalConfiguration,
+    CPPythonLocalConfiguration,
+    PEP621Configuration,
+    ProjectConfiguration,
+)
+from cppython.test.schema import Variant, Variants
+
+
+def _pep621_configuration_list() -> Variants[PEP621Configuration]:
+    """Creates a list of mocked configuration types
+
+    Returns:
+        A list of variants to test
+    """
+    data = Variants[PEP621Configuration]()
+
+    # Default
+    default = PEP621Configuration(name='default-test', version='1.0.0')
+    default_variant = Variant[PEP621Configuration](configuration=default)
+
+    data.variants.append(default_variant)
+
+    return data
+
+
+def _cppython_local_configuration_list() -> Variants[CPPythonLocalConfiguration]:
+    """Mocked list of local configuration data
+
+    Returns:
+        A list of variants to test
+    """
+    data = Variants[CPPythonLocalConfiguration]()
+
+    # Default
+    default = CPPythonLocalConfiguration()
+    default_variant = Variant[CPPythonLocalConfiguration](configuration=default)
+
+    data.variants.append(default_variant)
+
+    return data
+
+
+def _cppython_global_configuration_list() -> Variants[CPPythonGlobalConfiguration]:
+    """Mocked list of global configuration data
+
+    Returns:
+        A list of variants to test
+    """
+    data = Variants[CPPythonGlobalConfiguration]()
+
+    # Default
+    default = CPPythonGlobalConfiguration()
+    default_variant = Variant[CPPythonGlobalConfiguration](configuration=default)
+
+    # Check off
+    check_off_data = {'current-check': False}
+    check_off = CPPythonGlobalConfiguration(**check_off_data)
+    check_off_variant = Variant[CPPythonGlobalConfiguration](configuration=check_off)
+
+    data.variants.append(default_variant)
+    data.variants.append(check_off_variant)
+
+    return data
+
+
+def _project_configuration_list() -> Variants[ProjectConfiguration]:
+    """Mocked list of project configuration data
+
+    Returns:
+        A list of variants to test
+    """
+    data = Variants[ProjectConfiguration]()
+
+    # NOTE: pyproject_file will be overridden by fixture
+
+    # Default
+    default = ProjectConfiguration(pyproject_file=Path('pyproject.toml'), version='0.1.0')
+    default_variant = Variant[ProjectConfiguration](configuration=default)
+
+    data.variants.append(default_variant)
+
+    return data
+
+
+pep621_variants = _pep621_configuration_list()
+cppython_local_variants = _cppython_local_configuration_list()
+cppython_global_variants = _cppython_global_configuration_list()
+project_variants = _project_configuration_list()

cppython/test/pytest/shared.py

@@ -27,11 +27,12 @@
     ProjectConfiguration,
     ProjectData,
 )
-from cppython.test.pytest.variants import (
+from cppython.test.data.mocks import (
     generator_variants,
     provider_variants,
     scm_variants,
 )
+from cppython.test.schema import Variant
 
 
 class BaseTests[T: Plugin](metaclass=ABCMeta):
@@ -130,7 +131,7 @@ class BaseUnitTests[T: Plugin](BaseTests[T], metaclass=ABCMeta):
     """Unit testing information for all plugin test classes"""
 
     @staticmethod
-    def test_feature_extraction(plugin_type: type[T], project_configuration: ProjectConfiguration) -> None:
+    def test_feature_extraction(plugin_type: type[T], project_configuration: Variant[ProjectConfiguration]) -> None:
         """Test the feature extraction of a plugin.
 
         This method tests the feature extraction functionality of a plugin by asserting that the features
@@ -140,7 +141,7 @@ def test_feature_extraction(plugin_type: type[T], project_configuration: Project
             plugin_type: The type of plugin to test.
             project_configuration: The project configuration to use for testing.
         """
-        assert plugin_type.features(project_configuration.pyproject_file.parent)
+        assert plugin_type.features(project_configuration.configuration.pyproject_file.parent)
 
     @staticmethod
     def test_information(plugin_type: type[T]) -> None:

cppython/test/pytest/variants.py

@@ -0,0 +1,19 @@
+"""Data schemas for plugin testing"""
+
+from typing import Annotated
+
+from pydantic import Field
+
+from cppython.core.schema import CPPythonModel
+
+
+class Variant[T: CPPythonModel](CPPythonModel):
+    """A configuration variant for a schema type"""
+
+    configuration: Annotated[T, Field(description='The configuration data')]
+
+
+class Variants[T: CPPythonModel](CPPythonModel):
+    """A group of variants"""
+
+    variants: Annotated[list[Variant[T]], Field(description='Data variants')] = []