d768fbc97d
This change adds a module for listing configuration options and setting their defaults. It also changes the key manager base class to incorporate a configuration during creation. By default, the key manager will continue to use the global CONF object from the oslo.config package. For the most part, this change will be backwards compatible. The one exception is the creation of sample configuration files. Previously, importing castellan was sufficient to add these options to the global configuration object. Now, these options will need to be applied by using the castellan.options.list_opts function, or adding them through other means, to create sample configuration files. Similar applies for setting configuration before instantiating a key manager. changes * adding castellan.options with list_opts and set_defaults functions * changing KeyManager abc to include a configuration option to __init__ * changing barbican and not_implemented key managers to accept configuration parameters * adding tests for set_defaults function * fixing barbican tests to accomodate new configuration parameter * adding documentation about configuration usage * adding castellan configs to oslo entry point in setup.cfg * adding a genconfig target to tox for producing a sample castellan configuration file * adding the sample configuration file to the git ignore * renaming barbican option api_version to barbican_api_version Change-Id: I86d6d7d49a893beaae6f311060ec593e0482d889 Implements: blueprint improved-configuration-options
41 lines
1.5 KiB
Python
41 lines
1.5 KiB
Python
# Copyright (c) 2015 Red Hat, Inc.
|
|
# 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.
|
|
|
|
from oslo_config import cfg
|
|
|
|
from castellan.key_manager import barbican_key_manager as bkm
|
|
from castellan import options
|
|
from castellan.tests import base
|
|
|
|
|
|
class TestOptions(base.TestCase):
|
|
|
|
def test_set_defaults(self):
|
|
conf = cfg.ConfigOpts()
|
|
|
|
api_class = 'test.api.class'
|
|
options.set_defaults(conf, api_class=api_class)
|
|
self.assertEqual(api_class, conf.key_manager.api_class)
|
|
|
|
barbican_endpoint = 'http://test-server.org:9311/'
|
|
options.set_defaults(conf, barbican_endpoint=barbican_endpoint)
|
|
self.assertEqual(barbican_endpoint,
|
|
conf.get(bkm.BARBICAN_OPT_GROUP).barbican_endpoint)
|
|
|
|
barbican_api_version = 'vSomething'
|
|
options.set_defaults(conf, barbican_api_version=barbican_api_version)
|
|
self.assertEqual(barbican_api_version,
|
|
conf.get(bkm.BARBICAN_OPT_GROUP).barbican_api_version)
|