sphinxconfiggen to generate multiple sample files
Add support for oslo_config.sphinxconfiggen extension to generate multiple sample files. Update existing config option config_generator_config_file to take a list of tuples containing the file names as (input, output). This retains support for the option refering to a single string, and using the sample_config_basename for the output file. After this change is release, update projects to always use the list of tuples, then remove sample_config_basename and the support for config_generator_config_file being a single string. Change-Id: Ifd3cea0f53d78358a3735375f25c89381cf65eea
This commit is contained in:
Hemanth Makkapati
parent
9c6bbb1a6c
commit
cd16e52be2
|
|
@ -19,22 +19,46 @@ from oslo_config import generator
|
|||
|
||||
def generate_sample(app):
|
||||
|
||||
def info(msg):
|
||||
app.info('[%s] %s' % (__name__, msg))
|
||||
|
||||
if not app.config.config_generator_config_file:
|
||||
app.warn("No config_generator_config_file is specified, "
|
||||
"skipping sample config generation")
|
||||
return
|
||||
|
||||
# Decided to update the existing config option
|
||||
# config_generator_config_file to support a value that is a list of
|
||||
# tuples, containing the file names as (input, output).
|
||||
# We need to retain support for the option referring to a single string,
|
||||
# and using the sample_config_basename for the output file in that case.
|
||||
# After we release support for both forms of the option, we can update
|
||||
# projects to always use the list of tuples, then remove
|
||||
# sample_config_basename and the support for config_generator_config_file
|
||||
# being a single string.
|
||||
|
||||
if isinstance(app.config.config_generator_config_file, list):
|
||||
for config_file, base_name in app.config.config_generator_config_file:
|
||||
if base_name is None:
|
||||
base_name = _get_default_basename(config_file)
|
||||
_generate_sample(app, config_file, base_name)
|
||||
else:
|
||||
_generate_sample(app,
|
||||
app.config.config_generator_config_file,
|
||||
app.config.sample_config_basename)
|
||||
|
||||
|
||||
def _get_default_basename(config_file):
|
||||
return os.path.splitext(os.path.basename(config_file))[0]
|
||||
|
||||
|
||||
def _generate_sample(app, config_file, base_name):
|
||||
|
||||
def info(msg):
|
||||
app.info('[%s] %s' % (__name__, msg))
|
||||
|
||||
# If we are given a file that isn't an absolute path, look for it
|
||||
# in the source directory if it doesn't exist.
|
||||
candidates = [
|
||||
app.config.config_generator_config_file,
|
||||
os.path.join(
|
||||
app.srcdir,
|
||||
app.config.config_generator_config_file,
|
||||
),
|
||||
config_file,
|
||||
os.path.join(app.srcdir, config_file,),
|
||||
]
|
||||
for c in candidates:
|
||||
if os.path.isfile(c):
|
||||
|
|
@ -46,9 +70,8 @@ def generate_sample(app):
|
|||
"Could not find config_generator_config_file %r" %
|
||||
app.config.config_generator_config_file)
|
||||
|
||||
if app.config.sample_config_basename:
|
||||
out_file = os.path.join(
|
||||
app.srcdir, app.config.sample_config_basename) + '.conf.sample'
|
||||
if base_name:
|
||||
out_file = os.path.join(app.srcdir, base_name) + '.conf.sample'
|
||||
if not os.path.isdir(os.path.dirname(os.path.abspath(out_file))):
|
||||
os.mkdir(os.path.dirname(os.path.abspath(out_file)))
|
||||
else:
|
||||
|
|
|
|||
|
|
@ -0,0 +1,128 @@
|
|||
# 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 mock
|
||||
from oslotest import base
|
||||
|
||||
from oslo_config import sphinxconfiggen
|
||||
|
||||
|
||||
class SingleSampleGenerationTest(base.BaseTestCase):
|
||||
|
||||
@mock.patch('os.path.isdir')
|
||||
@mock.patch('os.path.isfile')
|
||||
@mock.patch('oslo_config.generator.main')
|
||||
def test_sample_gen_with_single_config_file(self, main, isfile, isdir):
|
||||
isfile.side_effect = [False, True]
|
||||
isdir.return_value = True
|
||||
|
||||
config = mock.Mock(config_generator_config_file='nova-gen.conf',
|
||||
sample_config_basename='nova')
|
||||
app = mock.Mock(srcdir='/opt/nova', config=config)
|
||||
sphinxconfiggen.generate_sample(app)
|
||||
|
||||
main.assert_called_once_with(args=['--config-file',
|
||||
'/opt/nova/nova-gen.conf',
|
||||
'--output-file',
|
||||
'/opt/nova/nova.conf.sample'
|
||||
])
|
||||
|
||||
@mock.patch('os.path.isdir')
|
||||
@mock.patch('os.path.isfile')
|
||||
@mock.patch('oslo_config.generator.main')
|
||||
def test_sample_gen_with_single_config_file_no_base(self, main, isfile,
|
||||
isdir):
|
||||
isfile.side_effect = [False, True]
|
||||
isdir.return_value = True
|
||||
|
||||
config = mock.Mock(config_generator_config_file='nova-gen.conf',
|
||||
sample_config_basename=None)
|
||||
app = mock.Mock(srcdir='/opt/nova', config=config)
|
||||
sphinxconfiggen.generate_sample(app)
|
||||
|
||||
main.assert_called_once_with(args=['--config-file',
|
||||
'/opt/nova/nova-gen.conf',
|
||||
'--output-file',
|
||||
'/opt/nova/sample.config'])
|
||||
|
||||
|
||||
class MultipleSampleGenerationTest(base.BaseTestCase):
|
||||
|
||||
@mock.patch('os.path.isdir')
|
||||
@mock.patch('os.path.isfile')
|
||||
@mock.patch('oslo_config.generator.main')
|
||||
def test_multi_sample_gen(self, main, isfile, isdir):
|
||||
isfile.side_effect = [False, True, False, True]
|
||||
isdir.return_value = True
|
||||
|
||||
multiple_configs = [('glance-api-gen.conf', 'glance-api'),
|
||||
('glance-reg-gen.conf', 'glance-reg')]
|
||||
config = mock.Mock(config_generator_config_file=multiple_configs)
|
||||
app = mock.Mock(srcdir='/opt/glance', config=config)
|
||||
sphinxconfiggen.generate_sample(app)
|
||||
|
||||
self.assertEqual(main.call_count, 2)
|
||||
main.assert_any_call(args=['--config-file',
|
||||
'/opt/glance/glance-api-gen.conf',
|
||||
'--output-file',
|
||||
'/opt/glance/glance-api.conf.sample'])
|
||||
main.assert_any_call(args=['--config-file',
|
||||
'/opt/glance/glance-reg-gen.conf',
|
||||
'--output-file',
|
||||
'/opt/glance/glance-reg.conf.sample'])
|
||||
|
||||
@mock.patch('os.path.isdir')
|
||||
@mock.patch('os.path.isfile')
|
||||
@mock.patch('oslo_config.generator.main')
|
||||
def test_multi_sample_gen_with_without_one_base(self, main, isfile, isdir):
|
||||
isfile.side_effect = [False, True, False, True]
|
||||
isdir.return_value = True
|
||||
|
||||
multiple_configs = [('glance-api-gen.conf', 'glance-api'),
|
||||
('glance-reg-gen.conf', None)]
|
||||
config = mock.Mock(config_generator_config_file=multiple_configs)
|
||||
app = mock.Mock(srcdir='/opt/glance', config=config)
|
||||
sphinxconfiggen.generate_sample(app)
|
||||
|
||||
self.assertEqual(main.call_count, 2)
|
||||
main.assert_any_call(args=['--config-file',
|
||||
'/opt/glance/glance-api-gen.conf',
|
||||
'--output-file',
|
||||
'/opt/glance/glance-api.conf.sample'])
|
||||
main.assert_any_call(args=['--config-file',
|
||||
'/opt/glance/glance-reg-gen.conf',
|
||||
'--output-file',
|
||||
'/opt/glance/glance-reg-gen.conf.sample'])
|
||||
|
||||
@mock.patch('os.path.isdir')
|
||||
@mock.patch('os.path.isfile')
|
||||
@mock.patch('oslo_config.generator.main')
|
||||
def test_multi_sample_gen_with_without_any_base(self, main, isfile, isdir):
|
||||
isfile.side_effect = [False, True, False, True]
|
||||
isdir.return_value = True
|
||||
|
||||
multiple_configs = [('glance-api-gen.conf', None),
|
||||
('glance-reg-gen.conf', None)]
|
||||
config = mock.Mock(config_generator_config_file=multiple_configs)
|
||||
app = mock.Mock(srcdir='/opt/glance', config=config)
|
||||
sphinxconfiggen.generate_sample(app)
|
||||
|
||||
self.assertEqual(main.call_count, 2)
|
||||
main.assert_any_call(args=['--config-file',
|
||||
'/opt/glance/glance-api-gen.conf',
|
||||
'--output-file',
|
||||
'/opt/glance/glance-api-gen.conf.sample'])
|
||||
main.assert_any_call(args=['--config-file',
|
||||
'/opt/glance/glance-reg-gen.conf',
|
||||
'--output-file',
|
||||
'/opt/glance/glance-reg-gen.conf.sample'])
|
||||
Loading…
Reference in New Issue