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
|
# -*- coding: utf-8 -*-
from __future__ import absolute_import, division, print_function
__metaclass__ = type
import unittest
from ansible_collections.vyos.rest.plugins.module_utils.vyos import dict_op
from ansible_collections.vyos.rest.plugins.modules.vyos_firewall_global import (
_device_to_argspec,
_groups_from_device,
_groups_to_device,
_want_to_device,
)
from .base import load_fixture
_BASE = ["firewall", "group"]
class TestGroupHelpers(unittest.TestCase):
"""Test group list <-> device dict conversion helpers."""
def test_groups_to_device_with_members(self):
groups = [{"name": "SERVERS", "address": ["192.168.1.10", "192.168.1.11"]}]
result = _groups_to_device(groups, "address")
self.assertIn("SERVERS", result)
self.assertIn("192.168.1.10", result["SERVERS"]["address"])
self.assertIn("192.168.1.11", result["SERVERS"]["address"])
def test_groups_to_device_with_description(self):
groups = [{"name": "LAN", "description": "Local network", "network": ["192.168.0.0/16"]}]
result = _groups_to_device(groups, "network")
self.assertEqual(result["LAN"]["description"], "Local network")
def test_groups_to_device_empty(self):
self.assertEqual(_groups_to_device([], "address"), {})
self.assertEqual(_groups_to_device(None, "address"), {})
def test_groups_from_device_with_members(self):
raw = {"SERVERS": {"address": {"192.168.1.10": {}, "192.168.1.11": {}}}}
result = _groups_from_device(raw, "address")
self.assertEqual(len(result), 1)
self.assertEqual(result[0]["name"], "SERVERS")
self.assertIn("192.168.1.10", result[0]["address"])
def test_groups_from_device_single_member_string(self):
# VyOS returns single member as string
raw = {"WEB": {"port": "80"}}
result = _groups_from_device(raw, "port")
self.assertIn("80", result[0]["port"])
def test_groups_from_device_with_description(self):
raw = {"LAN": {"description": "Local", "network": {"192.168.0.0/16": {}}}}
result = _groups_from_device(raw, "network")
self.assertEqual(result[0]["description"], "Local")
def test_groups_from_device_sorted(self):
raw = {"Z-GROUP": {}, "A-GROUP": {}}
result = _groups_from_device(raw, "address")
self.assertEqual(result[0]["name"], "A-GROUP")
self.assertEqual(result[1]["name"], "Z-GROUP")
def test_groups_from_device_empty(self):
self.assertEqual(_groups_from_device({}, "address"), [])
self.assertEqual(_groups_from_device(None, "address"), [])
class TestWantToDevice(unittest.TestCase):
"""Test argspec -> device shape conversion."""
def test_empty(self):
self.assertEqual(_want_to_device({}), {})
self.assertEqual(_want_to_device(None), {})
def test_address_group(self):
config = {
"group": {
"address_group": [
{"name": "SERVERS", "address": ["192.168.1.10"]},
],
},
}
result = _want_to_device(config)
self.assertIn("address-group", result)
self.assertIn("SERVERS", result["address-group"])
self.assertIn("192.168.1.10", result["address-group"]["SERVERS"]["address"])
def test_network_group(self):
config = {
"group": {
"network_group": [{"name": "LAN", "network": ["192.168.0.0/16"]}],
},
}
result = _want_to_device(config)
self.assertIn("network-group", result)
self.assertIn("LAN", result["network-group"])
def test_port_group(self):
config = {
"group": {
"port_group": [{"name": "WEB", "port": ["80", "443"]}],
},
}
result = _want_to_device(config)
self.assertIn("port-group", result)
self.assertIn("80", result["port-group"]["WEB"]["port"])
def test_interface_group(self):
config = {
"group": {
"interface_group": [{"name": "LAN-IFACES", "interface": ["eth1"]}],
},
}
result = _want_to_device(config)
self.assertIn("interface-group", result)
def test_ipv6_network_group(self):
config = {
"group": {
"ipv6_network_group": [{"name": "IPV6-LAN", "network": ["2001:db8::/32"]}],
},
}
result = _want_to_device(config)
self.assertIn("ipv6-network-group", result)
class TestDeviceToArgspec(unittest.TestCase):
"""Test device response -> argspec shape conversion."""
def test_empty(self):
self.assertEqual(_device_to_argspec({}), {})
self.assertEqual(_device_to_argspec(None), {})
def test_address_group(self):
raw = {
"address-group": {
"SERVERS": {
"description": "Web servers",
"address": {"192.168.1.10": {}, "192.168.1.11": {}},
},
},
}
result = _device_to_argspec(raw)
groups = result["group"]["address_group"]
servers = next(g for g in groups if g["name"] == "SERVERS")
self.assertEqual(servers["description"], "Web servers")
self.assertIn("192.168.1.10", servers["address"])
def test_no_group_returns_empty(self):
self.assertEqual(_device_to_argspec({}), {})
class TestDeviceToArgspecFixture(unittest.TestCase):
"""Test _device_to_argspec against fixture."""
def setUp(self):
self.fixture = load_fixture("firewall_global_running.json")
def test_parses_address_groups(self):
result = _device_to_argspec(self.fixture)
groups = result["group"]["address_group"]
names = [g["name"] for g in groups]
self.assertIn("SERVERS", names)
self.assertIn("DNS", names)
servers = next(g for g in groups if g["name"] == "SERVERS")
self.assertEqual(servers["description"], "Web servers")
self.assertIn("192.168.1.10", servers["address"])
def test_parses_network_groups(self):
result = _device_to_argspec(self.fixture)
groups = result["group"]["network_group"]
dmz = next(g for g in groups if g["name"] == "DMZ")
self.assertIn("10.0.0.0/8", dmz["network"])
def test_parses_port_groups(self):
result = _device_to_argspec(self.fixture)
groups = result["group"]["port_group"]
web = next(g for g in groups if g["name"] == "WEB-PORTS")
self.assertIn("80", web["port"])
def test_parses_interface_groups(self):
result = _device_to_argspec(self.fixture)
groups = result["group"]["interface_group"]
lan = next(g for g in groups if g["name"] == "LAN-IFACES")
self.assertIn("eth1", lan["interface"])
def test_parses_ipv6_network_groups(self):
result = _device_to_argspec(self.fixture)
groups = result["group"]["ipv6_network_group"]
ipv6 = next(g for g in groups if g["name"] == "IPV6-LAN")
self.assertIn("2001:db8::/32", ipv6["network"])
def test_empty_config(self):
result = _device_to_argspec({})
self.assertEqual(result, {})
class TestDictOpFirewall(unittest.TestCase):
"""Test dict_op behaviour with firewall group shapes."""
def test_merged_adds_address_group(self):
want = _want_to_device(
{
"group": {
"address_group": [{"name": "SERVERS", "address": ["192.168.1.10"]}],
},
},
)
cmds = dict_op(want, {}, _BASE, op="set")
paths = [c[1] for c in cmds]
self.assertIn(_BASE + ["address-group", "SERVERS", "address", "192.168.1.10"], paths)
def test_merged_idempotent(self):
config = {
"group": {
"address_group": [{"name": "SERVERS", "address": ["192.168.1.10"]}],
},
}
want = _want_to_device(config)
have = {"address-group": {"SERVERS": {"address": {"192.168.1.10": {}}}}}
cmds = dict_op(want, have, _BASE, op="set")
self.assertEqual(cmds, [])
def test_merged_adds_network_group(self):
want = _want_to_device(
{
"group": {
"network_group": [{"name": "LAN", "network": ["192.168.0.0/16"]}],
},
},
)
cmds = dict_op(want, {}, _BASE, op="set")
paths = [c[1] for c in cmds]
self.assertIn(_BASE + ["network-group", "LAN", "network", "192.168.0.0/16"], paths)
def test_purge_removes_extra_group(self):
want = _want_to_device(
{
"group": {
"network_group": [{"name": "DMZ", "network": ["10.0.0.0/8"]}],
},
},
)
have = {
"address-group": {"SERVERS": {"address": {"192.168.1.10": {}}}},
"network-group": {"LAN": {"network": {"192.168.0.0/16": {}}}},
}
cmds = dict_op(want, have, _BASE, op="purge")
paths = [c[1] for c in cmds]
# address-group entirely absent from want -> whole type deleted
self.assertIn(_BASE + ["address-group"], paths)
self.assertIn(_BASE + ["network-group", "LAN"], paths)
def test_deleted_removes_base(self):
# deleted state is handled in main() not dict_op
# just verify want_to_device produces correct shape
want = _want_to_device({})
self.assertEqual(want, {})
if __name__ == "__main__":
unittest.main()
|
