ec2 settings

Author: pcrespov

packages/settings-library/src/settings_library/docker_registry.py

@@ -35,13 +35,16 @@ class RegistrySettings(BaseCustomSettings):
     ]
 
     REGISTRY_USER: Annotated[
-        str, Field(description="username to access the docker registry")
+        str,
+        Field(description="username to access the docker registry"),
     ]
     REGISTRY_PW: Annotated[
-        SecretStr, Field(description="password to access the docker registry")
+        SecretStr,
+        Field(description="password to access the docker registry"),
     ]
     REGISTRY_SSL: Annotated[
-        bool, Field(description="True if docker registry is using HTTPS protocol")
+        bool,
+        Field(description="True if docker registry is using HTTPS protocol"),
     ]
 
     @field_validator("REGISTRY_PATH", mode="before")

packages/settings-library/src/settings_library/ec2.py

@@ -8,11 +8,19 @@
 ANY_HTTP_URL_ADAPTER: TypeAdapter = TypeAdapter(AnyHttpUrl)
 
 
+def _validate_url(value: str | None) -> str | None:
+    if value is not None:
+        return str(ANY_HTTP_URL_ADAPTER.validate_python(value))
+    return value
+
+
 class EC2Settings(BaseCustomSettings):
     EC2_ACCESS_KEY_ID: str
     EC2_ENDPOINT: Annotated[
-        str, BeforeValidator(lambda x: str(ANY_HTTP_URL_ADAPTER.validate_python(x)))
-    ] | None = Field(default=None, description="do not define if using standard AWS")
+        str | None,
+        BeforeValidator(_validate_url),
+        Field(description="do not define if using standard AWS"),
+    ] = None
     EC2_REGION_NAME: str = "us-east-1"
     EC2_SECRET_ACCESS_KEY: str
 

packages/settings-library/tests/test_ec2.py

@@ -0,0 +1,63 @@
+# pylint: disable=redefined-outer-name
+# pylint: disable=unused-argument
+# pylint: disable=unused-variable
+# pylint: disable=too-many-arguments
+
+
+import pytest
+from pydantic import ValidationError
+from pytest_simcore.helpers.monkeypatch_envs import setenvs_from_dict
+from settings_library.ec2 import EC2Settings
+
+
+def test_ec2_endpoint_defaults_to_null(monkeypatch: pytest.MonkeyPatch):
+    setenvs_from_dict(
+        monkeypatch,
+        {
+            "EC2_ACCESS_KEY_ID": "my_access_key_id",
+            "EC2_REGION_NAME": "us-east-1",
+            "EC2_SECRET_ACCESS_KEY": "my_secret_access_key",
+        },
+    )
+
+    settings = EC2Settings.create_from_envs()
+    assert settings.EC2_ENDPOINT is None
+
+
+def test_ec2_endpoint_is_nullified(monkeypatch: pytest.MonkeyPatch):
+    setenvs_from_dict(
+        monkeypatch,
+        {
+            "EC2_ACCESS_KEY_ID": "my_access_key_id",
+            "EC2_ENDPOINT": "null",
+            "EC2_REGION_NAME": "us-east-1",
+            "EC2_SECRET_ACCESS_KEY": "my_secret_access_key",
+        },
+    )
+
+    settings = EC2Settings.create_from_envs()
+    assert settings.EC2_ENDPOINT is None
+
+
+def test_ec2_endpoint_invalid(monkeypatch: pytest.MonkeyPatch):
+    setenvs_from_dict(
+        monkeypatch,
+        {
+            "EC2_ACCESS_KEY_ID": "my_access_key_id",
+            "EC2_ENDPOINT": "ftp://my_ec2_endpoint.com",
+            "EC2_REGION_NAME": "us-east-1",
+            "EC2_SECRET_ACCESS_KEY": "my_secret_access_key",
+        },
+    )
+
+    with pytest.raises(ValidationError) as err_info:
+        EC2Settings.create_from_envs()
+
+    assert err_info.value.errors()
+    err_info.value.errors()[0]["loc"] == ("EC2_ENDPOINT")
+    err_info.value.errors()[0]["type"] == "url_scheme"
+
+
+def test_ec2_endpoint_description():
+    assert EC2Settings.model_fields["EC2_ACCESS_KEY_ID"].description is None
+    assert EC2Settings.model_fields["EC2_ENDPOINT"].description is not None