[BAK-10] DB 연결 마법사 구현

README.md

@@ -88,13 +88,13 @@
 
    ```bash
    poetry shell
-   uvicorn app.main:app --reload
+   uvicorn app.main:app --host 0.0.0.0 --port 39722 --reload
    ```
 
    또는 Poetry Run을 사용하여 직접 실행할 수 있습니다.
 
    ```bash
-   poetry run uvicorn main:app --reload
+   poetry run uvicorn main:app --host 0.0.0.0 --port 39722 --reload
    ```
 
 ### **코드 컨벤션 (PEP 8, Ruff, Black)**
@@ -141,24 +141,23 @@
 
 1. **브라우저 확인**
 
-   - 기본 루트 엔드포인트: <http://localhost:8000/>
-   - 헬스 체크 엔드포인트: <http://127.0.0.1:8000/health>
-   - API 문서: <http://127.0.0.1:8000/docs>
+   - 기본 루트 엔드포인트: <http://localhost:39722/>
+   - 헬스 체크 엔드포인트: <http://127.0.0.1:39722/health>
+   - API 문서: <http://127.0.0.1:39722/docs>
 
 2. **CLI로 접속 확인하기**
 
    FastAPI 앱이 poetry run uvicorn main:app --reload 명령어로 실행 중인 상태에서, 새로운 터미널을 열고 다음 curl 명령어를 입력하여 각 엔드포인트의 응답을 확인할 수 있습니다.
 
    - 기본 루트 엔드포인트:
      ```bash
-     curl http://localhost:8000/
+     curl http://localhost:39722/
      ```
    - 헬스 체크 엔드포인트:
      ```bash
-     curl http://localhost:8000/health
+     curl http://localhost:39722/health
      ```
    - API 문서:
      ```bash
-     curl http://localhost:8000/openapi.json
+     curl http://localhost:39722/openapi.json
      ```
-

app/api/api_router.py

@@ -1,10 +1,11 @@
 from fastapi import APIRouter
 
-from app.api import test_api
+from app.api import driver_api, test_api
+
 api_router = APIRouter()
 
 # 테스트 라우터
 api_router.include_router(test_api.router, prefix="/test", tags=["Test"])
 
 # 라우터
-# api_router.include_router(connect_driver.router, prefix="/connections", tags=["Driver"])
+api_router.include_router(driver_api.router, prefix="/connections", tags=["Driver"])

app/api/driver_api.py

@@ -0,0 +1,24 @@
+# app/api/driver_api.py
+
+from fastapi import APIRouter
+
+from app.core.db_driver_enum import DBTypesEnum
+from app.core.exceptions import APIException
+from app.core.status import CommonCode
+from app.schemas.driver_info import DriverInfo
+from app.schemas.response import ResponseMessage
+from app.services.driver_service import db_driver_info
+
+router = APIRouter()
+
+
+@router.get("/drivers/{driverId}", response_model=ResponseMessage[DriverInfo], summary="DB 드라이버 정보 조회 API")
+def read_driver_info(driverId: str):
+    """DB 드라이버 정보 조회"""
+    try:
+        # DBTypesEnum에서 driverID에 맞는 객체를 가져옵니다.
+        db_type_enum = DBTypesEnum[driverId.lower()]
+        return ResponseMessage.success(value=db_driver_info(DriverInfo.from_enum(db_type_enum)))
+    # db_type_enum 유효성 검사 실패
+    except KeyError:
+        raise APIException(CommonCode.INVALID_ENUM_VALUE)

app/api/health.py

@@ -1,7 +1,7 @@
 # app/api/health.py
 from fastapi import APIRouter
 
-router = APIRouter()
+router = APIRouter(tags=["Health"])
 
 
 @router.get("/health")

app/core/db_driver_enum.py

@@ -0,0 +1,13 @@
+# app/core/db_driver_enum.py
+from enum import Enum
+
+
+class DBTypesEnum(Enum):
+    """지원되는 데이터베이스 드라이버 타입"""
+
+    postgresql = "psycopg2"
+    mysql = "mysql.connector"
+    sqlite = "sqlite3"
+    oracle = "cx_Oracle"
+    sqlserver = "pyodbc"
+    mariadb = "pymysql"

app/core/status.py

@@ -1,6 +1,8 @@
 from enum import Enum
+
 from fastapi import status
 
