e3ec31c91d
The 16.10 release of the neutron-openvswitch charm changed the
file management strategy of /etc/default/openvswitch-switch
config file from managing the file when dpdk is enabled to always
managing the file. Additionally, the template file was changed
in the 16.10 release to modify the file header (commit 4463c334).
These two changes guarantee that the contents of the file will
change when upgrading the charm.
The changing file contents causes the openvswitch-switch service
to be restarted, which in turn causes a data plane outage. This
commit fixes that by migrating the /etc/default/openvswitch-switch
to be charm managed without restarting the openvswitch-switch
service.
The change will only attempt to migrate versions of the file
which were created before 16.10 by searching for a marker in the
rendered version of the file which was added in 16.10.
Change-Id: Icc0f326991be239b88a57292740473f501181ebb
Closes-Bug: #1712444
252 lines
9.5 KiB
Python
252 lines
9.5 KiB
Python
# Copyright 2016 Canonical Ltd
|
|
#
|
|
# 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 mock import MagicMock, patch, mock_open
|
|
import yaml
|
|
|
|
from test_utils import CharmTestCase
|
|
|
|
with patch('charmhelpers.core.hookenv.config') as config:
|
|
config.return_value = 'neutron'
|
|
import neutron_ovs_utils as utils
|
|
|
|
_reg = utils.register_configs
|
|
_map = utils.restart_map
|
|
|
|
utils.register_configs = MagicMock()
|
|
utils.restart_map = MagicMock()
|
|
|
|
import neutron_ovs_hooks as hooks
|
|
|
|
utils.register_configs = _reg
|
|
utils.restart_map = _map
|
|
|
|
TO_PATCH = [
|
|
'config',
|
|
'CONFIGS',
|
|
'get_shared_secret',
|
|
'git_install',
|
|
'log',
|
|
'relation_ids',
|
|
'relation_set',
|
|
'configure_ovs',
|
|
'configure_sriov',
|
|
'use_dvr',
|
|
'install_packages',
|
|
'purge_packages',
|
|
'enable_nova_metadata',
|
|
'enable_local_dhcp',
|
|
]
|
|
NEUTRON_CONF_DIR = "/etc/neutron"
|
|
|
|
NEUTRON_CONF = '%s/neutron.conf' % NEUTRON_CONF_DIR
|
|
|
|
|
|
class NeutronOVSHooksTests(CharmTestCase):
|
|
|
|
def setUp(self):
|
|
super(NeutronOVSHooksTests, self).setUp(hooks, TO_PATCH)
|
|
|
|
self.config.side_effect = self.test_config.get
|
|
hooks.hooks._config_save = False
|
|
|
|
def _call_hook(self, hookname):
|
|
hooks.hooks.execute([
|
|
'hooks/{}'.format(hookname)])
|
|
|
|
@patch.object(hooks, 'git_install_requested')
|
|
def test_install_hook(self, git_requested):
|
|
git_requested.return_value = False
|
|
self._call_hook('install')
|
|
self.install_packages.assert_called_with()
|
|
|
|
@patch.object(hooks, 'git_install_requested')
|
|
def test_install_hook_git(self, git_requested):
|
|
git_requested.return_value = True
|
|
openstack_origin_git = {
|
|
'repositories': [
|
|
{'name': 'requirements',
|
|
'repository': 'git://git.openstack.org/openstack/requirements', # noqa
|
|
'branch': 'stable/juno'},
|
|
{'name': 'neutron',
|
|
'repository': 'git://git.openstack.org/openstack/neutron',
|
|
'branch': 'stable/juno'}
|
|
],
|
|
'directory': '/mnt/openstack-git',
|
|
}
|
|
projects_yaml = yaml.dump(openstack_origin_git)
|
|
self.test_config.set('openstack-origin-git', projects_yaml)
|
|
self._call_hook('install')
|
|
self.install_packages.assert_called_with()
|
|
self.git_install.assert_called_with(projects_yaml)
|
|
|
|
@patch.object(hooks, 'restart_on_change')
|
|
def test_migrate_ovs_default_file(self, mock_restart):
|
|
# Tests that the /etc/default/openvswitch-switch file is/isn't
|
|
# migrated on the upgrade-charm hook and that no restarts are
|
|
# attempted of the openvswitch-switch service.
|
|
tests = [
|
|
('package-provided-openvswitch-switch', True),
|
|
('16.07-dpdk-openvswitch-switch', True),
|
|
('16.10-openvswitch-switch', False),
|
|
]
|
|
for sample, should_migrate in tests:
|
|
self.CONFIGS.write.reset_mock()
|
|
with open('unit_tests/%s' % sample, 'r') as f:
|
|
content = f.read()
|
|
|
|
with patch('__builtin__.open', mock_open(read_data=content),
|
|
create=True):
|
|
self._call_hook('upgrade-charm')
|
|
if should_migrate:
|
|
self.CONFIGS.write.assert_called_with(utils.OVS_DEFAULT)
|
|
else:
|
|
self.CONFIGS.write.assert_not_called()
|
|
self.assertEqual(0, mock_restart.call_count)
|
|
|
|
@patch.object(hooks, 'git_install_requested')
|
|
def test_config_changed(self, git_requested):
|
|
git_requested.return_value = False
|
|
self.relation_ids.return_value = ['relid']
|
|
_zmq_joined = self.patch('zeromq_configuration_relation_joined')
|
|
self._call_hook('config-changed')
|
|
self.assertTrue(self.CONFIGS.write_all.called)
|
|
self.assertTrue(_zmq_joined.called_with('relid'))
|
|
self.configure_ovs.assert_called_with()
|
|
self.configure_sriov.assert_called_with()
|
|
|
|
@patch.object(hooks, 'git_install_requested')
|
|
@patch.object(hooks, 'config_value_changed')
|
|
def test_config_changed_git(self, config_val_changed, git_requested):
|
|
git_requested.return_value = True
|
|
self.relation_ids.return_value = ['relid']
|
|
_zmq_joined = self.patch('zeromq_configuration_relation_joined')
|
|
openstack_origin_git = {
|
|
'repositories': [
|
|
{'name': 'requirements',
|
|
'repository':
|
|
'git://git.openstack.org/openstack/requirements',
|
|
'branch': 'stable/juno'},
|
|
{'name': 'neutron',
|
|
'repository': 'git://git.openstack.org/openstack/neutron',
|
|
'branch': 'stable/juno'}
|
|
],
|
|
'directory': '/mnt/openstack-git',
|
|
}
|
|
projects_yaml = yaml.dump(openstack_origin_git)
|
|
self.test_config.set('openstack-origin-git', projects_yaml)
|
|
self._call_hook('config-changed')
|
|
self.git_install.assert_called_with(projects_yaml)
|
|
self.assertTrue(self.CONFIGS.write_all.called)
|
|
self.assertTrue(_zmq_joined.called_with('relid'))
|
|
self.configure_ovs.assert_called_with()
|
|
|
|
@patch.object(hooks, 'git_install_requested')
|
|
def test_config_changed_dvr(self, git_requested):
|
|
git_requested.return_value = False
|
|
self._call_hook('config-changed')
|
|
self.install_packages.assert_called_with()
|
|
self.assertTrue(self.CONFIGS.write_all.called)
|
|
self.configure_ovs.assert_called_with()
|
|
|
|
@patch.object(hooks, 'neutron_plugin_joined')
|
|
def test_neutron_plugin_api(self, _plugin_joined):
|
|
self.relation_ids.return_value = ['rid']
|
|
self._call_hook('neutron-plugin-api-relation-changed')
|
|
self.configure_ovs.assert_called_with()
|
|
self.assertTrue(self.CONFIGS.write_all.called)
|
|
_plugin_joined.assert_called_with(relation_id='rid')
|
|
self.install_packages.assert_called_with()
|
|
|
|
@patch.object(hooks, 'neutron_plugin_joined')
|
|
def test_neutron_plugin_api_nodvr(self, _plugin_joined):
|
|
self.use_dvr.return_value = False
|
|
self.relation_ids.return_value = ['rid']
|
|
self._call_hook('neutron-plugin-api-relation-changed')
|
|
self.configure_ovs.assert_called_with()
|
|
self.assertTrue(self.CONFIGS.write_all.called)
|
|
_plugin_joined.assert_called_with(relation_id='rid')
|
|
self.purge_packages.assert_called_with(['neutron-l3-agent'])
|
|
|
|
@patch.object(hooks, 'git_install_requested')
|
|
def test_neutron_plugin_joined_dvr_dhcp(self, git_requested):
|
|
self.enable_nova_metadata.return_value = True
|
|
self.enable_local_dhcp.return_value = True
|
|
self.use_dvr.return_value = True
|
|
git_requested.return_value = False
|
|
self.get_shared_secret.return_value = 'secret'
|
|
self._call_hook('neutron-plugin-relation-joined')
|
|
rel_data = {
|
|
'metadata-shared-secret': 'secret',
|
|
}
|
|
self.relation_set.assert_called_with(
|
|
relation_id=None,
|
|
**rel_data
|
|
)
|
|
self.assertTrue(self.install_packages.called)
|
|
|
|
@patch.object(hooks, 'git_install_requested')
|
|
def test_neutron_plugin_joined_dvr_nodhcp(self, git_requested):
|
|
self.enable_nova_metadata.return_value = True
|
|
self.enable_local_dhcp.return_value = False
|
|
self.use_dvr.return_value = True
|
|
git_requested.return_value = False
|
|
self.get_shared_secret.return_value = 'secret'
|
|
self._call_hook('neutron-plugin-relation-joined')
|
|
rel_data = {
|
|
'metadata-shared-secret': 'secret',
|
|
}
|
|
self.relation_set.assert_called_with(
|
|
relation_id=None,
|
|
**rel_data
|
|
)
|
|
self.purge_packages.assert_called_with(['neutron-dhcp-agent'])
|
|
self.assertFalse(self.install_packages.called)
|
|
|
|
@patch.object(hooks, 'git_install_requested')
|
|
def test_neutron_plugin_joined_nodvr_nodhcp(self, git_requested):
|
|
self.enable_nova_metadata.return_value = False
|
|
self.enable_local_dhcp.return_value = False
|
|
self.use_dvr.return_value = False
|
|
git_requested.return_value = False
|
|
self.get_shared_secret.return_value = 'secret'
|
|
self._call_hook('neutron-plugin-relation-joined')
|
|
rel_data = {
|
|
'metadata-shared-secret': None,
|
|
}
|
|
self.relation_set.assert_called_with(
|
|
relation_id=None,
|
|
**rel_data
|
|
)
|
|
self.purge_packages.assert_called_with(['neutron-dhcp-agent',
|
|
'neutron-metadata-agent'])
|
|
self.assertFalse(self.install_packages.called)
|
|
|
|
def test_amqp_joined(self):
|
|
self._call_hook('amqp-relation-joined')
|
|
self.relation_set.assert_called_with(
|
|
username='neutron',
|
|
vhost='openstack',
|
|
relation_id=None
|
|
)
|
|
|
|
def test_amqp_changed(self):
|
|
self.CONFIGS.complete_contexts.return_value = ['amqp']
|
|
self._call_hook('amqp-relation-changed')
|
|
self.assertTrue(self.CONFIGS.write.called_with(NEUTRON_CONF))
|
|
|
|
def test_amqp_departed(self):
|
|
self._call_hook('amqp-relation-departed')
|
|
self.assertTrue(self.CONFIGS.write.called_with(NEUTRON_CONF))
|