Add a variantlib plugin validate-variant command

Author: mgorny

pyproject.toml

@@ -77,6 +77,7 @@ show = "variantlib.commands.config.show:show"
 [project.entry-points."variantlib.actions.plugins"]
 list = "variantlib.commands.plugins.list_plugins:list_plugins"
 get-supported-configs = "variantlib.commands.plugins.get_supported_configs:get_supported_configs"
+validate-property = "variantlib.commands.plugins.validate_property:validate_property"
 
 [tool.pytest.ini_options]
 testpaths = ["tests/"]

tests/commands/test_plugins.py

@@ -66,3 +66,33 @@ def test_plugins_get_supported_configs_filter_feature(
 test_namespace :: name1 :: val1b
 """
     )
+
+
+def test_plugins_validate_property(
+    capsys: pytest.CaptureFixture[str], mocked_entry_points: None
+) -> None:
+    main(
+        [
+            "plugins",
+            "validate-property",
+            "test_namespace :: name1 :: val1a",
+            "test_namespace :: name1::val1b",
+            "test_namespace :: name2 :: val2a",
+            "second_namespace:: name1:: val1a",
+            "second_namespace::name3 :: val3a",
+            "test_namespace  ::  name3    :: val3a",
+            "unknown_namespace::foo::bar",
+        ]
+    )
+    assert (
+        capsys.readouterr().out
+        == """\
+test_namespace :: name1 :: val1a : valid
+test_namespace :: name1 :: val1b : valid
+test_namespace :: name2 :: val2a : valid
+second_namespace :: name1 :: val1a : invalid
+second_namespace :: name3 :: val3a : valid
+test_namespace :: name3 :: val3a : invalid
+unknown_namespace :: foo :: bar : no-plugin
+"""
+    )

variantlib/commands/plugins/validate_property.py

@@ -0,0 +1,41 @@
+from __future__ import annotations
+
+import argparse
+import logging
+import sys
+from typing import TYPE_CHECKING
+
+from variantlib import __package_name__
+from variantlib.models.variant import VariantProperty
+
+if TYPE_CHECKING:
+    from variantlib.plugins.loader import BasePluginLoader
+
+
+logger = logging.getLogger(__name__)
+
+res_map = {
+    False: "invalid",
+    True: "valid",
+    None: "no-plugin",
+}
+
+
+def validate_property(args: list[str], plugin_loader: BasePluginLoader) -> None:
+    parser = argparse.ArgumentParser(
+        prog=f"{__package_name__} plugins validate-property",
+        description="CLI interface to validate properties",
+    )
+    parser.add_argument(
+        "property",
+        nargs="+",
+        type=VariantProperty.from_str,
+        help="One or more properties to validate",
+    )
+
+    parsed_args = parser.parse_args(args)
+    validation_result = plugin_loader.validate_properties(parsed_args.property)
+    for vprop in parsed_args.property:
+        sys.stdout.write(
+            f"{vprop.to_str()} : {res_map[validation_result.results[vprop]]}\n"
+        )