Updates

Author: ericsalesdeandrade

.gitignore

@@ -1,6 +1,7 @@
 __pycache__
 *.pytest_cache
 venv/
+.venv
 # .env
 *.db
 *.idea

README.md

@@ -1,23 +1,122 @@
-# Pytest FastAPI CRUD Example
+# User Service API Example
 
-This repo contains the sample code for the article - [Building And Testing FastAPI CRUD APIs With Pytest (Hands-On Tutorial)](https://pytest-with-eric.com/pytest-advanced/pytest-fastapi-testing/)
+## Overview
 
-This project explains how to Build and Test A CRUD Rest API using FastAPI, SQLite (via SQLAlchemy) and Pytest.
+This is a simple User Service CRUD (Create, Read, Update, Delete) API built with FastAPI and SQLite. The API allows you to create, read, update, and delete users. It uses Pydantic models for request and response validation and SQLAlchemy for database operations.
 
-# Requirements
-* Python (3.12)
+## Architecture
+This project follows a clean architecture pattern, separating concerns to enhance maintainability and scalability. Here's a brief overview:
 
-This repo uses [Poetry](https://python-poetry.org/) for dependency management.
+- API Layer (FastAPI): Handles HTTP requests and responses, routing, and interaction with the service layer.
+- Service Layer: Contains business logic and communicates with the database layer.
+- Database Layer (SQLite): Manages data persistence and database operations.
+- Testing: Unit tests are written in Pytest to test the service layer functions.
+
+## Getting Started
+
+### Prerequisites and Dependencies
+- Python 3.12
+- FastAPI
+- SQLite
+- Uvicorn (for running the server)
+
+#### Poetry
+
+This project uses [Poetry](https://python-poetry.org/) for dependency management. 
+
+If you're not familiar with Poetry, please follow [these instructions](https://python-poetry.org/docs/#installation) to install it.
+
+Once you've installed Poetry, you can install the dependencies using the following command:
 
-Please install the dependencies using
 ```shell
 $ poetry install
 ```
 
-# How To Run the Unit Tests
+Then run the below command to activate the virtual environment.
+
+```shell
+$ poetry shell
+```
+
+#### Pip
+
+If you prefer using `pip`, you can create a virtual environment and then install the dependencies using the following command:
+
+```shell
+$ pip install -r requirements.txt
+```
+
+## How To Run the Server
+
+To run the server, use the following command:
+
+```shell
+$ uvicorn app.main:app --host localhost --port 8000 --reload
+```
+
+This will spin up the server at `http://localhost:8000` with a local SQLite database `users.db`.
+
+## API Endpoints
+
+### Create User
+
+- `POST /api/users/`: Create a new user.
+
+To create a user, send a POST request to `http://localhost:8000/api/users` with the following JSON payload:
+
+```json
+{
+ "first_name": "John",
+ "last_name": "Doe",
+ "address": "123 Fake St",
+ "activated": true
+}
+```
+
+As we use Pydantic models, the API will validate the request payload and return an error if the payload is invalid.
+
+### Get Users
+
+- `GET /api/users/`: Get all users.
+
+To get all users, send a GET request to `http://localhost:8000/api/users`.
+
+### Get User by ID
+
+- `GET /api/users/{userId}/`: Get a user by ID.
+
+To get a user by ID, send a GET request to `http://localhost:8000/api/users/{userId}`. 
+
+If the user with the specified ID does not exist, the API will return a 404 Not Found response. The same logic is carried out for the Update and Delete endpoints.
+
+
+### Update User
+
+- `PATCH /api/users/{userId}/`: Update a user by ID.
+
+To update a user by ID, send a PATCH request to `http://localhost:8000/api/users/{userId}` with the following JSON payload:
+
+```json
+{
+ "first_name": "Jane",
+ "last_name": "Doe",
+ "address": "321 Fake St",
+ "activated": true
+}
+```
+
+### Delete User
+
+- `DELETE /api/users/{userId}/`: Delete a user by ID.
+
+To delete a user by ID, send a DELETE request to `http://localhost:8000/api/users/{userId}`.
+
+## How To Run the Unit Tests
 To run the Unit Tests, from the root of the repo run
 ```shell
-pytest 
+$ pytest 
 ```
 
-If you have any questions about the project please raise an Issue on GitHub. 
+This will spin up a test database in SQLite `test_db.db`, run the tests and then tear down the database. 
+
+You can use `pytest -v` for verbose output and `pytest -s` to disable output capture for better debugging.

app/models.py

@@ -1,5 +1,5 @@
 from app.database import Base
-from sqlalchemy import TIMESTAMP, Column, String, Boolean, Index
+from sqlalchemy import TIMESTAMP, Column, String, Boolean
 from sqlalchemy.sql import func
 from sqlalchemy_utils import UUIDType
 import uuid

app/schemas.py

@@ -2,7 +2,7 @@
 from datetime import datetime
 from typing import List
 from pydantic import BaseModel, Field
-from uuid import uuid4, UUID
+from uuid import UUID
 
 
 class UserBaseSchema(BaseModel):

app/user.py

@@ -1,7 +1,7 @@
-import app.schemas as schemas, app.models as models
+import app.schemas as schemas
+import app.models as models
 from sqlalchemy.orm import Session
 from sqlalchemy.exc import IntegrityError
-from pydantic import ValidationError
 from fastapi import Depends, HTTPException, status, APIRouter
 from app.database import get_db
 
@@ -14,7 +14,7 @@
 def create_user(payload: schemas.UserBaseSchema, db: Session = Depends(get_db)):
  try:
  # Create a new user instance from the payload
- new_user = models.User(**payload.dict())
+ new_user = models.User(**payload.model_dump())
  db.add(new_user)
  db.commit()
  db.refresh(new_user)
@@ -55,7 +55,7 @@ def get_user(userId: str, db: Session = Depends(get_db)):
 
  try:
  return schemas.GetUserResponse(
- Status=schemas.Status.Success, User=schemas.UserBaseSchema.from_orm(db_user)
+ Status=schemas.Status.Success, User=schemas.UserBaseSchema.model_validate(db_user)
  )
  except Exception as e:
  raise HTTPException(
@@ -86,7 +86,7 @@ def update_user(
  user_query.update(update_data, synchronize_session=False)
  db.commit()
  db.refresh(db_user)
- user_schema = schemas.UserBaseSchema.from_orm(db_user)
+ user_schema = schemas.UserBaseSchema.model_validate(db_user)
  return schemas.UserResponse(Status=schemas.Status.Success, User=user_schema)
  except IntegrityError as e:
  db.rollback()

pyproject.toml

@@ -1,7 +1,7 @@
 [tool.poetry]
-name = "pytest-fastapi-crud-example"
+name = "user-service-example"
 version = "0.1.0"
-description = "Example of testing a FastAPI CRUD API in Pytest"
+description = "A simple user service example"
 authors = ["ericsalesdeandrade <sdaeric19@gmail.com>"]
 readme = "README.md"
 

requirements.txt

@@ -0,0 +1,10 @@
+
+fastapi~=0.110.3 
+httpx~=0.27.0 
+pydantic~=2.7.1 
+sqlalchemy-utils~=0.41.2 
+sqlalchemy~=2.0.29 
+starlette~=0.37.2 
+uvicorn~=0.29.0
+pytest~=8.2.0
+pytest-randomly~=3.15.0

tests/conftest.py

@@ -2,7 +2,6 @@
 import uuid
 from sqlalchemy import create_engine
 from sqlalchemy.orm import sessionmaker
-from sqlalchemy.ext.declarative import declarative_base
 from sqlalchemy.pool import StaticPool
 from fastapi.testclient import TestClient
 from app.main import app

tests/test_crud_api.py

@@ -65,10 +65,7 @@ def test_create_delete_user(test_client, user_payload):
  response = test_client.get(f"/api/users/{user_payload['id']}")
  assert response.status_code == 404
  response_json = response.json()
- assert (
- response_json["detail"]
- == f"No User with this id: `{user_payload['id']}` found",
- )
+ assert response_json["detail"] == f"No User with this id: `{user_payload['id']}` found"
 
 
 def test_get_user_not_found(test_client, user_id):