756 lines
30 KiB
Python
756 lines
30 KiB
Python
# Copyright 2012 New Dream Network, LLC (DreamHost)
|
|
# All Rights Reserved.
|
|
#
|
|
# 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 copy
|
|
import os
|
|
import re
|
|
import sys
|
|
import textwrap
|
|
|
|
from alembic.autogenerate import api as alembic_ag_api
|
|
from alembic import config as alembic_config
|
|
from alembic.operations import ops as alembic_ops
|
|
from alembic import script as alembic_script
|
|
import fixtures
|
|
import mock
|
|
from neutron_lib.utils import helpers
|
|
from oslo_utils import fileutils
|
|
import pkg_resources
|
|
import sqlalchemy as sa
|
|
from testtools import matchers
|
|
|
|
from neutron.conf.db import migration_cli
|
|
from neutron.db import migration
|
|
from neutron.db.migration import autogen
|
|
from neutron.db.migration import cli
|
|
from neutron.tests import base
|
|
from neutron.tests import tools
|
|
from neutron.tests.unit import testlib_api
|
|
|
|
|
|
class FakeConfig(object):
|
|
service = ''
|
|
|
|
|
|
class FakeRevision(object):
|
|
path = 'fakepath'
|
|
|
|
def __init__(self, labels=None, down_revision=None, is_branch_point=False):
|
|
if not labels:
|
|
labels = set()
|
|
self.branch_labels = labels
|
|
self.down_revision = down_revision
|
|
self.is_branch_point = is_branch_point
|
|
self.revision = helpers.get_random_string(10)
|
|
self.module = mock.MagicMock()
|
|
|
|
|
|
class MigrationEntrypointsMemento(fixtures.Fixture):
|
|
'''Create a copy of the migration entrypoints map so it can be restored
|
|
during test cleanup.
|
|
'''
|
|
|
|
def _setUp(self):
|
|
self.ep_backup = {}
|
|
for proj, ep in migration_cli.migration_entrypoints.items():
|
|
self.ep_backup[proj] = copy.copy(ep)
|
|
self.addCleanup(self.restore)
|
|
|
|
def restore(self):
|
|
migration_cli.migration_entrypoints = self.ep_backup
|
|
|
|
|
|
class TestDbMigration(base.BaseTestCase):
|
|
|
|
def setUp(self):
|
|
super(TestDbMigration, self).setUp()
|
|
mock.patch('alembic.op.get_bind').start()
|
|
self.mock_alembic_is_offline = mock.patch(
|
|
'alembic.context.is_offline_mode', return_value=False).start()
|
|
self.mock_alembic_is_offline.return_value = False
|
|
self.mock_sa_inspector = mock.patch(
|
|
'sqlalchemy.engine.reflection.Inspector').start()
|
|
|
|
def _prepare_mocked_sqlalchemy_inspector(self):
|
|
mock_inspector = mock.MagicMock()
|
|
mock_inspector.get_table_names.return_value = ['foo', 'bar']
|
|
mock_inspector.get_columns.return_value = [{'name': 'foo_column'},
|
|
{'name': 'bar_column'}]
|
|
self.mock_sa_inspector.from_engine.return_value = mock_inspector
|
|
|
|
def test_schema_has_table(self):
|
|
self._prepare_mocked_sqlalchemy_inspector()
|
|
self.assertTrue(migration.schema_has_table('foo'))
|
|
|
|
def test_schema_has_table_raises_if_offline(self):
|
|
self.mock_alembic_is_offline.return_value = True
|
|
self.assertRaises(RuntimeError, migration.schema_has_table, 'foo')
|
|
|
|
def test_schema_has_column_missing_table(self):
|
|
self._prepare_mocked_sqlalchemy_inspector()
|
|
self.assertFalse(migration.schema_has_column('meh', 'meh'))
|
|
|
|
def test_schema_has_column(self):
|
|
self._prepare_mocked_sqlalchemy_inspector()
|
|
self.assertTrue(migration.schema_has_column('foo', 'foo_column'))
|
|
|
|
def test_schema_has_column_raises_if_offline(self):
|
|
self.mock_alembic_is_offline.return_value = True
|
|
self.assertRaises(RuntimeError, migration.schema_has_column,
|
|
'foo', 'foo_col')
|
|
|
|
def test_schema_has_column_missing_column(self):
|
|
self._prepare_mocked_sqlalchemy_inspector()
|
|
self.assertFalse(migration.schema_has_column(
|
|
'foo', column_name='meh'))
|
|
|
|
|
|
class TestCli(base.BaseTestCase):
|
|
def setUp(self):
|
|
super(TestCli, self).setUp()
|
|
self.do_alembic_cmd_p = mock.patch.object(cli, 'do_alembic_command')
|
|
self.do_alembic_cmd = self.do_alembic_cmd_p.start()
|
|
self.mock_alembic_err = mock.patch.object(cli, "log_error").start()
|
|
self.mock_alembic_warn = mock.patch.object(cli, "log_warning").start()
|
|
self.mock_alembic_err.side_effect = SystemExit
|
|
|
|
def mocked_root_dir(cfg):
|
|
return os.path.join('/fake/dir', cli._get_project_base(cfg))
|
|
mock_root = mock.patch.object(cli, '_get_package_root_dir').start()
|
|
mock_root.side_effect = mocked_root_dir
|
|
# Avoid creating fake directories
|
|
mock.patch('oslo_utils.fileutils.ensure_tree').start()
|
|
|
|
# Set up some configs and entrypoints for tests to chew on
|
|
self.configs = []
|
|
self.projects = ('neutron', 'networking-foo', 'neutron-fwaas')
|
|
ini = os.path.join(os.path.dirname(cli.__file__), 'alembic.ini')
|
|
self.useFixture(MigrationEntrypointsMemento())
|
|
migration_cli.migration_entrypoints = {}
|
|
for project in self.projects:
|
|
config = alembic_config.Config(ini)
|
|
config.set_main_option('neutron_project', project)
|
|
module_name = project.replace('-', '_') + '.db.migration'
|
|
attrs = ('alembic_migrations',)
|
|
script_location = ':'.join([module_name, attrs[0]])
|
|
config.set_main_option('script_location', script_location)
|
|
self.configs.append(config)
|
|
entrypoint = pkg_resources.EntryPoint(project,
|
|
module_name,
|
|
attrs=attrs)
|
|
migration_cli.migration_entrypoints[project] = entrypoint
|
|
|
|
def _main_test_helper(self, argv, func_name, exp_kwargs=[{}]):
|
|
with mock.patch.object(sys, 'argv', argv),\
|
|
mock.patch.object(cli, 'run_sanity_checks'),\
|
|
mock.patch.object(cli, 'validate_revisions'):
|
|
|
|
cli.main()
|
|
|
|
def _append_version_path(args):
|
|
args = copy.copy(args)
|
|
if 'autogenerate' in args and not args['autogenerate']:
|
|
args['version_path'] = mock.ANY
|
|
return args
|
|
|
|
self.do_alembic_cmd.assert_has_calls(
|
|
[mock.call(mock.ANY, func_name, **_append_version_path(kwargs))
|
|
for kwargs in exp_kwargs]
|
|
)
|
|
|
|
def test_stamp(self):
|
|
self._main_test_helper(
|
|
['prog', 'stamp', 'foo'],
|
|
'stamp',
|
|
[{'revision': 'foo', 'sql': False}]
|
|
)
|
|
|
|
self._main_test_helper(
|
|
['prog', 'stamp', 'foo', '--sql'],
|
|
'stamp',
|
|
[{'revision': 'foo', 'sql': True}]
|
|
)
|
|
|
|
def _validate_cmd(self, cmd):
|
|
self._main_test_helper(
|
|
['prog', cmd],
|
|
cmd,
|
|
[{'verbose': False}])
|
|
|
|
self._main_test_helper(
|
|
['prog', cmd, '--verbose'],
|
|
cmd,
|
|
[{'verbose': True}])
|
|
|
|
def test_branches(self):
|
|
self._validate_cmd('branches')
|
|
|
|
def test_current(self):
|
|
self._validate_cmd('current')
|
|
|
|
def test_history(self):
|
|
self._validate_cmd('history')
|
|
|
|
def test_heads(self):
|
|
self._validate_cmd('heads')
|
|
|
|
def test_check_migration(self):
|
|
with mock.patch.object(cli, 'validate_head_files') as validate:
|
|
self._main_test_helper(['prog', 'check_migration'], 'branches')
|
|
self.assertEqual(len(self.projects), validate.call_count)
|
|
|
|
def _test_database_sync_revision(self, separate_branches=True):
|
|
with mock.patch.object(cli, 'update_head_files') as update:
|
|
if separate_branches:
|
|
mock.patch('os.path.exists').start()
|
|
expected_kwargs = [{
|
|
'message': 'message', 'sql': False, 'autogenerate': True,
|
|
}]
|
|
self._main_test_helper(
|
|
['prog', 'revision', '--autogenerate', '-m', 'message'],
|
|
'revision',
|
|
expected_kwargs
|
|
)
|
|
self.assertEqual(len(self.projects), update.call_count)
|
|
update.reset_mock()
|
|
|
|
expected_kwargs = [{
|
|
'message': 'message',
|
|
'sql': True,
|
|
'autogenerate': False,
|
|
'head': cli._get_branch_head(branch)
|
|
} for branch in cli.MIGRATION_BRANCHES]
|
|
for kwarg in expected_kwargs:
|
|
kwarg['autogenerate'] = False
|
|
kwarg['sql'] = True
|
|
|
|
self._main_test_helper(
|
|
['prog', 'revision', '--sql', '-m', 'message'],
|
|
'revision',
|
|
expected_kwargs
|
|
)
|
|
self.assertEqual(len(self.projects), update.call_count)
|
|
update.reset_mock()
|
|
|
|
expected_kwargs = [{
|
|
'message': 'message',
|
|
'sql': False,
|
|
'autogenerate': False,
|
|
'head': 'expand@head'
|
|
}]
|
|
self._main_test_helper(
|
|
['prog', 'revision', '-m', 'message', '--expand'],
|
|
'revision',
|
|
expected_kwargs
|
|
)
|
|
self.assertEqual(len(self.projects), update.call_count)
|
|
update.reset_mock()
|
|
|
|
for kwarg in expected_kwargs:
|
|
kwarg['head'] = 'contract@head'
|
|
|
|
self._main_test_helper(
|
|
['prog', 'revision', '-m', 'message', '--contract'],
|
|
'revision',
|
|
expected_kwargs
|
|
)
|
|
self.assertEqual(len(self.projects), update.call_count)
|
|
|
|
def test_database_sync_revision(self):
|
|
self._test_database_sync_revision()
|
|
|
|
def test_database_sync_revision_no_branches(self):
|
|
# Test that old branchless approach is still supported
|
|
self._test_database_sync_revision(separate_branches=False)
|
|
|
|
def test_upgrade_revision(self):
|
|
self._main_test_helper(
|
|
['prog', 'upgrade', '--sql', 'head'],
|
|
'upgrade',
|
|
[{'desc': None, 'revision': 'heads', 'sql': True}]
|
|
)
|
|
|
|
def test_upgrade_delta(self):
|
|
self._main_test_helper(
|
|
['prog', 'upgrade', '--delta', '3'],
|
|
'upgrade',
|
|
[{'desc': None, 'revision': '+3', 'sql': False}]
|
|
)
|
|
|
|
def test_upgrade_revision_delta(self):
|
|
self._main_test_helper(
|
|
['prog', 'upgrade', 'kilo', '--delta', '3'],
|
|
'upgrade',
|
|
[{'desc': None, 'revision': 'kilo+3', 'sql': False}]
|
|
)
|
|
|
|
def test_upgrade_expand(self):
|
|
self._main_test_helper(
|
|
['prog', 'upgrade', '--expand'],
|
|
'upgrade',
|
|
[{'desc': cli.EXPAND_BRANCH,
|
|
'revision': 'expand@head',
|
|
'sql': False}]
|
|
)
|
|
|
|
def test_upgrade_expand_contract_are_mutually_exclusive(self):
|
|
with testlib_api.ExpectedException(SystemExit):
|
|
self._main_test_helper(
|
|
['prog', 'upgrade', '--expand --contract'], 'upgrade')
|
|
|
|
def _test_upgrade_conflicts_with_revision(self, mode):
|
|
with testlib_api.ExpectedException(SystemExit):
|
|
self._main_test_helper(
|
|
['prog', 'upgrade', '--%s revision1' % mode], 'upgrade')
|
|
|
|
def _test_upgrade_conflicts_with_delta(self, mode):
|
|
with testlib_api.ExpectedException(SystemExit):
|
|
self._main_test_helper(
|
|
['prog', 'upgrade', '--%s +3' % mode], 'upgrade')
|
|
|
|
def _test_revision_autogenerate_conflicts_with_branch(self, branch):
|
|
with testlib_api.ExpectedException(SystemExit):
|
|
self._main_test_helper(
|
|
['prog', 'revision', '--autogenerate', '--%s' % branch],
|
|
'revision')
|
|
|
|
def test_revision_autogenerate_conflicts_with_expand(self):
|
|
self._test_revision_autogenerate_conflicts_with_branch(
|
|
cli.EXPAND_BRANCH)
|
|
|
|
def test_revision_autogenerate_conflicts_with_contract(self):
|
|
self._test_revision_autogenerate_conflicts_with_branch(
|
|
cli.CONTRACT_BRANCH)
|
|
|
|
def test_upgrade_expand_conflicts_with_revision(self):
|
|
self._test_upgrade_conflicts_with_revision('expand')
|
|
|
|
def test_upgrade_contract_conflicts_with_revision(self):
|
|
self._test_upgrade_conflicts_with_revision('contract')
|
|
|
|
def test_upgrade_expand_conflicts_with_delta(self):
|
|
self._test_upgrade_conflicts_with_delta('expand')
|
|
|
|
def test_upgrade_contract_conflicts_with_delta(self):
|
|
self._test_upgrade_conflicts_with_delta('contract')
|
|
|
|
def test_upgrade_contract(self):
|
|
self._main_test_helper(
|
|
['prog', 'upgrade', '--contract'],
|
|
'upgrade',
|
|
[{'desc': cli.CONTRACT_BRANCH,
|
|
'revision': 'contract@head',
|
|
'sql': False}]
|
|
)
|
|
|
|
@mock.patch('alembic.script.ScriptDirectory.walk_revisions')
|
|
def test_upgrade_milestone_expand_before_contract(self, walk_mock):
|
|
c_revs = [FakeRevision(labels={cli.CONTRACT_BRANCH}) for r in range(5)]
|
|
c_revs[1].module.neutron_milestone = [migration.LIBERTY]
|
|
e_revs = [FakeRevision(labels={cli.EXPAND_BRANCH}) for r in range(5)]
|
|
e_revs[3].module.neutron_milestone = [migration.LIBERTY]
|
|
walk_mock.return_value = c_revs + e_revs
|
|
self._main_test_helper(
|
|
['prog', '--subproject', 'neutron', 'upgrade', 'liberty'],
|
|
'upgrade',
|
|
[{'desc': cli.EXPAND_BRANCH,
|
|
'revision': e_revs[3].revision,
|
|
'sql': False},
|
|
{'desc': cli.CONTRACT_BRANCH,
|
|
'revision': c_revs[1].revision,
|
|
'sql': False}]
|
|
)
|
|
|
|
def assert_command_fails(self, command):
|
|
# Avoid cluttering stdout with argparse error messages
|
|
mock.patch('argparse.ArgumentParser._print_message').start()
|
|
with mock.patch.object(sys, 'argv', command), mock.patch.object(
|
|
cli, 'run_sanity_checks'):
|
|
self.assertRaises(SystemExit, cli.main)
|
|
|
|
def test_downgrade_fails(self):
|
|
self.assert_command_fails(['prog', 'downgrade', '--sql', 'juno'])
|
|
|
|
def test_upgrade_negative_relative_revision_fails(self):
|
|
self.assert_command_fails(['prog', 'upgrade', '-2'])
|
|
|
|
def test_upgrade_negative_delta_fails(self):
|
|
self.assert_command_fails(['prog', 'upgrade', '--delta', '-2'])
|
|
|
|
def test_upgrade_rejects_delta_with_relative_revision(self):
|
|
self.assert_command_fails(['prog', 'upgrade', '+2', '--delta', '3'])
|
|
|
|
def _test_validate_head_files_helper(self, heads, contract_head='',
|
|
expand_head=''):
|
|
fake_config = self.configs[0]
|
|
head_files_not_exist = (contract_head == expand_head == '')
|
|
with mock.patch('alembic.script.ScriptDirectory.from_config') as fc,\
|
|
mock.patch('os.path.exists') as os_mock:
|
|
if head_files_not_exist:
|
|
os_mock.return_value = False
|
|
else:
|
|
os_mock.return_value = True
|
|
|
|
fc.return_value.get_heads.return_value = heads
|
|
|
|
revs = {heads[0]: FakeRevision(labels=cli.CONTRACT_BRANCH),
|
|
heads[1]: FakeRevision(labels=cli.EXPAND_BRANCH)}
|
|
fc.return_value.get_revision.side_effect = revs.__getitem__
|
|
mock_open_con = self.useFixture(
|
|
tools.OpenFixture(cli._get_contract_head_file_path(
|
|
fake_config), contract_head + '\n')).mock_open
|
|
mock_open_ex = self.useFixture(
|
|
tools.OpenFixture(cli._get_expand_head_file_path(
|
|
fake_config), expand_head + '\n')).mock_open
|
|
|
|
if contract_head in heads and expand_head in heads:
|
|
cli.validate_head_files(fake_config)
|
|
elif head_files_not_exist:
|
|
cli.validate_head_files(fake_config)
|
|
self.assertTrue(self.mock_alembic_warn.called)
|
|
else:
|
|
self.assertRaises(
|
|
SystemExit,
|
|
cli.validate_head_files,
|
|
fake_config
|
|
)
|
|
self.assertTrue(self.mock_alembic_err.called)
|
|
|
|
if contract_head in heads and expand_head in heads:
|
|
mock_open_ex.assert_called_with(
|
|
cli._get_expand_head_file_path(fake_config))
|
|
mock_open_con.assert_called_with(
|
|
cli._get_contract_head_file_path(fake_config))
|
|
|
|
if not head_files_not_exist:
|
|
fc.assert_called_once_with(fake_config)
|
|
|
|
def test_validate_head_files_success(self):
|
|
self._test_validate_head_files_helper(['a', 'b'], contract_head='a',
|
|
expand_head='b')
|
|
|
|
def test_validate_head_files_missing_file(self):
|
|
self._test_validate_head_files_helper(['a', 'b'])
|
|
|
|
def test_validate_head_files_wrong_contents(self):
|
|
self._test_validate_head_files_helper(['a', 'b'], contract_head='c',
|
|
expand_head='d')
|
|
|
|
@mock.patch.object(fileutils, 'delete_if_exists')
|
|
def test_update_head_files_success(self, *mocks):
|
|
heads = ['a', 'b']
|
|
mock_open_con = self.useFixture(
|
|
tools.OpenFixture(cli._get_contract_head_file_path(
|
|
self.configs[0]))).mock_open
|
|
mock_open_ex = self.useFixture(
|
|
tools.OpenFixture(cli._get_expand_head_file_path(
|
|
self.configs[0]))).mock_open
|
|
with mock.patch('alembic.script.ScriptDirectory.from_config') as fc:
|
|
fc.return_value.get_heads.return_value = heads
|
|
revs = {heads[0]: FakeRevision(labels=cli.CONTRACT_BRANCH),
|
|
heads[1]: FakeRevision(labels=cli.EXPAND_BRANCH)}
|
|
fc.return_value.get_revision.side_effect = revs.__getitem__
|
|
cli.update_head_files(self.configs[0])
|
|
mock_open_con.return_value.write.assert_called_with(
|
|
heads[0] + '\n')
|
|
mock_open_ex.return_value.write.assert_called_with(heads[1] + '\n')
|
|
|
|
old_head_file = cli._get_head_file_path(
|
|
self.configs[0])
|
|
old_heads_file = cli._get_heads_file_path(
|
|
self.configs[0])
|
|
delete_if_exists = mocks[0]
|
|
self.assertIn(mock.call(old_head_file),
|
|
delete_if_exists.call_args_list)
|
|
self.assertIn(mock.call(old_heads_file),
|
|
delete_if_exists.call_args_list)
|
|
|
|
def test_get_project_base(self):
|
|
config = alembic_config.Config()
|
|
config.set_main_option('script_location', 'a.b.c:d')
|
|
proj_base = cli._get_project_base(config)
|
|
self.assertEqual('a', proj_base)
|
|
|
|
def test_get_root_versions_dir(self):
|
|
config = alembic_config.Config()
|
|
config.set_main_option('script_location', 'a.b.c:d')
|
|
versions_dir = cli._get_root_versions_dir(config)
|
|
self.assertEqual('/fake/dir/a/a/b/c/d/versions', versions_dir)
|
|
|
|
def test_get_subproject_script_location(self):
|
|
foo_ep = cli._get_subproject_script_location('networking-foo')
|
|
expected = 'networking_foo.db.migration:alembic_migrations'
|
|
self.assertEqual(expected, foo_ep)
|
|
|
|
def test_get_subproject_script_location_not_installed(self):
|
|
self.assertRaises(
|
|
SystemExit, cli._get_subproject_script_location, 'not-installed')
|
|
|
|
def test_get_subproject_base_not_installed(self):
|
|
self.assertRaises(
|
|
SystemExit, cli._get_subproject_base, 'not-installed')
|
|
|
|
def test__compare_labels_ok(self):
|
|
labels = {'label1', 'label2'}
|
|
fake_revision = FakeRevision(labels)
|
|
cli._compare_labels(fake_revision, {'label1', 'label2'})
|
|
|
|
def test__compare_labels_fail_unexpected_labels(self):
|
|
labels = {'label1', 'label2', 'label3'}
|
|
fake_revision = FakeRevision(labels)
|
|
self.assertRaises(
|
|
SystemExit,
|
|
cli._compare_labels, fake_revision, {'label1', 'label2'})
|
|
|
|
@mock.patch.object(cli, '_compare_labels')
|
|
def test__validate_single_revision_labels_branchless_fail_different_labels(
|
|
self, compare_mock):
|
|
|
|
fake_down_revision = FakeRevision()
|
|
fake_revision = FakeRevision(down_revision=fake_down_revision)
|
|
|
|
script_dir = mock.Mock()
|
|
script_dir.get_revision.return_value = fake_down_revision
|
|
cli._validate_single_revision_labels(script_dir, fake_revision,
|
|
label=None)
|
|
|
|
expected_labels = set()
|
|
compare_mock.assert_has_calls(
|
|
[mock.call(revision, expected_labels)
|
|
for revision in (fake_revision, fake_down_revision)]
|
|
)
|
|
|
|
@mock.patch.object(cli, '_compare_labels')
|
|
def test__validate_single_revision_labels_branches_fail_different_labels(
|
|
self, compare_mock):
|
|
|
|
fake_down_revision = FakeRevision()
|
|
fake_revision = FakeRevision(down_revision=fake_down_revision)
|
|
|
|
script_dir = mock.Mock()
|
|
script_dir.get_revision.return_value = fake_down_revision
|
|
cli._validate_single_revision_labels(
|
|
script_dir, fake_revision, label='fakebranch')
|
|
|
|
expected_labels = {'fakebranch'}
|
|
compare_mock.assert_has_calls(
|
|
[mock.call(revision, expected_labels)
|
|
for revision in (fake_revision, fake_down_revision)]
|
|
)
|
|
|
|
@mock.patch.object(cli, '_validate_single_revision_labels')
|
|
def test__validate_revision_validates_branches(self, validate_mock):
|
|
script_dir = mock.Mock()
|
|
fake_revision = FakeRevision()
|
|
branch = cli.MIGRATION_BRANCHES[0]
|
|
fake_revision.path = os.path.join('/fake/path', branch)
|
|
cli._validate_revision(script_dir, fake_revision)
|
|
validate_mock.assert_called_with(
|
|
script_dir, fake_revision, label=branch)
|
|
|
|
@mock.patch.object(cli, '_validate_single_revision_labels')
|
|
def test__validate_revision_validates_branchless_migrations(
|
|
self, validate_mock):
|
|
|
|
script_dir = mock.Mock()
|
|
fake_revision = FakeRevision()
|
|
cli._validate_revision(script_dir, fake_revision)
|
|
validate_mock.assert_called_with(script_dir, fake_revision)
|
|
|
|
@mock.patch.object(cli, '_validate_revision')
|
|
@mock.patch('alembic.script.ScriptDirectory.walk_revisions')
|
|
def test_validate_revisions_walks_thru_all_revisions(
|
|
self, walk_mock, validate_mock):
|
|
|
|
revisions = [FakeRevision() for i in range(10)]
|
|
walk_mock.return_value = revisions
|
|
cli.validate_revisions(self.configs[0])
|
|
validate_mock.assert_has_calls(
|
|
[mock.call(mock.ANY, revision) for revision in revisions]
|
|
)
|
|
|
|
@mock.patch.object(cli, '_validate_revision')
|
|
@mock.patch('alembic.script.ScriptDirectory.walk_revisions')
|
|
def test_validate_revisions_fails_on_multiple_branch_points(
|
|
self, walk_mock, validate_mock):
|
|
|
|
revisions = [FakeRevision(is_branch_point=True) for i in range(2)]
|
|
walk_mock.return_value = revisions
|
|
self.assertRaises(
|
|
SystemExit, cli.validate_revisions, self.configs[0])
|
|
|
|
@mock.patch('alembic.script.ScriptDirectory.walk_revisions')
|
|
def test__get_branch_points(self, walk_mock):
|
|
revisions = [FakeRevision(is_branch_point=tools.get_random_boolean)
|
|
for i in range(50)]
|
|
walk_mock.return_value = revisions
|
|
script_dir = alembic_script.ScriptDirectory.from_config(
|
|
self.configs[0])
|
|
self.assertEqual(set(rev for rev in revisions if rev.is_branch_point),
|
|
set(cli._get_branch_points(script_dir)))
|
|
|
|
@mock.patch.object(cli, '_get_version_branch_path')
|
|
def test_autogen_process_directives(self, get_version_branch_path):
|
|
|
|
get_version_branch_path.side_effect = lambda cfg, release, branch: (
|
|
"/foo/expand" if branch == 'expand' else "/foo/contract")
|
|
|
|
migration_script = alembic_ops.MigrationScript(
|
|
'eced083f5df',
|
|
# these directives will be split into separate
|
|
# expand/contract scripts
|
|
alembic_ops.UpgradeOps(
|
|
ops=[
|
|
alembic_ops.CreateTableOp(
|
|
'organization',
|
|
[
|
|
sa.Column('id', sa.Integer(), primary_key=True),
|
|
sa.Column('name', sa.String(50), nullable=False)
|
|
]
|
|
),
|
|
alembic_ops.ModifyTableOps(
|
|
'user',
|
|
ops=[
|
|
alembic_ops.AddColumnOp(
|
|
'user',
|
|
sa.Column('organization_id', sa.Integer())
|
|
),
|
|
alembic_ops.CreateForeignKeyOp(
|
|
'org_fk', 'user', 'organization',
|
|
['organization_id'], ['id']
|
|
),
|
|
alembic_ops.DropConstraintOp(
|
|
'user', 'uq_user_org'
|
|
),
|
|
alembic_ops.DropColumnOp(
|
|
'user', 'organization_name'
|
|
)
|
|
]
|
|
)
|
|
]
|
|
),
|
|
# these will be discarded
|
|
alembic_ops.DowngradeOps(
|
|
ops=[
|
|
alembic_ops.AddColumnOp(
|
|
'user', sa.Column(
|
|
'organization_name', sa.String(50), nullable=True)
|
|
),
|
|
alembic_ops.CreateUniqueConstraintOp(
|
|
'uq_user_org', 'user',
|
|
['user_name', 'organization_name']
|
|
),
|
|
alembic_ops.ModifyTableOps(
|
|
'user',
|
|
ops=[
|
|
alembic_ops.DropConstraintOp('org_fk', 'user'),
|
|
alembic_ops.DropColumnOp('user', 'organization_id')
|
|
]
|
|
),
|
|
alembic_ops.DropTableOp('organization')
|
|
]
|
|
),
|
|
message='create the organization table and '
|
|
'replace user.organization_name'
|
|
)
|
|
|
|
directives = [migration_script]
|
|
autogen.process_revision_directives(
|
|
mock.Mock(), mock.Mock(), directives
|
|
)
|
|
|
|
expand = directives[0]
|
|
contract = directives[1]
|
|
self.assertEqual("/foo/expand", expand.version_path)
|
|
self.assertEqual("/foo/contract", contract.version_path)
|
|
self.assertTrue(expand.downgrade_ops.is_empty())
|
|
self.assertTrue(contract.downgrade_ops.is_empty())
|
|
|
|
def _get_regex(s):
|
|
s = textwrap.dedent(s)
|
|
s = re.escape(s)
|
|
# alembic 0.8.9 added additional leading '# ' before comments
|
|
return s.replace('\\#\\#\\#\\ ', '(# )?### ')
|
|
|
|
expected_regex = ("""\
|
|
### commands auto generated by Alembic - please adjust! ###
|
|
op.create_table('organization',
|
|
sa.Column('id', sa.Integer(), nullable=False),
|
|
sa.Column('name', sa.String(length=50), nullable=False),
|
|
sa.PrimaryKeyConstraint('id')
|
|
)
|
|
op.add_column('user', """
|
|
"""sa.Column('organization_id', sa.Integer(), nullable=True))
|
|
op.create_foreign_key('org_fk', 'user', """
|
|
"""'organization', ['organization_id'], ['id'])
|
|
### end Alembic commands ###""")
|
|
self.assertThat(
|
|
alembic_ag_api.render_python_code(expand.upgrade_ops),
|
|
matchers.MatchesRegex(_get_regex(expected_regex)))
|
|
|
|
expected_regex = ("""\
|
|
### commands auto generated by Alembic - please adjust! ###
|
|
op.drop_constraint('user', 'uq_user_org', type_=None)
|
|
op.drop_column('user', 'organization_name')
|
|
### end Alembic commands ###""")
|
|
self.assertThat(
|
|
alembic_ag_api.render_python_code(contract.upgrade_ops),
|
|
matchers.MatchesRegex(_get_regex(expected_regex)))
|
|
|
|
@mock.patch('alembic.script.ScriptDirectory.walk_revisions')
|
|
def test__find_milestone_revisions_one_branch(self, walk_mock):
|
|
c_revs = [FakeRevision(labels={cli.CONTRACT_BRANCH}) for r in range(5)]
|
|
c_revs[1].module.neutron_milestone = [migration.LIBERTY]
|
|
|
|
walk_mock.return_value = c_revs
|
|
m = cli._find_milestone_revisions(self.configs[0], 'liberty',
|
|
cli.CONTRACT_BRANCH)
|
|
self.assertEqual(1, len(m))
|
|
m = cli._find_milestone_revisions(self.configs[0], 'liberty',
|
|
cli.EXPAND_BRANCH)
|
|
self.assertEqual(0, len(m))
|
|
|
|
@mock.patch('alembic.script.ScriptDirectory.walk_revisions')
|
|
def test__find_milestone_revisions_two_branches(self, walk_mock):
|
|
c_revs = [FakeRevision(labels={cli.CONTRACT_BRANCH}) for r in range(5)]
|
|
c_revs[1].module.neutron_milestone = [migration.LIBERTY]
|
|
e_revs = [FakeRevision(labels={cli.EXPAND_BRANCH}) for r in range(5)]
|
|
e_revs[3].module.neutron_milestone = [migration.LIBERTY]
|
|
|
|
walk_mock.return_value = c_revs + e_revs
|
|
m = cli._find_milestone_revisions(self.configs[0], 'liberty')
|
|
self.assertEqual(2, len(m))
|
|
|
|
m = cli._find_milestone_revisions(self.configs[0], 'mitaka')
|
|
self.assertEqual(0, len(m))
|
|
|
|
@mock.patch('alembic.script.ScriptDirectory.walk_revisions')
|
|
def test__find_milestone_revisions_branchless(self, walk_mock):
|
|
revisions = [FakeRevision() for r in range(5)]
|
|
revisions[2].module.neutron_milestone = [migration.LIBERTY]
|
|
|
|
walk_mock.return_value = revisions
|
|
m = cli._find_milestone_revisions(self.configs[0], 'liberty')
|
|
self.assertEqual(1, len(m))
|
|
|
|
m = cli._find_milestone_revisions(self.configs[0], 'mitaka')
|
|
self.assertEqual(0, len(m))
|
|
|
|
|
|
class TestSafetyChecks(base.BaseTestCase):
|
|
|
|
def test_validate_revisions(self, *mocks):
|
|
cli.validate_revisions(cli.get_neutron_config())
|