Merge pull request #11 from jmeisele/docs

✅ added tests

Author: jmeisele

tests/conftest.py

@@ -0,0 +1,15 @@
+import pytest
+from starlette.config import environ
+from starlette.testclient import TestClient
+
+environ["API_KEY"] = "a1279d26-63ac-41f1-8266-4ef3702ad7cb"
+environ["DEFAULT_MODEL_PATH"] = "./sample_model/lin_reg_california_housing_model.joblib"
+
+from fastapi_scaffolding.main import get_app  # noqa: E402
+
+
+@pytest.fixture()
+def test_client():
+    app = get_app()
+    with TestClient(app) as test_client:
+        yield test_client

tests/test_api/test_api_auth.py

@@ -0,0 +1,17 @@
+from fastapi_scaffolding.core import messages
+
+
+def test_auth_using_prediction_api_no_apikey_header(test_client) -> None:
+    response = test_client.post('/api/model/predict')
+    assert response.status_code == 400
+    assert response.json() == {"detail": messages.NO_API_KEY}
+
+
+def test_auth_using_prediction_api_wrong_apikey_header(test_client) -> None:
+    response = test_client.post(
+        '/api/model/predict',
+        json={"image": "test"},
+        headers={"token": "WRONG_TOKEN"}
+    )
+    assert response.status_code == 401
+    assert response.json() == {"detail": messages.AUTH_REQ}

tests/test_api/test_heartbeat.py

@@ -0,0 +1,14 @@
+from fastapi_scaffolding.main import get_app
+
+app = get_app()
+
+
+def test_heartbeat(test_client) -> None:
+    response = test_client.get('/api/health/heartbeat')
+    assert response.status_code == 200
+    assert response.json() == {"is_alive": True}
+
+
+def test_default_route(test_client) -> None:
+    response = test_client.get('/')
+    assert response.status_code == 404

tests/test_api/test_prediction.py

@@ -0,0 +1,31 @@
+from fastapi_scaffolding.core import config
+
+
+def test_prediction(test_client) -> None:
+    response = test_client.post(
+        "/api/model/predict",
+        json={
+            "median_income_in_block": 8.3252,
+            "median_house_age_in_block": 41,
+            "average_rooms": 6,
+            "average_bedrooms": 1,
+            "population_per_block": 322,
+            "average_house_occupancy": 2.55,
+            "block_latitude": 37.88,
+            "block_longitude": -122.23
+        },
+        headers={"token": str(config.API_KEY)}
+    )
+    assert response.status_code == 200
+    assert "median_house_value" in response.json()
+    assert "currency" in response.json()
+
+
+def test_prediction_nopayload(test_client) -> None:
+    response = test_client.post(
+        "/api/model/predict",
+        json={},
+        headers={"token": str(config.API_KEY)}
+    )
+    assert response.status_code == 422
+