openstack
/
neutron
Code Issues Proposed changes

Complete removing support for unsplit alembic branches 

We used to support subprojects with a single alembic branch.
Now the plan is to switch to a single alembic env for Neutron
and all installed subprojects. In a single alembic env, all
subprojects must use split (contract and expand) alembic branches.

The first step of removing single branch support was done in [1]
where we removed support for single HEAD files.

The --split_branches option was used by developers only. By removing
it we do not break any subproject, but force them to use split
branches for any new migration scripts.

[1] https://review.openstack.org/295905

Partial-Bug: #1497830

Change-Id: I62a191e1d22a1af4061c25fdc4a8df965d585419
This commit is contained in:
Henry Gessau 2016-06-06 15:15:23 -04:00
parent 26230eb840
commit 65bd0cd9ff
3 changed files with 16 additions and 56 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
neutron/db/migration/autogen.py
View File

@ -22,10 +22,9 @@ _ec_dispatcher = Dispatcher()
def process_revision_directives(context, revision, directives):
if cli._use_separate_migration_branches(context.config):
directives[:] = [
directive for directive in _assign_directives(context, directives)
]
directives[:] = [
directive for directive in _assign_directives(context, directives)
]
def _assign_directives(context, directives, phase=None):

19
neutron/db/migration/cli.py
View File

@ -69,8 +69,11 @@ _core_opts = [
"Can be one of: '%s'.")
% "', '".join(INSTALLED_SUBPROJECTS))),
cfg.BoolOpt('split_branches',
default=False,
help=_("Enforce using split branches file structure."))
default=True,
deprecated_for_removal=True,
help=_("DEPRECATED. Alembic environments integrating with "
"Neutron must implement split (contract and expand) "
"branches file structure."))
]
_db_opts = [
@ -557,18 +560,6 @@ def _get_version_branch_path(config, release=None, branch=None):
return version_path
def _use_separate_migration_branches(config):
'''Detect whether split migration branches should be used.'''
if CONF.split_branches:
return True
script_dir = alembic_script.ScriptDirectory.from_config(config)
if _get_branch_points(script_dir):
return True
return False
def _set_version_locations(config):
'''Make alembic see all revisions in all migration branches.'''
split_branches = False

46
neutron/tests/unit/db/test_migration.py
View File

@ -150,9 +150,8 @@ class TestCli(base.BaseTestCase):
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'),\
mock.patch.object(cli, '_use_separate_migration_branches'):
mock.patch.object(cli, 'run_sanity_checks'),\
mock.patch.object(cli, 'validate_revisions'):
cli.main()
@ -209,9 +208,7 @@ class TestCli(base.BaseTestCase):
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,\
mock.patch.object(cli, '_use_separate_migration_branches',
return_value=separate_branches):
with mock.patch.object(cli, 'update_head_files') as update:
if separate_branches:
mock.patch('os.path.exists').start()
expected_kwargs = [{
@ -382,16 +379,13 @@ class TestCli(base.BaseTestCase):
def test_downgrade_fails(self):
self.assert_command_fails(['prog', 'downgrade', '--sql', 'juno'])
@mock.patch.object(cli, '_use_separate_migration_branches')
def test_upgrade_negative_relative_revision_fails(self, use_mock):
def test_upgrade_negative_relative_revision_fails(self):
self.assert_command_fails(['prog', 'upgrade', '-2'])
@mock.patch.object(cli, '_use_separate_migration_branches')
def test_upgrade_negative_delta_fails(self, use_mock):
def test_upgrade_negative_delta_fails(self):
self.assert_command_fails(['prog', 'upgrade', '--delta', '-2'])
@mock.patch.object(cli, '_use_separate_migration_branches')
def test_upgrade_rejects_delta_with_relative_revision(self, use_mock):
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='',
@ -399,9 +393,7 @@ class TestCli(base.BaseTestCase):
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,\
mock.patch.object(cli, '_use_separate_migration_branches',
return_value=True):
mock.patch('os.path.exists') as os_mock:
if head_files_not_exist:
os_mock.return_value = False
else:
@ -452,8 +444,6 @@ class TestCli(base.BaseTestCase):
self._test_validate_head_files_helper(['a', 'b'], contract_head='c',
expand_head='d')
@mock.patch.object(cli, '_use_separate_migration_branches',
return_value=True)
@mock.patch.object(fileutils, 'delete_if_exists')
def test_update_head_files_success(self, *mocks):
heads = ['a', 'b']
@ -607,14 +597,9 @@ class TestCli(base.BaseTestCase):
self.assertEqual(set(rev for rev in revisions if rev.is_branch_point),
set(cli._get_branch_points(script_dir)))
@mock.patch.object(cli, '_use_separate_migration_branches')
@mock.patch.object(cli, '_get_version_branch_path')
def test_autogen_process_directives(
self,
get_version_branch_path,
use_separate_migration_branches):
def test_autogen_process_directives(self, get_version_branch_path):
use_separate_migration_branches.return_value = True
get_version_branch_path.side_effect = lambda cfg, release, branch: (
"/foo/expand" if branch == 'expand' else "/foo/contract")
@ -713,21 +698,6 @@ class TestCli(base.BaseTestCase):
alembic_ag_api.render_python_code(contract.upgrade_ops)
)
@mock.patch.object(cli, '_get_branch_points', return_value=[])
@mock.patch.object(cli.CONF, 'split_branches',
new_callable=mock.PropertyMock,
return_value=True, create=True)
def test__use_separate_migration_branches_enforced(self, *mocks):
self.assertTrue(cli._use_separate_migration_branches(self.configs[0]))
@mock.patch.object(cli, '_get_branch_points', return_value=[])
def test__use_separate_migration_branches_no_branch_points(self, *mocks):
self.assertFalse(cli._use_separate_migration_branches(self.configs[0]))
@mock.patch.object(cli, '_get_branch_points', return_value=['fake1'])
def test__use_separate_migration_branches_with_branch_points(self, *mocks):
self.assertTrue(cli._use_separate_migration_branches(self.configs[0]))
@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)]