django-health-check 4.0rc2__tar.gz → 4.0rc3__tar.gz

{django_health_check-4.0rc2 → django_health_check-4.0rc3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: django-health-check
-Version: 4.0rc2
+Version: 4.0rc3
 Summary: Monitor the health of your Django app and its connected services.
 Keywords: django,postgresql
 Author-email: Kristian Ollegaard <kristian@oellegaard.com>, Johannes Maron <johannes@maron.family>

{django_health_check-4.0rc2 → django_health_check-4.0rc3}/health_check/_version.py

@@ -28,7 +28,7 @@ version_tuple: VERSION_TUPLE
 commit_id: COMMIT_ID
 __commit_id__: COMMIT_ID
 
-__version__ = version = '4.0rc2'
-__version_tuple__ = version_tuple = (4, 0, 'rc2')
+__version__ = version = '4.0rc3'
+__version_tuple__ = version_tuple = (4, 0, 'rc3')
 
-__commit_id__ = commit_id = 'gb01cffaff'
+__commit_id__ = commit_id = 'g1e96d3f90'

django_health_check-4.0rc3/health_check/management/commands/health_check.py

@@ -0,0 +1,124 @@
+import os
+import sys
+import urllib.error
+import urllib.request
+
+from django.conf import settings
+from django.core.management.base import BaseCommand
+from django.urls import NoReverseMatch, reverse
+
+
+class Command(BaseCommand):
+    help = "Run health checks and exit 0 if everything went well."
+
+    @property
+    def default_forwarded_host(self):
+        return (
+            settings.ALLOWED_HOSTS[0].strip(".")
+            if settings.ALLOWED_HOSTS and settings.ALLOWED_HOSTS[0] != "*"
+            else None
+        )
+
+    @property
+    def default_addrport(self):
+        return ":".join([os.getenv("HOST", "127.0.0.1"), os.getenv("PORT", "8000")])
+
+    def add_arguments(self, parser):
+        parser.add_argument(
+            "endpoint",
+            type=str,
+            help="URL-pattern name of health check endpoint to test",
+        )
+        parser.add_argument(
+            "addrport",
+            nargs="?",
+            type=str,
+            default=self.default_addrport,
+            help=f"Optional port number, or ipaddr:port (default: {self.default_addrport})",
+        )
+        parser.add_argument(
+            "--forwarded-host",
+            type=str,
+            default=self.default_forwarded_host,
+            help=f"Value for X-Forwarded-Host header (default: {self.default_forwarded_host})",
+        )
+        parser.add_argument(
+            "--forwarded-proto",
+            type=str,
+            choices=["http", "https"],
+            default="https",
+            help="Value for X-Forwarded-Proto header (default: https)",
+        )
+        parser.add_argument(
+            "--timeout",
+            type=int,
+            default=5,
+            help="Timeout in seconds for the health check request (default: 5 seconds)",
+        )
+
+    def handle(self, *args, **options):
+        endpoint = options.get("endpoint")
+        try:
+            path = reverse(endpoint)
+        except NoReverseMatch as e:
+            self.stderr.write(
+                f"Could not resolve endpoint {endpoint!r}: {e}\n"
+                "Please provide a valid URL pattern name for the health check endpoint."
+            )
+            sys.exit(2)
+        addrport = options.get("addrport")
+        # Use HTTPS only when SSL redirect is enabled without forwarded headers (direct HTTPS required).
+        # Otherwise use HTTP (typical for containers with X-Forwarded-Proto header support).
+        proto = (
+            "https"
+            if settings.SECURE_SSL_REDIRECT and not settings.USE_X_FORWARDED_HOST
+            else "http"
+        )
+        url = f"{proto}://{addrport}{path}"
+
+        headers = {"Accept": "text/plain"}
+
+        # Add X-Forwarded-Host header
+        if forwarded_host := options.get("forwarded_host"):
+            headers["X-Forwarded-Host"] = forwarded_host
+
+        # Add X-Forwarded-Proto header
+        if forwarded_proto := options.get("forwarded_proto"):
+            headers["X-Forwarded-Proto"] = forwarded_proto
+
+        if options.get("verbosity", 1) >= 2:
+            self.stdout.write(
+                f"Checking health endpoint at {url!r} with headers: {headers}"
+            )
+
+        request = urllib.request.Request(url, headers=headers)  # noqa: S310
+        try:
+            response = urllib.request.urlopen(request, timeout=options["timeout"])  # noqa: S310
+        except urllib.error.HTTPError as e:
+            match e.code:
+                case 500:  # Health check failed
+                    self.stdout.write(e.read().decode("utf-8"))
+                    sys.exit(1)
+                case 400:
+                    self.stderr.write(
+                        f"{url!r} is not reachable: {e.reason}\nPlease check your ALLOWED_HOSTS setting or use the --forwarded-host option."
+                    )
+                    sys.exit(2)
+                case _:
+                    self.stderr.write(
+                        "Unexpected HTTP error "
+                        f"when trying to reach {url!r}: {e}\n"
+                        f"You may have selected an invalid endpoint {endpoint!r}"
+                        f" or another application is running on {addrport!r}."
+                    )
+                    sys.exit(2)
+        except urllib.error.URLError as e:
+            self.stderr.write(
+                f"{url!r} is not reachable: {e.reason}\nPlease check your server is running and reachable."
+            )
+            sys.exit(2)
+        except TimeoutError as e:
+            self.stderr.write(f"Timeout when trying to reach {url!r}: {e}")
+            sys.exit(2)
+        else:
+            self.stdout.write(response.read().decode("utf-8"))

django_health_check-4.0rc2/health_check/management/commands/health_check.py

@@ -1,46 +0,0 @@
-import sys
-import urllib.error
-import urllib.request
-
-from django.core.management.base import BaseCommand
-from django.urls import reverse
-
-
-class Command(BaseCommand):
-    help = "Run health checks and exit 0 if everything went well."
-
-    def add_arguments(self, parser):
-        parser.add_argument(
-            "endpoint",
-            type=str,
-            help="URL-pattern name of health check endpoint to test",
-        )
-        parser.add_argument(
-            "addrport",
-            nargs="?",
-            type=str,
-            help="Optional port number, or ipaddr:port (default: localhost:8000)",
-            default="localhost:8000",
-        )
-
-    def handle(self, *args, **options):
-        endpoint = options.get("endpoint")
-        path = reverse(endpoint)
-        host, sep, port = options.get("addrport").partition(":")
-        url = f"http://{host}:{port}{path}" if sep else f"http://{host}{path}"
-        request = urllib.request.Request(  # noqa: S310
-            url, headers={"Accept": "text/plain"}
-        )
-        try:
-            response = urllib.request.urlopen(request)  # noqa: S310
-        except urllib.error.HTTPError as e:
-            # 500 status codes will raise HTTPError
-            self.stdout.write(e.read().decode("utf-8"))
-            sys.exit(1)
-        except urllib.error.URLError as e:
-            self.stderr.write(
-                f'"{url}" is not reachable: {e.reason}\nPlease check your ALLOWED_HOSTS setting.'
-            )
-            sys.exit(2)
-        else:
-            self.stdout.write(response.read().decode("utf-8"))