alembic with initial migration and tests

All sqlalchemy migrations and code associated with them was removed including tests Added all necessery alembic code to expose alembic specific features: like revision and stamp Added initial migration for alembic, that is fully in sync with models including: uniques, indexes and columns params Refactored test_versions to use alembic as migration api Refactored BaseTestCase and Database fixture to use alembic as migration api Change-Id: I8a91704d21ccea1b8135b9d724df5856ac21108c
openstack · Jan 27, 2014 · 50b3a02 · 50b3a02
1 parent 5983ad8
commit 50b3a02
Show file tree

Hide file tree

Showing 33 changed files with 513 additions and 1,086 deletions.
diff --git a/ironic/cmd/dbsync.py b/ironic/cmd/dbsync.py
@@ -24,10 +24,74 @@
 
 import sys
 
+from oslo.config import cfg
+
 from ironic.common import service
 from ironic.db import migration
 
 
+CONF = cfg.CONF
+
+
+class DBCommand(object):
+
+    def upgrade(self):
+        migration.upgrade(CONF.command.revision)
+
+    def downgrade(self):
+        migration.downgrade(CONF.command.revision)
+
+    def revision(self):
+        migration.revision(CONF.command.message, CONF.command.autogenerate)
+
+    def stamp(self):
+        migration.stamp(CONF.command.revision)
+
+    def version(self):
+        print(migration.version())
+
+
+def add_command_parsers(subparsers):
+    command_object = DBCommand()
+
+    parser = subparsers.add_parser('upgrade')
+    parser.set_defaults(func=command_object.upgrade)
+    parser.add_argument('--revision', nargs='?')
+
+    parser = subparsers.add_parser('downgrade')
+    parser.set_defaults(func=command_object.downgrade)
+    parser.add_argument('--revision', nargs='?')
+
+    parser = subparsers.add_parser('stamp')
+    parser.add_argument('--revision', nargs='?')
+    parser.set_defaults(func=command_object.stamp)
+
+    parser = subparsers.add_parser('revision')
+    parser.add_argument('-m', '--message')
+    parser.add_argument('--autogenerate', action='store_true')
+    parser.set_defaults(func=command_object.revision)
+
+    parser = subparsers.add_parser('version')
+    parser.set_defaults(func=command_object.version)
+
+
+command_opt = cfg.SubCommandOpt('command',
+                                title='Command',
+                                help='Available commands',
+                                handler=add_command_parsers)
+
+CONF.register_cli_opt(command_opt)
+
+
 def main():
+    # this is hack to work with previous usage of ironic-dbsync
+    # pls change it to ironic-dbsync upgrade
+    valid_commands = set([
+        'upgrade', 'downgrade', 'revision',
+        'version', 'stamp'
+    ])
+    if not set(sys.argv) & valid_commands:
+        sys.argv.append('upgrade')
+
     service.prepare_service(sys.argv)
-    migration.db_sync()
+    CONF.command.func()
diff --git a/ironic/db/migration.py b/ironic/db/migration.py
@@ -28,18 +28,29 @@
                 group='database')
 
 IMPL = utils.LazyPluggable(
-        pivot='backend',
-        config_group='database',
-        sqlalchemy='ironic.db.sqlalchemy.migration')
+    pivot='backend',
+    config_group='database',
+    sqlalchemy='ironic.db.sqlalchemy.migration')
 
 INIT_VERSION = 0
 
 
-def db_sync(version=None):
+def upgrade(version=None):
     """Migrate the database to `version` or the most recent version."""
