Merge branch 'tg-964-email-service' into 'enterprise'

feat(notifications): Adding basic email sending functionality

See merge request dkinternal/testgen/dataops-testgen!341

Author: ci bot

pyproject.toml

@@ -60,6 +60,7 @@ dependencies = [
     "streamlit-pydantic==0.6.0",
     "cron-converter==1.2.1",
     "cron-descriptor==2.0.5",
+    "pybars3==0.9.7",
 
     # Pinned to match the manually compiled libs or for security
     "pyarrow==18.1.0",

testgen/common/email.py

@@ -0,0 +1,90 @@
+import logging
+import smtplib
+import ssl
+from collections.abc import Mapping
+from email.mime.multipart import MIMEMultipart
+from email.mime.text import MIMEText
+
+from pybars import Compiler
+
+from testgen import settings
+
+LOG = logging.getLogger(__name__)
+
+MANDATORY_SETTINGS = (
+    "EMAIL_FROM_ADDRESS",
+    "SMTP_ENDPOINT",
+    "SMTP_PORT",
+    "SMTP_USERNAME",
+    "SMTP_PASSWORD",
+)
+
+
+class EmailTemplateException(Exception):
+    pass
+
+
+class BaseEmailTemplate:
+
+    def __init__(self):
+        compiler = Compiler()
+        self.compiled_subject = compiler.compile(self.get_subject_template())
+        self.compiled_body = compiler.compile(self.get_body_template())
+
+    def validate_settings(self):
+        missing_settings = [
+            f"TG_{setting_name}"
+            for setting_name in MANDATORY_SETTINGS
+            if getattr(settings, setting_name) is None
+        ]
+
+        if missing_settings:
+            LOG.error(
+                "Template '%s' can not send emails because the following settings are missing: %s",
+                self.__class__.__name__,
+                ", ".join(missing_settings),
+            )
+
+            raise EmailTemplateException("Invalid or insufficient email/SMTP settings")
+
+    def get_subject_template(self) -> str:
+        raise NotImplementedError
+
+    def get_body_template(self) -> str:
+        raise NotImplementedError
+
+    def get_message(self, recipients: list[str], context: Mapping | None) -> MIMEMultipart:
+        subject = self.compiled_subject(context)
+        body = self.compiled_body(context)
+
+        message = MIMEMultipart("alternative")
+        message["Subject"] = subject
+        message["To"] = ", ".join(recipients)
+        message["From"] = settings.EMAIL_FROM_ADDRESS
+        message.attach(MIMEText(body, "html"))
+        return message
+
+    def send_mime_message(self, recipients: list[str], message: MIMEMultipart) -> dict:
+        ssl_context = ssl.SSLContext(ssl.PROTOCOL_SSLv23)
+        try:
+            with smtplib.SMTP_SSL(settings.SMTP_ENDPOINT, settings.SMTP_PORT, context=ssl_context) as smtp_server:
+                smtp_server.login(settings.SMTP_USERNAME, settings.SMTP_PASSWORD)
+                response = smtp_server.sendmail(settings.EMAIL_FROM_ADDRESS, recipients, message.as_string())
+        except Exception as e:
+            LOG.error("Template '%s' failed to send email with: %s", self.__class__.__name__, e)  # noqa: TRY400
+        else:
+            return response
+
+    def send(self, recipients: list[str], context: Mapping | None) -> dict:
+        self.validate_settings()
+        mime_message = self.get_message(recipients, context)
+        response = self.send_mime_message(recipients, mime_message)
+
+        LOG.info(
+            "Template '%s' successfully sent email to %d recipients -- %d failed.",
+            self.__class__.__name__,
+            len(recipients) - len(response),
+            len(response)
+        )
+
+        return response

testgen/settings.py

@@ -374,7 +374,7 @@
 
 OBSERVABILITY_VERIFY_SSL: bool = os.getenv("TG_EXPORT_TO_OBSERVABILITY_VERIFY_SSL", "yes").lower() in ["yes", "true"]
 """
-When False, exporting events to your instance of Observabilty will skip
+When False, exporting events to your instance of Observability will skip
 SSL verification.
 
 from env variable: `TG_EXPORT_TO_OBSERVABILITY_VERIFY_SSL`
@@ -383,7 +383,7 @@
 
 OBSERVABILITY_EXPORT_LIMIT: int = int(os.getenv("TG_OBSERVABILITY_EXPORT_MAX_QTY", "5000"))
 """
-When exporting to your instance of Observabilty, the maximum number of
+When exporting to your instance of Observability, the maximum number of
 events that will be sent to the events API on a single export.
 
 from env variable: `TG_OBSERVABILITY_EXPORT_MAX_QTY`
@@ -392,7 +392,7 @@
 
 OBSERVABILITY_DEFAULT_COMPONENT_TYPE: str = os.getenv("OBSERVABILITY_DEFAULT_COMPONENT_TYPE", "dataset")
 """
-When exporting to your instance of Observabilty, the type of event that
+When exporting to your instance of Observability, the type of event that
 will be sent to the events API.
 
 from env variable: `OBSERVABILITY_DEFAULT_COMPONENT_TYPE`
@@ -401,7 +401,7 @@
 
 OBSERVABILITY_DEFAULT_COMPONENT_KEY: str = os.getenv("OBSERVABILITY_DEFAULT_COMPONENT_KEY", "default")
 """
-When exporting to your instance of Observabilty, the key sent to the
+When exporting to your instance of Observability, the key sent to the
 events API to identify the components.
 
 from env variable: `OBSERVABILITY_DEFAULT_COMPONENT_KEY`
@@ -475,3 +475,28 @@
 """
 Limit the number of records used to generate the PDF with test results and hygiene issue reports.
 """
+
+EMAIL_FROM_ADDRESS: str | None = os.getenv("TG_EMAIL_FROM_ADDRESS")
+"""
+Email: Sender address
+"""
+
+SMTP_ENDPOINT: str | None = os.getenv("TG_SMTP_ENDPOINT")
+"""
+Email: SMTP endpoint
+"""
+
+SMTP_PORT: int | None = int(os.getenv("TG_SMTP_PORT", 0)) or None
+"""
+Email: SMTP port
+"""
+
+SMTP_USERNAME: str | None = os.getenv("TG_SMTP_USERNAME")
+"""
+Email: SMTP username
+"""
+
+SMTP_PASSWORD: str | None = os.getenv("TG_SMTP_PASSWORD")
+"""
+Email: SMTP password
+"""

tests/unit/test_common_email.py

@@ -0,0 +1,68 @@
+from unittest.mock import ANY, call, patch
+
+import pytest
+
+from testgen.common.email import BaseEmailTemplate, EmailTemplateException
+
+
+class TestEmailTemplate(BaseEmailTemplate):
+
+    def get_subject_template(self) -> str:
+        return "{{project}}: Test execution finished"
+
+    def get_body_template(self) -> str:
+        return "<html><body><h1>DataKitchen TestGen</h1><p>Hi, {{user}}!</p></body></html>"
+
+
+@pytest.fixture
+def smtp_mock():
+    with patch("testgen.common.email.smtplib.SMTP_SSL") as mock:
+        yield mock
+
+
+@pytest.fixture
+def def_settings():
+    with patch("testgen.common.email.settings") as mock:
+        mock.EMAIL_FROM_ADDRESS = "from@email"
+        mock.SMTP_ENDPOINT = "smtp-endpoint"
+        mock.SMTP_PORT = 333
+        mock.SMTP_USERNAME = "smtp-user"
+        mock.SMTP_PASSWORD = "smtp-pass"  # noqa: S105
+        yield mock
+
+
+@pytest.fixture
+def template(smtp_mock, def_settings):
+    yield TestEmailTemplate()
+
+
+@pytest.fixture
+def send_args():
+    return ["test@data.kitchen"], {"project": "Test Project", "user": "Test user"}
+
+
+def test_send_email(smtp_mock, template, send_args, def_settings):
+    template.send(*send_args)
+
+    smtp_mock.assert_has_calls(
+        [
+            call("smtp-endpoint", 333, context=ANY),
+            call().__enter__().login("smtp-user", "smtp-pass"),
+            call().__enter__().sendmail("from@email", ["test@data.kitchen"], ANY)
+        ],
+        any_order=True,
+    )
+    email_body = smtp_mock().__enter__().sendmail.call_args_list[0][0][2]
+    assert "<h1>DataKitchen TestGen</h1>" in email_body
+    assert "Subject: Test Project: Test execution finished" in email_body
+    assert "<p>Hi, Test user!</p>" in email_body
+
+
+@pytest.mark.parametrize(
+    "missing",
+    ("EMAIL_FROM_ADDRESS", "SMTP_ENDPOINT", "SMTP_PORT", "SMTP_USERNAME", "SMTP_PASSWORD")
+)
+def test_settings_validation(missing, template, def_settings, send_args):
+    setattr(def_settings, missing, None)
+    with pytest.raises(EmailTemplateException, match="Invalid or insufficient email/SMTP settings"):
+        template.send(*send_args)