plugins: Add a public name property and use it as primary identifier (#14)

* Add a public `name` property to plugin classes

Add a public `name` property to plugin classes, to replace the private
`__name__` property, and use it to identify plugins instead of the entry
point name.  This is the first step towards cleaning up the current
naming confusion.

* Use plugin name rather than entry point to detect duplicates

* Fix loading plugins with no distribution metadata

* Rename name/provider to namespace

* Throw an error if two plugins use the same namespace

Author: mgorny

tests/artifacts/expected.json

@@ -21,15 +21,15 @@
 @pytest.fixture(scope="session")
 def configs():
     config_custom_hw = ProviderConfig(
-        provider="custom_hw",
+        namespace="custom_hw",
         configs=[
             KeyConfig(key="driver_version", values=["1.3", "1.2", "1.1", "1"]),
             KeyConfig(key="hw_architecture", values=["3.4", "3"]),
         ],
     )
 
     config_networking = ProviderConfig(
-        provider="networking",
+        namespace="networking",
         configs=[
             KeyConfig(key="speed", values=["10GBPS", "1GBPS", "100MBPS"]),
         ],
@@ -59,7 +59,7 @@ def desc_to_json(desc_list: list[VariantDescription]) -> Generator:
     for desc in shuffled_desc_list:
         variant_dict = {}
         for variant_meta in desc:
-            provider_dict = variant_dict.setdefault(variant_meta.provider, {})
+            provider_dict = variant_dict.setdefault(variant_meta.namespace, {})
             provider_dict[variant_meta.key] = variant_meta.value
         yield (desc.hexdigest, variant_dict)
 
@@ -75,24 +75,24 @@ def test_filtered_sorted_variants_roundtrip(configs):
 @example(
     [
         ProviderConfig(
-            provider="A",
+            namespace="A",
             configs=[
                 KeyConfig(key="A1", values=["x"]),
                 KeyConfig(key="A2", values=["x"]),
             ],
         ),
-        ProviderConfig(provider="B", configs=[KeyConfig(key="B1", values=["x"])]),
-        ProviderConfig(provider="C", configs=[KeyConfig(key="C1", values=["x"])]),
+        ProviderConfig(namespace="B", configs=[KeyConfig(key="B1", values=["x"])]),
+        ProviderConfig(namespace="C", configs=[KeyConfig(key="C1", values=["x"])]),
     ]
 )
 @given(
     st.lists(
         min_size=1,
         max_size=3,
-        unique_by=lambda provider_cfg: provider_cfg.provider,
+        unique_by=lambda provider_cfg: provider_cfg.namespace,
         elements=st.builds(
             ProviderConfig,
-            provider=st.text(
+            namespace=st.text(
                 string.ascii_letters + string.digits + "_", min_size=1, max_size=64
             ),
             configs=st.lists(

tests/test_combinations.py

@@ -16,10 +16,10 @@ def test_provider_config_creation_valid():
     key_config_1 = KeyConfig(key="attr_nameA", values=["7", "4", "8", "12"])
     key_config_2 = KeyConfig(key="attr_nameB", values=["3", "7", "2", "18", "22"])
     provider_config = ProviderConfig(
-        provider="provider_name", configs=[key_config_1, key_config_2]
+        namespace="provider_name", configs=[key_config_1, key_config_2]
     )
 
-    assert provider_config.provider == "provider_name"
+    assert provider_config.namespace == "provider_name"
     assert len(provider_config.configs) == 2
     assert provider_config.configs[0].key == "attr_nameA"
     assert provider_config.configs[1].key == "attr_nameB"
@@ -33,7 +33,7 @@ def test_duplicate_key_config():
     with pytest.raises(
         ValueError, match="Duplicate `KeyConfig` for key='attr_nameA' found."
     ):
-        ProviderConfig(provider="provider_name", configs=[key_config_1, key_config_2])
+        ProviderConfig(namespace="provider_name", configs=[key_config_1, key_config_2])
 
 
 def test_empty_values_list_in_key_config():
@@ -69,34 +69,34 @@ def test_invalid_values_type_in_key_config():
         )  # Expecting a list for `values`
 
 
-def test_provider_config_invalid_provider_type():
-    """Test that an invalid provider type raises a validation error."""
+def test_provider_config_invalid_namespace_type():
+    """Test that an invalid namespace type raises a validation error."""
     with pytest.raises(TypeError):
         ProviderConfig(
-            provider=1,
+            namespace=1,
             configs=[KeyConfig(key="attr_nameA", values=["7", "4", "8", "12"])],
         )
 
 
 def test_provider_config_invalid_configs_type():
     """Test that an invalid configs type raises a validation error."""
     with pytest.raises(TypeError):
-        ProviderConfig(provider="provider_name", configs="not_a_list_of_key_configs")
+        ProviderConfig(namespace="provider_name", configs="not_a_list_of_key_configs")
 
 
 def test_provider_config_invalid_key_type_in_configs():
     """Test that invalid `KeyConfig` inside `ProviderConfig` raises an error."""
     with pytest.raises(TypeError):
         ProviderConfig(
-            provider="provider_name",
+            namespace="provider_name",
             configs=[{"key": "attr_nameA", "values": ["7", "4", "8", "12"]}],
         )
 
 
 def test_empty_provider_config():
     """Test creation of ProviderConfig with an empty list of KeyConfigs."""
     with pytest.raises(AssertionError):
-        _ = ProviderConfig(provider="provider_name", configs=[])
+        _ = ProviderConfig(namespace="provider_name", configs=[])
 
 
 def test_provider_config_invalid_key_config_type():
@@ -105,7 +105,7 @@ def test_provider_config_invalid_key_config_type():
 
     with pytest.raises(TypeError):
         ProviderConfig(
-            provider="provider_name",
+            namespace="provider_name",
             configs=[
                 KeyConfig(key="attr_nameA", values=["7", "4", "8", "12"]),
                 SimpleNamespace(key=1, values=["1", "2"]),
@@ -130,11 +130,11 @@ def test_provider_config_repr():
     key_config_1 = KeyConfig(key="attr_nameA", values=["7", "4", "8", "12"])
     key_config_2 = KeyConfig(key="attr_nameB", values=["3", "7", "2", "18", "22"])
     provider_config = ProviderConfig(
-        provider="provider_name", configs=[key_config_1, key_config_2]
+        namespace="provider_name", configs=[key_config_1, key_config_2]
     )
 
     expected_repr = (
-        "ProviderConfig(provider='provider_name', "
+        "ProviderConfig(namespace='provider_name', "
         "configs=[KeyConfig(key='attr_nameA', values=['7', '4', '8', '12']), "
         "KeyConfig(key='attr_nameB', values=['3', '7', '2', '18', '22'])])"
     )