Add alembic migrations

Makefile

@@ -13,11 +13,20 @@ install-dev:
 	$(VENV_DIR)/bin/pip install -r $(REQ_FILE) -r requirements-dev.txt
 
 start:
-	docker compose up
+	docker compose up --build
 
 clean-db:
 	docker compose down
 	docker compose down -v db
 
 clean:
-	rm -rf $(VENV_DIR)
+	rm -rf $(VENV_DIR)
+
+create-migration:
+	@read -p "Enter migration message: " MESSAGE; \
+	if [ -z "$$MESSAGE" ]; then \
+	    echo "Migration message cannot be empty."; \
+	    exit 1; \
+	fi; \
+	docker compose up -d db
+	cd backend && alembic revision --autogenerate -m "$$MESSAGE"

backend/Dockerfile

@@ -7,6 +7,8 @@ RUN pip install --no-cache-dir -r requirements.txt
 
 COPY ./app /code/app
 COPY .env /code/.env
+COPY ./alembic.ini /code/alembic.ini
+COPY ./migrations /code/migrations
 
 EXPOSE 8080
 

backend/alembic.ini

@@ -0,0 +1,117 @@
+# A generic, single database configuration.
+
+[alembic]
+# path to migration scripts
+# Use forward slashes (/) also on windows to provide an os agnostic path
+script_location = ./migrations
+
+# 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
+
+# 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>=3.9 or backports.zoneinfo library.
+# Any required deps can 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 backend/migrations/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:backend/migrations/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 = newline
+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 = 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

backend/app/main.py

@@ -1,7 +1,7 @@
 from fastapi import FastAPI, Depends
 from fastapi.middleware.cors import CORSMiddleware
 
-from .providers.db_provider import create_db_and_tables
+from .providers.db_provider import create_db_and_tables, startup_migrations
 from .routers.houses import router as houses_router
 from .routers.owners import router as owners_router
 from .middleware.authenticate import authenticate
@@ -10,6 +10,7 @@ from contextlib import asynccontextmanager
 
 @asynccontextmanager
 async def lifespan(_app: FastAPI):
+    startup_migrations()
     create_db_and_tables()
     yield
 

backend/app/providers/db_provider.py

@@ -11,6 +11,8 @@ from sqlalchemy.ext.asyncio import (
 )
 from sqlmodel import create_engine, SQLModel
 from sqlalchemy.orm import Session
+import os
+import subprocess
 
 from ..models.user import User
 
@@ -80,3 +82,13 @@ def create_db_and_tables():
     engine = _get_engine()
     SQLModel.metadata.create_all(engine)
     _seed_db()
+
+def startup_migrations():
+    print("Running Alembic migrations...")
+
+    backend_path = os.path.dirname(os.path.abspath(__file__)) + "/../.."
+    try:
+        subprocess.run(["alembic", "upgrade", "head"], check=True, cwd=backend_path)
+        print("Migrations applied successfully!")
+    except subprocess.CalledProcessError as e:
+        print(f"Error applying migrations: {e}")

backend/migrations/README

@@ -0,0 +1 @@
+Generic single-database configuration.

backend/migrations/env.py

@@ -0,0 +1,77 @@
+from logging.config import fileConfig
+
+from sqlalchemy.engine import Connection
+from sqlmodel import SQLModel
+from app.providers.db_provider import get_connection
+
+from alembic import context
+
+import asyncio
+
+# 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 = SQLModel.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 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:
+    async with get_connection() as connection:
+        await connection.run_sync(do_run_migrations)
+
+
+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()

backend/migrations/script.py.mako

@@ -0,0 +1,27 @@
+"""${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
+import sqlmodel.sql.sqltypes
+${imports if imports else ""}
+
+# 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"}

backend/migrations/versions/bbee168ba406_.py

@@ -0,0 +1,49 @@
+"""
+
+Revision ID: bbee168ba406
+Revises: 
+Create Date: 2025-02-19 15:48:47.075283
+
+"""
+from typing import Sequence, Union
+
+from alembic import op
+import sqlalchemy as sa
+import sqlmodel.sql.sqltypes
+
+
+# revision identifiers, used by Alembic.
+revision: str = 'bbee168ba406'
+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! ###
+    op.drop_table('house')
+    op.drop_table('owner')
+    # ### end Alembic commands ###
+
+
+def downgrade() -> None:
+    # ### commands auto generated by Alembic - please adjust! ###
+    op.create_table('owner',
+    sa.Column('id', sa.UUID(), autoincrement=False, nullable=False),
+    sa.Column('user_id', sa.UUID(), autoincrement=False, nullable=False),
+    sa.ForeignKeyConstraint(['user_id'], ['user.id'], name='owner_user_id_fkey'),
+    sa.PrimaryKeyConstraint('id', name='owner_pkey'),
+    postgresql_ignore_search_path=False
+    )
+    op.create_table('house',
+    sa.Column('id', sa.UUID(), autoincrement=False, nullable=False),
+    sa.Column('address', sa.VARCHAR(), autoincrement=False, nullable=False),
+    sa.Column('city', sa.VARCHAR(), autoincrement=False, nullable=False),
+    sa.Column('country', sa.VARCHAR(), autoincrement=False, nullable=False),
+    sa.Column('price', sa.DOUBLE_PRECISION(precision=53), autoincrement=False, nullable=False),
+    sa.Column('description', sa.VARCHAR(), autoincrement=False, nullable=False),
+    sa.Column('owner_id', sa.UUID(), autoincrement=False, nullable=False),
+    sa.ForeignKeyConstraint(['owner_id'], ['owner.id'], name='house_owner_id_fkey'),
+    sa.PrimaryKeyConstraint('id', name='house_pkey')
+    )
+    # ### end Alembic commands ###

backend/requirements.txt

@@ -6,3 +6,5 @@ sqlalchemy
 pydantic-settings
 python-dotenv
 pg8000
+alembic
+asyncpg