From ed6055744fb69188ce910524dcb0f515918a402d Mon Sep 17 00:00:00 2001 From: Tulir Asokan Date: Fri, 27 Sep 2019 00:45:17 +0300 Subject: [PATCH] Add Alembic setup --- alembic.ini | 83 +++++++++++++++++ alembic/README | 1 + alembic/env.py | 90 +++++++++++++++++++ alembic/script.py.mako | 24 +++++ .../versions/d295f8dcfa64_initial_revision.py | 50 +++++++++++ maubot/db.py | 28 ++++-- 6 files changed, 269 insertions(+), 7 deletions(-) create mode 100644 alembic.ini create mode 100644 alembic/README create mode 100644 alembic/env.py create mode 100644 alembic/script.py.mako create mode 100644 alembic/versions/d295f8dcfa64_initial_revision.py diff --git a/alembic.ini b/alembic.ini new file mode 100644 index 0000000..0d78e89 --- /dev/null +++ b/alembic.ini @@ -0,0 +1,83 @@ +# A generic, single database configuration. + +[alembic] +# path to migration scripts +script_location = alembic + +# template used to generate migration files +# file_template = %%(rev)s_%%(slug)s + +# timezone to use when rendering the date +# within the migration file as well as the filename. +# 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 alembic/versions. When using multiple version +# directories, initial revisions must be specified with --version-path +# version_locations = %(here)s/bar %(here)s/bat alembic/versions + +# the output encoding used when revision files +# are written from script.py.mako +# output_encoding = utf-8 + + +[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 + +# 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 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..51f01c2 --- /dev/null +++ b/alembic/env.py @@ -0,0 +1,90 @@ +from logging.config import fileConfig + +from sqlalchemy import engine_from_config, pool + +from alembic import context + +import sys +from os.path import abspath, dirname + +sys.path.insert(0, dirname(dirname(abspath(__file__)))) + +from mautrix.util.db import Base +from maubot.config import Config +from maubot import db + +# this is the Alembic Config object, which provides +# access to the values within the .ini file in use. +config = context.config + +maubot_config_path = context.get_x_argument(as_dictionary=True).get("config", "config.yaml") +maubot_config = Config(maubot_config_path, None) +maubot_config.load() +config.set_main_option("sqlalchemy.url", maubot_config["database"].replace("%", "%%")) + +# Interpret the config file for Python logging. +# This line sets up loggers basically. +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(): + """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(): + """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..2c01563 --- /dev/null +++ b/alembic/script.py.mako @@ -0,0 +1,24 @@ +"""${message} + +Revision ID: ${up_revision} +Revises: ${down_revision | comma,n} +Create Date: ${create_date} + +""" +from alembic import op +import sqlalchemy as sa +${imports if imports else ""} + +# revision identifiers, used by Alembic. +revision = ${repr(up_revision)} +down_revision = ${repr(down_revision)} +branch_labels = ${repr(branch_labels)} +depends_on = ${repr(depends_on)} + + +def upgrade(): + ${upgrades if upgrades else "pass"} + + +def downgrade(): + ${downgrades if downgrades else "pass"} diff --git a/alembic/versions/d295f8dcfa64_initial_revision.py b/alembic/versions/d295f8dcfa64_initial_revision.py new file mode 100644 index 0000000..ffa502f --- /dev/null +++ b/alembic/versions/d295f8dcfa64_initial_revision.py @@ -0,0 +1,50 @@ +"""Initial revision + +Revision ID: d295f8dcfa64 +Revises: +Create Date: 2019-09-27 00:21:02.527915 + +""" +from alembic import op +import sqlalchemy as sa + + +# revision identifiers, used by Alembic. +revision = 'd295f8dcfa64' +down_revision = None +branch_labels = None +depends_on = None + + +def upgrade(): + # ### commands auto generated by Alembic - please adjust! ### + op.create_table('client', + sa.Column('id', sa.String(length=255), nullable=False), + sa.Column('homeserver', sa.String(length=255), nullable=False), + sa.Column('access_token', sa.Text(), nullable=False), + sa.Column('enabled', sa.Boolean(), nullable=False), + sa.Column('next_batch', sa.String(length=255), nullable=False), + sa.Column('filter_id', sa.String(length=255), nullable=False), + sa.Column('sync', sa.Boolean(), nullable=False), + sa.Column('autojoin', sa.Boolean(), nullable=False), + sa.Column('displayname', sa.String(length=255), nullable=False), + sa.Column('avatar_url', sa.String(length=255), nullable=False), + sa.PrimaryKeyConstraint('id') + ) + op.create_table('plugin', + sa.Column('id', sa.String(length=255), nullable=False), + sa.Column('type', sa.String(length=255), nullable=False), + sa.Column('enabled', sa.Boolean(), nullable=False), + sa.Column('primary_user', sa.String(length=255), nullable=False), + sa.Column('config', sa.Text(), nullable=False), + sa.ForeignKeyConstraint(['primary_user'], ['client.id'], onupdate='CASCADE', ondelete='RESTRICT'), + sa.PrimaryKeyConstraint('id') + ) + # ### end Alembic commands ### + + +def downgrade(): + # ### commands auto generated by Alembic - please adjust! ### + op.drop_table('plugin') + op.drop_table('client') + # ### end Alembic commands ### diff --git a/maubot/db.py b/maubot/db.py index b8c97f8..ba9dbfc 100644 --- a/maubot/db.py +++ b/maubot/db.py @@ -14,6 +14,8 @@ # You should have received a copy of the GNU Affero General Public License # along with this program. If not, see . from typing import Iterable, Optional +import logging +import sys from sqlalchemy import Column, String, Boolean, ForeignKey, Text from sqlalchemy.engine.base import Engine @@ -72,13 +74,25 @@ class DBClient(Base): def init(config: Config) -> Engine: - db_engine = sql.create_engine(config["database"]) - Base.metadata.bind = db_engine + db = sql.create_engine(config["database"]) + Base.metadata.bind = db for table in (DBPlugin, DBClient): - table.db = db_engine - table.t = table.__table__ - table.c = table.t.c - table.column_names = table.c.keys() + table.bind(db) - return db_engine + if not db.has_table("alembic_version"): + log = logging.getLogger("maubot.db") + + if db.has_table("client") and db.has_table("plugin"): + log.warning("alembic_version table not found, but cligent and plugin tables found. " + "Assuming pre-Alembic database and inserting version.") + db.execute("CREATE TABLE IF NOT EXISTS alembic_version (" + " version_num VARCHAR(32) PRIMARY KEY" + ");") + db.execute("INSERT INTO alembic_version VALUES ('d295f8dcfa64');") + else: + log.critical("alembic_version table not found. " + "Did you forget to `alembic upgrade head`?") + sys.exit(10) + + return db