Merge pull request #16 from Zerohertz/issue#8/feat/database

[Feat] DB (MySQL) 추가 및 `models`, `repositories`, `services` layer 개발

Author: Zerohertz

.github/workflows/ci.yaml

@@ -88,6 +88,35 @@ jobs:
         if: always()
 
   test:
+    env:
+      DB_ROOT: "password"
+      DB_TYPE: "mysql"
+      DB_DRIVER: "mysqldb"
+      DB_HOST: "127.0.0.1"
+      DB_PORT: 3306
+      DB_USER: "test"
+      DB_PASSWORD: "test"
+      DB_NAME: "test"
+      DB_TABLE_CREATE: true
+    services:
+      mysql:
+        image: mysql:8.0
+        env:
+          MYSQL_ROOT_PASSWORD: ${{ env.DB_ROOT }}
+          # WARN: Kubernetes manifest의 livenessProbe와 다르게 MYSQL_PWD를 설정하면 아래 오류가 발생한다.
+          # ERROR 1045 (28000): Access denied for user 'root'@'localhost' (using password: YES)
+          # MYSQL_PWD: ${{ env.DB_ROOT }}
+          MYSQL_USER: ${{ env.DB_USER }}
+          MYSQL_PASSWORD: ${{ env.DB_PASSWORD}}
+          MYSQL_DATABASE: ${{ env.DB_NAME }}
+        ports:
+          - 3306:3306
+        options: >-
+          --health-cmd="mysqladmin ping"
+          --health-interval=10s
+          --health-timeout=5s
+          --health-retries=3
+
     name: Test
     needs: setup
     runs-on: ubuntu-latest
@@ -103,6 +132,12 @@ jobs:
           restore-keys: |
             ${{ runner.os }}-python-venv-
 
+      # NOTE: 기본적으로 GitHub Actions의 Ubuntu에는 아래 의존성이 설치된 것으로 확인
+      # - name: Install MySQL dependencies
+      #   run: |
+      #     sudo apt-get update
+      #     sudo apt-get install default-libmysqlclient-dev build-essential pkg-config -y
+
       - name: Run pytest
         run: |
           source .venv/bin/activate

.gitignore

@@ -171,9 +171,10 @@ cython_debug/
 .pypirc
 
 # Credentials
-local.env
+dev.env
 prod.env
-local.yaml
+dev.yaml
+secrets.yaml
 
 # Etc
 junit.xml

Dockerfile

@@ -9,7 +9,10 @@ ARG DEBIAN_FRONTEND=noninteractive
 WORKDIR /workspace
 COPY ./ /workspace
 
-RUN apt-get update && apt-get install make tzdata -y && \
+RUN apt-get update && \
+    apt-get install make tzdata \
+    # NOTE: mysqlclient depndencies
+    default-libmysqlclient-dev build-essential pkg-config -y && \
     ln -sf /usr/share/zoneinfo/Asia/Seoul /etc/localtime && \
     dpkg-reconfigure --frontend noninteractive tzdata
 

Makefile

@@ -13,12 +13,37 @@ lint:
 
 .PHONY: test
 test:
-	export DESCRIPTION=$$(cat README.md) && uv run pytest --cov=app --cov-branch --cov-report=xml --junitxml=junit.xml -o junit_family=legacy
+	export DESCRIPTION=$$(cat README.md) && \
+		uv run pytest \
+		--cov=app --cov-branch --cov-report=xml \
+		--junitxml=junit.xml -o junit_family=legacy
 
-.PHONY: local
-local:
-	export DESCRIPTION=$$(cat README.md) && source ./envs/local.env && uv run uvicorn app.main:app --host 0.0.0.0 --port $${PORT} --env-file ./envs/local.env --proxy-headers --forwarded-allow-ips='*' --reload
+.PHONY: dev
+dev:
+	export DESCRIPTION=$$(cat README.md) && \
+		source ./envs/dev.env && \
+		uv run uvicorn app.main:app --host 0.0.0.0 --port $${PORT} \
+		--env-file ./envs/dev.env \
+		--proxy-headers --forwarded-allow-ips='*' \
+		--reload
 
 .PHONY: prod
 prod:
-	export DESCRIPTION=$$(cat README.md) && uv run uvicorn app.main:app --host 0.0.0.0 --env-file ./envs/prod.env --proxy-headers --forwarded-allow-ips='*'
+	export DESCRIPTION=$$(cat README.md) && \
+		uv run uvicorn app.main:app --host 0.0.0.0 \
+		--env-file ./envs/prod.env \
+		--proxy-headers --forwarded-allow-ips='*'
+
+.PHONY: k8s
+k8s:
+	kubectl delete -n fastapi -f k8s/dev.yaml 2> /dev/null || echo "Not deployed to the dev environment! 🌎"
+	kubectl apply -n fastapi -f k8s/secrets.yaml
+	kubectl apply -n fastapi -f k8s/dev.yaml
+
+.PHONY: exec
+exec:
+	kubectl exec -it -n fastapi deploy/fastapi-dev -- zsh
+
+.PHONY: expose
+expose:
+	 kubectl expose -n fastapi po/mysql-0 --port 3306 --type=NodePort

README.md

@@ -20,7 +20,7 @@
 <br />
 <img src="https://img.shields.io/badge/FastAPI-009688?style=for-the-badge&logo=FastAPI&logoColor=white"/>
 <br />
-<img src="https://img.shields.io/badge/uv-DE5FE9?style=flat&logo=uv&logoColor=white"/> <img src="https://img.shields.io/badge/Pydantic-E92063?style=flat&logo=Pydantic&logoColor=white"/> <img src="https://img.shields.io/badge/SQLModel-D71F00?style=flat&logo=SQLAlchemy&logoColor=white"/>
+<img src="https://img.shields.io/badge/uv-DE5FE9?style=flat&logo=uv&logoColor=white"/> <img src="https://img.shields.io/badge/Pydantic-E92063?style=flat&logo=Pydantic&logoColor=white"/> <img src="https://img.shields.io/badge/SQLAlchemy-D71F00?style=flat&logo=SQLAlchemy&logoColor=white"/>
 <br />
 <img src="https://img.shields.io/badge/Pytest-0A9EDC?style=flat&logo=pytest&logoColor=white"/> <a href="https://codecov.io/github/Zerohertz/fastapi-boilerplate" ><img src="https://codecov.io/github/Zerohertz/fastapi-boilerplate/graph/badge.svg?token=8318TEPMVO"/></a> <img src="https://img.shields.io/badge/GitHub Actions-2088FF?style=flat&logo=githubactions&logoColor=white"/>
 <br />

app/api/v1/endpoints/users.py

@@ -1,37 +1,87 @@
-from datetime import datetime
-
-from loguru import logger
+from dependency_injector.wiring import Provide, inject
+from fastapi import Depends
+from starlette import status
 
+from app.core.container import Container
 from app.core.router import CoreAPIRouter
-from app.exceptions.users import (
-    InsufficientFunds,
-    InvalidInput,
-    UnauthorizedAccess,
-    UserNotFound,
-)
-from app.schemas.users import User
+from app.schemas.users import UserCreateRequest, UserCreateResponse
+from app.services.users import UserService
 
 router = CoreAPIRouter(prefix="/user", tags=["user"])
 
 
-@router.get(
+@router.post(
     "",
-    response_model=User,
-    status_code=200,
-    summary="Get User Test",
-    description="1 ~ 4: Error!",
+    response_model=UserCreateResponse,
+    status_code=status.HTTP_201_CREATED,
+    summary="",
+    description="",
+)
+@inject
+async def create_user(
+    user: UserCreateRequest,
+    service: UserService = Depends(Provide[Container.user_service]),
+):
+    return service.create(user)
+
+
+@router.get(
+    "/{id}",
+    response_model=UserCreateResponse,
+    status_code=status.HTTP_200_OK,
+    summary="",
+    description="",
+)
+@inject
+async def get_user(
+    id: int,
+    service: UserService = Depends(Provide[Container.user_service]),
+):
+    return service.get_by_id(id)
+
+
+@router.put(
+    "/{id}",
+    response_model=UserCreateResponse,
+    status_code=status.HTTP_200_OK,
+    summary="",
+    description="",
+)
+@inject
+async def put_user(
+    id: int,
+    user: UserCreateRequest,
+    service: UserService = Depends(Provide[Container.user_service]),
+):
+    return service.put_by_id(id=id, schema=user)
+
+
+@router.patch(
+    "/{id}",
+    response_model=UserCreateResponse,
+    status_code=status.HTTP_200_OK,
+    summary="",
+    description="",
+)
+@inject
+async def patch_user(
+    id: int,
+    user: UserCreateRequest,
+    service: UserService = Depends(Provide[Container.user_service]),
+):
+    return service.patch_by_id(id=id, schema=user)
+
+
+@router.delete(
+    "/{id}",
+    response_model=UserCreateResponse,
+    status_code=status.HTTP_200_OK,
+    summary="",
+    description="",
 )
-async def get_user(user_id: int):
-    try:
-        if user_id == 1:
-            raise InsufficientFunds
-        if user_id == 2:
-            raise InvalidInput
-        if user_id == 3:
-            raise UnauthorizedAccess("Unauthorized.")
-        if user_id == 4:
-            raise UserNotFound("User not found.")
-    except Exception as error:
-        logger.exception(repr(error))
-        raise error
-    return User(id=user_id, created_at=datetime.now(), updated_at=datetime.now())
+@inject
+async def delete_user(
+    id: int,
+    service: UserService = Depends(Provide[Container.user_service]),
+):
+    return service.delete_by_id(id)

app/core/configs.py

@@ -1,11 +1,49 @@
+from typing import Optional
+
+from pydantic import computed_field
+from pydantic_core import MultiHostUrl
 from pydantic_settings import BaseSettings
 
 
 class Configs(BaseSettings):
+    # --------- APP SETTINGS --------- #
     PROJECT_NAME: str
     DESCRIPTION: str
     VERSION: str
     PREFIX: str
 
+    # --------- DATABASE SETTINGS --------- #
+    DB_TYPE: str
+    DB_DRIVER: Optional[str]
+    DB_HOST: Optional[str]
+    DB_PORT: Optional[int] = 0
+    DB_USER: Optional[str]
+    DB_PASSWORD: Optional[str]
+    DB_NAME: Optional[str]
+    DB_ECHO: Optional[bool] = True
+    DB_TABLE_CREATE: Optional[bool] = True
+
+    @property
+    def DB_SCHEME(self) -> str:
+        if self.DB_DRIVER:
+            return f"{self.DB_TYPE}+{self.DB_DRIVER}"
+        return self.DB_TYPE
+
+    @computed_field  # type: ignore[prop-decorator]
+    @property
+    def DATABASE_URI(self) -> str:
+        if self.DB_TYPE == "sqlite" and self.DB_PORT == 0:
+            return f"{self.DB_TYPE}:///{self.DB_NAME}"
+        return str(
+            MultiHostUrl.build(
+                scheme=self.DB_SCHEME,
+                host=self.DB_HOST,
+                port=self.DB_PORT,
+                username=self.DB_USER,
+                password=self.DB_PASSWORD,
+                path=self.DB_NAME,
+            )
+        )
+
 
 configs = Configs()  # type: ignore

app/core/container.py

@@ -0,0 +1,16 @@
+from dependency_injector.containers import DeclarativeContainer, WiringConfiguration
+from dependency_injector.providers import Factory, Singleton
+
+from app.core.database import Database
+from app.repositories.users import UserRepository
+from app.services.users import UserService
+
+
+class Container(DeclarativeContainer):
+    wiring_config = WiringConfiguration(modules=["app.api.v1.endpoints.users"])
+
+    database = Singleton(Database)
+
+    user_repository = Factory(UserRepository, session=database.provided.session)
+
+    user_service = Factory(UserService, user_repository=user_repository)

app/core/database.py

@@ -0,0 +1,34 @@
+from contextlib import contextmanager
+from typing import Any, Generator
+
+from sqlalchemy import create_engine
+from sqlalchemy.orm import Session, scoped_session, sessionmaker
+
+from app.core.configs import configs
+from app.models.base import BaseModel
+
+
+class Database:
+    def __init__(self) -> None:
+        self.engine = create_engine(configs.DATABASE_URI, echo=configs.DB_ECHO)
+        self.scoped_session = scoped_session(
+            sessionmaker(
+                autocommit=False,
+                autoflush=False,
+                bind=self.engine,
+            ),
+        )
+
+    def create_all(self) -> None:
+        BaseModel.metadata.create_all(self.engine)
+
+    @contextmanager
+    def session(self) -> Generator[Any, Any, None]:
+        session: Session = self.scoped_session()
+        try:
+            yield session
+        except Exception:
+            session.rollback()
+            raise
+        finally:
+            session.close()

app/core/lifespan.py

@@ -6,6 +6,8 @@
 from fastapi import FastAPI
 from loguru import logger
 
+from app.core.configs import configs
+from app.core.container import Container
 from app.utils.logging import remove_handler
 
 
@@ -16,11 +18,19 @@ async def lifespan(app: FastAPI):  # pylint: disable=unused-argument
     logger.remove()
     logger.add(
         sys.stderr,
+        level=0,
         format="<green>{time:YYYY-MM-DD HH:mm:ss.SSS}</green> <bg #800a0a>"
         + time.tzname[0]
         + "</bg #800a0a> | <level>{level: <8}</level> | <fg #800a0a>{name}</fg #800a0a>:<fg #800a0a>{function}</fg #800a0a>:<fg #800a0a>{line}</fg #800a0a> - <level>{message}</level>",
         colorize=True,
     )
     # logging.getLogger("uvicorn.access").addHandler(LoguruHandler())
     # logging.getLogger("uvicorn.error").addHandler(LoguruHandler())
+
+    container = Container()
+    if configs.DB_TABLE_CREATE:
+        logger.warning("Create database")
+        database = container.database()
+        database.create_all()
+
     yield