charm-cinder/unit_tests/test_cinder_contexts.py
Samuel Walladge 7f97a6d30e Add support to configure scheduler_default_filters
Add new config option: `scheduler-default-filters`.
This is unset by default, so cinder retains the default value for
scheduler_default_filters.

Closes-Bug: #1956727
Change-Id: I9777bf8fe5ddbb69689db60c2790e8a4be57e1ab
2022-01-25 11:04:40 +10:30

548 lines
23 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.
import os
from test_utils import CharmTestCase
from unittest.mock import patch, MagicMock
import cinder_contexts as contexts
os.environ['JUJU_UNIT_NAME'] = 'cinder'
import cinder_utils as utils
TO_PATCH = [
'config',
'relation_ids',
'service_name',
'determine_apache_port',
'determine_api_port',
'os_release',
'related_units',
'relation_get'
]
class TestCinderContext(CharmTestCase):
def setUp(self):
super(TestCinderContext, self).setUp(contexts, TO_PATCH)
def test_enable_lvm_disabled(self):
for v in [None, 'None', 'none']:
self.config.return_value = v
self.assertFalse(contexts.enable_lvm())
def test_enable_lvm_enabled(self):
self.config.return_value = '/dev/sdd'
self.assertTrue(contexts.enable_lvm())
def test_glance_not_related(self):
self.relation_ids.return_value = []
self.assertEqual(contexts.ImageServiceContext()(), {})
def test_glance_related(self):
self.relation_ids.return_value = ['image-service:0']
self.config.return_value = '1'
self.assertEqual(contexts.ImageServiceContext()(),
{'glance_api_version': '1'})
def test_glance_related_api_v2(self):
self.relation_ids.return_value = ['image-service:0']
self.config.return_value = '2'
self.assertEqual(contexts.ImageServiceContext()(),
{'glance_api_version': '2'})
def test_ceph_not_related(self):
self.relation_ids.return_value = []
self.assertEqual(contexts.CephContext()(), {})
def test_ceph_related(self):
self.relation_ids.return_value = ['ceph:0']
self.os_release.return_value = 'havana'
service = 'mycinder'
self.service_name.return_value = service
self.assertEqual(
contexts.CephContext()(),
{'volume_driver': 'cinder.volume.driver.RBDDriver',
'rbd_pool': service,
'rbd_user': service,
'rbd_ceph_conf': '/var/lib/charm/mycinder/ceph.conf',
'host': service})
def test_ceph_related_icehouse(self):
self.relation_ids.return_value = ['ceph:0']
self.os_release.return_value = 'icehouse'
service = 'mycinder'
self.service_name.return_value = service
self.assertEqual(
contexts.CephContext()(),
{'volume_driver': 'cinder.volume.drivers.rbd.RBDDriver',
'rbd_pool': service,
'rbd_user': service,
'rbd_ceph_conf': '/var/lib/charm/mycinder/ceph.conf',
'host': service})
def test_ceph_related_ocata(self):
self.relation_ids.return_value = ['ceph:0']
self.os_release.return_value = 'ocata'
service = 'mycinder'
self.service_name.return_value = service
self.assertEqual(
contexts.CephContext()(),
{'ceph_volume_driver': 'cinder.volume.drivers.rbd.RBDDriver',
'rbd_pool': service,
'rbd_user': service,
'rbd_ceph_conf': '/var/lib/charm/mycinder/ceph.conf',
'host': service})
@patch.object(utils, 'service_enabled')
def test_apache_ssl_context_service_disabled(self, service_enabled):
service_enabled.return_value = False
self.assertEqual(contexts.ApacheSSLContext()(), {})
def test_storage_backend_no_backends(self):
self.test_config.set('default-volume-type', None)
self.test_config.set('image-volume-cache-enabled', False)
self.test_config.set('image-volume-cache-max-size-gb', 0)
self.test_config.set('image-volume-cache-max-count', 0)
self.config.side_effect = self.test_config.get
self.relation_ids.return_value = []
self.os_release.return_value = 'havana'
self.assertEqual(
contexts.StorageBackendContext()(),
{'active_backends': [],
'backends': '',
'default_volume_type': None,
'scheduler_default_filters': None,
'image_volume_cache_enabled': False,
'image_volume_cache_max_size_gb': 0,
'image_volume_cache_max_count': 0})
def test_storage_backend_single_backend(self):
rel_dict = {
'storage-backend': ['cinder-ceph:0'],
'ceph': []}
self.relation_ids.side_effect = lambda x: rel_dict[x]
self.related_units.return_value = ['cinder-ceph/0']
self.relation_get.return_value = 'cinder-ceph'
self.os_release.return_value = 'havana'
self.test_config.set('default-volume-type', None)
self.test_config.set('image-volume-cache-enabled', False)
self.test_config.set('image-volume-cache-max-size-gb', 0)
self.test_config.set('image-volume-cache-max-count', 0)
self.config.side_effect = self.test_config.get
self.assertEqual(contexts.StorageBackendContext()(),
{'backends': 'cinder-ceph',
'active_backends': ['cinder-ceph'],
'default_volume_type': None,
'scheduler_default_filters': None,
'image_volume_cache_enabled': False,
'image_volume_cache_max_size_gb': 0,
'image_volume_cache_max_count': 0})
def test_storage_backend_multi_backend(self):
self.test_config.set('default-volume-type', None)
self.test_config.set('image-volume-cache-enabled', False)
self.test_config.set('image-volume-cache-max-size-gb', 0)
self.test_config.set('image-volume-cache-max-count', 0)
self.config.side_effect = self.test_config.get
self.os_release.return_value = 'havana'
rel_dict = {
'storage-backend': ['cinder-ceph:0', 'cinder-vmware:0'],
'ceph': []}
self.relation_ids.side_effect = lambda x: rel_dict[x]
self.related_units.side_effect = [['cinder-ceph/0'],
['cinder-vmware/0']]
self.relation_get.side_effect = ['cinder-ceph', 'cinder-vmware']
self.assertEqual(
contexts.StorageBackendContext()(),
{'backends': 'cinder-ceph,cinder-vmware',
'active_backends': ['cinder-ceph', 'cinder-vmware'],
'default_volume_type': None,
'scheduler_default_filters': None,
'image_volume_cache_enabled': False,
'image_volume_cache_max_size_gb': 0,
'image_volume_cache_max_count': 0})
def test_storage_backend_multi_backend_with_default_type(self):
self.test_config.set('default-volume-type', 'my-preferred-volume-type')
self.test_config.set('image-volume-cache-enabled', True)
self.test_config.set('image-volume-cache-max-size-gb', 10)
self.test_config.set('image-volume-cache-max-count', 100)
self.config.side_effect = self.test_config.get
self.os_release.return_value = 'havana'
rel_dict = {
'storage-backend': ['cinder-ceph:0', 'cinder-vmware:0'],
'ceph': []}
self.relation_ids.side_effect = lambda x: rel_dict[x]
self.related_units.side_effect = [['cinder-ceph/0'],
['cinder-vmware/0']]
self.relation_get.side_effect = ['cinder-ceph', 'cinder-vmware']
self.assertEqual(
contexts.StorageBackendContext()(),
{'backends': 'cinder-ceph,cinder-vmware',
'active_backends': ['cinder-ceph', 'cinder-vmware'],
'default_volume_type': 'my-preferred-volume-type',
'scheduler_default_filters': None,
'image_volume_cache_enabled': True,
'image_volume_cache_max_size_gb': 10,
'image_volume_cache_max_count': 100})
def test_storage_backend_default_filters_set(self):
self.test_config.set(
'scheduler-default-filters',
'DriverFilter,AvailabilityFilter'
)
self.config.side_effect = self.test_config.get
self.relation_ids.return_value = []
self.os_release.return_value = 'havana'
self.assertEqual(
contexts.StorageBackendContext()(),
{'active_backends': [],
'backends': '',
'default_volume_type': None,
'scheduler_default_filters': 'DriverFilter,AvailabilityFilter',
'image_volume_cache_enabled': False,
'image_volume_cache_max_size_gb': 0,
'image_volume_cache_max_count': 0})
def test_image_volume_cache(self):
rel_dict = {
'storage-backend': ['cinder-ceph:0'],
'ceph': []}
self.relation_ids.side_effect = lambda x: rel_dict[x]
self.related_units.return_value = ['cinder-ceph/0']
self.relation_get.return_value = 'cinder-ceph'
self.os_release.return_value = 'havana'
image_volume_cache_param_list = [(False, 0, 0), (True, 10, 100)]
for enabled, size, count in image_volume_cache_param_list:
with self.subTest():
self.test_config.set('default-volume-type', None)
self.test_config.set('image-volume-cache-enabled', enabled)
self.test_config.set('image-volume-cache-max-size-gb', size)
self.test_config.set('image-volume-cache-max-count', count)
self.config.side_effect = self.test_config.get
self.assertEqual(contexts.StorageBackendContext()(),
{'backends': 'cinder-ceph',
'active_backends': ['cinder-ceph'],
'default_volume_type': None,
'scheduler_default_filters': None,
'image_volume_cache_enabled': enabled,
'image_volume_cache_max_size_gb': size,
'image_volume_cache_max_count': count})
mod_ch_context = 'charmhelpers.contrib.openstack.context'
@patch('charmhelpers.contrib.openstack.context.relation_ids')
@patch('charmhelpers.contrib.openstack.context.resolve_address')
@patch('charmhelpers.contrib.openstack.ip.config')
@patch('%s.ApacheSSLContext.canonical_names' % (mod_ch_context))
@patch('%s.ApacheSSLContext.configure_ca' % (mod_ch_context))
@patch('%s.config' % (mod_ch_context))
@patch('%s.is_clustered' % (mod_ch_context))
@patch('%s.determine_apache_port' % (mod_ch_context))
@patch('%s.determine_api_port' % (mod_ch_context))
@patch("%s.local_address" % mod_ch_context)
@patch('%s.https' % (mod_ch_context))
@patch.object(utils, 'service_enabled')
def test_apache_ssl_context_service_enabled(self, service_enabled,
mock_https,
mock_local_address,
mock_determine_api_port,
mock_determine_apache_port,
mock_is_clustered,
mock_hookenv,
mock_configure_ca,
mock_cfg_canonical_names,
mock_ip_config,
mock_ip_network_get,
mock_relation_ids):
mock_relation_ids.return_value = []
mock_https.return_value = True
mock_local_address.return_value = '1.2.3.4'
mock_ip_network_get.return_value = '1.2.3.4'
mock_determine_api_port.return_value = '12'
mock_determine_apache_port.return_value = '34'
mock_is_clustered.return_value = False
ctxt = contexts.ApacheSSLContext()
ctxt.enable_modules = MagicMock()
ctxt.configure_cert = MagicMock()
ctxt.configure_ca = MagicMock()
ctxt.canonical_names = MagicMock()
service_enabled.return_value = False
self.assertEqual(ctxt(), {})
self.assertFalse(mock_https.called)
service_enabled.return_value = True
self.assertEqual(ctxt(), {'endpoints': [('1.2.3.4', '1.2.3.4',
34, 12)],
'ext_ports': [34],
'namespace': 'cinder'})
self.assertTrue(mock_https.called)
@patch('%s.relation_get' % (mod_ch_context))
@patch('%s.related_units' % (mod_ch_context))
@patch('%s.relation_ids' % (mod_ch_context))
@patch('%s.log' % (mod_ch_context), lambda *args, **kwargs: None)
def test_subordinate_config_context_stateless(self, mock_rel_ids,
mock_rel_units,
mock_rel_get):
mock_rel_ids.return_value = ['storage-backend:0']
self.relation_ids.return_value = ['storage-backend:0']
mock_rel_units.return_value = ['cinder-ceph/0']
self.related_units.return_value = ['cinder-ceph/0']
self.service_name.return_value = 'cinder'
settings = \
{'backend_name': 'cinder-ceph',
'private-address': '10.5.8.191',
'stateless': 'True',
'subordinate_configuration':
'{"cinder": '
'{"/etc/cinder/cinder.conf": '
'{"sections": '
'{"cinder-ceph": '
'[["volume_backend_name", '
'"cinder-ceph"], '
'["volume_driver", '
'"cinder.volume.drivers.rbd.RBDDriver"], '
'["rbd_pool", '
'"cinder-ceph"], '
'["rbd_user", '
'"cinder-ceph"]]}}}}'}
def fake_rel_get(attribute=None, unit=None, rid=None):
return settings.get(attribute)
mock_rel_get.side_effect = fake_rel_get
self.relation_get.side_effect = fake_rel_get
ctxt = contexts.CinderSubordinateConfigContext(
interface='storage-backend',
service='cinder',
config_file='/etc/cinder/cinder.conf')()
exp = {'sections': {'DEFAULT': [('host', 'cinder')],
u'cinder-ceph': [[u'volume_backend_name', u'cinder-ceph'],
[u'volume_driver',
u'cinder.volume.drivers.rbd.RBDDriver'],
[u'rbd_pool', u'cinder-ceph'],
[u'rbd_user', u'cinder-ceph']]}}
self.assertEqual(ctxt, exp)
@patch('%s.relation_get' % (mod_ch_context))
@patch('%s.related_units' % (mod_ch_context))
@patch('%s.relation_ids' % (mod_ch_context))
@patch('%s.log' % (mod_ch_context), lambda *args, **kwargs: None)
def test_subordinate_config_context_statefull(self, mock_rel_ids,
mock_rel_units,
mock_rel_get):
mock_rel_ids.return_value = ['storage-backend:0']
self.relation_ids.return_value = ['storage-backend:0']
mock_rel_units.return_value = ['cinder-ceph/0']
self.related_units.return_value = ['cinder-ceph/0']
self.service_name.return_value = 'cinder'
settings = \
{'backend_name': 'cinder-ceph',
'private-address': '10.5.8.191',
'stateless': 'False',
'subordinate_configuration':
'{"cinder": '
'{"/etc/cinder/cinder.conf": '
'{"sections": '
'{"cinder-ceph": '
'[["volume_backend_name", '
'"cinder-ceph"], '
'["volume_driver", '
'"cinder.volume.drivers.rbd.RBDDriver"], '
'["rbd_pool", '
'"cinder-ceph"], '
'["rbd_user", '
'"cinder-ceph"]]}}}}'}
def fake_rel_get(attribute=None, unit=None, rid=None):
return settings.get(attribute)
mock_rel_get.side_effect = fake_rel_get
self.relation_get.side_effect = fake_rel_get
ctxt = contexts.CinderSubordinateConfigContext(
interface='storage-backend',
service='cinder',
config_file='/etc/cinder/cinder.conf')()
exp = {'sections':
{u'cinder-ceph': [[u'volume_backend_name',
u'cinder-ceph'],
[u'volume_driver',
u'cinder.volume.drivers.rbd.RBDDriver'],
[u'rbd_pool', u'cinder-ceph'],
[u'rbd_user', u'cinder-ceph']]}}
self.assertEqual(ctxt, exp)
del settings['stateless']
ctxt = contexts.CinderSubordinateConfigContext(
interface='storage-backend',
service='cinder',
config_file='/etc/cinder/cinder.conf')()
exp = {'sections':
{u'cinder-ceph': [[u'volume_backend_name',
u'cinder-ceph'],
[u'volume_driver',
u'cinder.volume.drivers.rbd.RBDDriver'],
[u'rbd_pool', u'cinder-ceph'],
[u'rbd_user', u'cinder-ceph']]}}
self.assertEqual(ctxt, exp)
@patch('%s.relation_get' % (mod_ch_context))
@patch('%s.related_units' % (mod_ch_context))
@patch('%s.relation_ids' % (mod_ch_context))
@patch.object(contexts, 'log', lambda *args, **kwargs: None)
@patch('%s.log' % (mod_ch_context), lambda *args, **kwargs: None)
def test_subordinate_config_context_mixed(self, mock_rel_ids,
mock_rel_units,
mock_rel_get):
mock_rel_ids.return_value = ['storage-backend:0', 'storage-backend:1']
self.relation_ids.return_value = ['storage-backend:0',
'storage-backend:1']
def fake_rel_units(rid):
if rid == 'storage-backend:0':
return ['cinder-ceph/0']
else:
return ['cinder-other/0']
mock_rel_units.side_effect = fake_rel_units
self.related_units.side_effect = fake_rel_units
self.service_name.return_value = 'cinder'
cinder_ceph_settings = \
{'backend_name': 'cinder-ceph',
'private-address': '10.5.8.191',
'stateless': 'True',
'subordinate_configuration':
'{"cinder": '
'{"/etc/cinder/cinder.conf": '
'{"sections": '
'{"cinder-ceph": '
'[["volume_backend_name", '
'"cinder-ceph"], '
'["volume_driver", '
'"cinder.volume.drivers.rbd.RBDDriver"], '
'["rbd_pool", '
'"cinder-ceph"], '
'["rbd_user", '
'"cinder-ceph"]]}}}}'}
cinder_other_settings = \
{'backend_name': 'cinder-other',
'private-address': '10.5.8.192',
'subordinate_configuration':
'{"cinder": '
'{"/etc/cinder/cinder.conf": '
'{"sections": '
'{"cinder-other": '
'[["volume_backend_name", '
'"cinder-other"], '
'["volume_driver", '
'"cinder.volume.drivers.OtherDriver"]]}}}}'}
def fake_rel_get(attribute=None, unit=None, rid=None):
if unit == 'cinder-ceph/0':
return cinder_ceph_settings.get(attribute)
elif unit == 'cinder-other/0':
return cinder_other_settings.get(attribute)
mock_rel_get.side_effect = fake_rel_get
self.relation_get.side_effect = fake_rel_get
ctxt = contexts.CinderSubordinateConfigContext(
interface='storage-backend',
service='cinder',
config_file='/etc/cinder/cinder.conf')()
exp = {'sections':
{u'cinder-ceph': [[u'volume_backend_name',
u'cinder-ceph'],
[u'volume_driver',
u'cinder.volume.drivers.rbd.RBDDriver'],
[u'rbd_pool', u'cinder-ceph'],
[u'rbd_user', u'cinder-ceph']],
u'cinder-other': [[u'volume_backend_name',
u'cinder-other'],
[u'volume_driver',
u'cinder.volume.drivers.OtherDriver']]}}
self.assertEqual(ctxt, exp)
def test_region_context(self):
self.config.return_value = 'two'
ctxt = contexts.RegionContext()()
self.assertEqual('two', ctxt['region'])
def test_sectional_config_context_ocata(self):
self.os_release.return_value = 'ocata'
ctxt = contexts.SectionalConfigContext()()
self.assertTrue(ctxt['sectional_default_config'])
def test_sectional_config_context_newton(self):
self.os_release.return_value = 'newton'
ctxt = contexts.SectionalConfigContext()()
self.assertFalse(ctxt['sectional_default_config'])
@patch.object(contexts, 'enable_lvm')
def test_lvm_context_disabled(self, enable_lvm):
enable_lvm.return_value = False
ctxt = contexts.LVMContext()()
self.assertEqual(ctxt, {})
@patch.object(contexts, 'enable_lvm')
def test_lvm_context_enabled(self, enable_lvm):
enable_lvm.return_value = True
self.config.return_value = 'cinder-vol1'
ctxt = contexts.LVMContext()()
expect = {
'volume_backend_name': 'LVM',
'volume_driver': 'cinder.volume.drivers.lvm.LVMVolumeDriver',
'volume_group': 'cinder-vol1',
'volume_name_template': 'volume-%s',
'volumes_dir': '/var/lib/cinder/volumes'}
self.assertEqual(ctxt, expect)
@patch('builtins.open')
def test_volume_usage_audit_context(self, _open):
self.config.return_value = 'month'
ctxt = contexts.VolumeUsageAuditContext()()
_open.assert_called_with(
contexts.VolumeUsageAuditContext.DEFAULT_CRONTAB_PATH, "wt+")
self.assertEqual(self.config.return_value,
ctxt["volume_usage_audit_period"])