Added health route (#314)

Author: sritanmotati

app/tests.py

@@ -8,6 +8,7 @@
 from django.test import TestCase
 from unittest import skip
 from django.core import mail
+from django.urls import reverse
 
 from django.contrib.auth.models import User
 from .models import CFAUser, Event, Grant
@@ -348,6 +349,11 @@ def test_get_or_none_exists(self):
     def test_get_or_none_does_not_exist(self):
         self.assertEqual(None, helpers.get_or_none(Event, pk=2))
 
+class HealthTestCase(TestCase):
+    def test_health(self):
+        resp = self.client.get("/health/")
+        self.assertEqual(resp.status_code, 200)
+        self.assertEqual(resp.json(), {"message": "OK"})
 
 class TestExportRequests(TestCase):
     def setUp(self):

app/urls.py

@@ -12,4 +12,5 @@
     # re_path(r'^(\d+)/download/$', views.event_download, name='event-download'),
     re_path(r'^funders/(\d+)/edit/$', views.funder_edit, name='funder-edit'),
     re_path(r'^export-requests/$', views.export_requests, name='export-requests'),
+    re_path(r'^health/', views.HealthView.as_view(), name='health'),
 ]

app/views.py

@@ -3,6 +3,9 @@
 from datetime import timedelta
 import json
 import re
+from http import HTTPStatus
+from django.http import JsonResponse
+from django.views.generic import View
 
 import smtplib
 from django.contrib.auth.views import LoginView
@@ -477,6 +480,26 @@ def funder_edit(request, user_id):
     else:
         return HttpResponseNotAllowed(["GET"])
 
+class HealthView(View):
+    def get(self, request):
+        """
+        Health check endpoint to confirm the backend is running.
+        ---
+        summary: Health Check
+        responses:
+            "200":
+                content:
+                    application/json:
+                        schema:
+                            type: object
+                            properties:
+                                message:
+                                    type: string
+                                    enum: ["OK"]
+        ---
+        """
+        return JsonResponse({"message": "OK"}, status=HTTPStatus.OK) 
+
 @admin_only
 @require_http_methods(["GET"])
 def export_requests(request):
@@ -555,4 +578,4 @@ def export_requests(request):
 
     response = HttpResponse(output.getvalue(), content_type='text/csv')
     response['Content-Disposition'] = 'attachment; filename="funding_requests.csv"'
-    return response
+    return response