+
 class CommonCode(Enum):
     """
     애플리케이션의 모든 상태 코드를 중앙에서 관리합니다.
@@ -21,13 +23,13 @@ class CommonCode(Enum):
     NO_VALUE = (status.HTTP_400_BAD_REQUEST, "4000", "필수 값이 존재하지 않습니다.")
     DUPLICATION = (status.HTTP_409_CONFLICT, "4001", "이미 존재하는 데이터입니다.")
     NO_SEARCH_DATA = (status.HTTP_404_NOT_FOUND, "4002", "요청한 데이터를 찾을 수 없습니다.")
+    INVALID_ENUM_VALUE = (status.HTTP_422_UNPROCESSABLE_ENTITY, "4003", "지원하지 않는 데이터베이스 값입니다.")
 
     # ==================================
     #    서버 오류 (Server Error) - 5xx
     # ==================================
     FAIL = (status.HTTP_500_INTERNAL_SERVER_ERROR, "9999", "서버 처리 중 오류가 발생했습니다.")
 
-
     def __init__(self, http_status: int, code: str, message: str):
         """Enum 멤버가 생성될 때 각 값을 속성으로 할당합니다."""
         self.http_status = http_status
@@ -39,4 +41,3 @@ def get_message(self, *args) -> str:
         메시지 포맷팅이 필요한 경우, 인자를 받아 완성된 메시지를 반환합니다.
         """
         return self.message % args if args else self.message
-

app/main.py

@@ -4,15 +4,8 @@
 from fastapi import FastAPI
 
 from app.api import health  # 헬스 체크
-from app.core.port import get_available_port  # 동적 포트 할당
 from app.api.api_router import api_router
-
-
-from app.core.exceptions import (
-    APIException,
-    api_exception_handler,
-    generic_exception_handler
-)
+from app.core.exceptions import APIException, api_exception_handler, generic_exception_handler
 
 app = FastAPI()
 
@@ -24,13 +17,7 @@
 app.include_router(health.router)
 app.include_router(api_router, prefix="/api")
 
-@app.get("/")
-async def read_root():
-    return {"message": "Hello, FastAPI Backend!"}
-
 
 if __name__ == "__main__":
-    # 동적 할당 로직
-    port = get_available_port()
     # Uvicorn 서버를 시작합니다.
-    uvicorn.run(app, host="0.0.0.0", port=port)
+    uvicorn.run(app, host="0.0.0.0", port=39722)

app/schemas/driver_info.py

@@ -0,0 +1,38 @@
+# app/schemas/driver_info.py
+from pydantic import BaseModel
+
+from app.core.db_driver_enum import DBTypesEnum
+
+
+class DriverInfo(BaseModel):
+    db_type: str
+    is_installed: bool
+    driver_name: str | None
+    driver_version: str | None
+    driver_size_bytes: int | None
+
+    def update_from_module(self, version: str | None, size: int | None):
+        """
+        객체 자신의 속성을 직접 업데이트하여 설치된 드라이버 정보를 채웁니다.
+        """
+        self.is_installed = True
+        self.driver_version = version
+        self.driver_size_bytes = size
+
+        return self
+
+    @classmethod
+    def from_enum(cls, db_type_enum: DBTypesEnum):
+        """
+        DBTypesEnum 객체를 인자로 받아, db_type, driver_name만으로 driverInfo 객체를 생성합니다.
+        `is_installed`는 False로 설정됩니다.
+        """
+        db_type = db_type_enum.name
+        driver_name = db_type_enum.value
+        return cls(
+            db_type=db_type,
+            is_installed=False,
+            driver_name=driver_name,
+            driver_version=None,
+            driver_size_bytes=None,
+        )

app/services/driver_service.py

@@ -0,0 +1,20 @@
+# app/service/driver_service.py
+import importlib
+import os
+
+from app.core.exceptions import APIException
+from app.core.status import CommonCode
+from app.schemas.driver_info import DriverInfo
+
+
+def db_driver_info(driver_info: DriverInfo):
+    try:
+        mod = importlib.import_module(driver_info.driver_name)
+        version = getattr(mod, "__version__", None)
+        path = getattr(mod.__spec__, "origin", None)
+        size = os.path.getsize(path) if path else None
+
+        return driver_info.update_from_module(version, size)
+
+    except (ModuleNotFoundError, AttributeError, OSError):
+        raise APIException(CommonCode.FAIL)