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
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
|
import os
import unittest
from mock import patch, call, MagicMock
import charmhelpers.contrib.openstack.templating as templating
class FakeContextGenerator(object):
interfaces = None
def set(self, interfaces, context):
self.interfaces = interfaces
self.context = context
def __call__(self):
return self.context
class FakeLoader(object):
def set(self, template):
self.template = template
def get(self, name):
return self.template
class MockFSLoader(object):
def __init__(self, dirs):
self.searchpath = [dirs]
class MockChoiceLoader(object):
def __init__(self, loaders):
self.loaders = loaders
def MockTemplate():
templ = MagicMock()
templ.render = MagicMock()
return templ
class TemplatingTests(unittest.TestCase):
def setUp(self):
path = os.path.dirname(__file__)
self.loader = FakeLoader()
self.context = FakeContextGenerator()
self.addCleanup(patch.object(templating, 'apt_install').start().stop())
self.addCleanup(patch.object(templating, 'log').start().stop())
templating.FileSystemLoader = MockFSLoader
templating.ChoiceLoader = MockChoiceLoader
templating.Environment = MagicMock
self.renderer = templating.OSConfigRenderer(templates_dir=path,
openstack_release='folsom')
@patch.object(templating, 'apt_install')
def test_initializing_a_render_ensures_jinja2_present(self, apt):
'''Creatinga new renderer object installs jinja2 if needed'''
# temp. undo the patching from setUp
templating.FileSystemLoader = None
templating.ChoiceLoader = None
templating.Environment = None
templating.OSConfigRenderer(templates_dir='/tmp',
openstack_release='foo')
templating.FileSystemLoader = MockFSLoader
templating.ChoiceLoader = MockChoiceLoader
templating.Environment = MagicMock
apt.assert_called_with('python-jinja2')
def test_create_renderer_invalid_templates_dir(self):
'''Ensure OSConfigRenderer checks templates_dir'''
self.assertRaises(templating.OSConfigException,
templating.OSConfigRenderer,
templates_dir='/tmp/foooo0',
openstack_release='grizzly')
def test_render_unregistered_config(self):
'''Ensure cannot render an unregistered config file'''
self.assertRaises(templating.OSConfigException,
self.renderer.render,
config_file='/tmp/foo')
def test_write_unregistered_config(self):
'''Ensure cannot write an unregistered config file'''
self.assertRaises(templating.OSConfigException,
self.renderer.write,
config_file='/tmp/foo')
def test_render_complete_context(self):
'''It renders a template when provided a complete context'''
self.loader.set('{{ foo }}')
self.context.set(interfaces=['fooservice'], context={'foo': 'bar'})
self.renderer.register('/tmp/foo', [self.context])
with patch.object(self.renderer, '_get_template') as _get_t:
fake_tmpl = MockTemplate()
_get_t.return_value = fake_tmpl
self.renderer.render('/tmp/foo')
fake_tmpl.render.assert_called_with(self.context())
self.assertIn('fooservice', self.renderer.complete_contexts())
def test_render_incomplete_context_with_template(self):
'''It renders a template when provided an incomplete context'''
self.context.set(interfaces=['fooservice'], context={})
self.renderer.register('/tmp/foo', [self.context])
with patch.object(self.renderer, '_get_template') as _get_t:
fake_tmpl = MockTemplate()
_get_t.return_value = fake_tmpl
self.renderer.render('/tmp/foo')
fake_tmpl.render.assert_called_with({})
self.assertNotIn('fooservice', self.renderer.complete_contexts())
@patch('__builtin__.open')
@patch.object(templating, 'get_loader')
def test_write_out_config(self, loader, _open):
'''It writes a templated config when provided a complete context'''
self.context.set(interfaces=['fooservice'], context={'foo': 'bar'})
self.renderer.register('/tmp/foo', [self.context])
with patch.object(self.renderer, '_get_template') as _get_t:
fake_tmpl = MockTemplate()
_get_t.return_value = fake_tmpl
self.renderer.write('/tmp/foo')
_open.assert_called_with('/tmp/foo', 'wb')
def test_write_all(self):
'''It writes out all configuration files at once'''
self.context.set(interfaces=['fooservice'], context={'foo': 'bar'})
self.renderer.register('/tmp/foo', [self.context])
self.renderer.register('/tmp/bar', [self.context])
ex_calls = [
call('/tmp/bar'),
call('/tmp/foo'),
]
with patch.object(self.renderer, 'write') as _write:
self.renderer.write_all()
self.assertEquals(ex_calls, _write.call_args_list)
pass
@patch.object(templating, 'get_loader')
def test_reset_template_loader_for_new_os_release(self, loader):
self.loader.set('')
self.context.set(interfaces=['fooservice'], context={})
loader.return_value = MockFSLoader('/tmp/foo')
self.renderer.register('/tmp/foo', [self.context])
self.renderer.render('/tmp/foo')
loader.assert_called_with(os.path.dirname(__file__), 'folsom')
self.renderer.set_release(openstack_release='grizzly')
self.renderer.render('/tmp/foo')
loader.assert_called_with(os.path.dirname(__file__), 'grizzly')
@patch.object(templating, 'get_loader')
def test_incomplete_context_not_reported_complete(self, loader):
'''It does not recognize an incomplete context as a complete context'''
self.context.set(interfaces=['fooservice'], context={})
self.renderer.register('/tmp/foo', [self.context])
self.assertNotIn('fooservice', self.renderer.complete_contexts())
@patch.object(templating, 'get_loader')
def test_complete_context_reported_complete(self, loader):
'''It recognizes a complete context as a complete context'''
self.context.set(interfaces=['fooservice'], context={'foo': 'bar'})
self.renderer.register('/tmp/foo', [self.context])
self.assertIn('fooservice', self.renderer.complete_contexts())
@patch('os.path.isdir')
def test_get_loader_no_templates_dir(self, isdir):
'''Ensure getting loader fails with no template dir'''
isdir.return_value = False
self.assertRaises(templating.OSConfigException,
templating.get_loader,
templates_dir='/tmp/foo', os_release='foo')
@patch('os.path.isdir')
def test_get_loader_all_search_paths(self, isdir):
'''Ensure loader reverse searches of all release template dirs'''
isdir.return_value = True
choice_loader = templating.get_loader('/tmp/foo',
os_release='icehouse')
dirs = [l.searchpath for l in choice_loader.loaders]
common_tmplts = os.path.join(os.path.dirname(templating.__file__),
'templates')
expected = [['/tmp/foo/icehouse'],
['/tmp/foo/havana'],
['/tmp/foo/grizzly'],
['/tmp/foo/folsom'],
['/tmp/foo/essex'],
['/tmp/foo/diablo'],
['/tmp/foo'],
[common_tmplts]]
self.assertEquals(dirs, expected)
@patch('os.path.isdir')
def test_get_loader_some_search_paths(self, isdir):
'''Ensure loader reverse searches of some release template dirs'''
isdir.return_value = True
choice_loader = templating.get_loader('/tmp/foo', os_release='grizzly')
dirs = [l.searchpath for l in choice_loader.loaders]
common_tmplts = os.path.join(os.path.dirname(templating.__file__),
'templates')
expected = [['/tmp/foo/grizzly'],
['/tmp/foo/folsom'],
['/tmp/foo/essex'],
['/tmp/foo/diablo'],
['/tmp/foo'],
[common_tmplts]]
self.assertEquals(dirs, expected)
def test_register_template_with_list_of_contexts(self):
'''Ensure registering a template with a list of context generators'''
def _c1():
pass
def _c2():
pass
tmpl = templating.OSConfigTemplate(config_file='/tmp/foo',
contexts=[_c1, _c2])
self.assertEquals(tmpl.contexts, [_c1, _c2])
def test_register_template_with_single_context(self):
'''Ensure registering a template with a single non-list context'''
def _c1():
pass
tmpl = templating.OSConfigTemplate(config_file='/tmp/foo',
contexts=_c1)
self.assertEquals(tmpl.contexts, [_c1])
|