Merge pull request #10 from fastapi-mvc/improve_tests

Refactor and improve tests suite

Author: rszamszur

template/.coveragerc.jinja

@@ -62,7 +62,7 @@ integration-test: install ## Run {{project_name}} integration tests
 .PHONY: coverage
 coverage: install  ## Run {{project_name}} tests coverage
 	echo "[coverage] Run {{project_name}} tests coverage."
-	${POETRY_BINARY} run pytest --cov-config=.coveragerc --cov={{package_name}} --cov-fail-under=90 --cov-report=xml --cov-report=term-missing tests
+	${POETRY_BINARY} run pytest --cov={{package_name}} --cov-fail-under=90 --cov-report=xml --cov-report=term-missing tests
 
 .PHONY: test
 test: unit-test integration-test  ## Run {{project_name}} tests

template/Makefile.jinja

@@ -56,3 +56,14 @@ myst-parser = "~0.18.1"
 [build-system]
 requires = ["poetry-core>=1.0.0"]
 build-backend = "poetry.core.masonry.api"
+
+[tool.coverage.run]
+omit = [
+    "{{package_name}}/config/gunicorn.py",
+    "{{package_name}}/__main__.py",
+]
+
+[tool.coverage.report]
+exclude_lines = [
+    "pass",
+]

template/pyproject.toml.jinja

@@ -0,0 +1,41 @@
+from {{package_name}}.config import settings
+
+
+class TestReadyController:
+
+    def test_should_return_ok(self, app_runner):
+        # given
+        settings.USE_REDIS = False
+
+        # when
+        response = app_runner.get("/api/ready")
+
+        # then
+        assert response.status_code == 200
+        assert response.json() == {"status": "ok"}
+
+    def test_should_return_not_found_when_invalid_uri(self, app_runner):
+        # given / when
+        response = app_runner.get("/api/ready/123")
+
+        # then
+        assert response.status_code == 404
+{%- if redis %}
+
+    def test_should_return_bad_gateway_when_redis_unavailable(self, app_runner):
+        # given
+        settings.USE_REDIS = True
+
+        # when
+        response = app_runner.get("/api/ready")
+
+        # then
+        assert response.status_code == 502
+        assert response.json() == {
+            "error": {
+                "code": 502,
+                "message": "Could not connect to Redis",
+                "status": "BAD_GATEWAY",
+            }
+        }
+{% endif %}

template/tests/integration/app/__init__.py

@@ -0,0 +1,15 @@
+import pytest
+from fastapi.testclient import TestClient
+from {{package_name}}.app import get_application
+from {{package_name}}.config import settings
+
+
+@pytest.fixture
+def app_runner():
+    # Overriding to true in order to initialize redis client on FastAPI event
+    # startup handler. It'll be needed for unit tests.
+    settings.USE_REDIS = True
+    app = get_application()
+
+    with TestClient(app) as client:
+        yield client

template/tests/integration/app/controllers/__init__.py

@@ -5,7 +5,7 @@ from {{package_name}}.config import settings
 
 
 @pytest.fixture
-def app():
+def app_runner():
     # Overriding to true in order to initialize redis client on FastAPI event
     # startup handler. It'll be needed for unit tests.
     settings.USE_REDIS = True

template/tests/integration/app/controllers/test_ready.py.jinja

@@ -1,28 +1,41 @@
 from {{package_name}}.config import settings
 
 
-def test_ready(app):
-    settings.USE_REDIS = False
-    response = app.get("/api/ready")
-    assert response.status_code == 200
-    assert response.json() == {"status": "ok"}
+class TestReadyController:
 
+    def test_should_return_ok(self, app_runner):
+        # given
+        settings.USE_REDIS = False
 
-def test_ready_invalid(app):
-    response = app.get("/api/ready/123")
-    assert response.status_code == 404
+        # when
+        response = app_runner.get("/api/ready")
+
+        # then
+        assert response.status_code == 200
+        assert response.json() == {"status": "ok"}
+
+    def test_should_return_not_found_when_invalid_uri(self, app_runner):
+        # given / when
+        response = app_runner.get("/api/ready/123")
+
+        # then
+        assert response.status_code == 404
 {%- if redis %}
 
+    def test_should_return_bad_gateway_when_redis_unavailable(self, app_runner):
+        # given
+        settings.USE_REDIS = True
+
+        # when
+        response = app_runner.get("/api/ready")
 
-def test_ready_invalid_with_redis(app):
-    settings.USE_REDIS = True
-    response = app.get("/api/ready")
-    assert response.status_code == 502
-    assert response.json() == {
-        "error": {
-            "code": 502,
-            "message": "Could not connect to Redis",
-            "status": "BAD_GATEWAY",
+        # then
+        assert response.status_code == 502
+        assert response.json() == {
+            "error": {
+                "code": 502,
+                "message": "Could not connect to Redis",
+                "status": "BAD_GATEWAY",
+            }
         }
-    }
 {% endif %}