-    return IMPL.db_sync(version=version)
+    return IMPL.upgrade(version)
 
 
-def db_version():
-    """Display the current database version."""
-    return IMPL.db_version()
+def downgrade(version=None):
+    return IMPL.downgrade(version)
+
+
+def version():
+    return IMPL.version()
+
+
+def stamp(version):
+    return IMPL.stamp(version)
+
+
+def revision(message, autogenerate):
+    return IMPL.revision(message, autogenerate)
diff --git a/ironic/db/sqlalchemy/alembic.ini b/ironic/db/sqlalchemy/alembic.ini
@@ -0,0 +1,54 @@
+# A generic, single database configuration.
+
+[alembic]
+# path to migration scripts
+script_location = %(here)s/alembic
+
+# template used to generate migration files
+# file_template = %%(rev)s_%%(slug)s
+
+# 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
+
+#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/ironic/db/sqlalchemy/alembic/README b/ironic/db/sqlalchemy/alembic/README
@@ -0,0 +1,16 @@
+Please see https://alembic.readthedocs.org/en/latest/index.html for general documentation
+
+To create alembic migrations use:
+$ ironic-dbsync revision --message --autogenerate
+
+Stamp db with most recent migration version, without actually running migrations
+$ ironic-dbsync stamp --revision head
+
+Upgrade can be performed by:
+$ ironic-dbsync - for backward compatibility
+$ ironic-dbsync upgrade
+# ironic-dbsync upgrade --revision head
+
+Downgrading db:
+$ ironic-dbsync downgrade
+$ ironic-dbsync downgrade --revision base
diff --git a/ironic/db/sqlalchemy/alembic/env.py b/ironic/db/sqlalchemy/alembic/env.py
@@ -0,0 +1,54 @@
+#    Licensed under the Apache License, Version 2.0 (the "License"); you may
+#    not use this file except in compliance with the License. You may obtain
+#    a copy of the License at
+#
+#         http://www.apache.org/licenses/LICENSE-2.0
+#
+#    Unless required by applicable law or agreed to in writing, software
+#    distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+#    WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+#    License for the specific language governing permissions and limitations
+#    under the License.
+
+from logging import config as log_config
+
+from alembic import context
+
+from ironic.db.sqlalchemy import models
+import ironic.openstack.common.db.sqlalchemy.session as sqlalchemy_session
+
+# 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.
+log_config.fileConfig(config.config_file_name)
+
+# add your model's MetaData object here
+# for 'autogenerate' support
+# from myapp import mymodel
+target_metadata = models.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_online():
+    """Run migrations in 'online' mode.
+
+    In this scenario we need to create an Engine
+    and associate a connection with the context.
+
+    """
+    engine = sqlalchemy_session.get_engine()
+    with engine.connect() as connection:
+        context.configure(connection=connection,
+                          target_metadata=target_metadata)
+        with context.begin_transaction():
+            context.run_migrations()
+
+
+run_migrations_online()
diff --git a/ironic/db/sqlalchemy/alembic/script.py.mako b/ironic/db/sqlalchemy/alembic/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/ironic/db/sqlalchemy/alembic/versions/2581ebaf0cb2_initial_migration.py b/ironic/db/sqlalchemy/alembic/versions/2581ebaf0cb2_initial_migration.py
@@ -0,0 +1,106 @@
+#
+#    Licensed under the Apache License, Version 2.0 (the "License"); you may
+#    not use this file except in compliance with the License. You may obtain
+#    a copy of the License at
+#
+#         http://www.apache.org/licenses/LICENSE-2.0
+#
+#    Unless required by applicable law or agreed to in writing, software
+#    distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+#    WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+#    License for the specific language governing permissions and limitations
+#    under the License.
+
+"""initial migration
+
+Revision ID: 2581ebaf0cb2
+Revises: None
+Create Date: 2014-01-17 12:14:07.754448
+
+"""
+
+# revision identifiers, used by Alembic.
+revision = '2581ebaf0cb2'
+down_revision = None
+
+from alembic import op
+import sqlalchemy as sa
+
+
+def upgrade():
+    ### commands auto generated by Alembic - please adjust! ###
+    op.create_table(
+        'conductors',
+        sa.Column('created_at', sa.DateTime(), nullable=True),
+        sa.Column('updated_at', sa.DateTime(), nullable=True),
+        sa.Column('id', sa.Integer(), nullable=False),
+        sa.Column('hostname', sa.String(length=255), nullable=False),
+        sa.Column('drivers', sa.Text(), nullable=True),
+        sa.PrimaryKeyConstraint('id'),
+        sa.UniqueConstraint('hostname', name='uniq_conductors0hostname'),
+        mysql_ENGINE='InnoDB',
+        mysql_DEFAULT_CHARSET='UTF8'
+    )
+    op.create_table(
+        'chassis',
+        sa.Column('created_at', sa.DateTime(), nullable=True),
+        sa.Column('updated_at', sa.DateTime(), nullable=True),
+        sa.Column('id', sa.Integer(), nullable=False),
+        sa.Column('uuid', sa.String(length=36), nullable=True),
+        sa.Column('extra', sa.Text(), nullable=True),
+        sa.Column('description', sa.String(length=255), nullable=True),
+        sa.PrimaryKeyConstraint('id'),
+        sa.UniqueConstraint('uuid', name='uniq_chassis0uuid'),
+        mysql_ENGINE='InnoDB',
+        mysql_DEFAULT_CHARSET='UTF8'
+    )
+    op.create_table(
+        'nodes',
+        sa.Column('created_at', sa.DateTime(), nullable=True),
+        sa.Column('updated_at', sa.DateTime(), nullable=True),
+        sa.Column('id', sa.Integer(), nullable=False),
+        sa.Column('uuid', sa.String(length=36), nullable=True),
+        sa.Column('instance_uuid', sa.String(length=36), nullable=True),
+        sa.Column('chassis_id', sa.Integer(), nullable=True),
+        sa.Column('power_state', sa.String(length=15), nullable=True),
+        sa.Column('target_power_state', sa.String(length=15), nullable=True),
+        sa.Column('provision_state', sa.String(length=15), nullable=True),
+        sa.Column('target_provision_state', sa.String(length=15),
+                  nullable=True),
+        sa.Column('last_error', sa.Text(), nullable=True),
+        sa.Column('properties', sa.Text(), nullable=True),
+        sa.Column('driver', sa.String(length=15), nullable=True),
+        sa.Column('driver_info', sa.Text(), nullable=True),
+        sa.Column('reservation', sa.String(length=255), nullable=True),
+        sa.Column('maintenance', sa.Boolean(), nullable=True),
+        sa.Column('extra', sa.Text(), nullable=True),
+        sa.ForeignKeyConstraint(['chassis_id'], ['chassis.id'], ),
+        sa.PrimaryKeyConstraint('id'),
+        sa.UniqueConstraint('uuid', name='uniq_nodes0uuid'),
+        mysql_ENGINE='InnoDB',
+        mysql_DEFAULT_CHARSET='UTF8'
+    )
+    op.create_index('node_instance_uuid', 'nodes', ['instance_uuid'],
+                    unique=False)
+    op.create_table(
+        'ports',
+        sa.Column('created_at', sa.DateTime(), nullable=True),
+        sa.Column('updated_at', sa.DateTime(), nullable=True),
+        sa.Column('id', sa.Integer(), nullable=False),
+        sa.Column('uuid', sa.String(length=36), nullable=True),
+        sa.Column('address', sa.String(length=18), nullable=True),
+        sa.Column('node_id', sa.Integer(), nullable=True),
+        sa.Column('extra', sa.Text(), nullable=True),
+        sa.ForeignKeyConstraint(['node_id'], ['nodes.id'], ),
+        sa.PrimaryKeyConstraint('id'),
+        sa.UniqueConstraint('address', name='uniq_ports0address'),
+        sa.UniqueConstraint('uuid', name='uniq_ports0uuid'),
+        mysql_ENGINE='InnoDB',
+        mysql_DEFAULT_CHARSET='UTF8'
+    )
+    ### end Alembic commands ###
+
+
+def downgrade():
+    raise NotImplementedError(('Downgrade from initial migration is'
+                              ' unsupported.'))
diff --git a/ironic/db/sqlalchemy/migrate_repo/__init__.py b/ironic/db/sqlalchemy/migrate_repo/__init__.py
diff --git a/ironic/db/sqlalchemy/migrate_repo/manage.py b/ironic/db/sqlalchemy/migrate_repo/manage.py