Add ping endpoint, closes #155

bothub/health/apps.py

@@ -0,0 +1,5 @@
+from django.apps import AppConfig
+
+
+class HealthConfig(AppConfig):
+    name = 'health'

bothub/health/checks.py

@@ -0,0 +1,23 @@
+def check_database_connection(**kwargs):
+    from django.db import connections
+    from django.db.utils import OperationalError
+    db_conn = connections['default']
+    if not db_conn:
+        return False
+    try:
+        db_conn.cursor()
+        return True
+    except OperationalError as e:
+        return False
+
+
+def check_accessible_api(request, **kwargs):
+    import requests
+    HTTP_HOST = request.META.get('HTTP_HOST')
+    repositories_url = 'http://{}/api/repositories/'.format(HTTP_HOST)
+    request = requests.get(repositories_url)
+    try:
+        request.raise_for_status()
+        return True
+    except requests.HTTPError as e:
+        return False

bothub/health/tests.py

@@ -0,0 +1 @@
+# from django.test import TestCase

bothub/health/views.py

@@ -0,0 +1,34 @@
+from collections import OrderedDict
+from functools import reduce
+
+from django.http import HttpResponse
+from rest_framework import status
+
+from .checks import check_database_connection
+from .checks import check_accessible_api
+
+CHECKS = [
+    check_database_connection,
+    check_accessible_api,
+]
+
+
+def ping(request):
+    checks_status = OrderedDict(map(
+        lambda check: (check.__name__, check(request=request)),
+        CHECKS))
+    healthy = reduce(
+        lambda current, status: current and status,
+        checks_status.values(),
+        True)
+    content = '{}\n{}'.format(
+        'OK' if healthy else 'something wrong happened',
+        '\n'.join(map(
+            lambda x: '{}: {}'.format(*x),
+            checks_status.items())))
+    status_code = status.HTTP_200_OK \
+        if healthy else status.HTTP_503_SERVICE_UNAVAILABLE
+    return HttpResponse(
+        content=content,
+        content_type='text/plain',
+        status=status_code)

bothub/urls.py

@@ -4,12 +4,14 @@
 from rest_framework.documentation import include_docs_urls
 
 from bothub.api.routers import router as bothub_api_routers
+from bothub.health.views import ping
 
 
 urlpatterns = [
     path('api/', include(bothub_api_routers.urls)),
     path('docs/', include_docs_urls(title='API Documentation')),
     path('admin/', admin.site.urls),
+    path('ping/', ping, name='ping'),
 ]
 
 if settings.DEBUG: