Updates

Author: ericsalesdeandrade

app/models.py

@@ -1,16 +1,28 @@
 from app.database import Base
-from sqlalchemy import TIMESTAMP, Column, String, Boolean
+from sqlalchemy import TIMESTAMP, Column, String, Boolean, Index
 from sqlalchemy.sql import func
 from fastapi_utils.guid_type import GUID, GUID_DEFAULT_SQLITE
 
 
 class User(Base):
     __tablename__ = "users"
+
+    # Primary key and GUID type
     id = Column(GUID, primary_key=True, default=GUID_DEFAULT_SQLITE)
-    first_name = Column(String, nullable=False)
-    last_name = Column(String, nullable=False)
-    address = Column(String, nullable=True)
+
+    # String types with appropriate non-null constraints
+    first_name = Column(
+        String(255), nullable=False, index=True
+    )  # Indexed for faster searches
+    last_name = Column(
+        String(255), nullable=False, index=True
+    )  # Indexed for faster searches
+    address = Column(String(255), nullable=True)
+
+    # Boolean type with a default value
     activated = Column(Boolean, nullable=False, default=True)
+
+    # Timestamps with timezone support
     createdAt = Column(
         TIMESTAMP(timezone=True), nullable=False, server_default=func.now()
     )

app/schemas.py

@@ -1,12 +1,14 @@
 from datetime import datetime
 from typing import List
-from pydantic import BaseModel
+from pydantic import BaseModel, Field
 
 
 class UserBaseSchema(BaseModel):
     id: str | None = None
-    first_name: str
-    last_name: str
+    first_name: str = Field(
+        ..., description="The first name of the user", example="John"
+    )
+    last_name: str = Field(..., description="The last name of the user", example="Doe")
     address: str | None = None
     activated: bool = False
     createdAt: datetime | None = None

poetry.lock

@@ -0,0 +1,22 @@
+[tool.poetry]
+name = "pytest-fastapi-crud-example"
+version = "0.1.0"
+description = "Example of testing a FastAPI CRUD API in Pytest"
+authors = ["ericsalesdeandrade <[email protected]>"]
+readme = "README.md"
+
+[tool.poetry.dependencies]
+python = "^3.12"
+fastapi = "0.110.3"
+fastapi-utils = "^0.2.1"
+uvicorn = "^0.29.0"
+pydantic = "<2.0, >=1.7.4"
+httpx = "^0.27.0"
+
+
+[tool.poetry.group.test.dependencies]
+pytest = "^8.2.0"
+
+[build-system]
+requires = ["poetry-core"]
+build-backend = "poetry.core.masonry.api"

pyproject.toml

@@ -1,4 +1,4 @@
 [pytest]
-log_cli=true
-log_level=INFO
+; log_cli=true
+; log_level=INFO
 addopts = -p no:warnings

pytest.ini

@@ -0,0 +1,25 @@
+from fastapi.testclient import TestClient
+from app.main import app
+import uuid
+import pytest
+
+
+@pytest.fixture
+def test_client():
+    yield TestClient(app)
+
+
+@pytest.fixture
+def user_id(scope="session"):
+    return str(uuid.uuid4())
+
+
+@pytest.fixture
+def user_payload(user_id):
+    return {
+        "id": user_id,
+        "first_name": "PLACEHOLDER",
+        "last_name": "PLACEHOLDER",
+        "address": "PLACEHOLDER",
+        "createdAt": "2024-04-30T16:39:23",
+    }

requirements.txt

@@ -0,0 +1,82 @@
+def test_root(test_client):
+    response = test_client.get("/api/healthchecker")
+    assert response.status_code == 200
+    assert response.json() == {"message": "The API is LIVE!!"}
+
+
+def test_create_user_success(test_client, user_payload, user_id):
+    response = test_client.post("/api/users/", json=user_payload)
+    assert response.status_code == 201
+    assert response.json() == {
+        "Status": "Success",
+        "User": {
+            "id": user_id,
+            "activated": False,
+            "createdAt": "2024-04-30T16:39:23",
+            "first_name": "PLACEHOLDER",
+            "last_name": "PLACEHOLDER",
+            "address": "PLACEHOLDER",
+            "updatedAt": None,
+        },
+    }
+
+
+# def test_create_user_fail(test_client, user_payload, user_id):
+#     response = test_client.post("/api/users/", json=user_payload)
+#     assert response.status_code == 400
+#     assert response.json() == {
+#         "detail": "User with id: `16303002-876a-4f39-ad16-e715f151bab3` already exists"
+#     }
+
+
+# def test_get_user(test_client):
+#     response = test_client.get(f"/api/users/{user_id}")
+#     assert response.status_code == 200
+#     assert response.json() == {
+#         "Status": "Success",
+#         "User": {
+#             "first_name": "PLACEHOLDER",
+#             "last_name": "PLACEHOLDER",
+#             "activated": False,
+#             "createdAt": "2023-03-17T00:04:32",
+#             "address": "PLACEHOLDER",
+#             "id": user_id,
+#             "updatedAt": None,
+#         },
+#     }
+
+
+# def test_update_user(test_client, sample_payload):
+#     response = test_client.patch(f"/api/users/{user_id}", json=sample_payload)
+#     assert response.status_code == 202
+#     assert response.json() == {
+#         "Status": "Success",
+#         "User": {
+#             "first_name": "PLACEHOLDER2",
+#             "last_name": "PLACEHOLDER2",
+#             "activated": True,
+#             "createdAt": "2023-03-17T00:04:32",
+#             "id": user_id,
+#             "address": "PLACEHOLDER2",
+#             "updatedAt": "2023-03-17T00:06:32",
+#         },
+#     }
+
+
+# def test_delete_user(test_client):
+#     response = test_client.delete(f"/api/users/{user_id}")
+#     assert response.status_code == 200
+#     assert response.json() == {
+#         "Status": "Success",
+#         "Message": "User deleted successfully",
+#     }
+
+
+# def test_get_user_not_found(test_client):
+#     response = test_client.get(
+#         f"/api/users/16303002-876a-4f39-ad16-e715f151bab3"
+#     )  # GUID not in DB
+#     assert response.status_code == 404
+#     assert response.json() == {
+#         "detail": "No User with this id: `16303002-876a-4f39-ad16-e715f151bab3` found"
+#     }