update database configurations for multiple DB support

Author: Pythonian

.env.example

@@ -1,7 +1,11 @@
-DB_TYPE=postgresql
-DB_NAME=blogdb
-DB_USER=blogusr
-DB_PASSWORD=blogpwd
+DB_TYPE=sqlite # Options: postgresql, mysql
+DB_NAME=db.sqlite3
+DB_USER=fastapiusr
+DB_PASSWORD=fastapipwd
 DB_HOST=localhost
-DB_PORT=5432
-DB_URL=postgresql://blogusr:blogpwd@localhost:5432/blogdb
+DB_PORT=
+# Uncomment the line below if DB_TYPE=postgresql
+# DB_URL=postgresql://fastapiusr:fastapipwd@localhost:5432/fastapidb
+# Uncomment the line below if DB_TYPE=mysql
+# DB_URL=mysql+pymysql://fastapiusr:fastapipwd@localhost:3306/fastapidb
+MYSQL_DRIVER=

Makefile

@@ -39,29 +39,30 @@ venv: ## Create a virtual environment
 install: ## Install development dependencies
 	$(PIP) install --upgrade pip
 	$(PIP) install -r requirements.txt
-	$(PIP) install pre-commit==3.7.1
-	$(PRE_COMMIT) install
 	cp .env.example .env
 	@echo "Development dependencies has been setup."
 
 migrate: ## Run the database migration
 	$(ALEMBIC) upgrade head
 
 check: ## Run all checks using tox and pre-commit
+	$(PIP) install tox==4.16.0 pre-commit==3.7.1
 	$(TOX)
+	$(PRE_COMMIT) install
 	$(PRE_COMMIT) run --all-files
 	@echo "All checks passed"
 
 run: ## Run the development server
 	$(UVICORN) main:app --reload
 
-clean: ## Clean up the project of unneeded files
-	@echo "Cleaning up the project of unneeded files..."
+clean: ## Clean up the project
+	@echo "Cleaning up the project of temporary files and directories..."
 	@rm -rf $(VENV_DIR)
 	@rm -rf .cache
 	@rm -rf build
 	@rm -rf htmlcov coverage.xml .coverage
 	@rm -rf .tox
+	@rm -rf *.log
 	@rm -rf .mypy_cache
 	@rm -rf .ruff_cache
 	@rm -rf *.egg-info

api/db/database.py

@@ -15,22 +15,21 @@
 
 
 def get_db_engine(test_mode: bool = False):  # type: ignore
-    DATABASE_URL = f"postgresql://{DB_USER}:{DB_PASSWORD}@{DB_HOST}:{DB_PORT}/{DB_NAME}"
-
     if DB_TYPE == "sqlite" or test_mode:
         BASE_PATH = f"sqlite:///{BASE_DIR}"
-        DATABASE_URL = BASE_PATH + "/"
-
-        if test_mode:
-            DATABASE_URL = BASE_PATH + "test.db"
+        DATABASE_URL = BASE_PATH + ("/test.db" if test_mode else "/db.sqlite3")
 
-            return create_engine(
-                DATABASE_URL, connect_args={"check_same_thread": False}
-            )
+        return create_engine(DATABASE_URL, connect_args={"check_same_thread": False})
+    elif DB_TYPE == "mysql":
+        DATABASE_URL = (
+            f"mysql+pymysql://{DB_USER}:{DB_PASSWORD}@{DB_HOST}:{DB_PORT}/{DB_NAME}"
+        )
     elif DB_TYPE == "postgresql":
         DATABASE_URL = (
             f"postgresql://{DB_USER}:{DB_PASSWORD}@{DB_HOST}:{DB_PORT}/{DB_NAME}"
         )
+    else:
+        raise ValueError(f"Unsupported DB_TYPE: {DB_TYPE}")
 
     return create_engine(DATABASE_URL)
 

requirements.txt

@@ -7,4 +7,3 @@ pytest==8.3.1
 pytest-mock==3.14.0
 python-decouple==3.8
 SQLAlchemy==2.0.31
-tox==4.16.0

tests/database.py

@@ -7,19 +7,29 @@
 from api.db.database import Base, get_db
 from main import app
 
-DB_TYPE = config("DB_TYPE")
-DB_NAME = config("DB_NAME")
-DB_USER = config("DB_USER")
-DB_PASSWORD = config("DB_PASSWORD")
-DB_HOST = config("DB_HOST")
-DB_PORT = config("DB_PORT")
-MYSQL_DRIVER = config("MYSQL_DRIVER")
-DATABASE_URL = ""
-
-SQLALCHEMY_DATABASE_URL = f"{DB_TYPE}+{MYSQL_DRIVER}://{DB_USER}:{DB_PASSWORD}@{DB_HOST}:{DB_PORT}/{DB_NAME}_test"
-
-
-engine = create_engine(SQLALCHEMY_DATABASE_URL)
+DB_TYPE = config("DB_TYPE", default="sqlite")
+DB_NAME = config("DB_NAME", default="test.db")
+DB_USER = config("DB_USER", default="")
+DB_PASSWORD = config("DB_PASSWORD", default="")
+DB_HOST = config("DB_HOST", default="")
+DB_PORT = config("DB_PORT", default="")
+MYSQL_DRIVER = config("MYSQL_DRIVER", default="pymysql")
+
+if DB_TYPE == "sqlite":
+    SQLALCHEMY_DATABASE_URL = f"sqlite:///./{DB_NAME}"
+elif DB_TYPE == "mysql":
+    SQLALCHEMY_DATABASE_URL = f"mysql+{MYSQL_DRIVER}://{DB_USER}:{DB_PASSWORD}@{DB_HOST}:{DB_PORT}/{DB_NAME}_test"
+elif DB_TYPE == "postgresql":
+    SQLALCHEMY_DATABASE_URL = (
+        f"postgresql://{DB_USER}:{DB_PASSWORD}@{DB_HOST}:{DB_PORT}/{DB_NAME}_test"
+    )
+else:
+    raise ValueError(f"Unsupported DB_TYPE: {DB_TYPE}")
+
+engine = create_engine(
+    SQLALCHEMY_DATABASE_URL,
+    connect_args={"check_same_thread": False} if DB_TYPE == "sqlite" else {},
+)
 
 TestingSessionLocal = sessionmaker(
     autocommit=False,