206 lines
7.8 KiB
Python
206 lines
7.8 KiB
Python
#
|
|
# Copyright 2013 Mirantis, Inc.
|
|
# Copyright 2013 OpenStack Foundation
|
|
# 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 oslotest import base
|
|
|
|
from oslo_config import cfg
|
|
from oslo_config import fixture as config
|
|
|
|
|
|
class ConfigTestCase(base.BaseTestCase):
|
|
|
|
def _make_fixture(self):
|
|
conf = cfg.ConfigOpts()
|
|
config_fixture = config.Config(conf)
|
|
config_fixture.setUp()
|
|
config_fixture.register_opt(cfg.StrOpt(
|
|
'testing_option', default='initial_value'))
|
|
config_fixture.register_opt(cfg.IntOpt(
|
|
'test2', min=0, default=5))
|
|
config_fixture.register_opt(cfg.StrOpt(
|
|
'test3', choices=['a', 'b'], default='a'))
|
|
return config_fixture
|
|
|
|
def test_overridden_value(self):
|
|
f = self._make_fixture()
|
|
self.assertEqual(f.conf.get('testing_option'), 'initial_value')
|
|
f.config(testing_option='changed_value')
|
|
self.assertEqual('changed_value',
|
|
f.conf.get('testing_option'))
|
|
|
|
def test_overridden_value_with_enforce_type(self):
|
|
f = self._make_fixture()
|
|
self.assertEqual(5, f.conf.get('test2'))
|
|
self.assertEqual('a', f.conf.get('test3'))
|
|
# with enforce_type=False
|
|
f.config(test2=-1)
|
|
self.assertEqual(-1, f.conf.get('test2'))
|
|
f.config(test3='c')
|
|
self.assertEqual('c', f.conf.get('test3'))
|
|
# with enforce_type=True
|
|
self.assertRaises(ValueError, f.config, test2=-1, enforce_type=True)
|
|
self.assertRaises(ValueError, f.config, test3='c', enforce_type=True)
|
|
|
|
def test_cleanup(self):
|
|
f = self._make_fixture()
|
|
f.config(testing_option='changed_value')
|
|
self.assertEqual(f.conf.get('testing_option'),
|
|
'changed_value')
|
|
f.conf.reset()
|
|
self.assertEqual(f.conf.get('testing_option'), 'initial_value')
|
|
|
|
def test_register_option(self):
|
|
f = self._make_fixture()
|
|
opt = cfg.StrOpt('new_test_opt', default='initial_value')
|
|
f.register_opt(opt)
|
|
self.assertEqual(f.conf.get('new_test_opt'),
|
|
opt.default)
|
|
|
|
def test_register_options(self):
|
|
f = self._make_fixture()
|
|
opt1 = cfg.StrOpt('first_test_opt', default='initial_value_1')
|
|
opt2 = cfg.StrOpt('second_test_opt', default='initial_value_2')
|
|
f.register_opts([opt1, opt2])
|
|
self.assertEqual(f.conf.get('first_test_opt'), opt1.default)
|
|
self.assertEqual(f.conf.get('second_test_opt'), opt2.default)
|
|
|
|
def test_cleanup_unregister_option(self):
|
|
f = self._make_fixture()
|
|
opt = cfg.StrOpt('new_test_opt', default='initial_value')
|
|
f.register_opt(opt)
|
|
self.assertEqual(f.conf.get('new_test_opt'),
|
|
opt.default)
|
|
f.cleanUp()
|
|
self.assertRaises(cfg.NoSuchOptError, f.conf.get, 'new_test_opt')
|
|
|
|
def test_register_cli_option(self):
|
|
f = self._make_fixture()
|
|
opt = cfg.StrOpt('new_test_opt', default='initial_value')
|
|
f.register_cli_opt(opt)
|
|
self.assertEqual(f.conf.get('new_test_opt'),
|
|
opt.default)
|
|
|
|
def test_register_cli_options(self):
|
|
f = self._make_fixture()
|
|
opt1 = cfg.StrOpt('first_test_opt', default='initial_value_1')
|
|
opt2 = cfg.StrOpt('second_test_opt', default='initial_value_2')
|
|
f.register_cli_opts([opt1, opt2])
|
|
self.assertEqual(f.conf.get('first_test_opt'), opt1.default)
|
|
self.assertEqual(f.conf.get('second_test_opt'), opt2.default)
|
|
|
|
def test_cleanup_unregister_cli_option(self):
|
|
f = self._make_fixture()
|
|
opt = cfg.StrOpt('new_test_opt', default='initial_value')
|
|
f.register_cli_opt(opt)
|
|
self.assertEqual(f.conf.get('new_test_opt'),
|
|
opt.default)
|
|
f.cleanUp()
|
|
self.assertRaises(cfg.NoSuchOptError, f.conf.get, 'new_test_opt')
|
|
|
|
def test_load_raw_values(self):
|
|
f = self._make_fixture()
|
|
f.load_raw_values(first_test_opt='loaded_value_1',
|
|
second_test_opt='loaded_value_2')
|
|
|
|
# Must not be registered.
|
|
self.assertRaises(cfg.NoSuchOptError, f.conf.get, 'first_test_opt')
|
|
self.assertRaises(cfg.NoSuchOptError, f.conf.get, 'second_test_opt')
|
|
|
|
opt1 = cfg.StrOpt('first_test_opt', default='initial_value_1')
|
|
opt2 = cfg.StrOpt('second_test_opt', default='initial_value_2')
|
|
|
|
f.register_opt(opt1)
|
|
f.register_opt(opt2)
|
|
|
|
self.assertEqual(f.conf.first_test_opt, 'loaded_value_1')
|
|
self.assertEqual(f.conf.second_test_opt, 'loaded_value_2')
|
|
|
|
# Cleanup.
|
|
f.cleanUp()
|
|
|
|
# Must no longer be registered.
|
|
self.assertRaises(cfg.NoSuchOptError, f.conf.get, 'first_test_opt')
|
|
self.assertRaises(cfg.NoSuchOptError, f.conf.get, 'second_test_opt')
|
|
|
|
# Even when registered, must be default.
|
|
f.register_opt(opt1)
|
|
f.register_opt(opt2)
|
|
self.assertEqual(f.conf.first_test_opt, 'initial_value_1')
|
|
self.assertEqual(f.conf.second_test_opt, 'initial_value_2')
|
|
|
|
def test_assert_default_files_cleanup(self):
|
|
"""Assert that using the fixture forces a clean list."""
|
|
f = self._make_fixture()
|
|
self.assertNotIn('default_config_files', f.conf)
|
|
self.assertNotIn('default_config_dirs', f.conf)
|
|
|
|
config_files = ['./test_fixture.conf']
|
|
config_dirs = ['./test_fixture.conf.d']
|
|
f.set_config_files(config_files)
|
|
f.set_config_dirs(config_dirs)
|
|
|
|
self.assertEqual(f.conf.default_config_files, config_files)
|
|
self.assertEqual(f.conf.default_config_dirs, config_dirs)
|
|
f.cleanUp()
|
|
|
|
self.assertNotIn('default_config_files', f.conf)
|
|
self.assertNotIn('default_config_dirs', f.conf)
|
|
|
|
def test_load_custom_files(self):
|
|
f = self._make_fixture()
|
|
self.assertNotIn('default_config_files', f.conf)
|
|
config_files = ['./oslo_config/tests/test_fixture.conf']
|
|
f.set_config_files(config_files)
|
|
|
|
opt1 = cfg.StrOpt('first_test_opt', default='initial_value_1')
|
|
opt2 = cfg.StrOpt('second_test_opt', default='initial_value_2')
|
|
|
|
f.register_opt(opt1)
|
|
f.register_opt(opt2)
|
|
|
|
self.assertEqual('loaded_value_1', f.conf.get('first_test_opt'))
|
|
self.assertEqual('loaded_value_2', f.conf.get('second_test_opt'))
|
|
|
|
def test_set_default(self):
|
|
f = self._make_fixture()
|
|
opt = cfg.StrOpt('new_test_opt', default='initial_value')
|
|
# Register the option directly so it is not cleaned up by the
|
|
# fixture.
|
|
f.conf.register_opt(opt)
|
|
f.set_default(
|
|
name='new_test_opt',
|
|
default='alternate_value',
|
|
)
|
|
self.assertEqual('alternate_value', f.conf.new_test_opt)
|
|
f.cleanUp()
|
|
self.assertEqual('initial_value', f.conf.new_test_opt)
|
|
|
|
def test_set_default_group(self):
|
|
f = self._make_fixture()
|
|
opt = cfg.StrOpt('new_test_opt', default='initial_value')
|
|
# Register the option directly so it is not cleaned up by the
|
|
# fixture.
|
|
f.conf.register_opt(opt, group='foo')
|
|
f.set_default(
|
|
name='new_test_opt',
|
|
default='alternate_value',
|
|
group='foo',
|
|
)
|
|
self.assertEqual('alternate_value', f.conf.foo.new_test_opt)
|
|
f.cleanUp()
|
|
self.assertEqual('initial_value', f.conf.foo.new_test_opt)
|