Adding api tests

Author: Bryan Sieber

src/app/environment.py

@@ -21,7 +21,7 @@ def get_version():
     Return contents of version.json.
     This has generic data in repo, but gets the build details in CI.
     """
-    _root = os.path.dirname(os.path.dirname(__file__))
+    _root = os.path.dirname(os.path.dirname(os.path.dirname(__file__)))
     version_path = os.path.join(_root, "version.json")
     info = {}
     if os.path.exists(version_path):

src/app/monitor.py

@@ -13,10 +13,9 @@ def heartbeat(request: Request, settings: environment.Settings):
     """Return status of backing services, as required by Dockerflow."""
     data: Dict = {}
     data.update(jbi_service_health_map(settings))
-
     status_code = 200
     for _, health in data.items():
-        if not health["up"]:
+        if not health.get("up"):
             status_code = 503
 
     return JSONResponse(content=data, status_code=status_code)

tests/unit/app/conftest.py

@@ -0,0 +1,16 @@
+import pytest
+from fastapi.testclient import TestClient
+
+from src.app.api import app
+from src.app.environment import Settings
+
+
+@pytest.fixture
+def anon_client():
+    """A test client with no authorization."""
+    return TestClient(app)
+
+
+@pytest.fixture
+def settings():
+    return Settings()

tests/unit/app/test_api.py

@@ -0,0 +1,8 @@
+def test_read_root(anon_client):
+    """The site root redirects to the Swagger docs"""
+    resp = anon_client.get("/")
+    assert resp.status_code == 200
+    assert len(resp.history) == 1
+    prev_resp = resp.history[0]
+    assert prev_resp.status_code == 307  # Temporary Redirect
+    assert prev_resp.headers["location"] == "./docs"

tests/unit/app/test_monitor.py

@@ -0,0 +1,42 @@
+import json
+import os.path
+from unittest.mock import patch
+
+
+def test_read_version(anon_client):
+    """__version__ returns the contents of version.json."""
+    here = os.path.dirname(__file__)
+    root_dir = os.path.dirname(os.path.dirname(os.path.dirname(here)))
+    version_path = os.path.join(root_dir, "version.json")
+    with open(version_path, "r", encoding="utf8") as vp_file:
+        version_contents = vp_file.read()
+    expected = json.loads(version_contents)
+    resp = anon_client.get("/__version__")
+    assert resp.status_code == 200
+    assert resp.json() == expected
+
+
+def test_read_heartbeat_no_services_fails(anon_client):
+    """/__heartbeat__ returns 503 when the services are unavailable."""
+    resp = anon_client.get("/__heartbeat__")
+    assert resp.status_code == 503
+    data = resp.json()
+    expected = {"bugzilla": {"up": False}, "jira": {"up": False}}
+    assert data == expected
+
+
+def test_read_heartbeat_success(anon_client):
+    """/__heartbeat__ returns 200 when measuring the acoustic backlog fails."""
+    expected = {
+        "jira": {
+            "up": True,
+        },
+        "bugzilla": {
+            "up": True,
+        },
+    }
+    with patch("src.app.monitor.jbi_service_health_map", return_value=expected):
+        resp = anon_client.get("/__heartbeat__")
+    assert resp.status_code == 200
+    data = resp.json()
+    assert data == expected