From 6186232720168bddb8f2a11d25e9be434e5b5cef Mon Sep 17 00:00:00 2001
From: Lars Beckers <lars.beckers@rwth-aachen.de>
Date: Fri, 2 Oct 2015 17:36:40 +0159
Subject: [PATCH] add db-migration support and initial migration
---
migrations/README | 1 +
migrations/alembic.ini | 45 ++++++++++++++++
migrations/env.py | 87 ++++++++++++++++++++++++++++++
migrations/script.py.mako | 22 ++++++++
migrations/versions/68688a3014_.py | 64 ++++++++++++++++++++++
requirements.txt | 2 +
server.py | 8 ++-
7 files changed, 227 insertions(+), 2 deletions(-)
create mode 100755 migrations/README
create mode 100644 migrations/alembic.ini
create mode 100755 migrations/env.py
create mode 100755 migrations/script.py.mako
create mode 100644 migrations/versions/68688a3014_.py
diff --git a/migrations/README b/migrations/README
new file mode 100755
index 0000000..98e4f9c
--- /dev/null
+++ b/migrations/README
@@ -0,0 +1 @@
+Generic single-database configuration.
\ No newline at end of file
diff --git a/migrations/alembic.ini b/migrations/alembic.ini
new file mode 100644
index 0000000..f8ed480
--- /dev/null
+++ b/migrations/alembic.ini
@@ -0,0 +1,45 @@
+# A generic, single database configuration.
+
+[alembic]
+# template used to generate migration files
+# file_template = %%(rev)s_%%(slug)s
+
+# set to 'true' to run the environment during
+# the 'revision' command, regardless of autogenerate
+# revision_environment = false
+
+
+# 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/migrations/env.py b/migrations/env.py
new file mode 100755
index 0000000..4593816
--- /dev/null
+++ b/migrations/env.py
@@ -0,0 +1,87 @@
+from __future__ import with_statement
+from alembic import context
+from sqlalchemy import engine_from_config, pool
+from logging.config import fileConfig
+import logging
+
+# 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.
+fileConfig(config.config_file_name)
+logger = logging.getLogger('alembic.env')
+
+# add your model's MetaData object here
+# for 'autogenerate' support
+# from myapp import mymodel
+# target_metadata = mymodel.Base.metadata
+from flask import current_app
+config.set_main_option('sqlalchemy.url',
+ current_app.config.get('SQLALCHEMY_DATABASE_URI'))
+target_metadata = current_app.extensions['migrate'].db.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)
+
+ 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.
+
+ """
+
+ # this callback is used to prevent an auto-migration from being generated
+ # when there are no changes to the schema
+ # reference: http://alembic.readthedocs.org/en/latest/cookbook.html
+ def process_revision_directives(context, revision, directives):
+ if getattr(config.cmd_opts, 'autogenerate', False):
+ script = directives[0]
+ if script.upgrade_ops.is_empty():
+ directives[:] = []
+ logger.info('No changes in schema detected.')
+
+ engine = engine_from_config(config.get_section(config.config_ini_section),
+ prefix='sqlalchemy.',
+ poolclass=pool.NullPool)
+
+ connection = engine.connect()
+ context.configure(connection=connection,
+ target_metadata=target_metadata,
+ process_revision_directives=process_revision_directives,
+ **current_app.extensions['migrate'].configure_args)
+
+ try:
+ with context.begin_transaction():
+ context.run_migrations()
+ finally:
+ connection.close()
+
+if context.is_offline_mode():
+ run_migrations_offline()
+else:
+ run_migrations_online()
diff --git a/migrations/script.py.mako b/migrations/script.py.mako
new file mode 100755
index 0000000..9570201
--- /dev/null
+++ b/migrations/script.py.mako
@@ -0,0 +1,22 @@
+"""${message}
+
+Revision ID: ${up_revision}
+Revises: ${down_revision}
+Create Date: ${create_date}
+
+"""
+
+# revision identifiers, used by Alembic.
+revision = ${repr(up_revision)}
+down_revision = ${repr(down_revision)}
+
+from alembic import op
+import sqlalchemy as sa
+${imports if imports else ""}
+
+def upgrade():
+ ${upgrades if upgrades else "pass"}
+
+
+def downgrade():
+ ${downgrades if downgrades else "pass"}
diff --git a/migrations/versions/68688a3014_.py b/migrations/versions/68688a3014_.py
new file mode 100644
index 0000000..f4dde57
--- /dev/null
+++ b/migrations/versions/68688a3014_.py
@@ -0,0 +1,64 @@
+"""empty message
+
+Revision ID: 68688a3014
+Revises: None
+Create Date: 2015-10-02 17:36:48.851931
+
+"""
+
+# revision identifiers, used by Alembic.
+revision = '68688a3014'
+down_revision = None
+
+from alembic import op
+import sqlalchemy as sa
+
+
+def upgrade():
+ ### commands auto generated by Alembic - please adjust! ###
+ op.create_table('events',
+ sa.Column('id', sa.Integer(), nullable=False),
+ sa.Column('name', sa.String(), nullable=True),
+ sa.Column('mode', sa.String(), nullable=True),
+ sa.PrimaryKeyConstraint('id'),
+ sa.UniqueConstraint('name')
+ )
+ op.create_table('users',
+ sa.Column('id', sa.Integer(), nullable=False),
+ sa.Column('fullname', sa.String(), nullable=True),
+ sa.Column('username', sa.String(), nullable=True),
+ sa.Column('password', sa.String(), nullable=True),
+ sa.Column('roles', sa.PickleType(), nullable=True),
+ sa.Column('temp_key', sa.String(), nullable=True),
+ sa.Column('temp_key_timestamp', sa.DateTime(), nullable=True),
+ sa.PrimaryKeyConstraint('id'),
+ sa.UniqueConstraint('username')
+ )
+ op.create_table('speakers',
+ sa.Column('id', sa.Integer(), nullable=False),
+ sa.Column('name', sa.String(), nullable=True),
+ sa.Column('event', sa.Integer(), nullable=False),
+ sa.ForeignKeyConstraint(['event'], ['events.id'], ),
+ sa.PrimaryKeyConstraint('id')
+ )
+ op.create_table('statements',
+ sa.Column('id', sa.Integer(), nullable=False),
+ sa.Column('speaker', sa.Integer(), nullable=False),
+ sa.Column('event', sa.Integer(), nullable=False),
+ sa.Column('insertion_time', sa.DateTime(), nullable=True),
+ sa.Column('executed', sa.Boolean(), nullable=True),
+ sa.Column('execution_time', sa.DateTime(), nullable=True),
+ sa.ForeignKeyConstraint(['event'], ['events.id'], ),
+ sa.ForeignKeyConstraint(['speaker'], ['speakers.id'], ),
+ sa.PrimaryKeyConstraint('id')
+ )
+ ### end Alembic commands ###
+
+
+def downgrade():
+ ### commands auto generated by Alembic - please adjust! ###
+ op.drop_table('statements')
+ op.drop_table('speakers')
+ op.drop_table('users')
+ op.drop_table('events')
+ ### end Alembic commands ###
diff --git a/requirements.txt b/requirements.txt
index 46bda7c..585ce9e 100644
--- a/requirements.txt
+++ b/requirements.txt
@@ -14,3 +14,5 @@ itsdangerous==0.24
passlib==1.6.1
psycopg2==2.6.1
wheel==0.24.0
+Flask-Script
+Flask-Migrate
diff --git a/server.py b/server.py
index e08a739..7e9f928 100755
--- a/server.py
+++ b/server.py
@@ -3,6 +3,8 @@
from flask import Flask, g, current_app, request, session, flash, redirect, url_for, abort
from flask.ext.login import login_user, logout_user, login_required, current_user
from flask.ext.principal import Principal, Identity, AnonymousIdentity, identity_changed, identity_loaded, UserNeed, RoleNeed
+from flask.ext.script import Manager
+from flask.ext.migrate import Migrate, MigrateCommand
from passlib.hash import pbkdf2_sha256
import config
@@ -13,6 +15,9 @@ from models.database import User, Statement, Speaker, Event
app = Flask(__name__)
app.config.from_object(config)
db.init_app(app)
+migrate = Migrate(app, db)
+manager = Manager(app)
+manager.add_command('db', MigrateCommand)
login_manager.init_app(app)
login_manager.login_view = "login"
login_manager.login_message_category = "alert-error"
@@ -23,7 +28,6 @@ from modules import admin, speech
app.register_blueprint(admin.admin, url_prefix="/admin")
app.register_blueprint(speech.speech, url_prefix="/speech")
-db.create_all(app=app)
@app.route("/")
def index():
@@ -132,4 +136,4 @@ def load_user(user_id):
return db.session.query(User).filter_by(id=user_id).first()
if __name__ == "__main__":
- app.run(debug=config.DEBUG)
+ manager.run()
--
GitLab