Introduce support for dynamic config return values in plugins (#106)

* Introduce support for dynamic config return values in plugins

Add support for the plugins dynamically adjusting the return values
for `get_all_configs()` and `get_supported_configs()` based on input
`known_properties` values.  The values are either provided based
on the variants being validated (for `get_all_configs()`) or based
on all properties found in available wheels (for
`get_supported_configs()`).  The dynamic API is entirely optional --
the plugin can simply ignore the additional argument and return a fixed
list as usual.  It also permits for hybrid plugins that combine static
and dynamic properties.

* Remove the default argument from protocol

* Add a `dynamic` property to distinguish dynamic plugins

* Use `frozenset` in plugin API

* Use a stricter value regex

* Extend failing regex tests with \t

Author: mgorny

tests/artifacts/test-plugin-package/dist/test_plugin_package-0-py3-none-any.whl

@@ -1,4 +1,10 @@
+from __future__ import annotations
+
 from dataclasses import dataclass
+from typing import TYPE_CHECKING
+
+if TYPE_CHECKING:
+    from variantlib.protocols import VariantPropertyType
 
 
 @dataclass
@@ -8,16 +14,19 @@ class FeatConfig:
 
 
 namespace = "installable_plugin"
+dynamic = False
 
 
-def get_all_configs() -> list[FeatConfig]:
+def get_all_configs(known_properties: frozenset[VariantPropertyType] | None) -> list[FeatConfig]:
+    assert known_properties is None
     return [
         FeatConfig("feat1", ["val1a", "val1b", "val1c"]),
         FeatConfig("feat2", ["val2a", "val2b"]),
     ]
 
 
-def get_supported_configs() -> list[FeatConfig]:
+def get_supported_configs(known_properties: frozenset[VariantPropertyType] | None) -> list[FeatConfig]:
+    assert known_properties is None
     return [
         FeatConfig("feat1", ["val1c", "val1b"]),
     ]

tests/artifacts/test-plugin-package/test_plugin_package.py

@@ -5,14 +5,22 @@
 
 if TYPE_CHECKING:
     from variantlib.protocols import VariantFeatureConfigType
+    from variantlib.protocols import VariantPropertyType
 
 
 namespace = "module_namespace"
+dynamic = False
 
 
-def get_all_configs() -> list[VariantFeatureConfigType]:
+def get_all_configs(
+    known_properties: frozenset[VariantPropertyType] | None,
+) -> list[VariantFeatureConfigType]:
+    assert known_properties is None
     return [Namespace(name="feature", values=["a", "b"])]
 
 
-def get_supported_configs() -> list[VariantFeatureConfigType]:
+def get_supported_configs(
+    known_properties: frozenset[VariantPropertyType] | None,
+) -> list[VariantFeatureConfigType]:
+    assert known_properties is None
     return []

tests/mocked_plugin_as_module.py

@@ -18,21 +18,28 @@ class MockedEntryPoint:
 
 class MockedPluginA(PluginType):
     namespace = "test_namespace"
+    dynamic = False
 
-    def get_all_configs(self) -> list[VariantFeatureConfigType]:
+    def get_all_configs(
+        self, known_properties: frozenset[VariantPropertyType] | None
+    ) -> list[VariantFeatureConfigType]:
+        assert known_properties is None
         return [
             VariantFeatureConfig("name1", ["val1a", "val1b", "val1c", "val1d"]),
             VariantFeatureConfig("name2", ["val2a", "val2b", "val2c"]),
         ]
 
-    def get_supported_configs(self) -> list[VariantFeatureConfigType]:
+    def get_supported_configs(
+        self, known_properties: frozenset[VariantPropertyType] | None
+    ) -> list[VariantFeatureConfigType]:
+        assert known_properties is None
         return [
             VariantFeatureConfig("name1", ["val1a", "val1b"]),
             VariantFeatureConfig("name2", ["val2a", "val2b", "val2c"]),
         ]
 
     def get_build_setup(
-        self, properties: list[VariantPropertyType]
+        self, properties: frozenset[VariantPropertyType]
     ) -> dict[str, list[str]]:
         for prop in properties:
             assert prop.namespace == self.namespace
@@ -52,15 +59,36 @@ def get_build_setup(
 # to test that we don't rely on that inheritance
 class MockedPluginB:
     namespace = "second_namespace"
-
-    def get_all_configs(self) -> list[MyVariantFeatureConfig]:
+    dynamic = True
+
+    def get_all_configs(
+        self, known_properties: frozenset[VariantPropertyType] | None
+    ) -> list[MyVariantFeatureConfig]:
+        assert known_properties is not None
+        assert all(prop.namespace == self.namespace for prop in known_properties)
+        vals3 = ["val3a", "val3b", "val3c"]
+        vals3.extend(
+            x.value
+            for x in known_properties
+            if x.feature == "name3" and x.value not in vals3
+        )
         return [
-            MyVariantFeatureConfig("name3", ["val3a", "val3b", "val3c"]),
+            MyVariantFeatureConfig("name3", vals3),
         ]
 
-    def get_supported_configs(self) -> list[MyVariantFeatureConfig]:
+    def get_supported_configs(
+        self, known_properties: frozenset[VariantPropertyType] | None
+    ) -> list[MyVariantFeatureConfig]:
+        assert known_properties is not None
+        assert all(prop.namespace == self.namespace for prop in known_properties)
+        vals3 = ["val3a"]
+        vals3.extend(
+            x.value
+            for x in known_properties
+            if x.feature == "name3" and x.value not in vals3
+        )
         return [
-            MyVariantFeatureConfig("name3", ["val3a"]),
+            MyVariantFeatureConfig("name3", vals3),
         ]
 
 
@@ -75,20 +103,27 @@ def __init__(self, name: str) -> None:
 
 class MockedPluginC(PluginType):
     namespace = "incompatible_namespace"
+    dynamic = False
 
-    def get_all_configs(self) -> list[VariantFeatureConfigType]:
+    def get_all_configs(
+        self, known_properties: frozenset[VariantPropertyType] | None
+    ) -> list[VariantFeatureConfigType]:
+        assert known_properties is None
         return [
             MyFlag("flag1"),
             MyFlag("flag2"),
             MyFlag("flag3"),
             MyFlag("flag4"),
         ]
 
-    def get_supported_configs(self) -> list[VariantFeatureConfigType]:
+    def get_supported_configs(
+        self, known_properties: frozenset[VariantPropertyType] | None
+    ) -> list[VariantFeatureConfigType]:
+        assert known_properties is None
         return []
 
     def get_build_setup(
-        self, properties: list[VariantPropertyType]
+        self, properties: frozenset[VariantPropertyType]
     ) -> dict[str, list[str]]:
         flag_opts = []
 

tests/mocked_plugins.py

@@ -116,7 +116,7 @@ def test_failing_regex_name() -> None:
     with pytest.raises(ValidationError, match="must match regex"):
         _ = VariantFeatureConfig(name="", values=["7", "4", "8", "12"])
 
-    for c in "@#$%&*^()[]?.!-{}[]\\/ ":
+    for c in "@#$%&*^()[]?.!-{}[]\\/ \t":
         with pytest.raises(ValidationError, match="must match regex"):
             _ = VariantFeatureConfig(name=f"name{c}value", values=["7", "4", "8", "12"])
 
@@ -125,7 +125,7 @@ def test_failing_regex_value() -> None:
     with pytest.raises(ValidationError, match="must match regex"):
         _ = VariantFeatureConfig(name="name", values=[""])
 
-    for c in "@#$%&*^()[]?!-{}[]\\/ ":
+    for c in "@#$%&*^()[]?-{}[]\\/ \t":
         with pytest.raises(ValidationError, match="must match regex"):
             _ = VariantFeatureConfig(name="name", values=[f"val{c}ue"])
 

tests/models/test_provider.py

@@ -4,6 +4,7 @@
 import sys
 from functools import partial
 from pathlib import Path
+from typing import TYPE_CHECKING
 from typing import Callable
 
 import pytest
@@ -33,6 +34,9 @@
 from variantlib.pyproject_toml import VariantPyProjectToml
 from variantlib.variants_json import VariantsJson
 
+if TYPE_CHECKING:
+    from variantlib.protocols import VariantPropertyType
+
 if sys.version_info >= (3, 11):
     import tomllib
 else:
@@ -44,25 +48,35 @@
 
 class ClashingPlugin(PluginType):
     namespace = "test_namespace"
+    dynamic = False
 
-    def get_all_configs(self) -> list[VariantFeatureConfigType]:
+    def get_all_configs(
+        self, known_properties: frozenset[VariantPropertyType] | None
+    ) -> list[VariantFeatureConfigType]:
         return [
             VariantFeatureConfig("name1", ["val1a", "val1b", "val1c", "val1d"]),
         ]
 
-    def get_supported_configs(self) -> list[VariantFeatureConfigType]:
+    def get_supported_configs(
+        self, known_properties: frozenset[VariantPropertyType] | None
+    ) -> list[VariantFeatureConfigType]:
         return []
 
 
 class ExceptionPluginBase(PluginType):
     namespace = "exception_test"
+    dynamic = False
 
     returned_value: list[VariantFeatureConfigType]
 
-    def get_all_configs(self) -> list[VariantFeatureConfigType]:
+    def get_all_configs(
+        self, known_properties: frozenset[VariantPropertyType] | None
+    ) -> list[VariantFeatureConfigType]:
         return self.returned_value
 
-    def get_supported_configs(self) -> list[VariantFeatureConfigType]:
+    def get_supported_configs(
+        self, known_properties: frozenset[VariantPropertyType] | None
+    ) -> list[VariantFeatureConfigType]:
         return self.returned_value
 
 
@@ -115,6 +129,65 @@ def test_get_supported_configs(
     }
 
 
+def test_get_all_configs_dynamic(
+    mocked_plugin_loader: BasePluginLoader,
+) -> None:
+    assert mocked_plugin_loader.get_all_configs(
+        [
+            VariantProperty("test_namespace", "name1", "val1z"),
+            VariantProperty("second_namespace", "name3", "val3bcde"),
+        ]
+    ) == {
+        "incompatible_namespace": ProviderConfig(
+            namespace="incompatible_namespace",
+            configs=[
+                VariantFeatureConfig("flag1", ["on"]),
+                VariantFeatureConfig("flag2", ["on"]),
+                VariantFeatureConfig("flag3", ["on"]),
+                VariantFeatureConfig("flag4", ["on"]),
+            ],
+        ),
+        "second_namespace": ProviderConfig(
+            namespace="second_namespace",
+            configs=[
+                VariantFeatureConfig("name3", ["val3a", "val3b", "val3c", "val3bcde"]),
+            ],
+        ),
+        "test_namespace": ProviderConfig(
+            namespace="test_namespace",
+            configs=[
+                VariantFeatureConfig("name1", ["val1a", "val1b", "val1c", "val1d"]),
+                VariantFeatureConfig("name2", ["val2a", "val2b", "val2c"]),
+            ],
+        ),
+    }
+
+
+def test_get_supported_configs_dynamic(
+    mocked_plugin_loader: BasePluginLoader,
+) -> None:
+    assert mocked_plugin_loader.get_supported_configs(
+        [
+            VariantProperty("test_namespace", "name1", "val1z"),
+            VariantProperty("second_namespace", "name3", "val3abcd"),
+        ]
+    ) == {
+        "second_namespace": ProviderConfig(
+            namespace="second_namespace",
+            configs=[
+                VariantFeatureConfig("name3", ["val3a", "val3abcd"]),
+            ],
+        ),
+        "test_namespace": ProviderConfig(
+            namespace="test_namespace",
+            configs=[
+                VariantFeatureConfig("name1", ["val1a", "val1b"]),
+                VariantFeatureConfig("name2", ["val2a", "val2b", "val2c"]),
+            ],
+        ),
+    }
+
+
 def test_namespace_clash() -> None:
     with (
         pytest.raises(
@@ -227,8 +300,11 @@ def test_namespace_incorrect_name() -> None:
 
 class IncompletePlugin:
     namespace = "incomplete_plugin"
+    dynamic = False
 
-    def get_supported_configs(self) -> list[VariantFeatureConfigType]:
+    def get_supported_configs(
+        self, known_properties: frozenset[VariantPropertyType] | None
+    ) -> list[VariantFeatureConfigType]:
         return []
 
 
@@ -237,8 +313,8 @@ def test_namespace_incorrect_type() -> None:
         pytest.raises(
             PluginError,
             match=r"'tests.plugins.test_loader:RANDOM_STUFF' does not meet "
-            r"the PluginType prototype: 123 \(missing attributes: get_all_configs, "
-            r"get_supported_configs, namespace\)",
+            r"the PluginType prototype: 123 \(missing attributes: dynamic, "
+            r"get_all_configs, get_supported_configs, namespace\)",
         ),
         ListPluginLoader(["tests.plugins.test_loader:RANDOM_STUFF"]),
     ):
@@ -251,10 +327,14 @@ class RaisingInstantiationPlugin:
     def __init__(self) -> None:
         raise RuntimeError("I failed to initialize")
 
-    def get_all_configs(self) -> list[VariantFeatureConfigType]:
+    def get_all_configs(
+        self, known_properties: frozenset[VariantPropertyType]
+    ) -> list[VariantFeatureConfigType]:
         return []
 
-    def get_supported_configs(self) -> list[VariantFeatureConfigType]:
+    def get_supported_configs(
+        self, known_properties: frozenset[VariantPropertyType]
+    ) -> list[VariantFeatureConfigType]:
         return []
 
 
@@ -273,14 +353,19 @@ def test_namespace_instantiation_raises() -> None:
 
 class CrossTypeInstantiationPlugin:
     namespace = "cross_plugin"
+    dynamic = False
 
     def __new__(cls) -> IncompletePlugin:  # type: ignore[misc]
         return IncompletePlugin()
 
-    def get_all_configs(self) -> list[VariantFeatureConfigType]:
+    def get_all_configs(
+        self, known_properties: frozenset[VariantPropertyType] | None
+    ) -> list[VariantFeatureConfigType]:
         return []
 
-    def get_supported_configs(self) -> list[VariantFeatureConfigType]:
+    def get_supported_configs(
+        self, known_properties: frozenset[VariantPropertyType] | None
+    ) -> list[VariantFeatureConfigType]:
         return []
 
 
@@ -314,9 +399,13 @@ def test_get_build_setup(
         ]
     )
 
-    assert mocked_plugin_loader.get_build_setup(variant_desc) == {
-        "cflags": ["-mflag1", "-mflag4", "-march=val1b"],
-        "cxxflags": ["-mflag1", "-mflag4", "-march=val1b"],
+    # flag order may depend on (random) property ordering
+    assert {
+        k: sorted(v)
+        for k, v in mocked_plugin_loader.get_build_setup(variant_desc).items()
+    } == {
+        "cflags": ["-march=val1b", "-mflag1", "-mflag4"],
+        "cxxflags": ["-march=val1b", "-mflag1", "-mflag4"],
         "ldflags": ["-Wl,--test-flag"],
     }