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
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
|
# -*- coding: utf-8 -*-
# Copyright 2019 Alan Rominger <arominge@redhat.net>
#
# This file is part of Ansible
#
# Ansible is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# Ansible is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with Ansible. If not, see <http://www.gnu.org/licenses/>.
from __future__ import annotations
import pytest
from ansible.errors import AnsibleParserError
from ansible._internal._datatag._tags import TrustedAsTemplate
from ansible.plugins.inventory.constructed import InventoryModule
from ansible.inventory.data import InventoryData
from ansible.template import Templar
@pytest.fixture()
def inventory_module():
r = InventoryModule()
r.inventory = InventoryData()
r.templar = Templar()
r._options = {'leading_separator': True}
return r
def _trust(value):
"""Recursively apply TrustedAsTemplate to input (simulating what wuold come out of a trusted input source like the dataloader YAML/JSON/ini parser)"""
if isinstance(value, dict):
return {_trust(k): _trust(v) for k, v in value.items()}
if isinstance(value, list):
return [_trust(item) for item in value]
if isinstance(value, str):
return TrustedAsTemplate().tag(value)
return value
def test_group_by_value_only(inventory_module):
inventory_module.inventory.add_host('foohost')
inventory_module.inventory.set_variable('foohost', 'bar', 'my_group_name')
host = inventory_module.inventory.get_host('foohost')
keyed_groups = [
{
'prefix': '',
'separator': '',
'key': 'bar'
}
]
inventory_module._add_host_to_keyed_groups(
_trust(keyed_groups), host.vars, host.name, strict=False
)
assert 'my_group_name' in inventory_module.inventory.groups
group = inventory_module.inventory.groups['my_group_name']
assert group.hosts == [host]
def test_keyed_group_separator(inventory_module):
inventory_module.inventory.add_host('farm')
inventory_module.inventory.set_variable('farm', 'farmer', 'mcdonald')
inventory_module.inventory.set_variable('farm', 'barn', {'cow': 'betsy'})
host = inventory_module.inventory.get_host('farm')
keyed_groups = [
{
'prefix': 'farmer',
'separator': '_old_',
'key': 'farmer'
},
{
'separator': 'mmmmmmmmmm',
'key': 'barn'
}
]
inventory_module._add_host_to_keyed_groups(
_trust(keyed_groups), host.vars, host.name, strict=False
)
for group_name in ('farmer_old_mcdonald', 'mmmmmmmmmmcowmmmmmmmmmmbetsy'):
assert group_name in inventory_module.inventory.groups
group = inventory_module.inventory.groups[group_name]
assert group.hosts == [host]
def test_keyed_group_empty_construction(inventory_module):
inventory_module.inventory.add_host('farm')
inventory_module.inventory.set_variable('farm', 'barn', {})
host = inventory_module.inventory.get_host('farm')
keyed_groups = [
{
'separator': 'mmmmmmmmmm',
'key': 'barn'
}
]
inventory_module._add_host_to_keyed_groups(
_trust(keyed_groups), host.vars, host.name, strict=True
)
assert host.groups == []
def test_keyed_group_host_confusion(inventory_module):
inventory_module.inventory.add_host('cow')
inventory_module.inventory.add_group('cow')
host = inventory_module.inventory.get_host('cow')
host.vars['species'] = 'cow'
keyed_groups = [
{
'separator': '',
'prefix': '',
'key': 'species'
}
]
inventory_module._add_host_to_keyed_groups(
_trust(keyed_groups), host.vars, host.name, strict=True
)
group = inventory_module.inventory.groups['cow']
# group cow has host of cow
assert group.hosts == [host]
def test_keyed_parent_groups(inventory_module):
inventory_module.inventory.add_host('web1')
inventory_module.inventory.add_host('web2')
inventory_module.inventory.set_variable('web1', 'region', 'japan')
inventory_module.inventory.set_variable('web2', 'region', 'japan')
host1 = inventory_module.inventory.get_host('web1')
host2 = inventory_module.inventory.get_host('web2')
keyed_groups = [
{
'prefix': 'region',
'key': 'region',
'parent_group': 'region_list'
}
]
for host in [host1, host2]:
inventory_module._add_host_to_keyed_groups(
_trust(keyed_groups), host.vars, host.name, strict=False
)
assert 'region_japan' in inventory_module.inventory.groups
assert 'region_list' in inventory_module.inventory.groups
region_group = inventory_module.inventory.groups['region_japan']
all_regions = inventory_module.inventory.groups['region_list']
assert all_regions.child_groups == [region_group]
assert region_group.hosts == [host1, host2]
def test_parent_group_templating(inventory_module):
inventory_module.inventory.add_host('cow')
inventory_module.inventory.set_variable('cow', 'sound', 'mmmmmmmmmm')
inventory_module.inventory.set_variable('cow', 'nickname', 'betsy')
host = inventory_module.inventory.get_host('cow')
keyed_groups = [
{
'key': 'sound',
'prefix': 'sound',
'parent_group': '{{ nickname }}'
},
{
'key': 'nickname',
'prefix': '',
'separator': '',
'parent_group': 'nickname' # statically-named parent group, conflicting with hostvar
},
{
'key': 'nickname',
'separator': '',
'parent_group': '{{ location | default("field") }}'
},
{
# duplicate this one to ensure it doesn't show up in parents more than once
'key': 'nickname',
'separator': '',
'parent_group': '{{ location | default("field") }}'
},
{
'key': 'nickname',
'prefix': 'omitted_parent',
'parent_group': '{{ omit }}'
}
]
inventory_module._add_host_to_keyed_groups(
_trust(keyed_groups), host.vars, host.name, strict=True
)
# first keyed group, "betsy" is a parent group name dynamically generated
betsys_group = inventory_module.inventory.groups['betsy']
assert [child.name for child in betsys_group.child_groups] == ['sound_mmmmmmmmmm']
# second keyed group, "nickname" is a statically-named root group
nicknames_group = inventory_module.inventory.groups['nickname']
assert [child.name for child in nicknames_group.child_groups] == ['betsy']
# second keyed group actually generated the parent group of the first keyed group
assert nicknames_group.child_groups == [betsys_group]
# assert that these are, in fact, the same object
assert nicknames_group.child_groups[0] is betsys_group
# "betsy" has two parents
locations_group = inventory_module.inventory.groups['field']
assert [child.name for child in locations_group.child_groups] == ['betsy']
assert len(inventory_module.inventory.groups['betsy'].parent_groups) == 2
assert set(inventory_module.inventory.groups['betsy'].parent_groups) == {locations_group, nicknames_group}
def test_parent_group_templating_error(inventory_module):
inventory_module.inventory.add_host('cow')
inventory_module.inventory.set_variable('cow', 'nickname', 'betsy')
host = inventory_module.inventory.get_host('cow')
keyed_groups = [
{
'key': 'nickname',
'separator': '',
'parent_group': '{{ location.barn-yard }}'
}
]
with pytest.raises(AnsibleParserError) as ex:
inventory_module._add_host_to_keyed_groups(
_trust(keyed_groups), host.vars, host.name, strict=True
)
assert 'Could not generate parent group' in str(ex.value)
# invalid parent group did not raise an exception with strict=False
inventory_module._add_host_to_keyed_groups(
_trust(keyed_groups), host.vars, host.name, strict=False
)
# assert group was never added with invalid parent
assert 'betsy' not in inventory_module.inventory.groups
def test_keyed_group_exclusive_argument(inventory_module):
inventory_module.inventory.add_host('cow')
inventory_module.inventory.set_variable('cow', 'nickname', 'betsy')
host = inventory_module.inventory.get_host('cow')
keyed_groups = [
{
'key': 'nickname',
'separator': '_',
'default_value': 'default_value_name',
'trailing_separator': True
}
]
with pytest.raises(AnsibleParserError) as ex:
inventory_module._add_host_to_keyed_groups(
_trust(keyed_groups), host.vars, host.name, strict=True
)
assert 'parameters are mutually exclusive' in str(ex.value)
def test_keyed_group_empty_value(inventory_module):
inventory_module.inventory.add_host('server0')
inventory_module.inventory.set_variable('server0', 'tags', {'environment': 'prod', 'status': ''})
host = inventory_module.inventory.get_host('server0')
keyed_groups = [
{
'prefix': 'tag',
'separator': '_',
'key': 'tags'
}
]
inventory_module._add_host_to_keyed_groups(
_trust(keyed_groups), host.vars, host.name, strict=False
)
for group_name in ('tag_environment_prod', 'tag_status_'):
assert group_name in inventory_module.inventory.groups
def test_keyed_group_dict_with_default_value(inventory_module):
inventory_module.inventory.add_host('server0')
inventory_module.inventory.set_variable('server0', 'tags', {'environment': 'prod', 'status': ''})
host = inventory_module.inventory.get_host('server0')
keyed_groups = [
{
'prefix': 'tag',
'separator': '_',
'key': 'tags',
'default_value': 'running'
}
]
inventory_module._add_host_to_keyed_groups(
_trust(keyed_groups), host.vars, host.name, strict=False
)
for group_name in ('tag_environment_prod', 'tag_status_running'):
assert group_name in inventory_module.inventory.groups
def test_keyed_group_str_no_default_value(inventory_module):
inventory_module.inventory.add_host('server0')
inventory_module.inventory.set_variable('server0', 'tags', '')
host = inventory_module.inventory.get_host('server0')
keyed_groups = [
{
'prefix': 'tag',
'separator': '_',
'key': 'tags'
}
]
inventory_module._add_host_to_keyed_groups(
_trust(keyed_groups), host.vars, host.name, strict=False
)
# when the value is an empty string. this group is not generated
assert "tag_" not in inventory_module.inventory.groups
def test_keyed_group_str_with_default_value(inventory_module):
inventory_module.inventory.add_host('server0')
inventory_module.inventory.set_variable('server0', 'tags', '')
host = inventory_module.inventory.get_host('server0')
keyed_groups = [
{
'prefix': 'tag',
'separator': '_',
'key': 'tags',
'default_value': 'running'
}
]
inventory_module._add_host_to_keyed_groups(
_trust(keyed_groups), host.vars, host.name, strict=False
)
assert "tag_running" in inventory_module.inventory.groups
def test_keyed_group_list_with_default_value(inventory_module):
inventory_module.inventory.add_host('server0')
inventory_module.inventory.set_variable('server0', 'tags', ['test', ''])
host = inventory_module.inventory.get_host('server0')
keyed_groups = [
{
'prefix': 'tag',
'separator': '_',
'key': 'tags',
'default_value': 'prod'
}
]
inventory_module._add_host_to_keyed_groups(
_trust(keyed_groups), host.vars, host.name, strict=False
)
for group_name in ('tag_test', 'tag_prod'):
assert group_name in inventory_module.inventory.groups
def test_keyed_group_with_trailing_separator(inventory_module):
inventory_module.inventory.add_host('server0')
inventory_module.inventory.set_variable('server0', 'tags', {'environment': 'prod', 'status': ''})
host = inventory_module.inventory.get_host('server0')
keyed_groups = [
{
'prefix': 'tag',
'separator': '_',
'key': 'tags',
'trailing_separator': False
}
]
inventory_module._add_host_to_keyed_groups(
_trust(keyed_groups), host.vars, host.name, strict=False
)
for group_name in ('tag_environment_prod', 'tag_status'):
assert group_name in inventory_module.inventory.groups
|
