From 73a7ebc352878676522144835afb6e22c8cef1c3 Mon Sep 17 00:00:00 2001 From: rubenwardy Date: Wed, 23 May 2018 17:59:24 +0100 Subject: [PATCH] Add Flask migrations --- app/models.py | 2 + migrations/README | 1 + migrations/alembic.ini | 45 +++++++ migrations/env.py | 87 ++++++++++++++ migrations/script.py.mako | 24 ++++ migrations/versions/83622276d439_.py | 168 +++++++++++++++++++++++++++ requirements.txt | 1 + 7 files changed, 328 insertions(+) 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/83622276d439_.py diff --git a/app/models.py b/app/models.py index b5607ab6..36c4c820 100644 --- a/app/models.py +++ b/app/models.py @@ -17,6 +17,7 @@ from flask import Flask, url_for from flask_sqlalchemy import SQLAlchemy +from flask_migrate import Migrate from app import app from datetime import datetime from sqlalchemy.orm import validates @@ -25,6 +26,7 @@ import enum # Initialise database db = SQLAlchemy(app) +migrate = Migrate(app, db) class UserRank(enum.Enum): diff --git a/migrations/README b/migrations/README new file mode 100755 index 00000000..98e4f9c4 --- /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 00000000..f8ed4801 --- /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 00000000..23663ff2 --- /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.zzzcomputing.com/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 00000000..2c015630 --- /dev/null +++ b/migrations/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/migrations/versions/83622276d439_.py b/migrations/versions/83622276d439_.py new file mode 100644 index 00000000..49f5ebb0 --- /dev/null +++ b/migrations/versions/83622276d439_.py @@ -0,0 +1,168 @@ +"""empty message + +Revision ID: 83622276d439 +Revises: +Create Date: 2018-05-23 17:58:47.616987 + +""" +from alembic import op +import sqlalchemy as sa + + +# revision identifiers, used by Alembic. +revision = '83622276d439' +down_revision = None +branch_labels = None +depends_on = None + + +def upgrade(): + # ### commands auto generated by Alembic - please adjust! ### + op.create_table('license', + sa.Column('id', sa.Integer(), nullable=False), + sa.Column('name', sa.String(length=50), nullable=False), + sa.PrimaryKeyConstraint('id'), + sa.UniqueConstraint('name') + ) + op.create_table('tag', + sa.Column('id', sa.Integer(), nullable=False), + sa.Column('name', sa.String(length=100), nullable=False), + sa.Column('title', sa.String(length=100), nullable=False), + sa.Column('backgroundColor', sa.String(length=6), nullable=False), + sa.Column('textColor', sa.String(length=6), nullable=False), + sa.PrimaryKeyConstraint('id'), + sa.UniqueConstraint('name') + ) + op.create_table('user', + sa.Column('id', sa.Integer(), nullable=False), + sa.Column('username', sa.String(length=50), nullable=False), + sa.Column('password', sa.String(length=255), server_default='', nullable=False), + sa.Column('reset_password_token', sa.String(length=100), server_default='', nullable=False), + sa.Column('rank', sa.Enum('NOT_JOINED', 'NEW_MEMBER', 'MEMBER', 'EDITOR', 'MODERATOR', 'ADMIN', name='userrank'), nullable=True), + sa.Column('github_username', sa.String(length=50), nullable=True), + sa.Column('forums_username', sa.String(length=50), nullable=True), + sa.Column('email', sa.String(length=255), nullable=True), + sa.Column('confirmed_at', sa.DateTime(), nullable=True), + sa.Column('is_active', sa.Boolean(), server_default='0', nullable=False), + sa.Column('display_name', sa.String(length=100), server_default='', nullable=False), + sa.PrimaryKeyConstraint('id'), + sa.UniqueConstraint('email'), + sa.UniqueConstraint('forums_username'), + sa.UniqueConstraint('github_username'), + sa.UniqueConstraint('username') + ) + op.create_table('notification', + sa.Column('id', sa.Integer(), nullable=False), + sa.Column('user_id', sa.Integer(), nullable=True), + sa.Column('causer_id', sa.Integer(), nullable=True), + sa.Column('title', sa.String(length=100), nullable=False), + sa.Column('url', sa.String(length=200), nullable=True), + sa.ForeignKeyConstraint(['causer_id'], ['user.id'], ), + sa.ForeignKeyConstraint(['user_id'], ['user.id'], ), + sa.PrimaryKeyConstraint('id') + ) + op.create_table('package', + sa.Column('id', sa.Integer(), nullable=False), + sa.Column('author_id', sa.Integer(), nullable=True), + sa.Column('name', sa.String(length=100), nullable=False), + sa.Column('title', sa.String(length=100), nullable=False), + sa.Column('shortDesc', sa.String(length=200), nullable=False), + sa.Column('desc', sa.Text(), nullable=True), + sa.Column('type', sa.Enum('MOD', 'GAME', 'TXP', name='packagetype'), nullable=True), + sa.Column('license_id', sa.Integer(), nullable=True), + sa.Column('approved', sa.Boolean(), nullable=False), + sa.Column('repo', sa.String(length=200), nullable=True), + sa.Column('website', sa.String(length=200), nullable=True), + sa.Column('issueTracker', sa.String(length=200), nullable=True), + sa.Column('forums', sa.Integer(), nullable=False), + sa.ForeignKeyConstraint(['author_id'], ['user.id'], ), + sa.ForeignKeyConstraint(['license_id'], ['license.id'], ), + sa.PrimaryKeyConstraint('id') + ) + op.create_table('user_email_verification', + sa.Column('id', sa.Integer(), nullable=False), + sa.Column('user_id', sa.Integer(), nullable=True), + sa.Column('email', sa.String(length=100), nullable=True), + sa.Column('token', sa.String(length=32), nullable=True), + sa.ForeignKeyConstraint(['user_id'], ['user.id'], ), + sa.PrimaryKeyConstraint('id') + ) + op.create_table('edit_request', + sa.Column('id', sa.Integer(), nullable=False), + sa.Column('package_id', sa.Integer(), nullable=True), + sa.Column('author_id', sa.Integer(), nullable=True), + sa.Column('title', sa.String(length=100), nullable=False), + sa.Column('desc', sa.String(length=1000), nullable=True), + sa.Column('status', sa.Integer(), nullable=False), + sa.ForeignKeyConstraint(['author_id'], ['user.id'], ), + sa.ForeignKeyConstraint(['package_id'], ['package.id'], ), + sa.PrimaryKeyConstraint('id') + ) + op.create_table('harddeps', + sa.Column('package_id', sa.Integer(), nullable=False), + sa.Column('dependency_id', sa.Integer(), nullable=False), + sa.ForeignKeyConstraint(['dependency_id'], ['package.id'], ), + sa.ForeignKeyConstraint(['package_id'], ['package.id'], ), + sa.PrimaryKeyConstraint('package_id', 'dependency_id') + ) + op.create_table('package_release', + sa.Column('id', sa.Integer(), nullable=False), + sa.Column('package_id', sa.Integer(), nullable=True), + sa.Column('title', sa.String(length=100), nullable=False), + sa.Column('releaseDate', sa.DateTime(), nullable=False), + sa.Column('url', sa.String(length=100), nullable=False), + sa.Column('approved', sa.Boolean(), nullable=False), + sa.Column('task_id', sa.String(length=32), nullable=True), + sa.ForeignKeyConstraint(['package_id'], ['package.id'], ), + sa.PrimaryKeyConstraint('id') + ) + op.create_table('package_screenshot', + sa.Column('id', sa.Integer(), nullable=False), + sa.Column('package_id', sa.Integer(), nullable=True), + sa.Column('title', sa.String(length=100), nullable=False), + sa.Column('url', sa.String(length=100), nullable=False), + sa.ForeignKeyConstraint(['package_id'], ['package.id'], ), + sa.PrimaryKeyConstraint('id') + ) + op.create_table('softdeps', + sa.Column('package_id', sa.Integer(), nullable=False), + sa.Column('dependency_id', sa.Integer(), nullable=False), + sa.ForeignKeyConstraint(['dependency_id'], ['package.id'], ), + sa.ForeignKeyConstraint(['package_id'], ['package.id'], ), + sa.PrimaryKeyConstraint('package_id', 'dependency_id') + ) + op.create_table('tags', + sa.Column('tag_id', sa.Integer(), nullable=False), + sa.Column('package_id', sa.Integer(), nullable=False), + sa.ForeignKeyConstraint(['package_id'], ['package.id'], ), + sa.ForeignKeyConstraint(['tag_id'], ['tag.id'], ), + sa.PrimaryKeyConstraint('tag_id', 'package_id') + ) + op.create_table('edit_request_change', + sa.Column('id', sa.Integer(), nullable=False), + sa.Column('request_id', sa.Integer(), nullable=True), + sa.Column('key', sa.Enum('name', 'title', 'shortDesc', 'desc', 'type', 'license', 'tags', 'repo', 'website', 'issueTracker', 'forums', name='packagepropertykey'), nullable=False), + sa.Column('oldValue', sa.Text(), nullable=True), + sa.Column('newValue', sa.Text(), nullable=True), + sa.ForeignKeyConstraint(['request_id'], ['edit_request.id'], ), + sa.PrimaryKeyConstraint('id') + ) + # ### end Alembic commands ### + + +def downgrade(): + # ### commands auto generated by Alembic - please adjust! ### + op.drop_table('edit_request_change') + op.drop_table('tags') + op.drop_table('softdeps') + op.drop_table('package_screenshot') + op.drop_table('package_release') + op.drop_table('harddeps') + op.drop_table('edit_request') + op.drop_table('user_email_verification') + op.drop_table('package') + op.drop_table('notification') + op.drop_table('user') + op.drop_table('tag') + op.drop_table('license') + # ### end Alembic commands ### diff --git a/requirements.txt b/requirements.txt index 0d131a60..49751a6e 100644 --- a/requirements.txt +++ b/requirements.txt @@ -11,3 +11,4 @@ redis==2.10.6 beautifulsoup4==4.6.0 lxml==4.2.1 Flask-FlatPages==0.6 +Flask-Migrate==2.1.1