From 57be81f31a4c758137f37392eda2a3e92d67a2d0 Mon Sep 17 00:00:00 2001 From: AndroidDrew Date: Mon, 15 Jan 2018 15:43:18 -0500 Subject: [PATCH] Added support for alembic migrations --- alembic.ini | 74 +++++++++++++++++++ cookie_api/app.py | 4 +- cookie_api/models.py | 1 + migrations/README | 1 + migrations/env.py | 71 ++++++++++++++++++ migrations/script.py.mako | 24 ++++++ .../versions/227892845cde_initial_models.py | 28 +++++++ .../82595a1e5193_added_confirmed_to_user.py | 30 ++++++++ requirements.txt | 4 + 9 files changed, 236 insertions(+), 1 deletion(-) create mode 100644 alembic.ini create mode 100644 migrations/README create mode 100644 migrations/env.py create mode 100644 migrations/script.py.mako create mode 100644 migrations/versions/227892845cde_initial_models.py create mode 100644 migrations/versions/82595a1e5193_added_confirmed_to_user.py diff --git a/alembic.ini b/alembic.ini new file mode 100644 index 0000000..33b6827 --- /dev/null +++ b/alembic.ini @@ -0,0 +1,74 @@ +# A generic, single database configuration. + +[alembic] +# path to migration scripts +script_location = migrations + +# 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 migrations/versions. When using multiple version +# directories, initial revisions must be specified with --version-path +# version_locations = %(here)s/bar %(here)s/bat migrations/versions + +# the output encoding used when revision files +# are written from script.py.mako +# output_encoding = utf-8 + +sqlalchemy.url = driver://user:pass@localhost/dbname + + +# 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/cookie_api/app.py b/cookie_api/app.py index af9de99..2f28437 100644 --- a/cookie_api/app.py +++ b/cookie_api/app.py @@ -5,8 +5,10 @@ from apistar.frameworks.wsgi import WSGIApp as App from apistar.handlers import docs_urls, static_urls from apistar.interfaces import Router, Injector, Auth from apistar_jwt.authentication import JWTAuthentication +from apistar_alembic_migrations import commands as migrate_commands import logbook + from cookie_api.auth import auth_routes, auth_components from cookie_api.commands import commands from cookie_api.models import Cookie @@ -77,7 +79,7 @@ app_settings = { _routes = _routes + auth_routes -_commands = sqlalchemy_backend.commands + commands +_commands = sqlalchemy_backend.commands + commands + migrate_commands _components = sqlalchemy_backend.components + auth_components diff --git a/cookie_api/models.py b/cookie_api/models.py index caa2ebe..4bf2e41 100644 --- a/cookie_api/models.py +++ b/cookie_api/models.py @@ -55,6 +55,7 @@ class User(DBMixin, Base): email = Column(String(255), nullable=False, unique=True) password = Column(String(255)) admin = Column(Boolean, nullable=False, default=False) + confirmed = Column(Boolean, nullable=False, default=False) def __init__(self, email, password, admin=False): self.email = email diff --git a/migrations/README b/migrations/README new file mode 100644 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/env.py b/migrations/env.py new file mode 100644 index 0000000..869c0b7 --- /dev/null +++ b/migrations/env.py @@ -0,0 +1,71 @@ +from __future__ import with_statement +from alembic import context +from sqlalchemy import engine_from_config, pool +from logging.config import fileConfig +from cookie_api import Base + +# 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) + +# 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) + + 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/migrations/script.py.mako b/migrations/script.py.mako new file mode 100644 index 0000000..2c01563 --- /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/227892845cde_initial_models.py b/migrations/versions/227892845cde_initial_models.py new file mode 100644 index 0000000..e1fee76 --- /dev/null +++ b/migrations/versions/227892845cde_initial_models.py @@ -0,0 +1,28 @@ +"""initial models + +Revision ID: 227892845cde +Revises: +Create Date: 2018-01-15 14:58:17.931063 + +""" +from alembic import op +import sqlalchemy as sa + + +# revision identifiers, used by Alembic. +revision = '227892845cde' +down_revision = None +branch_labels = None +depends_on = None + + +def upgrade(): + # ### commands auto generated by Alembic - please adjust! ### + pass + # ### end Alembic commands ### + + +def downgrade(): + # ### commands auto generated by Alembic - please adjust! ### + pass + # ### end Alembic commands ### diff --git a/migrations/versions/82595a1e5193_added_confirmed_to_user.py b/migrations/versions/82595a1e5193_added_confirmed_to_user.py new file mode 100644 index 0000000..6b30523 --- /dev/null +++ b/migrations/versions/82595a1e5193_added_confirmed_to_user.py @@ -0,0 +1,30 @@ +"""Added confirmed to user + +Revision ID: 82595a1e5193 +Revises: 227892845cde +Create Date: 2018-01-15 15:34:46.028181 + +""" +from alembic import op +import sqlalchemy as sa + + +# revision identifiers, used by Alembic. +revision = '82595a1e5193' +down_revision = '227892845cde' +branch_labels = None +depends_on = None + + +def upgrade(): + # ### commands auto generated by Alembic - please adjust! ### + op.add_column('users', sa.Column('confirmed', sa.Boolean())) + op.execute('UPDATE users SET confirmed=FALSE') + op.alter_column('users', 'confirmed', nullable=False) + # ### end Alembic commands ### + + +def downgrade(): + # ### commands auto generated by Alembic - please adjust! ### + op.drop_column('users', 'confirmed') + # ### end Alembic commands ### diff --git a/requirements.txt b/requirements.txt index e900d54..8c6f0b9 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,4 +1,6 @@ +alembic==0.9.6 apistar==0.3.9 +apistar-alembic-migrations==0.0.6 apistar-jwt==0.2.1 bcrypt==3.1.4 certifi==2017.7.27.1 @@ -11,6 +13,7 @@ idna==2.6 itypes==1.1.0 Jinja2==2.9.6 Logbook==1.1.0 +Mako==1.0.7 MarkupSafe==1.0 marshmallow==2.15.0 psycopg2==2.7.3.1 @@ -19,6 +22,7 @@ pycparser==2.18 PyJWT==1.5.3 pytest==3.2.3 python-dateutil==2.6.1 +python-editor==1.0.3 requests==2.18.4 six==1.11.0 SQLAlchemy==1.1.14