Merge pull request #8 from SADiLaR/feature/health

Feature: basic health endpoint

app/app/urls.py

@@ -25,5 +25,6 @@
 
 urlpatterns = [
     path("admin/", admin.site.urls),
+    path("_health/", views.health, name="health"),
     path("", views.home, name="home"),
 ]

app/app/views.py

@@ -1,6 +1,14 @@
+from django.http import HttpResponse
 from django.shortcuts import render
 
 
+def health(request):
+    """A very basic (minimal dependency) health endpoint."""
+    # If we want/need a health check for DB, cache, files, etc. that should
+    # probably be separate.
+    return HttpResponse("OK", content_type="text/plain")
+
+
 def home(request):
     template = "app/home.html"
     context = {}

app/general/tests/test_views.py

@@ -0,0 +1,8 @@
+from django.test import Client, TestCase
+
+
+class TestViews(TestCase):
+
+    def test_health(self):
+        response = Client().get("/_health/")
+        self.assertIn(b"OK", response.content)

doc/urls.md

@@ -0,0 +1,5 @@
+URL naming
+==========
+
+If a URL is not really for public consumption, prefix it with an undrescore,
+e.g. "/_health/".