Add codecoverage measurement (#271)

Co-authored-by: Brzuszek Maël <[email protected]>

.github/workflows/test.yml

@@ -53,4 +53,9 @@ jobs:
           key: pytest_cache-${{ github.head_ref }}
 
       - name: Run unit tests
-        run: python -m pytest
+        run: python -m pytest --cov
+
+      - name: Upload coverage reports to Codecov
+        uses: codecov/codecov-action@v3
+        env:
+          CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}

.gitignore

@@ -25,4 +25,7 @@ firebase.json
 logs/
 
 # Migrations scripts
-migrations/versions/*.py
+migrations/versions/*.py
+
+# Pytest-cov
+.coverage

app/utils/types/raffle_types.py

@@ -5,6 +5,3 @@ class RaffleStatusType(str, Enum):
     creation = "creation"  # Can edit every parameter
     open = "open"  # Ordering is possible, no edition possible
     lock = "lock"  # Can't order
-
-    def __str__(self):
-        return f"{self.name}<{self.value}"

pyproject.toml

@@ -11,7 +11,7 @@ extend-exclude = '''
 
 [tool.isort]
 profile = "black"
-py_version=310
+py_version = 310
 skip_gitignore = true
 skip_glob = [".git", "migrations/*"]
 
@@ -30,4 +30,21 @@ warn_unreachable = true
 
 [tool.pytest.ini_options]
 asyncio_mode = "auto"
-filterwarnings = "error"
+filterwarnings = "error"
+
+[tool.coverage.run]
+source_pkgs = ["app"]
+omit = [
+    "main.py",       # Main is just a wrapper and is not used during tests
+    "mailworker.py", # We don't use send mails during tests
+    "*matrix*",      # We don't send logs to matrix during tests
+]
+
+
+[tool.coverage.report]
+# Regexes for lines to exclude from consideration
+# See https://coverage.readthedocs.io/en/latest/excluding.html#excluding for more info
+exclude_also = []
+
+skip_covered = true
+show_missing = true

requirements-dev.txt

@@ -12,3 +12,4 @@ types-requests==2.31.0.2
 types-redis==4.6.0.5
 mypy==1.5.1
 types-pytz==2023.3.1.1
+pytest-cov==4.1.0

tests/test_ratelimit.py

@@ -3,11 +3,12 @@
 
 def test_limiter():
     change_redis_client_status(activated=True)
-    for _ in range(settings.REDIS_LIMIT - 1):
-        response = client.get(
-            "/health"
-        )  # Fake endpoint, we don't care about the response
-        assert response.status_code == 404
-    response = client.get("/health")
-    assert response.status_code == 429
-    change_redis_client_status(activated=False)
+    try:
+        for _ in range(settings.REDIS_LIMIT - 1):
+            response = client.get("/information")
+            assert response.status_code == 200
+        for i in range(2):
+            response = client.get("/information")
+            assert response.status_code == 429
+    finally:
+        change_redis_client_status(activated=False)