Merge pull request #1137 from rkevin-arch/healthcheck-head-request

Allow head requests for the health endpoint

Author: betatim

binderhub/health.py

@@ -151,7 +151,12 @@ async def check_pod_quota(self):
         }
         return usage
 
-    async def get(self):
+    async def check_all(self):
+        """Runs all health checks and returns a tuple (overall, checks).
+
+        `overall` is a bool representing the overall status of the service
+        `checks` contains detailed information on each check's result
+        """
         checks = []
         check_futures = []
 
@@ -176,7 +181,15 @@ async def get(self):
         overall = all(
             check["ok"] for check in checks if check["service"] != "Pod quota"
         )
+        return overall, checks
+
+    async def get(self):
+        overall, checks = await self.check_all()
         if not overall:
             self.set_status(503)
-
         self.write({"ok": overall, "checks": checks})
+
+    async def head(self):
+        overall, checks = await self.check_all()
+        if not overall:
+            self.set_status(503)

binderhub/tests/test_health.py

@@ -27,3 +27,7 @@ async def test_basic_health(app):
         quota_check["total_pods"]
         == quota_check["build_pods"] + quota_check["user_pods"]
     )
+
+    # HEAD requests should work as well
+    r = await async_requests.head(app.url + "/health")
+    assert r.status_code == 200