324 lines
11 KiB
Python
324 lines
11 KiB
Python
# Copyright 2012 New Dream Network, LLC (DreamHost)
|
|
#
|
|
# 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 six
|
|
|
|
from alembic import command as alembic_command
|
|
from alembic import config as alembic_config
|
|
from alembic import environment
|
|
from alembic import script as alembic_script
|
|
from alembic import util as alembic_util
|
|
from oslo_config import cfg
|
|
from oslo_utils import importutils
|
|
|
|
from neutron.common import repos
|
|
|
|
|
|
# TODO(ihrachyshka): maintain separate HEAD files per branch
|
|
HEADS_FILENAME = 'HEADS'
|
|
CURRENT_RELEASE = "liberty"
|
|
MIGRATION_BRANCHES = ('expand', 'contract')
|
|
|
|
|
|
mods = repos.NeutronModules()
|
|
VALID_SERVICES = map(mods.alembic_name, mods.installed_list())
|
|
|
|
|
|
_core_opts = [
|
|
cfg.StrOpt('core_plugin',
|
|
default='',
|
|
help=_('Neutron plugin provider module')),
|
|
cfg.ListOpt('service_plugins',
|
|
default=[],
|
|
help=_("The service plugins Neutron will use")),
|
|
cfg.StrOpt('service',
|
|
choices=VALID_SERVICES,
|
|
help=_("The advanced service to execute the command against. "
|
|
"Can be one of '%s'.") % "', '".join(VALID_SERVICES))
|
|
]
|
|
|
|
_quota_opts = [
|
|
cfg.StrOpt('quota_driver',
|
|
default='',
|
|
help=_('Neutron quota driver class')),
|
|
]
|
|
|
|
_db_opts = [
|
|
cfg.StrOpt('connection',
|
|
deprecated_name='sql_connection',
|
|
default='',
|
|
secret=True,
|
|
help=_('URL to database')),
|
|
cfg.StrOpt('engine',
|
|
default='',
|
|
help=_('Database engine')),
|
|
]
|
|
|
|
CONF = cfg.ConfigOpts()
|
|
CONF.register_cli_opts(_core_opts)
|
|
CONF.register_cli_opts(_db_opts, 'database')
|
|
CONF.register_opts(_quota_opts, 'QUOTAS')
|
|
|
|
|
|
def do_alembic_command(config, cmd, *args, **kwargs):
|
|
try:
|
|
getattr(alembic_command, cmd)(config, *args, **kwargs)
|
|
except alembic_util.CommandError as e:
|
|
alembic_util.err(six.text_type(e))
|
|
|
|
|
|
def do_check_migration(config, cmd):
|
|
do_alembic_command(config, 'branches')
|
|
validate_heads_file(config)
|
|
|
|
|
|
def add_alembic_subparser(sub, cmd):
|
|
return sub.add_parser(cmd, help=getattr(alembic_command, cmd).__doc__)
|
|
|
|
|
|
def do_upgrade(config, cmd):
|
|
if not CONF.command.revision and not CONF.command.delta:
|
|
raise SystemExit(_('You must provide a revision or relative delta'))
|
|
|
|
revision = CONF.command.revision or ''
|
|
if '-' in revision:
|
|
raise SystemExit(_('Negative relative revision (downgrade) not '
|
|
'supported'))
|
|
|
|
delta = CONF.command.delta
|
|
if delta:
|
|
if '+' in revision:
|
|
raise SystemExit(_('Use either --delta or relative revision, '
|
|
'not both'))
|
|
if delta < 0:
|
|
raise SystemExit(_('Negative delta (downgrade) not supported'))
|
|
revision = '%s+%d' % (revision, delta)
|
|
|
|
# leave branchless 'head' revision request backward compatible by applying
|
|
# all heads in all available branches.
|
|
if revision == 'head':
|
|
revision = 'heads'
|
|
if not CONF.command.sql:
|
|
run_sanity_checks(config, revision)
|
|
do_alembic_command(config, cmd, revision, sql=CONF.command.sql)
|
|
|
|
|
|
def no_downgrade(config, cmd):
|
|
raise SystemExit(_("Downgrade no longer supported"))
|
|
|
|
|
|
def do_stamp(config, cmd):
|
|
do_alembic_command(config, cmd,
|
|
CONF.command.revision,
|
|
sql=CONF.command.sql)
|
|
|
|
|
|
def _get_branch_head(branch):
|
|
'''Get the latest @head specification for a branch.'''
|
|
return '%s_%s@head' % (CURRENT_RELEASE, branch)
|
|
|
|
|
|
def do_revision(config, cmd):
|
|
'''Generate new revision files, one per branch.'''
|
|
if _separate_migration_branches_supported(CONF):
|
|
for branch in MIGRATION_BRANCHES:
|
|
version_path = _get_version_branch_path(CONF, branch)
|
|
head = _get_branch_head(branch)
|
|
do_alembic_command(config, cmd,
|
|
message=CONF.command.message,
|
|
autogenerate=CONF.command.autogenerate,
|
|
sql=CONF.command.sql,
|
|
version_path=version_path,
|
|
head=head)
|
|
else:
|
|
do_alembic_command(config, cmd,
|
|
message=CONF.command.message,
|
|
autogenerate=CONF.command.autogenerate,
|
|
sql=CONF.command.sql)
|
|
update_heads_file(config)
|
|
|
|
|
|
def _get_sorted_heads(script):
|
|
'''Get the list of heads for all branches, sorted.'''
|
|
heads = script.get_heads()
|
|
# +1 stands for the core 'kilo' branch, the one that didn't have branches
|
|
if len(heads) > len(MIGRATION_BRANCHES) + 1:
|
|
alembic_util.err(_('No new branches are allowed except: %s') %
|
|
' '.join(MIGRATION_BRANCHES))
|
|
return sorted(heads)
|
|
|
|
|
|
def validate_heads_file(config):
|
|
'''Check that HEADS file contains the latest heads for each branch.'''
|
|
script = alembic_script.ScriptDirectory.from_config(config)
|
|
heads = _get_sorted_heads(script)
|
|
heads_path = _get_heads_file_path(CONF)
|
|
try:
|
|
with open(heads_path) as file_:
|
|
if file_.read().split() == heads:
|
|
return
|
|
except IOError:
|
|
pass
|
|
alembic_util.err(_('HEADS file does not match migration timeline heads'))
|
|
|
|
|
|
def update_heads_file(config):
|
|
'''Update HEADS file with the latest branch heads.'''
|
|
script = alembic_script.ScriptDirectory.from_config(config)
|
|
heads = _get_sorted_heads(script)
|
|
heads_path = _get_heads_file_path(CONF)
|
|
with open(heads_path, 'w+') as f:
|
|
f.write('\n'.join(heads))
|
|
|
|
|
|
def add_command_parsers(subparsers):
|
|
for name in ['current', 'history', 'branches']:
|
|
parser = add_alembic_subparser(subparsers, name)
|
|
parser.set_defaults(func=do_alembic_command)
|
|
|
|
help_text = (getattr(alembic_command, 'branches').__doc__ +
|
|
' and validate head file')
|
|
parser = subparsers.add_parser('check_migration', help=help_text)
|
|
parser.set_defaults(func=do_check_migration)
|
|
|
|
parser = add_alembic_subparser(subparsers, 'upgrade')
|
|
parser.add_argument('--delta', type=int)
|
|
parser.add_argument('--sql', action='store_true')
|
|
parser.add_argument('revision', nargs='?')
|
|
parser.add_argument('--mysql-engine',
|
|
default='',
|
|
help='Change MySQL storage engine of current '
|
|
'existing tables')
|
|
parser.set_defaults(func=do_upgrade)
|
|
|
|
parser = subparsers.add_parser('downgrade', help="(No longer supported)")
|
|
parser.add_argument('None', nargs='?', help="Downgrade not supported")
|
|
parser.set_defaults(func=no_downgrade)
|
|
|
|
parser = add_alembic_subparser(subparsers, 'stamp')
|
|
parser.add_argument('--sql', action='store_true')
|
|
parser.add_argument('revision')
|
|
parser.set_defaults(func=do_stamp)
|
|
|
|
parser = add_alembic_subparser(subparsers, 'revision')
|
|
parser.add_argument('-m', '--message')
|
|
parser.add_argument('--autogenerate', action='store_true')
|
|
parser.add_argument('--sql', action='store_true')
|
|
parser.set_defaults(func=do_revision)
|
|
|
|
|
|
command_opt = cfg.SubCommandOpt('command',
|
|
title='Command',
|
|
help=_('Available commands'),
|
|
handler=add_command_parsers)
|
|
|
|
CONF.register_cli_opt(command_opt)
|
|
|
|
|
|
def _get_neutron_service_base(neutron_config):
|
|
'''Return base python namespace name for a service.'''
|
|
if neutron_config.service:
|
|
validate_service_installed(neutron_config.service)
|
|
return "neutron_%s" % neutron_config.service
|
|
return "neutron"
|
|
|
|
|
|
def _get_root_versions_dir(neutron_config):
|
|
'''Return root directory that contains all migration rules.'''
|
|
service_base = _get_neutron_service_base(neutron_config)
|
|
root_module = importutils.import_module(service_base)
|
|
return os.path.join(
|
|
os.path.dirname(root_module.__file__),
|
|
'db/migration/alembic_migrations/versions')
|
|
|
|
|
|
def _get_heads_file_path(neutron_config):
|
|
'''Return the path of the file that contains all latest heads, sorted.'''
|
|
return os.path.join(
|
|
_get_root_versions_dir(neutron_config),
|
|
HEADS_FILENAME)
|
|
|
|
|
|
def _get_version_branch_path(neutron_config, branch=None):
|
|
version_path = _get_root_versions_dir(neutron_config)
|
|
if branch:
|
|
return os.path.join(version_path, CURRENT_RELEASE, branch)
|
|
return version_path
|
|
|
|
|
|
def _separate_migration_branches_supported(neutron_config):
|
|
'''Detect whether split migration branches are supported.'''
|
|
# Use HEADS file to indicate the new, split migration world
|
|
return os.path.exists(_get_heads_file_path(neutron_config))
|
|
|
|
|
|
def _set_version_locations(config):
|
|
'''Make alembic see all revisions in all migration branches.'''
|
|
version_paths = []
|
|
|
|
version_paths.append(_get_version_branch_path(CONF))
|
|
if _separate_migration_branches_supported(CONF):
|
|
for branch in MIGRATION_BRANCHES:
|
|
version_paths.append(_get_version_branch_path(CONF, branch))
|
|
|
|
config.set_main_option('version_locations', ' '.join(version_paths))
|
|
|
|
|
|
def validate_service_installed(service):
|
|
if not importutils.try_import('neutron_%s' % service):
|
|
alembic_util.err(_('Package neutron-%s not installed') % service)
|
|
|
|
|
|
def get_script_location(neutron_config):
|
|
location = '%s.db.migration:alembic_migrations'
|
|
return location % _get_neutron_service_base(neutron_config)
|
|
|
|
|
|
def get_alembic_config():
|
|
config = alembic_config.Config(os.path.join(os.path.dirname(__file__),
|
|
'alembic.ini'))
|
|
config.set_main_option('script_location', get_script_location(CONF))
|
|
_set_version_locations(config)
|
|
return config
|
|
|
|
|
|
def run_sanity_checks(config, revision):
|
|
script_dir = alembic_script.ScriptDirectory.from_config(config)
|
|
|
|
def check_sanity(rev, context):
|
|
# TODO(ihrachyshka): here we use internal API for alembic; we may need
|
|
# alembic to expose implicit_base= argument into public
|
|
# iterate_revisions() call
|
|
for script in script_dir.revision_map.iterate_revisions(
|
|
revision, rev, implicit_base=True):
|
|
if hasattr(script.module, 'check_sanity'):
|
|
script.module.check_sanity(context.connection)
|
|
return []
|
|
|
|
with environment.EnvironmentContext(config, script_dir,
|
|
fn=check_sanity,
|
|
starting_rev=None,
|
|
destination_rev=revision):
|
|
script_dir.run_env()
|
|
|
|
|
|
def main():
|
|
CONF(project='neutron')
|
|
config = get_alembic_config()
|
|
config.neutron_config = CONF
|
|
|
|
#TODO(gongysh) enable logging
|
|
CONF.command.func(config, CONF.command.name)
|