Add mail check

README.md

@@ -20,6 +20,7 @@ The following health checks are bundled with this project:
 - Celery ping
 - RabbitMQ
 - Migrations
+- Mail
 
 Writing your own custom health checks is also very quick and easy.
 
@@ -74,6 +75,7 @@ Add the `health_check` applications to your `INSTALLED_APPS`:
         'health_check.contrib.s3boto3_storage',     # requires boto3 and S3BotoStorage backend
         'health_check.contrib.rabbitmq',            # requires RabbitMQ broker
         'health_check.contrib.redis',               # requires Redis broker
+        'health_check.contrib.mail',
     ]
 ```
 
@@ -90,6 +92,15 @@ one of these checks, set its value to `None`.
     }
 ```
 
+(Optional) If using the `mail` app, you can configure timeout
+threshold settings; otherwise below defaults are assumed.
+
+```python
+    HEALTH_CHECK = {
+        'MAIL_TIMEOUT': 15,  # seconds
+    }
+```
+
 To use Health Check Subsets, Specify a subset name and associate it with the relevant health check services to utilize Health Check Subsets.
 ```python
     HEALTH_CHECK = {

health_check/contrib/mail/__init__.py

@@ -0,0 +1,4 @@
+import django
+
+if django.VERSION < (3, 2):
+    default_app_config = "health_check.contrib.mail.apps.HealthCheckConfig"

health_check/contrib/mail/apps.py

@@ -0,0 +1,12 @@
+from django.apps import AppConfig
+
+from health_check.plugins import plugin_dir
+
+
+class HealthCheckConfig(AppConfig):
+    name = "health_check.contrib.mail"
+
+    def ready(self):
+        from .backends import MailHealthCheck
+
+        plugin_dir.register(MailHealthCheck)

health_check/contrib/mail/backends.py

@@ -0,0 +1,28 @@
+import logging
+
+from django.core.mail import get_connection
+
+from health_check.backends import BaseHealthCheckBackend
+from health_check.conf import HEALTH_CHECK
+from health_check.exceptions import ServiceUnavailable
+
+logger = logging.getLogger(__name__)
+
+
+class MailHealthCheck(BaseHealthCheckBackend):
+    """Check that mail backend is working."""
+
+    def check_status(self) -> None:
+        """Open and close connection email server."""
+        try:
+            connection = get_connection(fail_silently=False)
+            connection.timeout = HEALTH_CHECK.get("MAIL_TIMEOUT", 15)
+            logger.debug("Trying to open connection to mail backend.")
+            connection.open()
+            connection.close()
+            logger.debug("Connection established. Mail backend is healthy.")
+        except Exception as error:
+            self.add_error(
+                error=ServiceUnavailable(error),
+                cause=error,
+            )

tests/test_mail.py

@@ -0,0 +1,44 @@
+from unittest import mock
+
+from health_check.contrib.mail.backends import MailHealthCheck
+
+
+class TestMailHealthCheck:
+    """Test mail health check."""
+
+    @mock.patch("health_check.contrib.mail.backends.get_connection")
+    def test_mail_conn_ok(self, mocked_backend):
+        """Test everything is OK."""
+
+        # instantiates the class
+        mail_health_checker = MailHealthCheck()
+
+        # invokes the method check_status()
+        mail_health_checker.check_status()
+        assert len(mail_health_checker.errors) == 0, mail_health_checker.errors
+
+        # mock assertions
+        assert mocked_backend.return_value.timeout == 15
+        mocked_backend.return_value.open.assert_called_once()
+        mocked_backend.return_value.close.assert_called_once()
+
+    @mock.patch("health_check.contrib.mail.backends.get_connection")
+    def test_mail_conn_refused(self, mocked_backend):
+        """Test case then connection refused."""
+
+        mocked_backend.return_value.open.side_effect = ConnectionRefusedError(
+            "Refused connection"
+        )
+        # instantiates the class
+        mail_health_checker = MailHealthCheck()
+
+        # invokes the method check_status()
+        mail_health_checker.check_status()
+        assert len(mail_health_checker.errors) == 1, mail_health_checker.errors
+        assert (
+            mail_health_checker.errors[0].message
+            == mocked_backend.return_value.open.side_effect
+        )
+
+        # mock assertions
+        mocked_backend.return_value.open.assert_called_once()

tests/testapp/settings.py

@@ -30,6 +30,7 @@
     "health_check.contrib.migrations",
     "health_check.contrib.celery_ping",
     "health_check.contrib.s3boto_storage",
+    "health_check.contrib.mail",
     "tests",
 )