Repository navigation
Expand file tree
/
Copy pathtest_enroll_fw.py
More file actions
509 lines (381 loc) · 16.2 KB
/
Copy pathtest_enroll_fw.py
File metadata and controls
509 lines (381 loc) · 16.2 KB
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
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
from types import SimpleNamespace
from typing import Any
from unittest.mock import MagicMock
import pytest
from ironicclient.common.apiclient import exceptions as ironic_exceptions
from understack_workflows.main import enroll_fw
BASE_ARGS: dict[str, Any] = {
"name": "PA1410-026701008071",
"physical_network": "f20-1-network",
"resource_class": "pa1410",
"ports": [
{
"label": "ethernet1/19",
"mac": "60:15:2b:33:31:22",
"switch": "n11-22-1.dfw3",
"intf": "Ethernet1/43",
}
],
}
FW_FIELDS: dict[str, Any] = {
"management_ip": "10.15.149.46",
"management_switch": "n11-22-1d.dfw3",
"management_switch_port": "Ethernet1/24",
"mate_serial": "026701010045",
}
def _node(
*,
driver: str = "panos",
resource_class: str = "pa1410",
provision_state: str = "active",
driver_info: dict | None = None,
extra: dict | None = None,
):
return SimpleNamespace(
uuid="node-uuid",
name=BASE_ARGS["name"],
driver=driver,
resource_class=resource_class,
provision_state=provision_state,
driver_info=driver_info or {},
extra=extra or {},
)
def _actual_port(
*,
label: str = "ethernet1/19",
mac: str = "60:15:2b:33:31:22",
switch: str = "n11-22-1.dfw3",
intf: str = "Ethernet1/43",
physnet: str = "f20-1-network",
switch_id: str = "00:00:00:00:00:00",
):
"""A node port matching the BASE_ARGS request (so no structural drift)."""
return SimpleNamespace(
uuid=f"port-{label}",
name=f"{BASE_ARGS['name']}:{label}",
address=mac,
physical_network=physnet,
category="network",
extra={"bios_name": label},
local_link_connection={
"switch_id": switch_id,
"switch_info": switch,
"port_id": intf,
},
)
def _mock_client(mocker, *, node=None, node_ports=None):
client = MagicMock()
if node is None:
client.get_node.side_effect = ironic_exceptions.NotFound()
else:
client.get_node.return_value = node
client.list_ports.return_value = node_ports or []
mocker.patch.object(enroll_fw, "IronicClient", return_value=client)
return client
def _patch_paths(update_node_call) -> dict[str, Any]:
(_uuid, patch), _ = update_node_call
return {op["path"]: op["value"] for op in patch}
# --- enrollment path (new / re-enrollable node) -----------------------------
def test_enroll_fw_hands_metadata_to_the_engine(mocker):
_mock_client(mocker, node=None) # not found -> new node -> engine enrolls
engine = mocker.patch.object(
enroll_fw.netdev_reconciler, "enroll", return_value="node-123"
)
node_uuid = enroll_fw.enroll_fw(**BASE_ARGS, **FW_FIELDS)
assert node_uuid == "node-123"
engine.assert_called_once_with(
name="PA1410-026701008071",
physical_network="f20-1-network",
ports=BASE_ARGS["ports"],
resource_class="pa1410",
driver="panos",
external_cmdb_id=None,
driver_info={
"management_ip": "10.15.149.46",
"management_switch": "n11-22-1d.dfw3",
"management_switch_port": "Ethernet1/24",
},
extra={"mate_serial": "026701010045"},
properties={},
assign_roles=True,
)
def test_enroll_fw_optional_fw_fields_can_be_omitted(mocker):
# management_switch/port are required; management_ip, mate_serial and
# external_cmdb_id are optional and are simply absent from the metadata.
_mock_client(mocker, node=None)
engine = mocker.patch.object(enroll_fw.netdev_reconciler, "enroll")
enroll_fw.enroll_fw(
**BASE_ARGS,
management_switch="n11-22-1d.dfw3",
management_switch_port="Ethernet1/24",
)
_, kwargs = engine.call_args
assert kwargs["driver_info"] == {
"management_switch": "n11-22-1d.dfw3",
"management_switch_port": "Ethernet1/24",
}
assert kwargs["extra"] == {}
def test_enroll_fw_passes_explicit_legacy_driver_to_engine(mocker):
_mock_client(mocker, node=None)
engine = mocker.patch.object(enroll_fw.netdev_reconciler, "enroll")
enroll_fw.enroll_fw(**BASE_ARGS, **FW_FIELDS, driver="netdev")
assert engine.call_args.kwargs["driver"] == "netdev"
@pytest.mark.parametrize("driver", ["", " "])
def test_enroll_fw_rejects_blank_driver_before_ironic_calls(mocker, driver):
client = mocker.patch.object(enroll_fw, "IronicClient")
engine = mocker.patch.object(enroll_fw.netdev_reconciler, "enroll")
with pytest.raises(ValueError, match="non-empty --driver"):
enroll_fw.enroll_fw(**BASE_ARGS, **FW_FIELDS, driver=driver)
client.assert_not_called()
engine.assert_not_called()
def test_existing_non_active_node_delegates_to_engine(mocker):
# A found-but-available node is re-enrollable, so it is handed to the engine
# rather than treated as in-service.
_mock_client(mocker, node=_node(provision_state="available"))
engine = mocker.patch.object(enroll_fw.netdev_reconciler, "enroll")
enroll_fw.enroll_fw(**BASE_ARGS, **FW_FIELDS)
engine.assert_called_once()
def test_enroll_fw_rejects_generic_and_empty_resource_class(mocker):
engine = mocker.patch.object(enroll_fw.netdev_reconciler, "enroll")
for bad in ("", " ", "generic", "GENERIC", " generic "):
args = {**BASE_ARGS, "resource_class": bad}
with pytest.raises(ValueError, match="purpose-made"):
enroll_fw.enroll_fw(**args, **FW_FIELDS)
# Rejected before the engine (or any Ironic call) is ever invoked.
engine.assert_not_called()
def test_enroll_fw_normalizes_resource_class_whitespace(mocker):
_mock_client(mocker, node=None)
engine = mocker.patch.object(enroll_fw.netdev_reconciler, "enroll")
args = {**BASE_ARGS, "resource_class": " pa1410 "}
enroll_fw.enroll_fw(**args, **FW_FIELDS)
assert engine.call_args.kwargs["resource_class"] == "pa1410"
def test_enroll_fw_requires_management_switch(mocker):
engine = mocker.patch.object(enroll_fw.netdev_reconciler, "enroll")
for bad in ("", " "):
args = {**BASE_ARGS, **FW_FIELDS, "management_switch": bad}
with pytest.raises(ValueError, match="management-switch"):
enroll_fw.enroll_fw(**args)
# Rejected before the engine (or any Ironic call) is ever invoked.
engine.assert_not_called()
def test_enroll_fw_requires_management_switch_port(mocker):
engine = mocker.patch.object(enroll_fw.netdev_reconciler, "enroll")
for bad in ("", " "):
args = {**BASE_ARGS, **FW_FIELDS, "management_switch_port": bad}
with pytest.raises(ValueError, match="management-switch-port"):
enroll_fw.enroll_fw(**args)
engine.assert_not_called()
# --- in-service (active) node: metadata-only in place -----------------------
def test_active_node_updates_metadata_when_ports_match(mocker):
client = _mock_client(mocker, node=_node(), node_ports=[_actual_port()])
engine = mocker.patch.object(enroll_fw.netdev_reconciler, "enroll")
node_uuid = enroll_fw.enroll_fw(**BASE_ARGS, **FW_FIELDS)
assert node_uuid == "node-uuid"
engine.assert_not_called()
client.update_node.assert_called_once()
paths = _patch_paths(client.update_node.call_args)
assert paths["/driver_info/management_ip"] == "10.15.149.46"
assert paths["/extra/mate_serial"] == "026701010045"
def test_active_node_records_external_cmdb_id(mocker):
client = _mock_client(mocker, node=_node(), node_ports=[_actual_port()])
mocker.patch.object(enroll_fw.netdev_reconciler, "enroll")
enroll_fw.enroll_fw(**BASE_ARGS, **FW_FIELDS, external_cmdb_id=12345)
paths = _patch_paths(client.update_node.call_args)
assert paths["/extra/external_cmdb_id"] == 12345
def test_active_node_noop_when_metadata_already_matches(mocker):
node = _node(
driver_info={
"management_ip": "10.15.149.46",
"management_switch": "n11-22-1d.dfw3",
"management_switch_port": "Ethernet1/24",
},
extra={"mate_serial": "026701010045"},
)
client = _mock_client(mocker, node=node, node_ports=[_actual_port()])
mocker.patch.object(enroll_fw.netdev_reconciler, "enroll")
enroll_fw.enroll_fw(**BASE_ARGS, **FW_FIELDS)
client.update_node.assert_not_called()
def test_active_node_rejects_port_connection_drift(mocker):
# switch_info differs from the request -> the port would be updated.
drifted = _actual_port(switch="some-other-switch.dfw3")
client = _mock_client(mocker, node=_node(), node_ports=[drifted])
engine = mocker.patch.object(enroll_fw.netdev_reconciler, "enroll")
with pytest.raises(RuntimeError, match="in-service firewall"):
enroll_fw.enroll_fw(**BASE_ARGS, **FW_FIELDS)
engine.assert_not_called()
client.update_node.assert_not_called()
def test_active_node_rejects_physical_network_drift(mocker):
drifted = _actual_port(physnet="some-other-network")
client = _mock_client(mocker, node=_node(), node_ports=[drifted])
mocker.patch.object(enroll_fw.netdev_reconciler, "enroll")
with pytest.raises(RuntimeError, match="in-service firewall"):
enroll_fw.enroll_fw(**BASE_ARGS, **FW_FIELDS)
client.update_node.assert_not_called()
def test_active_node_rejects_missing_port(mocker):
# Node has no port matching the requested label -> it would be created.
client = _mock_client(mocker, node=_node(), node_ports=[])
mocker.patch.object(enroll_fw.netdev_reconciler, "enroll")
with pytest.raises(RuntimeError, match="in-service firewall"):
enroll_fw.enroll_fw(**BASE_ARGS, **FW_FIELDS)
client.update_node.assert_not_called()
@pytest.mark.parametrize("driver", ["ipmi", "netdev"])
def test_active_node_rejects_different_driver(mocker, driver):
client = _mock_client(
mocker, node=_node(driver=driver), node_ports=[_actual_port()]
)
mocker.patch.object(enroll_fw.netdev_reconciler, "enroll")
with pytest.raises(RuntimeError, match="refusing to enroll it as 'panos'"):
enroll_fw.enroll_fw(**BASE_ARGS, **FW_FIELDS)
client.update_node.assert_not_called()
def test_active_legacy_node_updates_metadata_with_explicit_matching_driver(mocker):
client = _mock_client(
mocker, node=_node(driver="netdev"), node_ports=[_actual_port()]
)
engine = mocker.patch.object(enroll_fw.netdev_reconciler, "enroll")
enroll_fw.enroll_fw(**BASE_ARGS, **FW_FIELDS, driver="netdev")
engine.assert_not_called()
client.update_node.assert_called_once()
paths = _patch_paths(client.update_node.call_args)
assert paths["/driver_info/management_ip"] == "10.15.149.46"
assert "/driver" not in paths
client.set_node_provision_state.assert_not_called()
def test_active_node_rejects_resource_class_change(mocker):
client = _mock_client(
mocker, node=_node(resource_class="pa5410"), node_ports=[_actual_port()]
)
mocker.patch.object(enroll_fw.netdev_reconciler, "enroll")
with pytest.raises(RuntimeError, match="resource_class"):
enroll_fw.enroll_fw(**BASE_ARGS, **FW_FIELDS)
client.update_node.assert_not_called()
# --- argument parsing -------------------------------------------------------
@pytest.mark.parametrize(
("driver_args", "expected"), [([], "panos"), (["--driver", "netdev"], "netdev")]
)
def test_main_passes_default_or_explicit_driver(mocker, driver_args, expected):
engine = mocker.patch.object(enroll_fw, "enroll_fw")
mocker.patch.object(enroll_fw.helpers, "setup_logger")
mocker.patch(
"sys.argv",
[
"enroll-fw",
"--name",
"fw1",
"--physical-network",
"net",
"--ports",
"[]",
"--resource-class",
"pa1410",
"--management-switch",
"switch1",
"--management-switch-port",
"eth1",
*driver_args,
],
)
enroll_fw.main()
assert engine.call_args.kwargs["driver"] == expected
def test_main_emits_node_uuid_only_after_success(mocker, tmp_path):
output = tmp_path / "node-uuid"
mocker.patch.object(enroll_fw.helpers, "setup_logger")
mocker.patch(
"sys.argv",
[
"enroll-fw",
"--name",
"fw1",
"--physical-network",
"net",
"--ports",
"[]",
"--resource-class",
"pa1410",
"--management-switch",
"switch1",
"--management-switch-port",
"eth1",
"--node-uuid-output",
str(output),
],
)
engine = mocker.patch.object(enroll_fw, "enroll_fw", return_value="node-123")
enroll_fw.main()
assert output.read_text() == "node-123\n"
output.unlink()
engine.side_effect = RuntimeError("enrollment failed")
with pytest.raises(RuntimeError, match="enrollment failed"):
enroll_fw.main()
assert not output.exists()
def test_argument_parser_requires_resource_class():
parser = enroll_fw.argument_parser()
with pytest.raises(SystemExit):
parser.parse_args(
[
"--name",
"fw1",
"--physical-network",
"net",
"--ports",
"[]",
]
)
def test_argument_parser_requires_management_switch_and_port():
# Everything except the management switch/port -> argparse rejects it.
parser = enroll_fw.argument_parser()
with pytest.raises(SystemExit):
parser.parse_args(
[
"--name",
"fw1",
"--physical-network",
"net",
"--ports",
"[]",
"--resource-class",
"pa1410",
]
)
def test_active_node_with_port_roles_still_gets_metadata_updates(mocker):
# The request carries no roles here, so an "outside" port is not drift.
labelled = _actual_port()
labelled.category = "outside"
client = _mock_client(mocker, node=_node(), node_ports=[labelled])
engine = mocker.patch.object(enroll_fw.netdev_reconciler, "enroll")
enroll_fw.enroll_fw(**BASE_ARGS, **FW_FIELDS)
engine.assert_not_called()
client.update_port.assert_not_called()
client.update_node.assert_called_once() # metadata only
# --- enrollment without ports (inspection labels them) ----------------------
def _enroll_without_ports(mocker, categories):
"""Mock a new node whose inspection leaves ports with these categories."""
_mock_client(mocker, node_ports=[SimpleNamespace(category=c) for c in categories])
mocker.patch.object(
enroll_fw.netdev_reconciler,
"find_or_create_netdev_node",
return_value=(_node(provision_state="enroll"), True),
)
engine = mocker.patch.object(enroll_fw.netdev_reconciler, "enroll")
transition = mocker.patch.object(enroll_fw.ironic_node, "transition")
return engine, transition
def _steps(transition):
return [call.kwargs["target_state"] for call in transition.call_args_list]
def test_enroll_without_ports_inspects_before_providing(mocker):
engine, transition = _enroll_without_ports(mocker, ["outside", "inside", None])
node_uuid = enroll_fw.enroll_fw(**{**BASE_ARGS, "ports": []}, **FW_FIELDS)
assert node_uuid == "node-uuid"
engine.assert_not_called()
assert _steps(transition) == ["manage", "inspect", "provide"]
def test_enroll_without_ports_is_not_provided_without_both_roles(mocker):
_engine, transition = _enroll_without_ports(mocker, ["outside", None])
with pytest.raises(RuntimeError, match="an outside and an inside port"):
enroll_fw.enroll_fw(**{**BASE_ARGS, "ports": []}, **FW_FIELDS)
assert _steps(transition) == ["manage", "inspect"]
def test_active_node_without_ports_updates_metadata_only(mocker):
client = _mock_client(mocker, node=_node())
enroll_fw.enroll_fw(**{**BASE_ARGS, "ports": []}, **FW_FIELDS)
client.list_ports.assert_not_called() # nothing to compare
client.update_node.assert_called_once()
def test_ports_need_a_physical_network(mocker):
client = _mock_client(mocker)
with pytest.raises(ValueError, match="--physical-network"):
enroll_fw.enroll_fw(**{**BASE_ARGS, "physical_network": " "}, **FW_FIELDS)
client.get_node.assert_not_called()