merge: feat: add DB related features (#4)

feat: add DB related features

.env.ci

@@ -15,5 +15,5 @@ GENKAIERA_IS_TEST=1
 # Database
 GENKAIERA_POSTGRES_HOST=postgres
 GENKAIERA_POSTGRES_PORT=5432
-GENKAIERA_POSTGRES_USER=genkaiera_api
+GENKAIERA_POSTGRES_USER=genkaiera_app
 GENKAIERA_POSTGRES_PASSWORD=hM7UCyG61f5aKKy8LOuWlfEhZffuD9gCRia3w+rKrYg0I3sa3PaKP4e7IDrXNfmd

.env.example

@@ -15,5 +15,5 @@ GENKAIERA_IS_TEST=0
 # Database
 GENKAIERA_POSTGRES_HOST=postgres
 GENKAIERA_POSTGRES_PORT=5432
-GENKAIERA_POSTGRES_USER=genkaiera_api
+GENKAIERA_POSTGRES_USER=genkaiera_app
 GENKAIERA_POSTGRES_PASSWORD=hM7UCyG61f5aKKy8LOuWlfEhZffuD9gCRia3w+rKrYg0I3sa3PaKP4e7IDrXNfmd

.env.local

@@ -15,5 +15,5 @@ GENKAIERA_IS_TEST=0
 # Database
 GENKAIERA_POSTGRES_HOST=postgres
 GENKAIERA_POSTGRES_PORT=5432
-GENKAIERA_POSTGRES_USER=genkaiera_api
+GENKAIERA_POSTGRES_USER=genkaiera_app
 GENKAIERA_POSTGRES_PASSWORD=hM7UCyG61f5aKKy8LOuWlfEhZffuD9gCRia3w+rKrYg0I3sa3PaKP4e7IDrXNfmd

.env.test

@@ -15,5 +15,5 @@ GENKAIERA_IS_TEST=1
 # Database
 GENKAIERA_POSTGRES_HOST=postgres
 GENKAIERA_POSTGRES_PORT=5432
-GENKAIERA_POSTGRES_USER=genkaiera_api
+GENKAIERA_POSTGRES_USER=genkaiera_app
 GENKAIERA_POSTGRES_PASSWORD=hM7UCyG61f5aKKy8LOuWlfEhZffuD9gCRia3w+rKrYg0I3sa3PaKP4e7IDrXNfmd

Makefile

@@ -41,6 +41,10 @@ build:
 up:
 	docker compose up -d --build
 
+.PHONY: init
+init:
+	$(MAKE) online_migrate
+
 .PHONY: down
 down:
 	docker compose down
@@ -61,6 +65,18 @@ logs:
 shell:
 	docker compose run --rm app bash
 
+.PHONY: online_migrate
+online_migrate:
+	docker compose run --rm app bash -c "python ./script/database.py --online"
+
+.PHONY: offline_migrate
+offline_migrate:
+	docker compose run --rm app bash -c "python ./script/database.py"
+
+.PHONY: make_migration
+make_migration:
+	docker compose run --rm app bash -c "python ./script/run_command.py alembic revision --autogenerate"
+
 .PHONY: flake8
 flake8:
 	docker compose run --rm app bash -c "python ./script/run_command.py flake8 ./"
@@ -87,13 +103,16 @@ isort_check:
 
 .PHONY: pytest_html
 pytest_html:
+	$(MAKE) online_migrate
 	docker compose run --rm app bash -c "python ./script/run_command.py pytest -v ./test/ --cov=./src/ --cov-report=html --html=report.html"
 
 .PHONY: pytest_xml
 pytest_xml:
+	$(MAKE) online_migrate
 	docker compose run --rm app bash -c "python ./script/run_command.py pytest -v ./test/ --cov=./src/ --cov-report=xml"
 
 .PHONY: pytest_ci
 pytest_ci:
 	$(MAKE) up
-	docker compose run --rm app bash -c "python r./script/un_command.py pytest -v ./test/ --cov=./src/ --junitxml=pytest.xml --cov-report=term-missing:skip-covered | tee pytest-coverage.txt"
+	$(MAKE) online_migrate
+	docker compose run --rm app bash -c "python ./script/run_command.py pytest -v ./test/ --cov=./src/ --junitxml=pytest.xml --cov-report=term-missing:skip-covered | tee pytest-coverage.txt"

alembic.ini

@@ -0,0 +1,114 @@
+# A generic, single database configuration.
+
+[alembic]
+# path to migration scripts
+script_location = migration
+
+# template used to generate migration file names; The default value is %%(rev)s_%%(slug)s
+# Uncomment the line below if you want the files to be prepended with date and time
+# file_template = %%(year)d_%%(month).2d_%%(day).2d_%%(hour).2d%%(minute).2d-%%(rev)s_%%(slug)s
+
+# sys.path path, will be prepended to sys.path if present.
+# defaults to the current working directory.
+prepend_sys_path = .
+
+# timezone to use when rendering the date within the migration file
+# as well as the filename.
+# If specified, requires the python-dateutil library that can be
+# installed by adding `alembic[tz]` to the pip requirements
+# string value is passed to dateutil.tz.gettz()
+# leave blank for localtime
+# timezone =
+
+# max length of characters to apply to the
+# "slug" field
+# truncate_slug_length = 40
+
+# set to 'true' to run the environment during
+# the 'revision' command, regardless of autogenerate
+# revision_environment = false
+
+# set to 'true' to allow .pyc and .pyo files without
+# a source .py file to be detected as revisions in the
+# versions/ directory
+# sourceless = false
+
+# version location specification; This defaults
+# to migration/versions.  When using multiple version
+# directories, initial revisions must be specified with --version-path.
+# The path separator used here should be the separator specified by "version_path_separator" below.
+# version_locations = %(here)s/bar:%(here)s/bat:migration/versions
+
+# version path separator; As mentioned above, this is the character used to split
+# version_locations. The default within new alembic.ini files is "os", which uses os.pathsep.
+# If this key is omitted entirely, it falls back to the legacy behavior of splitting on spaces and/or commas.
+# Valid values for version_path_separator are:
+#
+# version_path_separator = :
+# version_path_separator = ;
+# version_path_separator = space
+version_path_separator = os  # Use os.pathsep. Default configuration used for new projects.
+
+# set to 'true' to search source files recursively
+# in each "version_locations" directory
+# new in Alembic version 1.10
+# recursive_version_locations = false
+
+# the output encoding used when revision files
+# are written from script.py.mako
+# output_encoding = utf-8
+
+sqlalchemy.url = driver://user:pass@localhost/dbname
+
+
+[post_write_hooks]
+# post_write_hooks defines scripts or Python functions that are run
+# on newly generated revision scripts.  See the documentation for further
+# detail and examples
+
+# format using "black" - use the console_scripts runner, against the "black" entrypoint
+# hooks = black
+# black.type = console_scripts
+# black.entrypoint = black
+# black.options = -l 79 REVISION_SCRIPT_FILENAME
+
+# lint with attempts to fix using "ruff" - use the exec runner, execute a binary
+# hooks = ruff
+# ruff.type = exec
+# ruff.executable = %(here)s/.venv/bin/ruff
+# ruff.options = --fix REVISION_SCRIPT_FILENAME
+
+# Logging configuration
+[loggers]
+keys = root,sqlalchemy,alembic
+
+[handlers]
+keys = console
+
+[formatters]
+keys = generic
+
+[logger_root]
+level = WARN
+handlers = console
+qualname =
+
+[logger_sqlalchemy]
+level = WARN
+handlers =
+qualname = sqlalchemy.engine
+
+[logger_alembic]
+level = INFO
+handlers =
+qualname = alembic
+
+[handler_console]
+class = StreamHandler
+args = (sys.stderr,)
+level = NOTSET
+formatter = generic
+
+[formatter_generic]
+format = %(levelname)-5.5s [%(name)s] %(message)s
+datefmt = %H:%M:%S

config.py

@@ -0,0 +1,42 @@
+from pydantic_settings import BaseSettings, SettingsConfigDict
+
+
+class GenkaiEraConfig(BaseSettings):
+    model_config = SettingsConfigDict(env_prefix="GENKAIERA_", case_sensitive=True)
+
+    IS_CI: int = 0
+    IS_TEST: int = 0
+
+    POSTGRES_HOST: str
+    POSTGRES_PORT: str
+    POSTGRES_DB_NAME: str = "genkaiera"
+    POSTGRES_USER: str
+    POSTGRES_PASSWORD: str
+
+    POSTGRES_CONNECT_ARGS: dict[str, str] = {}
+    POSTGRES_EXPIRE_ON_COMMIT: bool = False
+    POSTGRES_AUTOCOMMIT: bool = False
+    POSTGRES_AUTOFLUSH: bool = False
+
+    def get_postgres_dsn(self) -> str:
+        result: str = (
+            f"postgresql+asyncpg://"
+            f"{self.POSTGRES_USER}:{self.POSTGRES_PASSWORD}@"
+            f"{self.POSTGRES_HOST}:{self.POSTGRES_PORT}/"
+            f"{self.POSTGRES_DB_NAME}"
+        )
+
+        return result
+
+
+test_settings = SettingsConfigDict(
+    env_prefix="GENKAIERA_",
+    case_sensitive=True,
+    env_file="./test.env",
+)
+
+
+class GenkaiEraTestConfig(GenkaiEraConfig):
+    model_config = test_settings
+
+    POSTGRES_DB_NAME: str = "genkaiera_test"

migration/env.py

@@ -0,0 +1,92 @@
+import asyncio
+from logging.config import fileConfig
+
+from alembic import context
+from sqlalchemy.engine import Connection
+
+from config import GenkaiEraConfig
+from src.di.container import container
+from src.infrastructure.database.sqlalchemy.model.base.model import SABaseModel
+from src.infrastructure.database.sqlalchemy.session import SAAsyncSessionManager
+
+# this is the Alembic Config object, which provides
+# access to the values within the .ini file in use.
+config = context.config
+
+# Interpret the config file for Python logging.
+# This line sets up loggers basically.
+if config.config_file_name is not None:
+    fileConfig(config.config_file_name)
+
+# add your model's MetaData object here
+# for 'autogenerate' support
+# from myapp import mymodel
+# target_metadata = mymodel.Base.metadata
+target_metadata = (SABaseModel.metadata,)
+
+# other values from the config, defined by the needs of env.py,
+# can be acquired:
+# my_important_option = config.get_main_option("my_important_option")
+# ... etc.
+
+_ = ()
+
+sa_manager: SAAsyncSessionManager = container.get(SAAsyncSessionManager)
+
+
+def run_migrations_offline() -> None:
+    """Run migrations in 'offline' mode.
+
+    This configures the context with just a URL
+    and not an Engine, though an Engine is acceptable
+    here as well.  By skipping the Engine creation
+    we don't even need a DBAPI to be available.
+
+    Calls to context.execute() here emit the given string to the
+    script output.
+
+    """
+
+    url = GenkaiEraConfig().get_postgres_dsn()  # type: ignore
+    context.configure(
+        url=url,
+        target_metadata=target_metadata,  # type: ignore
+        literal_binds=True,
+        dialect_opts={"paramstyle": "named"},
+    )
+
+    with context.begin_transaction():
+        context.run_migrations()
+
+
+def do_run_migrations(connection: Connection) -> None:
+    context.configure(connection=connection, target_metadata=target_metadata)
+
+    with context.begin_transaction():
+        context.run_migrations()
+
+
+async def run_async_migrations() -> None:
+    """In this scenario we need to create an Engine
+    and associate a connection with the context.
+
+    """
+
+    connectable = sa_manager.get_async_engine()
+
+    async with connectable.connect() as connection:
+        await connection.run_sync(do_run_migrations)
+
+    await connectable.dispose()
+
+
+def run_migrations_online() -> None:
+    """Run migrations in 'online' mode."""
+
+    asyncio.run(run_async_migrations())
+
+
+if context.is_offline_mode():
+    run_migrations_offline()
+else:
+    run_migrations_online()

migration/script.py.mako

@@ -0,0 +1,28 @@
+"""${message}
+
+Revision ID: ${up_revision}
+Revises: ${down_revision | comma,n}
+Create Date: ${create_date}
+
+"""
+from typing import Sequence, Union
+
+from alembic import op
+import sqlalchemy as sa
+${imports if imports else ""}
+
+import src
+
+# revision identifiers, used by Alembic.
+revision: str = ${repr(up_revision)}
+down_revision: Union[str, None] = ${repr(down_revision)}
+branch_labels: Union[str, Sequence[str], None] = ${repr(branch_labels)}
+depends_on: Union[str, Sequence[str], None] = ${repr(depends_on)}
+
+
+def upgrade() -> None:
+    ${upgrades if upgrades else "pass"}
+
+
+def downgrade() -> None:
+    ${downgrades if downgrades else "pass"}

migration/versions/fbab55528ed7_.py

@@ -0,0 +1,26 @@
+"""empty message
+
+Revision ID: fbab55528ed7
+Revises: 
+Create Date: 2024-01-04 19:11:09.055615
+
+"""
+from typing import Sequence, Union
+
+# revision identifiers, used by Alembic.
+revision: str = "fbab55528ed7"
+down_revision: Union[str, None] = None
+branch_labels: Union[str, Sequence[str], None] = None
+depends_on: Union[str, Sequence[str], None] = None
+
+
+def upgrade() -> None:
+    # ### commands auto generated by Alembic - please adjust! ###
+    pass
+    # ### end Alembic commands ###
+
+
+def downgrade() -> None:
+    # ### commands auto generated by Alembic - please adjust! ###
+    pass
+    # ### end Alembic commands ###