Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

♻️ Refactor old CRUD utils and tests #622

Merged
merged 6 commits into from
Feb 29, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 2 additions & 12 deletions src/backend/app/api/api_v1/endpoints/users.py
Original file line number Diff line number Diff line change
Expand Up @@ -166,22 +166,12 @@ def update_user(
Update a user.
"""

db_user = session.get(User, user_id)
if not db_user:
db_user = crud.update_user(session=session, user_id=user_id, user_in=user_in)
if db_user is None:
raise HTTPException(
status_code=404,
detail="The user with this username does not exist in the system",
)
user_data = user_in.model_dump(exclude_unset=True)
extra_data = {}
if "password" in user_data:
password = user_data["password"]
hashed_password = get_password_hash(password)
extra_data["hashed_password"] = hashed_password
db_user.sqlmodel_update(user_data, update=extra_data)
session.add(db_user)
session.commit()
session.refresh(db_user)
return db_user


Expand Down
55 changes: 55 additions & 0 deletions src/backend/app/crud.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
from typing import Any

from sqlmodel import Session, select

from app.core.security import get_password_hash, verify_password
from app.models import Item, ItemCreate, User, UserCreate, UserUpdate


def create_user(*, session: Session, user_create: UserCreate) -> User:
db_obj = User.model_validate(
user_create, update={"hashed_password": get_password_hash(user_create.password)}
)
session.add(db_obj)
session.commit()
session.refresh(db_obj)
return db_obj


def update_user(*, session: Session, user_id: int, user_in: UserUpdate) -> Any:
db_user = session.get(User, user_id)
if not db_user:
return None
user_data = user_in.model_dump(exclude_unset=True)
extra_data = {}
if "password" in user_data:
password = user_data["password"]
hashed_password = get_password_hash(password)
extra_data["hashed_password"] = hashed_password
db_user.sqlmodel_update(user_data, update=extra_data)
session.add(db_user)
session.commit()
session.refresh(db_user)
return db_user


def get_user_by_email(*, session: Session, email: str) -> User | None:
statement = select(User).where(User.email == email)
session_user = session.exec(statement).first()
return session_user


def authenticate(*, session: Session, email: str, password: str) -> User | None:
db_user = get_user_by_email(session=session, email=email)
if not db_user:
return None
if not verify_password(password, db_user.hashed_password):
return None
return db_user

def create_item(*, session: Session, item_in: ItemCreate, owner_id: int) -> Item:
db_item = Item.model_validate(item_in, update={"owner_id": owner_id})
session.add(db_item)
session.commit()
session.refresh(db_item)
return db_item
37 changes: 0 additions & 37 deletions src/backend/app/crud/__init__.py

This file was deleted.

59 changes: 0 additions & 59 deletions src/backend/app/crud/base.py

This file was deleted.

32 changes: 0 additions & 32 deletions src/backend/app/crud/crud_item.py

This file was deleted.

55 changes: 0 additions & 55 deletions src/backend/app/crud/crud_user.py

This file was deleted.

2 changes: 1 addition & 1 deletion src/backend/app/tests/api/api_v1/test_items.py
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
from fastapi.testclient import TestClient
from sqlalchemy.orm import Session
from sqlmodel import Session

from app.core.config import settings
from app.tests.utils.item import create_random_item
Expand Down
16 changes: 8 additions & 8 deletions src/backend/app/tests/api/api_v1/test_users.py
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
from fastapi.testclient import TestClient
from sqlalchemy.orm import Session
from sqlmodel import Session

from app import crud
from app.core.config import settings
from app.schemas.user import UserCreate
from app.models import UserCreate
from app.tests.utils.utils import random_email, random_lower_string


Expand Down Expand Up @@ -42,7 +42,7 @@ def test_create_user_new_email(
)
assert 200 <= r.status_code < 300
created_user = r.json()
user = crud.user.get_by_email(db, email=username)
user = crud.get_user_by_email(session=db, email=username)
assert user
assert user.email == created_user["email"]

Expand All @@ -53,15 +53,15 @@ def test_get_existing_user(
username = random_email()
password = random_lower_string()
user_in = UserCreate(email=username, password=password)
user = crud.user.create(db, obj_in=user_in)
user = crud.create_user(session=db, user_create=user_in)
user_id = user.id
r = client.get(
f"{settings.API_V1_STR}/users/{user_id}",
headers=superuser_token_headers,
)
assert 200 <= r.status_code < 300
api_user = r.json()
existing_user = crud.user.get_by_email(db, email=username)
existing_user = crud.get_user_by_email(session=db, email=username)
assert existing_user
assert existing_user.email == api_user["email"]

Expand All @@ -73,7 +73,7 @@ def test_create_user_existing_username(
# username = email
password = random_lower_string()
user_in = UserCreate(email=username, password=password)
crud.user.create(db, obj_in=user_in)
crud.create_user(session=db, user_create=user_in)
data = {"email": username, "password": password}
r = client.post(
f"{settings.API_V1_STR}/users/",
Expand Down Expand Up @@ -105,12 +105,12 @@ def test_retrieve_users(
username = random_email()
password = random_lower_string()
user_in = UserCreate(email=username, password=password)
crud.user.create(db, obj_in=user_in)
crud.create_user(session=db, user_create=user_in)

username2 = random_email()
password2 = random_lower_string()
user_in2 = UserCreate(email=username2, password=password2)
crud.user.create(db, obj_in=user_in2)
crud.create_user(session=db, user_create=user_in2)

r = client.get(f"{settings.API_V1_STR}/users/", headers=superuser_token_headers)
all_users = r.json()
Expand Down
2 changes: 1 addition & 1 deletion src/backend/app/tests/conftest.py
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

import pytest
from fastapi.testclient import TestClient
from sqlalchemy.orm import Session
from sqlmodel import Session

from app.core.config import settings
from app.db.engine import engine
Expand Down
Loading