Updated to run checks in all app and test folders

.pre-commit-config.yaml

@@ -10,14 +10,12 @@ repos:
       - id: bandit
         args: [-c, pyproject.toml, -r, -l]
         additional_dependencies: ["bandit[toml]"]
-        exclude: 'tests/*'
   - repo: https://github.com/astral-sh/ruff-pre-commit
     # Ruff version.
     rev: "v0.6.4"
     hooks:
       # Run the linter.
       - id: ruff
         args: [--fix]
-        exclude: 'tests/*'
       # Run the formatter.
       - id: ruff-format

app/v3/notifications/route_schema.py

@@ -1,23 +1,21 @@
 """Request and Response bodies for v3/notifications."""
 
-from typing import Optional, Union
-
 from pydantic import UUID4, AwareDatetime, BaseModel
 
 
 class NotificationSingleRequest(BaseModel):
     """Request model for notification endpoint."""
 
     to: str
-    personalization: Optional[dict[str, str]] = None
+    personalization: None | dict[str, str] = None
     template: UUID4
 
-    def serialize(self) -> dict[str, Optional[Union[str, dict[str, str]]]]:
+    def serialize(self) -> dict[str, None | str | dict[str, str]]:
         """Serialize the pydantic model.
 
         Returns
         -------
-            dict[str, Optional[Union[str, dict[str, str]]]]: Serialized version of the model
+            dict[str, None | str | dict[str, str]]: Serialized version of the model
 
         """
         serialized = self.model_dump()
@@ -31,5 +29,5 @@ class NotificationSingleResponse(BaseModel):
     id: UUID4
     created_at: AwareDatetime
     updated_at: AwareDatetime
-    sent_at: Optional[AwareDatetime] = None
+    sent_at: None | AwareDatetime = None
     to: str

pyproject.toml

@@ -82,6 +82,9 @@ preview = true
 # Flag errors (`C901`) whenever the complexity level exceeds 5.
 max-complexity = 5
 
+[tool.bandit.assert_used]
+skips = ['*_test.py', '*/test_*.py']
+
 [build-system]
 requires = ["poetry-core"]
 build-backend = "poetry.core.masonry.api"

scripts/run_checks.sh

@@ -1,6 +1,6 @@
 #! /usr/bin/bash
 
-APP_FOLDER='app'
+APP_FOLDER='app tests'
 
 # Wrap each check so it hides the output unless there is failure. Quotes needed in echo to preserve newline
 args_check=$(flake8 --select=DCO020 $APP_FOLDER)

tests/app/v3/notifications/test_rest.py

@@ -3,23 +3,45 @@
 from uuid import uuid4
 
 from fastapi import status
+from fastapi.testclient import TestClient
 
 from app.v3.notifications.rest import RESPONSE_400
 from app.v3.notifications.route_schema import NotificationSingleRequest
 
 
-def test_get(client):
+def test_get(client: TestClient) -> None:
+    """Test GET /v3/notifications/.
+
+    Args:
+    ----
+        client(TestClient): FastAPI client fixture
+
+    """
     resp = client.get(f'/v3/notifications/{uuid4()}')
     assert resp.status_code == status.HTTP_200_OK
 
 
-def test_get_missing_uuid(client):
+def test_get_missing_uuid(client: TestClient) -> None:
+    """Test GET /v3/notifications/ with a missing uuid.
+
+    Args:
+    ----
+        client(TestClient): FastAPI client fixture
+
+    """
     # will think it's supposed to be a POST so throws 405 instead of 404 (FastAPI)
     resp = client.get('/v3/notifications/')
     assert resp.status_code == status.HTTP_405_METHOD_NOT_ALLOWED
 
 
-def test_get_malformed_request(client):
+def test_get_malformed_request(client: TestClient) -> None:
+    """Test GET /v3/notifications/ with a malformed request.
+
+    Args:
+    ----
+        client(TestClient): FastAPI client fixture
+
+    """
     malformed_uuid = '1234'
     resp = client.get(f'/v3/notifications/{malformed_uuid}')
     resp_text = resp.text
@@ -32,7 +54,14 @@ def test_get_malformed_request(client):
     assert malformed_uuid in resp_text
 
 
-def test_post(client):
+def test_post(client: TestClient) -> None:
+    """Test POST /v3/notifications/.
+
+    Args:
+    ----
+        client(TestClient): FastAPI client fixture
+
+    """
     srequest = NotificationSingleRequest(
         to='[email protected]',
         personalization={'hello': 'world'},
@@ -42,7 +71,14 @@ def test_post(client):
     assert resp.status_code == status.HTTP_202_ACCEPTED
 
 
-def test_post_no_personalization(client):
+def test_post_no_personalization(client: TestClient) -> None:
+    """Test POST /v3/notifications/ with no personalization.
+
+    Args:
+    ----
+        client(TestClient): FastAPI client fixture
+
+    """
     srequest = NotificationSingleRequest(
         to='[email protected]',
         template=uuid4(),
@@ -51,8 +87,15 @@ def test_post_no_personalization(client):
     assert resp.status_code == status.HTTP_202_ACCEPTED
 
 
-def test_post_malformed_request(client):
-    request = {}
+def test_post_malformed_request(client: TestClient) -> None:
+    """Test POST /v3/notifications/ with a malformed request.
+
+    Args:
+    ----
+        client(TestClient): FastAPI client fixture
+
+    """
+    request: dict[str, str] = {}
     resp = client.post('v3/notifications', data=request)
     resp_text = resp.text