🐛 Fixed email sending (ITISFoundation#2875)

* fix broken email sending

* adding tests and validators

* removing not necessary annotations

* fixed broken tests

Co-authored-by: Andrei Neagu <[email protected]>

Author: GitHK

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

@@ -1,6 +1,6 @@
 # Units
 
-GB = 1024 ** 3
+GB = 1024**3
 
 # Formatting
 HEADER_STR = "{:-^50}"

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

@@ -1,4 +1,5 @@
 from typing import Optional
+from pydantic import root_validator
 
 from pydantic.fields import Field
 from pydantic.types import SecretStr
@@ -18,3 +19,29 @@ class SMTPSettings(BaseCustomSettings):
     SMTP_TLS_ENABLED: bool = Field(False, description="Enables Secure Mode")
     SMTP_USERNAME: Optional[str]
     SMTP_PASSWORD: Optional[SecretStr]
+
+    @root_validator
+    @classmethod
+    def both_credentials_must_be_set(cls, values):
+        username = values.get("SMTP_USERNAME")
+        password = values.get("SMTP_PASSWORD")
+
+        if username is None and password or username and password is None:
+            raise ValueError(
+                f"Please provide both {username=} and {password=} not just one"
+            )
+
+        return values
+
+    @root_validator
+    @classmethod
+    def enabled_tls_required_authentication(cls, values):
+        tls_enabled = values.get("SMTP_TLS_ENABLED")
+        username = values.get("SMTP_USERNAME")
+        password = values.get("SMTP_PASSWORD")
+
+        if tls_enabled and not (username or password):
+            raise ValueError(
+                "when using SMTP_TLS_ENABLED is True username and password are required"
+            )
+        return values

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

@@ -1,8 +1,8 @@
 from functools import cached_property
-from typing_extensions import TypedDict
 
 from pydantic.networks import AnyUrl
 from pydantic.types import SecretStr
+from typing_extensions import TypedDict
 
 from .base import BaseCustomSettings
 from .basic_types import PortInt

packages/settings-library/tests/test_email.py

@@ -0,0 +1,60 @@
+from typing import Any, Dict
+from pydantic import ValidationError
+
+import pytest
+from settings_library.email import SMTPSettings
+
+
+@pytest.mark.parametrize(
+    "cfg",
+    [
+        {"SMTP_HOST": "test", "SMTP_PORT": 113},
+        {
+            "SMTP_HOST": "test",
+            "SMTP_PORT": 113,
+            "SMTP_USERNAME": "test",
+            "SMTP_PASSWORD": "test",
+        },
+        {
+            "SMTP_HOST": "test",
+            "SMTP_PORT": 113,
+            "SMTP_USERNAME": "test",
+            "SMTP_PASSWORD": "test",
+            "SMTP_TLS_ENABLED": False,
+        },
+        {
+            "SMTP_HOST": "test",
+            "SMTP_PORT": 113,
+            "SMTP_USERNAME": "test",
+            "SMTP_PASSWORD": "test",
+            "SMTP_TLS_ENABLED": True,
+        },
+    ],
+)
+def test_smtp_configuration_ok(cfg: Dict[str, Any]):
+    assert SMTPSettings.parse_obj(cfg)
+
+
+@pytest.mark.parametrize(
+    "cfg",
+    [
+        {"SMTP_HOST": "test", "SMTP_PORT": 113, "SMTP_USERNAME": "test"},
+        {"SMTP_HOST": "test", "SMTP_PORT": 113, "SMTP_PASSWORD": "test"},
+        {"SMTP_HOST": "test", "SMTP_PORT": 113, "SMTP_TLS_ENABLED": True},
+        {
+            "SMTP_HOST": "test",
+            "SMTP_PORT": 113,
+            "SMTP_TLS_ENABLED": True,
+            "SMTP_PASSWORD": "test",
+        },
+        {
+            "SMTP_HOST": "test",
+            "SMTP_PORT": 113,
+            "SMTP_TLS_ENABLED": True,
+            "SMTP_USERNAME": "test",
+        },
+    ],
+)
+def test_smtp_configuration_fails(cfg: Dict[str, Any]):
+    with pytest.raises(ValidationError):
+        assert SMTPSettings.parse_obj(cfg)

services/web/server/src/simcore_service_webserver/login/utils.py

@@ -136,14 +136,16 @@ async def send_mail(app: web.Application, msg: MIMEText):
         if cfg.SMTP_TLS_ENABLED:
             log.info("Starting TLS ...")
             await smtp.starttls(validate_certs=False)
-        if cfg.SMTP_USERNAME:
+        if cfg.SMTP_USERNAME and cfg.SMTP_PASSWORD:
             log.info("Login email server ...")
-            await smtp.login(cfg.SMTP_USERNAME, cfg.SMTP_PASSWORD)
+            await smtp.login(cfg.SMTP_USERNAME, cfg.SMTP_PASSWORD.get_secret_value())
         await smtp.send_message(msg)
         await smtp.quit()
     else:
         async with aiosmtplib.SMTP(**smtp_args) as smtp:
-            if cfg.SMTP_USERNAME:
+            if cfg.SMTP_USERNAME and cfg.SMTP_PASSWORD:
                 log.info("Login email server ...")
-                await smtp.login(cfg.SMTP_USERNAME, cfg.SMTP_PASSWORD)
+                await smtp.login(
+                    cfg.SMTP_USERNAME, cfg.SMTP_PASSWORD.get_secret_value()
+                )
             await smtp.send_message(msg)

services/web/server/tests/data/default_app_config-unit.yaml

@@ -87,7 +87,7 @@ smtp:
   host: mail.foo.com
   port: 25
   tls: false
-  username: None,
+  username: None
   password: None
 socketio:
   enabled: true