database auto migrations should work now

This commit is contained in:
Linus Vogel 2025-12-24 12:18:31 +01:00
parent f204040ed0
commit d79ba5d208
12 changed files with 182 additions and 25 deletions

148
alembic.ini Normal file
View File

@ -0,0 +1,148 @@
# 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/pillar_tool/db/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. 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 <script_location>/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.
# Note: this is overridden in the env.py file and not necessary here
#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

View File

@ -2,5 +2,5 @@
user = "db user" user = "db user"
password = "db password" password = "db password"
host = "db host" host = "db host"
post = 5432 port = 5432
database = "db name" database = "db name"

View File

@ -1,3 +1,8 @@
# load config so everything else can work
from pillar_tool.util import load_config, config
load_config()
from contextlib import asynccontextmanager from contextlib import asynccontextmanager
from fastapi import FastAPI from fastapi import FastAPI
@ -7,12 +12,8 @@ from fastapi.responses import HTMLResponse, PlainTextResponse
from starlette.responses import JSONResponse from starlette.responses import JSONResponse
from pillar_tool.middleware.basicauth_backend import BasicAuthBackend from pillar_tool.middleware.basicauth_backend import BasicAuthBackend
from pillar_tool.util import load_config, config
from pillar_tool.db import run_db_migrations from pillar_tool.db import run_db_migrations
# load config so everything else can work
load_config()
@asynccontextmanager @asynccontextmanager
async def app_lifespan(app: FastAPI): async def app_lifespan(app: FastAPI):

View File

@ -7,7 +7,7 @@ from alembic.command import upgrade
from pillar_tool.util import config from pillar_tool.util import config
from models import * from .models import *
cfg = config() cfg = config()
user = cfg.db.user user = cfg.db.user
@ -17,7 +17,7 @@ port = cfg.db.port
database = cfg.db.database database = cfg.db.database
alembic_cfg = Config() alembic_cfg = Config()
alembic_cfg.set_main_option('script_location', f'{os.path.dirname(os.path.realpath(__file__))}/migrations') alembic_cfg.set_main_option('script_location', f'{os.path.dirname(os.path.realpath(__file__))}/migrations')
alembic_cfg.set_main_option('sqlalchemy.url', f'postgres://{user}:{password}@{host}:{port}/{database}') alembic_cfg.set_main_option('sqlalchemy.url', f'postgresql://{user}:{password}@{host}:{port}/{database}')
alembic_cfg.set_main_option('prepend_sys_path', '.') alembic_cfg.set_main_option('prepend_sys_path', '.')

View File

@ -10,7 +10,7 @@ SessionLocal = sessionmaker(
autocommit=False, autocommit=False,
autoflush=False, autoflush=False,
bind=create_engine( bind=create_engine(
url=f"postgresql+psycopg2://{cfg.db.user}:{cfg.db.password}@{cfg.host}:{cfg.port}/{cfg.database}" url=f"postgresql+psycopg2://{cfg.db.user}:{cfg.db.password}@{cfg.db.host}:{cfg.db.port}/{cfg.db.database}"
) )
) )

View File

View File

@ -6,6 +6,8 @@ from sqlalchemy import pool
from alembic import context from alembic import context
from pillar_tool.db.database import Base
# this is the Alembic Config object, which provides # this is the Alembic Config object, which provides
# access to the values within the .ini file in use. # access to the values within the .ini file in use.
config = context.config config = context.config
@ -19,13 +21,22 @@ if config.config_file_name is not None:
# for 'autogenerate' support # for 'autogenerate' support
# from myapp import mymodel # from myapp import mymodel
# target_metadata = mymodel.Base.metadata # target_metadata = mymodel.Base.metadata
target_metadata = None target_metadata = Base.metadata
# other values from the config, defined by the needs of env.py, # other values from the config, defined by the needs of env.py,
# can be acquired: # can be acquired:
# my_important_option = config.get_main_option("my_important_option") # my_important_option = config.get_main_option("my_important_option")
# ... etc. # ... etc.
def get_custom_url():
with open("./pillar_tool.toml", 'rb') as f:
data = tomllib.load(f)
user = data['db']['user']
password = data['db']['password']
host = data['db']['host']
port = data['db']['port']
database = data['db']['database']
return f"postgresql://{user}:{password}@{host}:{port}/{database}"
def run_migrations_offline() -> None: def run_migrations_offline() -> None:
"""Run migrations in 'offline' mode. """Run migrations in 'offline' mode.
@ -39,14 +50,7 @@ def run_migrations_offline() -> None:
script output. script output.
""" """
with open("./pillar_tool.toml", 'rb') as f: url = get_custom_url()
data = tomllib.load(f)
user = data['db']['user']
password = data['db']['password']
host = data['db']['host']
port = data['db']['port']
database = data['db']['database']
url = f"postgresql://{user}:{password}@{host}:{port}/{database}"
#url = config.get_main_option("sqlalchemy.url") #url = config.get_main_option("sqlalchemy.url")
context.configure( context.configure(
url=url, url=url,
@ -66,8 +70,11 @@ def run_migrations_online() -> None:
and associate a connection with the context. and associate a connection with the context.
""" """
url = get_custom_url()
cfg = config.get_section(config.config_ini_section, {})
cfg['sqlalchemy.url'] = url
connectable = engine_from_config( connectable = engine_from_config(
config.get_section(config.config_ini_section, {}), cfg,
prefix="sqlalchemy.", prefix="sqlalchemy.",
poolclass=pool.NullPool, poolclass=pool.NullPool,
) )

View File

@ -1,5 +1,4 @@
from pydantic import UUID4 from sqlalchemy import Column, String, UUID
from sqlalchemy import Column, String
from pillar_tool.db.database import Base from pillar_tool.db.database import Base
@ -7,7 +6,7 @@ from pillar_tool.db.database import Base
class User(Base): class User(Base):
__tablename__ = 'users' __tablename__ = 'users'
id = Column(UUID4, primary_key=True) id = Column(UUID, primary_key=True)
username = Column(String, nullable=False) username = Column(String, nullable=False)
pw_hash = Column(String, nullable=False) pw_hash = Column(String, nullable=False)
pw_salt = Column(String, nullable=False) pw_salt = Column(String, nullable=False)

View File

@ -5,8 +5,8 @@ import tomllib
def load_config(): def load_config():
paths: list[str] = [ paths: list[str] = [
"/etc/pillar_tool/config.toml",
"./pillar_tool.toml", "./pillar_tool.toml",
"/etc/pillar_tool/config.toml",
] ]
for path in paths: for path in paths:
@ -17,9 +17,11 @@ def load_config():
cfg_dict = tomllib.load(f) cfg_dict = tomllib.load(f)
cfg = Config(**cfg_dict) cfg = Config(**cfg_dict)
globals()['_loaded_config_object'] = cfg globals()['_loaded_config_object'] = cfg
except: return
pass except Exception as e:
raise ValueError("No valid config file could be found!") print(e)
raise ValueError(f"No valid config file could be found! (working directory: {os.getcwd()})")
def config() -> Config: def config() -> Config: