Add AnyHttpUrl validator for jenkins's server_url config field

jenkins_agent_k8s_rock/rockcraft.yaml

@@ -20,7 +20,7 @@ parts:
       - default-jre-headless
       - git
     override-prime: |
-      craftctl default  
+      craftctl default
       /bin/bash -c "mkdir -p --mode=775 var/{lib/jenkins,lib/jenkins/agents,log/jenkins}"
       /bin/bash -c "chown -R 584792 var/{lib/jenkins,lib/jenkins/agents,log/jenkins}"
   entrypoint:

pyproject.toml

@@ -54,6 +54,7 @@ copyright-regexp = "Copyright\\s\\d{4}([-,]\\d{4})*\\s+%(author)s"
 ignore_missing_imports = true
 check_untyped_defs = true
 disallow_untyped_defs = true
+plugins = ["pydantic.mypy"]
 
 [[tool.mypy.overrides]]
 module = "tests.*"

src/state.py

@@ -9,7 +9,7 @@
 from dataclasses import dataclass
 
 import ops
-from pydantic import BaseModel, Field, ValidationError
+from pydantic import AnyHttpUrl, BaseModel, Field, ValidationError, tools
 
 import metadata
 import server
@@ -42,13 +42,20 @@ class JenkinsConfig(BaseModel):
     """The Jenkins config from juju config values.
 
     Attrs:
-        server_url: The Jenkins server url.
+        server_url_not_validated: The Jenkins server url, to be validated with pydantic.
+        server_url: The Jenkins server url, to be used by the charm.
         agent_name_token_pairs: Jenkins agent names paired with corresponding token value.
     """
 
-    server_url: str = Field(..., min_length=1)
+    server_url_not_validated: AnyHttpUrl
+
     agent_name_token_pairs: typing.List[typing.Tuple[str, str]] = Field(..., min_items=1)
 
+    @property
+    def server_url(self) -> str:
+        """Convert validated server_url to string."""
+        return str(self.server_url_not_validated)
+
     @classmethod
     def from_charm_config(cls, config: ops.ConfigData) -> typing.Optional["JenkinsConfig"]:
         """Instantiate JenkinsConfig from charm config.
@@ -69,7 +76,10 @@ def from_charm_config(cls, config: ops.ConfigData) -> typing.Optional["JenkinsCo
         agent_names = agent_name_config.split(":") if agent_name_config else []
         agent_tokens = agent_token_config.split(":") if agent_token_config else []
         agent_name_token_pairs = list(zip(agent_names, agent_tokens))
-        return cls(server_url=server_url or "", agent_name_token_pairs=agent_name_token_pairs)
+        return cls(
+            server_url_not_validated=tools.parse_obj_as(AnyHttpUrl, server_url) or "",
+            agent_name_token_pairs=agent_name_token_pairs,
+        )
 
 
 def _get_jenkins_unit(

tests/unit/conftest.py

@@ -30,7 +30,7 @@ def harness_fixture():
 def config_fixture():
     """The Jenkins testing configuration values."""
     return {
-        "jenkins_url": "http://testingurl",
+        "jenkins_url": "http://testingurl.com",
         "jenkins_agent_name": "testing_agent_name",
         "jenkins_agent_token": secrets.token_hex(16),
     }

tests/unit/test_state.py

@@ -71,7 +71,25 @@ def test_from_charm_invalid_charm_config(harness: ops.testing.Harness):
         state.State.from_charm(charm=harness.charm)
 
 
-def test_from_charm_vailid_config(harness: ops.testing.Harness, config: typing.Dict[str, str]):
+def test_from_charm_invalid_server_url(
+    harness: ops.testing.Harness, config: typing.Dict[str, str]
+):
+    """
+    arrange: given charm configuration data with invalid server_url attribute
+    act: when the state is initialized from_charm.
+    assert: InvalidStateError is raised. (due to pydantic's AnyHttpUrl validator)
+    """
+    invalid_config = config
+    # This configuration is invalid because schema (http or https) must be specified
+    invalid_config["jenkins_url"] = "example.com"
+    harness.update_config(invalid_config)
+    harness.begin()
+
+    with pytest.raises(state.InvalidStateError):
+        state.State.from_charm(charm=harness.charm)
+
+
+def test_from_charm_valid_config(harness: ops.testing.Harness, config: typing.Dict[str, str]):
     """
     arrange: given valid charm configuration data.
     act: when the state is initialized from_charm.