summaryrefslogtreecommitdiff
path: root/oslo_config/tests/test_sphinxconfiggen.py
blob: 982641eda20d305cd02ca46bf30d627f4e5e2cee (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
#    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'])