pydantic: use pydantic to check "type"

canonical · Jul 7, 2023 · f2e098a · f2e098a
1 parent d4197d1
commit f2e098a
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 11 deletions.
diff --git a/charmcraft/models/charmcraft.py b/charmcraft/models/charmcraft.py
@@ -18,7 +18,7 @@
 import datetime
 import pathlib
 import os
-from typing import Optional, List, Dict, Any, Union
+from typing import Optional, List, Dict, Any, Union, Literal
 
 import pydantic
 
@@ -116,7 +116,7 @@ class CharmcraftConfig(
 
     metadata_legacy: bool = False
 
-    type: str
+    type: Literal["bundle", "charm"]
     name: Optional[pydantic.StrictStr]
     summary: Optional[pydantic.StrictStr]
     description: Optional[pydantic.StrictStr]
@@ -140,13 +140,6 @@ class CharmcraftConfig(
     links: Optional[Links]
     config: Optional[JujuConfig]
 
-    @pydantic.validator("type")
-    def validate_charm_type(cls, charm_type):
-        """Verify charm type is valid with exception when instantiated without YAML."""
-        if charm_type not in ["bundle", "charm"]:
-            raise ValueError("must be either 'charm' or 'bundle'")
-        return charm_type
-
     @pydantic.validator("name", pre=True, always=True)
     def validate_name(cls, name, values):
         """Verify charm name is valid with exception when instantiated without YAML."""

diff --git a/tests/test_config.py b/tests/test_config.py
@@ -451,7 +451,7 @@ def test_schema_type_bad_type(
     assert str(cm.value) == dedent(
         """\
         Bad charmcraft.yaml content:
-        - must be either 'charm' or 'bundle' in field 'type'"""
+        - unexpected value; permitted: 'bundle', 'charm' in field 'type'"""
     )
 
 
@@ -497,7 +497,7 @@ def test_schema_type_limited_values(
     assert str(cm.value) == dedent(
         """\
         Bad charmcraft.yaml content:
-        - must be either 'charm' or 'bundle' in field 'type'"""
+        - unexpected value; permitted: 'bundle', 'charm' in field 'type'"""
     )