glance/glance/db/sqlalchemy/alembic_migrations/__init__.py

137 lines
5.0 KiB
Python

# Copyright 2016 Rackspace
# Copyright 2013 Intel Corporation
#
# 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.
import os
import sys
from alembic import command as alembic_command
from alembic import config as alembic_config
from alembic import migration as alembic_migration
from alembic import script as alembic_script
from sqlalchemy import MetaData, Table
from oslo_db import exception as db_exception
from oslo_db.sqlalchemy import migration as sqla_migration
from glance.db import migration as db_migration
from glance.db.sqlalchemy import api as db_api
from glance.i18n import _
def get_alembic_config(engine=None):
"""Return a valid alembic config object"""
ini_path = os.path.join(os.path.dirname(__file__), 'alembic.ini')
config = alembic_config.Config(os.path.abspath(ini_path))
if engine is None:
engine = db_api.get_engine()
# str(sqlalchemy.engine.url.URL) returns a RFC-1738 quoted URL.
# This means that a password like "foo@" will be turned into
# "foo%40". This causes a problem for set_main_option() here
# because that uses ConfigParser.set, which (by design) uses
# *python* interpolation to write the string out ... where "%" is
# the special python interpolation character! Avoid this
# mis-match by quoting all %'s for the set below.
quoted_engine_url = str(engine.url).replace('%', '%%')
config.set_main_option('sqlalchemy.url', quoted_engine_url)
return config
def get_current_alembic_heads():
"""Return current heads (if any) from the alembic migration table"""
engine = db_api.get_engine()
with engine.connect() as conn:
context = alembic_migration.MigrationContext.configure(conn)
heads = context.get_current_heads()
def update_alembic_version(old, new):
"""Correct alembic head in order to upgrade DB using EMC method.
:param:old: Actual alembic head
:param:new: Expected alembic head to be updated
"""
meta = MetaData(engine)
alembic_version = Table('alembic_version', meta, autoload=True)
alembic_version.update().values(
version_num=new).where(
alembic_version.c.version_num == old).execute()
if ("pike01" in heads):
update_alembic_version("pike01", "pike_contract01")
elif ("ocata01" in heads):
update_alembic_version("ocata01", "ocata_contract01")
heads = context.get_current_heads()
return heads
def get_current_legacy_head():
try:
legacy_head = sqla_migration.db_version(db_api.get_engine(),
db_migration.MIGRATE_REPO_PATH,
db_migration.INIT_VERSION)
except db_exception.DBMigrationError:
legacy_head = None
return legacy_head
def is_database_under_alembic_control():
if get_current_alembic_heads():
return True
return False
def is_database_under_migrate_control():
if get_current_legacy_head():
return True
return False
def place_database_under_alembic_control():
a_config = get_alembic_config()
if not is_database_under_migrate_control():
return
if not is_database_under_alembic_control():
print(_("Database is currently not under Alembic's migration "
"control."))
head = get_current_legacy_head()
if head == 42:
alembic_version = 'liberty'
elif head == 43:
alembic_version = 'mitaka01'
elif head == 44:
alembic_version = 'mitaka02'
elif head == 45:
alembic_version = 'ocata01'
elif head in range(1, 42):
print("Legacy head: ", head)
sys.exit(_("The current database version is not supported any "
"more. Please upgrade to Liberty release first."))
else:
sys.exit(_("Unable to place database under Alembic's migration "
"control. Unknown database state, can't proceed "
"further."))
print(_("Placing database under Alembic's migration control at "
"revision:"), alembic_version)
alembic_command.stamp(a_config, alembic_version)
def get_alembic_branch_head(branch):
"""Return head revision name for particular branch"""
a_config = get_alembic_config()
script = alembic_script.ScriptDirectory.from_config(a_config)
return script.revision_map.get_current_head(branch)