diff --git a/Makefile b/Makefile index e350134..2571ac6 100644 --- a/Makefile +++ b/Makefile @@ -45,3 +45,15 @@ create-venv: .PHONY: test test: ./test.sh + +.PHONY: alembic +alembic: + docker compose exec -e MSG="$(MSG)" api bash -c 'alembic revision --autogenerate -m "$${MSG}"' + +.PHONY: alembic-upgrade +alembic-upgrade: + docker compose exec api bash -c 'alembic upgrade head' + +.PHONY: alembic-downgrade +alembic-downgrade: + docker compose exec api bash -c 'alembic downgrade -1' diff --git a/alembic.ini b/alembic.ini new file mode 100644 index 0000000..17cb6e7 --- /dev/null +++ b/alembic.ini @@ -0,0 +1,149 @@ +# A generic, single database configuration. + +[alembic] +# path to migration scripts. +# this is typically a path given in POSIX (e.g. forward slashes) +# format, relative to the token %(here)s which refers to the location of this +# ini file +script_location = %(here)s/alembic + +# 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 +# see https://alembic.sqlalchemy.org/en/latest/tutorial.html#editing-the-ini-file +# for all available tokens +# file_template = %%(year)d_%%(month).2d_%%(day).2d_%%(hour).2d%%(minute).2d-%%(rev)s_%%(slug)s +# Or organize into date-based subdirectories (requires recursive_version_locations = true) +# file_template = %%(year)d/%%(month).2d/%%(day).2d_%%(hour).2d%%(minute).2d_%%(second).2d_%%(rev)s_%%(slug)s + +# sys.path path, will be prepended to sys.path if present. +# defaults to the current working directory. for multiple paths, the path separator +# is defined by "path_separator" below. +prepend_sys_path = . + + +# timezone to use when rendering the date within the migration file +# as well as the filename. +# If specified, requires the tzdata library which can be installed by adding +# `alembic[tz]` to the pip requirements. +# string value is passed to ZoneInfo() +# 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 /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 "path_separator" +# below. +# version_locations = %(here)s/bar:%(here)s/bat:%(here)s/alembic/versions + +# path_separator; This indicates what character is used to split lists of file +# paths, including version_locations and prepend_sys_path within configparser +# files such as alembic.ini. +# The default rendered in new alembic.ini files is "os", which uses os.pathsep +# to provide os-dependent path splitting. +# +# Note that in order to support legacy alembic.ini files, this default does NOT +# take place if path_separator is not present in alembic.ini. If this +# option is omitted entirely, fallback logic is as follows: +# +# 1. Parsing of the version_locations option falls back to using the legacy +# "version_path_separator" key, which if absent then falls back to the legacy +# behavior of splitting on spaces and/or commas. +# 2. Parsing of the prepend_sys_path option falls back to the legacy +# behavior of splitting on spaces, commas, or colons. +# +# Valid values for path_separator are: +# +# path_separator = : +# path_separator = ; +# path_separator = space +# path_separator = newline +# +# Use os.pathsep. Default configuration used for new projects. +path_separator = os + +# 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 + +# database URL. This is consumed by the user-maintained env.py script only. +# other means of configuring database URLs may be customized within the env.py +# file. +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 module runner, against the "ruff" module +# hooks = ruff +# ruff.type = module +# ruff.module = ruff +# ruff.options = check --fix REVISION_SCRIPT_FILENAME + +# Alternatively, use the exec runner to execute a binary found on your PATH +# hooks = ruff +# ruff.type = exec +# ruff.executable = ruff +# ruff.options = check --fix REVISION_SCRIPT_FILENAME + +# Logging configuration. This is also consumed by the user-maintained +# env.py script only. +[loggers] +keys = root,sqlalchemy,alembic + +[handlers] +keys = console + +[formatters] +keys = generic + +[logger_root] +level = WARNING +handlers = console +qualname = + +[logger_sqlalchemy] +level = WARNING +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 diff --git a/alembic/README b/alembic/README new file mode 100644 index 0000000..98e4f9c --- /dev/null +++ b/alembic/README @@ -0,0 +1 @@ +Generic single-database configuration. \ No newline at end of file diff --git a/alembic/env.py b/alembic/env.py new file mode 100644 index 0000000..d5d2406 --- /dev/null +++ b/alembic/env.py @@ -0,0 +1,81 @@ +from logging.config import fileConfig + +from sqlalchemy import engine_from_config +from sqlalchemy import pool + +from alembic import context +from fooder.domain import Base +from fooder.settings import settings + +# this is the Alembic Config object, which provides +# access to the values within the .ini file in use. +config = context.config + +sync_url = settings.DB_URI.replace("+asyncpg", "").replace("+aiosqlite", "") +config.set_main_option("sqlalchemy.url", sync_url) + +# 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 = Base.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. + + +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 = config.get_main_option("sqlalchemy.url") + context.configure( + url=url, + target_metadata=target_metadata, + literal_binds=True, + dialect_opts={"paramstyle": "named"}, + ) + + with context.begin_transaction(): + context.run_migrations() + + +def run_migrations_online() -> None: + """Run migrations in 'online' mode. + + In this scenario we need to create an Engine + and associate a connection with the context. + + """ + connectable = engine_from_config( + config.get_section(config.config_ini_section, {}), + prefix="sqlalchemy.", + poolclass=pool.NullPool, + ) + + with connectable.connect() as connection: + context.configure(connection=connection, target_metadata=target_metadata) + + with context.begin_transaction(): + context.run_migrations() + + +if context.is_offline_mode(): + run_migrations_offline() +else: + run_migrations_online() diff --git a/alembic/script.py.mako b/alembic/script.py.mako new file mode 100644 index 0000000..1101630 --- /dev/null +++ b/alembic/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 ""} + +# revision identifiers, used by Alembic. +revision: str = ${repr(up_revision)} +down_revision: Union[str, Sequence[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: + """Upgrade schema.""" + ${upgrades if upgrades else "pass"} + + +def downgrade() -> None: + """Downgrade schema.""" + ${downgrades if downgrades else "pass"} diff --git a/alembic/versions/97d77db27867_.py b/alembic/versions/97d77db27867_.py new file mode 100644 index 0000000..1e44604 --- /dev/null +++ b/alembic/versions/97d77db27867_.py @@ -0,0 +1,32 @@ +""" + +Revision ID: 97d77db27867 +Revises: +Create Date: 2026-04-02 19:03:34.833774 + +""" + +from typing import Sequence, Union + +from alembic import op +import sqlalchemy as sa + +# revision identifiers, used by Alembic. +revision: str = "97d77db27867" +down_revision: Union[str, Sequence[str], None] = None +branch_labels: Union[str, Sequence[str], None] = None +depends_on: Union[str, Sequence[str], None] = None + + +def upgrade() -> None: + """Upgrade schema.""" + # ### commands auto generated by Alembic - please adjust! ### + pass + # ### end Alembic commands ### + + +def downgrade() -> None: + """Downgrade schema.""" + # ### commands auto generated by Alembic - please adjust! ### + pass + # ### end Alembic commands ### diff --git a/docker-compose.yml b/docker-compose.yml index e8bdb59..ac2df6b 100644 --- a/docker-compose.yml +++ b/docker-compose.yml @@ -1,5 +1,3 @@ -version: '3' - networks: fooder: driver: bridge @@ -26,26 +24,8 @@ services: - .env ports: - "8000:8000" + volumes: + - ./fooder:/opt/fooder/fooder:ro,z + - ./alembic:/opt/fooder/alembic:rw,z + - ./alembic.ini:/opt/fooder/alembic.ini:ro command: "uvicorn fooder.app:app --host 0.0.0.0 --port 8000 --workers 1 --reload" - - tasks: - restart: unless-stopped - image: registry.domandoman.xyz/fooder/api - networks: - - fooder - platform: linux/amd64 - env_file: - - .env - command: "uvicorn fooder.tasks_app:app --host 0.0.0.0 --port 8000 --workers 1 --reload" - - cron: - restart: unless-stopped - image: registry.domandoman.xyz/fooder/cron - build: - dockerfile: Dockerfile.cron - context: . - platform: linux/amd64 - networks: - - fooder - env_file: - - .env diff --git a/fooder/context.py b/fooder/context.py index 5bbf09f..f824dce 100644 --- a/fooder/context.py +++ b/fooder/context.py @@ -1,6 +1,7 @@ from sqlalchemy.ext.asyncio import AsyncSession from fastapi import Depends -from fooder.db import get_db_session +from .db import get_db_session +from .repository import Repository class Context: @@ -8,8 +9,8 @@ class Context: Main API context, aggregating dependencies """ - def __init__(self, dbssn: AsyncSession) -> None: - self.dbssn = dbssn + def __init__(self, repo: Repository) -> None: + self.repo = Repository class ContextDependency: @@ -25,6 +26,6 @@ class ContextDependency: def __call__( self, - dbssn: AsyncSession = Depends(get_db_session), + session: AsyncSession = Depends(get_db_session), ): - return Context(dbssn=dbssn) + return Context(repo=Repository(session)) diff --git a/requirements/docker.txt b/requirements/docker.txt index 2ea3556..ba4a37f 100644 --- a/requirements/docker.txt +++ b/requirements/docker.txt @@ -2,6 +2,7 @@ fastapi pydantic pydantic-settings sqlalchemy[postgresql_asyncpg] +alembic uvicorn[standard] asyncpg psycopg2-binary==2.9.3 @@ -10,3 +11,4 @@ bcrypt<5.0.0 passlib[bcrypt] fastapi-users requests +black # for alembic diff --git a/requirements/local.txt b/requirements/local.txt index 2e90aa7..593fa63 100644 --- a/requirements/local.txt +++ b/requirements/local.txt @@ -2,6 +2,7 @@ fastapi pydantic pydantic-settings sqlalchemy[postgresql_asyncpg] +alembic uvicorn[standard] python-jose[cryptography] bcrypt<5.0.0