WI-15: Add health check for site status

server/portal/urls.py

@@ -27,6 +27,7 @@
 from django.views.generic.base import TemplateView
 from django.urls import path, re_path, include
 from impersonate import views as impersonate_views
+from portal.views.views import health_check
 admin.autodiscover()
 
 urlpatterns = [
@@ -112,4 +113,8 @@
     # version check.
     path('version/', portal_version),
 
+    # health check
+    path('core/health-check', health_check)
+
+
 ] + static(settings.MEDIA_URL, document_root=settings.MEDIA_ROOT)

server/portal/views/unit_test.py

@@ -6,6 +6,7 @@
 import requests
 import json
 
+
 # route to be used for testing purposes
 API_ROUTE = '/api/system-monitor/'
 
@@ -110,3 +111,9 @@ def test_exception(client, api_method_mock):
     response = client.get(API_ROUTE)
     assert response.status_code == 500
     assert json.loads(response.content) == {'message': 'Something went wrong here...'}
+
+
+def test_health_check(client):
+    response = client.get('/core/health-check')
+    assert response.status_code == 200
+    assert json.loads(response.content) == {'status': 'healthy'}

server/portal/views/views.py

@@ -1,5 +1,5 @@
 import logging
-from django.http import HttpResponse
+from django.http import HttpResponse, JsonResponse
 
 logger = logging.getLogger(__name__)
 
@@ -23,3 +23,8 @@ def project_version(request):
         version = 'UNKNOWN'
 
     return HttpResponse(version, content_type='text/plain')
+
+
+def health_check(request):
+    health_status = {'status': 'healthy'}
+    return JsonResponse(health_status)