Skip to content

Test health

hypha.test_health

TestHealthCheck

Bases: TestCase

test_returns_200_when_db_healthy 

test_returns_200_when_db_healthy()
Source code in hypha/test_health.py 
 9
10
11
def test_returns_200_when_db_healthy(self):
    response = self.client.get(reverse("health"))
    self.assertEqual(response.status_code, 200)

test_response_body_is_ok_when_healthy 

test_response_body_is_ok_when_healthy()
Source code in hypha/test_health.py 
13
14
15
def test_response_body_is_ok_when_healthy(self):
    response = self.client.get(reverse("health"))
    self.assertEqual(response.content, b"ok")

test_content_type_is_text_plain_when_healthy 

test_content_type_is_text_plain_when_healthy()
Source code in hypha/test_health.py 
17
18
19
def test_content_type_is_text_plain_when_healthy(self):
    response = self.client.get(reverse("health"))
    self.assertEqual(response["Content-Type"], "text/plain")

test_accessible_without_authentication 

test_accessible_without_authentication()
Source code in hypha/test_health.py 
21
22
23
24
def test_accessible_without_authentication(self):
    # Health check must be reachable by load balancers without credentials.
    response = self.client.get(reverse("health"))
    self.assertEqual(response.status_code, 200)

test_returns_500_when_db_unavailable 

test_returns_500_when_db_unavailable()
Source code in hypha/test_health.py 
26
27
28
29
30
31
32
def test_returns_500_when_db_unavailable(self):
    with patch(
        "hypha.health.connection.ensure_connection",
        side_effect=OperationalError("connection refused"),
    ):
        response = self.client.get(reverse("health"))
    self.assertEqual(response.status_code, 500)

test_response_body_is_failed_when_db_unavailable 

test_response_body_is_failed_when_db_unavailable()
Source code in hypha/test_health.py 
34
35
36
37
38
39
40
def test_response_body_is_failed_when_db_unavailable(self):
    with patch(
        "hypha.health.connection.ensure_connection",
        side_effect=OperationalError("connection refused"),
    ):
        response = self.client.get(reverse("health"))
    self.assertEqual(response.content, b"failed")

test_content_type_is_text_plain_on_failure 

test_content_type_is_text_plain_on_failure()
Source code in hypha/test_health.py 
42
43
44
45
46
47
48
def test_content_type_is_text_plain_on_failure(self):
    with patch(
        "hypha.health.connection.ensure_connection",
        side_effect=OperationalError("connection refused"),
    ):
        response = self.client.get(reverse("health"))
    self.assertEqual(response["Content-Type"], "text/plain")

test_exception_detail_not_exposed_in_response 

test_exception_detail_not_exposed_in_response()
Source code in hypha/test_health.py 
50
51
52
53
54
55
56
57
58
def test_exception_detail_not_exposed_in_response(self):
    # Internal DB details (host, credentials) must never reach the client.
    with patch(
        "hypha.health.connection.ensure_connection",
        side_effect=OperationalError("secret-db-host:5432 password=hunter2"),
    ):
        response = self.client.get(reverse("health"))
    self.assertNotIn(b"secret-db-host", response.content)
    self.assertNotIn(b"hunter2", response.content)

test_logs_error_on_db_failure 

test_logs_error_on_db_failure()
Source code in hypha/test_health.py 
60
61
62
63
64
65
66
67
def test_logs_error_on_db_failure(self):
    with patch("hypha.health.logger.exception") as mock_log:
        with patch(
            "hypha.health.connection.ensure_connection",
            side_effect=OperationalError("connection refused"),
        ):
            self.client.get(reverse("health"))
    mock_log.assert_called_once()