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
|
# -*- coding: utf-8 -*-
from __future__ import absolute_import, division, print_function
__metaclass__ = type
import unittest
from unittest.mock import MagicMock
from ansible_collections.vyos.rest.plugins.modules.vyos_ha import (
_device_to_argspec,
_group_from_device,
_group_to_device,
_real_server_from_device,
_real_server_to_device,
_virtual_server_from_device,
_virtual_server_to_device,
_want_to_device,
build_commands,
get_running_config,
)
from .base import load_fixture
_BASE = ["high-availability"]
class VyOSModuleTestCase(unittest.TestCase):
def setUp(self):
self.mock_vyos = MagicMock()
self.fixture = load_fixture("ha_running.json")
self.mock_vyos.get_config = MagicMock(return_value=self.fixture)
class TestGetRunningConfig(VyOSModuleTestCase):
def test_returns_raw_device_dict(self):
self.assertEqual(get_running_config(self.mock_vyos), self.fixture)
def test_empty_config(self):
self.mock_vyos.get_config = MagicMock(return_value=None)
self.assertEqual(get_running_config(self.mock_vyos), {})
class TestRealServer(unittest.TestCase):
def test_to_device_generic_fields(self):
result = _real_server_to_device({"address": "10.0.0.2", "port": 8080})
self.assertEqual(result, {"port": 8080})
def test_to_device_health_check_script_nested(self):
"""health_check_script is a genuine structural exception -- the
argspec has it flat, the device nests it under health-check.script."""
result = _real_server_to_device(
{"address": "10.0.0.2", "health_check_script": "/check.sh"},
)
self.assertEqual(result, {"health-check": {"script": "/check.sh"}})
def test_from_device_basic(self):
entry = _real_server_from_device("10.0.0.2", {"port": "8080"})
self.assertEqual(entry["address"], "10.0.0.2")
self.assertEqual(entry["port"], 8080)
def test_from_device_health_check_script_extracted(self):
entry = _real_server_from_device(
"10.0.0.2",
{"health-check": {"script": "/check.sh"}},
)
self.assertEqual(entry["health_check_script"], "/check.sh")
class TestVirtualServer(unittest.TestCase):
def test_to_device_keyed_fields(self):
result = _virtual_server_to_device({"name": "s1", "address": "10.0.0.1", "port": 80})
self.assertEqual(result, {"address": "10.0.0.1", "port": 80})
def test_to_device_real_server_keyed_by_address(self):
vs = {
"name": "s1",
"port": 80,
"real_server": [{"address": "10.0.0.2", "port": 8080}],
}
result = _virtual_server_to_device(vs)
self.assertEqual(result["real-server"]["10.0.0.2"], {"port": 8080})
def test_from_device_list_with_real_servers(self):
entry = _virtual_server_from_device(
"s1",
{"port": "80", "real-server": {"10.0.0.2": {"port": "8080"}}},
)
self.assertEqual(entry["name"], "s1")
self.assertEqual(entry["port"], 80)
self.assertEqual(entry["real_server"][0]["address"], "10.0.0.2")
self.assertEqual(entry["real_server"][0]["port"], 8080)
class TestGroup(unittest.TestCase):
"""address/excluded_address are genuine tagNodes (confirmed); track
is NOT special-cased for interface since that's a plain list."""
def test_to_device_basic_fields_generic(self):
result = _group_to_device({"name": "g1", "vrid": 20, "interface": "eth0"})
self.assertEqual(result, {"vrid": 20, "interface": "eth0"})
def test_to_device_address_tag_node(self):
result = _group_to_device(
{"name": "g1", "address": ["192.168.1.1/24", "192.168.1.2/24"]},
)
self.assertEqual(
result["address"],
{"192.168.1.1/24": {}, "192.168.1.2/24": {}},
)
def test_to_device_excluded_address_tag_node(self):
result = _group_to_device({"name": "g1", "excluded_address": ["10.0.0.1"]})
self.assertEqual(result["excluded-address"], {"10.0.0.1": {}})
def test_to_device_track_interface_stays_plain_list(self):
"""Regression test: track.interface is a confirmed <multi/>
leafNode, not a tag node -- must NOT be reshaped into a
dict-of-presence like address/excluded_address are."""
result = _group_to_device({"name": "g1", "track": {"interface": ["eth1", "eth2"]}})
self.assertEqual(result["track"]["interface"], ["eth1", "eth2"])
def test_to_device_bool_fields(self):
result = _group_to_device(
{"name": "g1", "disable": True, "no_preempt": True, "rfc3768_compatibility": False},
)
self.assertEqual(result["disable"], {})
self.assertEqual(result["no_preempt"], {})
self.assertNotIn("rfc3768_compatibility", result)
def test_from_device_vrid_and_priority_cast_to_int(self):
entry = _group_from_device("g1", {"vrid": "20", "priority": "100"})
self.assertEqual(entry["vrid"], 20)
self.assertEqual(entry["priority"], 100)
def test_from_device_address_tag_node_to_sorted_list(self):
entry = _group_from_device(
"g1",
{"address": {"192.168.1.2/24": {}, "192.168.1.1/24": {}}},
)
self.assertEqual(entry["address"], ["192.168.1.1/24", "192.168.1.2/24"])
def test_from_device_single_address_string_collapse(self):
entry = _group_from_device("g1", {"address": "192.168.1.1/24"})
self.assertEqual(entry["address"], ["192.168.1.1/24"])
def test_from_device_track_interface_stays_plain_list(self):
entry = _group_from_device("g1", {"track": {"interface": ["eth1", "eth2"]}})
self.assertEqual(entry["track"]["interface"], ["eth1", "eth2"])
def test_from_device_bool_presence_nodes(self):
entry = _group_from_device("g1", {"disable": {}, "no-preempt": {}})
self.assertTrue(entry["disable"])
self.assertTrue(entry["no_preempt"])
class TestWantToDevice(unittest.TestCase):
def test_empty(self):
self.assertEqual(_want_to_device({}), {})
self.assertEqual(_want_to_device(None), {})
def test_disable(self):
result = _want_to_device({"disable": True})
self.assertEqual(result["disable"], {})
def test_virtual_server_keyed_by_name(self):
config = {"virtual_servers": [{"name": "s1", "address": "10.0.0.1", "port": 80}]}
result = _want_to_device(config)
self.assertIn("s1", result["virtual-server"])
def test_vrrp_global_parameters_generic(self):
config = {
"vrrp": {"global_parameters": {"startup_delay": 30, "garp": {"master_repeat": 6}}},
}
result = _want_to_device(config)
gp = result["vrrp"]["global_parameters"]
self.assertEqual(gp["startup_delay"], 30)
self.assertEqual(gp["garp"]["master_repeat"], 6)
def test_snmp_enabled_becomes_presence_node(self):
result = _want_to_device({"vrrp": {"snmp": "enabled"}})
self.assertEqual(result["vrrp"]["snmp"], {})
def test_snmp_disabled_not_in_want(self):
result = _want_to_device({"vrrp": {"snmp": "disabled"}})
self.assertNotIn("snmp", result.get("vrrp", {}))
def test_group_keyed_by_name(self):
config = {"vrrp": {"groups": [{"name": "g1", "vrid": 20, "interface": "eth0"}]}}
result = _want_to_device(config)
self.assertEqual(result["vrrp"]["group"]["g1"]["vrid"], 20)
def test_sync_group_member_stays_plain_list(self):
"""Regression test: member is a confirmed <multi/> leafNode, not
a tag node -- must stay a plain list."""
config = {"vrrp": {"sync_groups": [{"name": "sg1", "member": ["g1", "g2"]}]}}
result = _want_to_device(config)
self.assertEqual(result["vrrp"]["sync-group"]["sg1"]["member"], ["g1", "g2"])
class TestDeviceToArgspecFixture(VyOSModuleTestCase):
def test_disable_parsed(self):
result = _device_to_argspec(self.fixture)
self.assertTrue(result["disable"])
def test_virtual_server_parsed(self):
result = _device_to_argspec(self.fixture)
vs = result["virtual_servers"][0]
self.assertEqual(vs["name"], "s1")
self.assertEqual(vs["port"], 80)
self.assertEqual(vs["real_server"][0]["address"], "10.10.50.2")
self.assertEqual(vs["real_server"][0]["port"], 8443)
def test_global_parameters_parsed(self):
result = _device_to_argspec(self.fixture)
gp = result["vrrp"]["global_parameters"]
self.assertEqual(gp["startup_delay"], 30)
self.assertEqual(gp["garp"]["master_repeat"], 6)
def test_snmp_parsed(self):
result = _device_to_argspec(self.fixture)
self.assertEqual(result["vrrp"]["snmp"], "enabled")
def test_groups_parsed_with_track_interface_as_list(self):
result = _device_to_argspec(self.fixture)
groups = {g["name"]: g for g in result["vrrp"]["groups"]}
self.assertEqual(groups["g1"]["interface"], "eth0")
self.assertEqual(groups["g1"]["vrid"], 20)
self.assertIn("192.168.1.100/24", groups["g1"]["address"])
self.assertTrue(groups["g1"]["no_preempt"])
self.assertEqual(groups["g1"]["track"]["interface"], ["eth1", "eth2"])
# g2: single address string collapsed by device -> list
self.assertEqual(groups["g2"]["address"], ["192.168.2.100/24"])
def test_sync_group_parsed_member_as_list(self):
result = _device_to_argspec(self.fixture)
sg = result["vrrp"]["sync_groups"][0]
self.assertEqual(sg["name"], "sg1")
self.assertEqual(sg["member"], ["g1"])
self.assertEqual(sg["health_check"]["failure_count"], 5)
self.assertEqual(sg["health_check"]["ping"], "192.168.1.1")
def test_empty_config(self):
self.assertEqual(_device_to_argspec({}), {})
self.assertEqual(_device_to_argspec(None), {})
class TestBuildCommands(VyOSModuleTestCase):
def test_merged_idempotent_against_own_fixture(self):
have = _device_to_argspec(self.fixture)
self.assertEqual(build_commands(have, self.fixture, "merged"), [])
def test_replaced_idempotent_against_own_fixture(self):
have = _device_to_argspec(self.fixture)
self.assertEqual(build_commands(have, self.fixture, "replaced"), [])
def test_overridden_idempotent_against_own_fixture(self):
"""overridden is a single dict_op purge+set call (simplified from
the original manual section-scan loop -- confirmed identical
behavior before removing the loop)."""
have = _device_to_argspec(self.fixture)
self.assertEqual(build_commands(have, self.fixture, "overridden"), [])
def test_merged_adds_vrrp_group(self):
config = {
"vrrp": {
"groups": [{"name": "g3", "vrid": 30, "interface": "eth2", "priority": 100}],
},
}
cmds = build_commands(config, {}, "merged")
self.assertIn(("set", _BASE + ["vrrp", "group", "g3", "vrid", "30"]), cmds)
self.assertIn(("set", _BASE + ["vrrp", "group", "g3", "interface", "eth2"]), cmds)
def test_overridden_deletes_omitted_top_level_section(self):
raw_have = {"virtual-server": {"s1": {"port": "80"}}, "vrrp": {"group": {"g1": {}}}}
config = {"vrrp": {"groups": [{"name": "g1"}]}}
cmds = build_commands(config, raw_have, "overridden")
self.assertIn(("delete", _BASE + ["virtual-server"]), cmds)
def test_replaced_removes_stale_track_interface_member(self):
"""Regression test for the dict_op purge list-value fix (this
session): track.interface being a plain list means removing a
member under 'replaced' relies on dict_op's list-purge handling."""
raw_have = {"vrrp": {"group": {"g1": {"track": {"interface": ["eth1", "eth2"]}}}}}
config = {"vrrp": {"groups": [{"name": "g1", "track": {"interface": ["eth1"]}}]}}
cmds = build_commands(config, raw_have, "replaced")
self.assertIn(
("delete", _BASE + ["vrrp", "group", "g1", "track", "interface", "eth2"]),
cmds,
)
def test_replaced_removes_stale_sync_group_member(self):
raw_have = {"vrrp": {"sync-group": {"sg1": {"member": ["g1", "g2"]}}}}
config = {"vrrp": {"sync_groups": [{"name": "sg1", "member": ["g1"]}]}}
cmds = build_commands(config, raw_have, "replaced")
self.assertIn(
("delete", _BASE + ["vrrp", "sync-group", "sg1", "member", "g2"]),
cmds,
)
def test_snmp_disabled_deletes_presence_node(self):
raw_have = {"vrrp": {"snmp": {}}}
config = {"vrrp": {"snmp": "disabled"}}
cmds = build_commands(config, raw_have, "merged")
self.assertIn(("delete", _BASE + ["vrrp", "snmp"]), cmds)
def test_deleted_no_have_is_noop(self):
self.assertEqual(build_commands({}, {}, "deleted"), [])
def test_deleted_with_have(self):
self.assertEqual(
build_commands({}, {"vrrp": {"group": {"g1": {}}}}, "deleted"),
[("delete", _BASE)],
)
def test_collapsed_track_interface_no_char_iteration_bug(self):
"""A group with exactly one tracked interface, collapsed by the
device to a bare string, must not be iterated character-by-
character (dict_op's own list handling corrects this natively)."""
raw_have = {"vrrp": {"group": {"g1": {"track": {"interface": "eth1"}}}}}
config = {"vrrp": {"groups": [{"name": "g1", "track": {"interface": ["eth1"]}}]}}
self.assertEqual(build_commands(config, raw_have, "merged"), [])
def test_collapsed_sync_group_member_no_char_iteration_bug(self):
raw_have = {"vrrp": {"sync-group": {"sg1": {"member": "g1"}}}}
config = {"vrrp": {"sync_groups": [{"name": "sg1", "member": ["g1"]}]}}
self.assertEqual(build_commands(config, raw_have, "merged"), [])
def test_virtual_server_address_never_treated_as_tag_node(self):
"""Regression test: virtual-server.<name>.address is a flat
scalar (the load-balancer bind address), unlike vrrp.group.
<name>.address which IS a genuine tag node (VRRP virtual IPs).
Same key name, different device shape depending on section --
a blanket key-name-based coercion previously corrupted this
into a spurious diff every single run."""
raw_have = {"virtual-server": {"s1": {"address": "10.10.10.5", "port": "80"}}}
config = {"virtual_servers": [{"name": "s1", "address": "10.10.10.5", "port": 80}]}
self.assertEqual(build_commands(config, raw_have, "merged"), [])
self.assertEqual(build_commands(config, raw_have, "replaced"), [])
if __name__ == "__main__":
unittest.main()
|
