openstack
/
charm-glance-simplestreams-sync
Code Issues Proposed changes

Merge "Add custom_properties config option"

This commit is contained in:
Zuul 2019-12-03 12:38:20 +00:00 committed by Gerrit Code Review
parent 33b9da2bc5 0bf193dc85
commit 6c43cedb55
5 changed files with 91 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
config.yaml
View File

@ -39,6 +39,12 @@ options:
type: string
default: "auto-sync/"
description: "This is prefixed to the object name when uploading to glance."
custom_properties:
type: string
default: ""
description: >
YAML-formatted list of any custom properties to be set in glance
for the synced image, e.g. architecture, hypervisor_type.
content_id_template:
type: string
default: "auto.sync"

52
files/glance-simplestreams-sync.py
View File

@ -112,6 +112,27 @@ except ImportError:
SIMPLESTREAMS_HAS_PROGRESS = False
class GlanceMirrorWithCustomProperties(glance.GlanceMirror):
def __init__(self, *args, **kwargs):
custom_properties = kwargs.pop('custom_properties', {})
super(GlanceMirrorWithCustomProperties, self).__init__(*args, **kwargs)
self.custom_properties = custom_properties
def prepare_glance_arguments(self, *args, **kwargs):
glance_args = (super(GlanceMirrorWithCustomProperties, self)
.prepare_glance_arguments(*args, **kwargs))
if self.custom_properties:
log.info('Setting custom image properties: {}'.format(
self.custom_properties))
props = glance_args.get('properties', {})
props.update(self.custom_properties)
glance_args['properties'] = props
return glance_args
class StatusMessageProgressAggregator(ProgressAggregator):
def __init__(self, remaining_items, send_status_message):
super(StatusMessageProgressAggregator, self).__init__(remaining_items)
@ -170,12 +191,30 @@ def get_conf():
log.info("{} does not exist, exiting.".format(conf_file_name))
sys.exit(1)
id_conf = read_conf(ID_CONF_FILE_NAME)
try:
id_conf = read_conf(ID_CONF_FILE_NAME)
except Exception as e:
msg = ("Error in {} configuration file."
"Check juju config values for errors."
"Exception: {}").format(ID_CONF_FILE_NAME, e)
status_set('blocked', msg)
log.info(msg)
sys.exit(1)
if None in id_conf.values():
log.info("Configuration value missing in {}:\n"
"{}".format(ID_CONF_FILE_NAME, redact_keys(id_conf)))
sys.exit(1)
charm_conf = read_conf(CHARM_CONF_FILE_NAME)
try:
charm_conf = read_conf(CHARM_CONF_FILE_NAME)
except Exception as e:
charm_conf = {}
msg = ("Error in {} configuration file. "
"Check juju config values for errors"
"Exception: {}").format(ID_CONF_FILE_NAME, e)
status_set('blocked', msg)
log.info(msg)
sys.exit(1)
if None in charm_conf.values():
log.info("Configuration value missing in {}:\n"
"{}".format(CHARM_CONF_FILE_NAME, redact_keys(charm_conf)))
@ -234,6 +273,11 @@ def set_openstack_env(id_conf, charm_conf):
os.environ['OS_PROJECT_ID'] = id_conf['admin_tenant_id']
os.environ['OS_PROJECT_NAME'] = id_conf['admin_tenant_name']
os.environ['OS_PROJECT_DOMAIN_NAME'] = id_conf['admin_domain_name']
if 'cacert' in id_conf.keys():
os.environ['OS_CACERT'] = id_conf['cacert']
if 'interface' in id_conf.keys():
os.environ['OS_INTERFACE'] = id_conf['interface']
os.environ['OS_ENDPOINT_TYPE'] = id_conf['interface']
else:
os.environ['OS_TENANT_ID'] = id_conf['admin_tenant_id']
os.environ['OS_TENANT_NAME'] = id_conf['admin_tenant_name']
@ -276,6 +320,8 @@ def do_sync(charm_conf, status_exchange):
mirror_args = dict(config=config, objectstore=store,
name_prefix=charm_conf['name_prefix'])
mirror_args['custom_properties'] = charm_conf.get('custom_properties',
False)
if SIMPLESTREAMS_HAS_PROGRESS:
log.info("Calling DryRun mirror to get item list")
@ -290,7 +336,7 @@ def do_sync(charm_conf, status_exchange):
log.info("Detected simplestreams version without progress"
" update support. Only limited feedback available.")
tmirror = glance.GlanceMirror(**mirror_args)
tmirror = GlanceMirrorWithCustomProperties(**mirror_args)
log.info("calling GlanceMirror.sync")
tmirror.sync(smirror, path=initial_path)

1
hooks/hooks.py
View File

@ -146,6 +146,7 @@ class MirrorsConfigServiceContext(OSContextGenerator):
region=config['region'],
cloud_name=config['cloud_name'],
user_agent=config['user_agent'],
custom_properties=config['custom_properties'],
hypervisor_mapping=config['hypervisor_mapping'])

3
templates/mirrors.yaml
View File

@ -7,3 +7,6 @@ region: {{ region }}
cloud_name: {{ cloud_name }}
content_id_template: {{ content_id_template }}
hypervisor_mapping: {{ hypervisor_mapping }}
{%- if custom_properties %}
custom_properties: {{ custom_properties }}
{% endif %}

32
unit_tests/test_hooks.py
View File

@ -77,6 +77,38 @@ class TestConfigChanged(CharmTestCase):
self.assertEqual(mirrors['mirror_list'], mirror_list)
update_nrpe_config.assert_called()
@mock.patch.object(hooks, 'update_nrpe_config')
@mock.patch('os.symlink')
@mock.patch('charmhelpers.core.hookenv.config')
@mock.patch('charmhelpers.core.hookenv.relations_of_type')
@mock.patch('charmhelpers.contrib.charmsupport.nrpe.get_nagios_hostname')
@mock.patch('charmhelpers.contrib.charmsupport.nrpe.config')
@mock.patch('charmhelpers.contrib.charmsupport.nrpe.local_unit')
def test_custom_properties_config(self, local_unit, nrpe_config, nag_host,
relations_of_type, config, symlink,
update_nrpe_config):
local_unit.return_value = 'juju/0'
nag_host.return_value = "nagios_hostname"
nrpe_config.return_value = self.test_config
setattr(self.test_config, "changed", lambda x: False)
self.test_config.config["custom_properties"] = {
'hypervisor_type': 'kvm',
'hw_firmware_type': 'uefi'
}
config.return_value = self.test_config
hooks.config_changed()
self.assertTrue(os.path.isfile(self.mirrors_conf_fpath))
with open(self.mirrors_conf_fpath, 'r') as f:
mirrors = yaml.safe_load(f)
self.assertEqual(
self.test_config.config['custom_properties'],
mirrors['custom_properties']
)
update_nrpe_config.assert_called()
@mock.patch.object(hooks, 'update_nrpe_config')
@mock.patch('os.path.exists')
@mock.patch('os.remove')