fix: DNS detection and Kea search raise on a failed read, hermetic open() test (#39, #40, #41) #42

Merged
christianmanivong merged 4 commits from fix/bugs-2026-11-02 into main 2026-11-02 08:20:46 +00:00
6 changed files with 159 additions and 44 deletions

No files matched your search

+13
View File
@@ -38,6 +38,19 @@ All notable changes to this driver. The format follows
public key (`wireguard-wg0-aBcD1234`, URL-safe) instead of its position, so a peer public key (`wireguard-wg0-aBcD1234`, URL-safe) instead of its position, so a peer
added ahead of another no longer renumbers it (#32). Every WireGuard key changes added ahead of another no longer renumbers it (#32). Every WireGuard key changes
once with this release. once with this release.
- `get_dns_entries()` raises when the service list (`/api/core/service/search`)
cannot be read, instead of returning an empty list as if neither Unbound nor
Dnsmasq ran: a transient API error made the firewall look as if it had no DNS
records. `sync_dns_zone()` raises that API error instead of "No active DNS
service (Unbound or Dnsmasq) detected" (#39).
- `create_dhcp_reservation()` raises `RuntimeError` naming `searchReservation` when
the search for an existing reservation fails, and writes nothing. It used to add
the reservation anyway: a retry then failed with "Kea rejected DHCP reservation"
instead of the real error, or left two reservations for one address, which Kea
refuses to load (#40).
- The unit tests no longer reach the network: the test of a failed `open()` looked
up a real host name and waited for the resolver, so it hung or behaved differently
on a build host with a slow resolver or one that answers every name (#41).
## [0.5.0] - 2026-10-23 ## [0.5.0] - 2026-10-23
+16
View File
@@ -7,6 +7,7 @@ edited by hand (#26), so every lookup here checks both.
from __future__ import annotations from __future__ import annotations
from ipaddress import ip_address, ip_network
from typing import Any from typing import Any
from napalm_device_types.dhcp import normalize_mac from napalm_device_types.dhcp import normalize_mac
@@ -19,6 +20,21 @@ def _mac_of(row: dict[str, Any], *fields: str) -> str:
return normalize_mac(next((str(row[f]) for f in fields if row.get(f)), "")) return normalize_mac(next((str(row[f]) for f in fields if row.get(f)), ""))
def subnet_containing(rows: list[dict[str, Any]], ip: str) -> dict[str, Any] | None:
"""The first ``searchSubnet`` row whose subnet holds *ip*; None when none does.
A row without a readable ``subnet`` is skipped.
"""
address = ip_address(ip)
for row in rows:
try:
if address in ip_network(str(row["subnet"]).strip(), strict=False):
return row
except (ValueError, KeyError):
continue
return None
def split_by_mac(rows: list[dict[str, Any]], mac: str) -> tuple[dict[str, Any] | None, str]: def split_by_mac(rows: list[dict[str, Any]], mac: str) -> tuple[dict[str, Any] | None, str]:
"""``(the row *mac* holds, the MAC of a row another host holds)`` among *rows*. """``(the row *mac* holds, the MAC of a row another host holds)`` among *rows*.
+32 -38
View File
@@ -41,7 +41,6 @@ import logging
import re import re
import socket import socket
import time import time
from ipaddress import ip_address, ip_network
from typing import Any from typing import Any
import requests import requests
@@ -64,7 +63,12 @@ from requests.exceptions import RequestException
from napalm_opnsense.api_endpoint import ALIVE_TIMEOUT, api_endpoint from napalm_opnsense.api_endpoint import ALIVE_TIMEOUT, api_endpoint
from napalm_opnsense.ha import config_sync, dhcp_ha from napalm_opnsense.ha import config_sync, dhcp_ha
from napalm_opnsense.kea_reservations import lease_held, reservation_unchanged, split_by_mac from napalm_opnsense.kea_reservations import (
lease_held,
reservation_unchanged,
split_by_mac,
subnet_containing,
)
from napalm_opnsense.listening import parse_socket_statistics, wireguard_listen_ports from napalm_opnsense.listening import parse_socket_statistics, wireguard_listen_ports
from napalm_opnsense.ospf_mixin import OPNsenseOspfMixin from napalm_opnsense.ospf_mixin import OPNsenseOspfMixin
from napalm_opnsense.ping_mixin import OPNsensePingMixin from napalm_opnsense.ping_mixin import OPNsensePingMixin
@@ -1453,7 +1457,8 @@ class OPNsenseDriver(
:param hostname: optional hostname to record on the reservation. :param hostname: optional hostname to record on the reservation.
:raises ValueError: if no Kea subnet contains ``ip``. :raises ValueError: if no Kea subnet contains ``ip``.
:raises RuntimeError: if Kea rejects the reservation (validation :raises RuntimeError: if Kea rejects the reservation (validation
errors), the Kea plugin isn't installed/enabled, or ``ip`` is errors), the Kea plugin isn't installed/enabled, the search for an
existing reservation fails (nothing is written then), or ``ip`` is
already reserved for another MAC (left untouched; the caller decides). already reserved for another MAC (left untouched; the caller decides).
""" """
try: try:
@@ -1461,19 +1466,10 @@ class OPNsenseDriver(
except Exception as exc: except Exception as exc:
raise RuntimeError(f"Kea DHCPv4 plugin unavailable: {exc}") from exc raise RuntimeError(f"Kea DHCPv4 plugin unavailable: {exc}") from exc
ip_obj = ip_address(ip) subnet_row = subnet_containing(subnets, ip)
subnet_uuid = None if subnet_row is None:
subnet_cidr = ""
for row in subnets:
try:
if ip_obj in ip_network(row["subnet"], strict=False):
subnet_uuid = row["uuid"]
subnet_cidr = str(row["subnet"]).strip()
break
except ValueError:
continue
if subnet_uuid is None:
raise ValueError(f"No Kea-managed subnet contains {ip}") raise ValueError(f"No Kea-managed subnet contains {ip}")
subnet_uuid, subnet_cidr = subnet_row["uuid"], str(subnet_row["subnet"]).strip()
existing_row = self._kea_own_reservation(ip, mac) existing_row = self._kea_own_reservation(ip, mac)
@@ -1514,12 +1510,12 @@ class OPNsenseDriver(
def _kea_own_reservation(self, ip: str, mac: str) -> dict[str, Any] | None: def _kea_own_reservation(self, ip: str, mac: str) -> dict[str, Any] | None:
"""*mac*'s reservation for *ip*, updated in place on a retry; raises if another """*mac*'s reservation for *ip*, updated in place on a retry; raises if another
MAC holds *ip* (#26).""" MAC holds *ip* (#26) or the search fails (#40)."""
try: try:
own, other = split_by_mac(self._kea_reservations_at(ip), mac) rows = self._kea_reservations_at(ip)
except Exception as exc: except RequestException as exc:
logger.debug("Kea reservation search failed, proceeding to add: %s", exc) raise RuntimeError(f"Kea searchReservation for {ip} failed: {exc}") from exc
return None own, other = split_by_mac(rows, mac)
if own is None and other: if own is None and other:
raise RuntimeError(f"Kea already reserves {ip} for {other}, not {normalize_mac(mac)}") raise RuntimeError(f"Kea already reserves {ip} for {other}, not {normalize_mac(mac)}")
return own return own
@@ -1631,14 +1627,10 @@ class OPNsenseDriver(
return str(row["uuid"]) return str(row["uuid"])
raise ValueError(f"No Kea-managed subnet matches {subnet}") raise ValueError(f"No Kea-managed subnet matches {subnet}")
ip_obj = ip_address(ip) row = subnet_containing(rows, ip)
for row in rows: if row is None:
try: raise ValueError(f"No Kea-managed subnet contains {ip}")
if ip_obj in ip_network(row["subnet"], strict=False): return str(row["uuid"])
return str(row["uuid"])
except (ValueError, KeyError):
continue
raise ValueError(f"No Kea-managed subnet contains {ip}")
def get_dhcp_reservations(self) -> list[dict[str, Any]]: def get_dhcp_reservations(self) -> list[dict[str, Any]]:
"""Return all Kea DHCPv4 static reservations, vendor-neutral. """Return all Kea DHCPv4 static reservations, vendor-neutral.
@@ -2794,15 +2786,16 @@ class OPNsenseDriver(
# ------------------------------------------------------------------ # ------------------------------------------------------------------
def _detect_active_dns(self) -> str | None: def _detect_active_dns(self) -> str | None:
"""Return 'unbound' or 'dnsmasq' depending on which service is running.""" """Return 'unbound' or 'dnsmasq' depending on which service is running.
try:
data = self._get("/api/core/service/search") None only when the service list was read and neither runs; a failed
for row in data.get("rows", []): read raises, so it cannot pass for "no DNS service".
name = (row.get("name") or "").lower() """
if name in ("unbound", "dnsmasq") and row.get("running"): data = self._get("/api/core/service/search")
return name for row in data.get("rows", []):
except Exception as exc: name = (row.get("name") or "").lower()
logger.warning("DNS service detection failed: %s", exc) if name in ("unbound", "dnsmasq") and row.get("running"):
return name
return None return None
def get_dns_entries(self) -> list[dict[str, Any]]: def get_dns_entries(self) -> list[dict[str, Any]]:
@@ -2810,7 +2803,8 @@ class OPNsenseDriver(
Checks whether Unbound (DNS Resolver) or Dnsmasq (DNS Forwarder) is Checks whether Unbound (DNS Resolver) or Dnsmasq (DNS Forwarder) is
running and returns host overrides from whichever is active. If neither running and returns host overrides from whichever is active. If neither
is running, returns an empty list. A failed read of the overrides raises. is running, returns an empty list. A failed read of the service list
or of the overrides raises.
Each entry:: Each entry::
+2 -3
View File
@@ -10,7 +10,6 @@
"napalm_opnsense/opnsense.py::OPNsenseDriver._kea_read_list": 11, "napalm_opnsense/opnsense.py::OPNsenseDriver._kea_read_list": 11,
"napalm_opnsense/opnsense.py::OPNsenseDriver.apply_dhcp_subnet": 21, "napalm_opnsense/opnsense.py::OPNsenseDriver.apply_dhcp_subnet": 21,
"napalm_opnsense/opnsense.py::OPNsenseDriver.apply_firewall_rule": 11, "napalm_opnsense/opnsense.py::OPNsenseDriver.apply_firewall_rule": 11,
"napalm_opnsense/opnsense.py::OPNsenseDriver.create_dhcp_reservation": 12,
"napalm_opnsense/opnsense.py::OPNsenseDriver.delete_dhcp_reservation_and_lease": 11, "napalm_opnsense/opnsense.py::OPNsenseDriver.delete_dhcp_reservation_and_lease": 11,
"napalm_opnsense/opnsense.py::OPNsenseDriver.get_bgp_neighbors": 16, "napalm_opnsense/opnsense.py::OPNsenseDriver.get_bgp_neighbors": 16,
"napalm_opnsense/opnsense.py::OPNsenseDriver.get_dhcp_leases": 15, "napalm_opnsense/opnsense.py::OPNsenseDriver.get_dhcp_leases": 15,
@@ -33,7 +32,7 @@
"function_lines": { "function_lines": {
"napalm_opnsense/opnsense.py::OPNsenseDriver._regenerate_web_cert": 51, "napalm_opnsense/opnsense.py::OPNsenseDriver._regenerate_web_cert": 51,
"napalm_opnsense/opnsense.py::OPNsenseDriver.apply_dhcp_subnet": 60, "napalm_opnsense/opnsense.py::OPNsenseDriver.apply_dhcp_subnet": 60,
"napalm_opnsense/opnsense.py::OPNsenseDriver.create_dhcp_reservation": 72, "napalm_opnsense/opnsense.py::OPNsenseDriver.create_dhcp_reservation": 64,
"napalm_opnsense/opnsense.py::OPNsenseDriver.delete_dhcp_reservation_and_lease": 79, "napalm_opnsense/opnsense.py::OPNsenseDriver.delete_dhcp_reservation_and_lease": 79,
"napalm_opnsense/opnsense.py::OPNsenseDriver.get_bgp_neighbors": 86, "napalm_opnsense/opnsense.py::OPNsenseDriver.get_bgp_neighbors": 86,
"napalm_opnsense/opnsense.py::OPNsenseDriver.get_dhcp_leases": 106, "napalm_opnsense/opnsense.py::OPNsenseDriver.get_dhcp_leases": 106,
@@ -56,7 +55,7 @@
"napalm_opnsense.resolver_mixin" "napalm_opnsense.resolver_mixin"
], ],
"python_file_lines": { "python_file_lines": {
"napalm_opnsense/opnsense.py": 3064 "napalm_opnsense/opnsense.py": 3058
}, },
"untyped_public": [ "untyped_public": [
"napalm_opnsense/opnsense.py::OPNsenseDriver.get_snmp_config" "napalm_opnsense/opnsense.py::OPNsenseDriver.get_snmp_config"
+72 -2
View File
@@ -132,8 +132,14 @@ class TestOpenClose:
password="s", password="s",
optional_args={"verify": False}, optional_args={"verify": False},
) )
with pytest.raises(ConnectionException): refused = requests.exceptions.ConnectionError("Connection refused")
drv.open() with patch.object(requests.Session, "get", side_effect=refused) as get:
with pytest.raises(ConnectionException, match="Connection refused"):
drv.open()
get.assert_called_once()
assert get.call_args.args[0] == "https://unreachable.invalid/api/core/system/status"
assert drv.session is None
def test_close_clears_session(self, driver): def test_close_clears_session(self, driver):
driver.close() driver.close()
@@ -2030,6 +2036,33 @@ class TestCreateDhcpReservation:
driver.session.post.assert_not_called() driver.session.post.assert_not_called()
# The search is what makes a retry update its reservation instead of adding a
# second one for the address: a write must not follow a search that failed (#40).
@pytest.mark.parametrize(
"error",
[
requests.exceptions.HTTPError("500 Server Error"),
requests.exceptions.ConnectionError("reset by peer"),
],
ids=["http-error", "connection-error"],
)
def test_failed_reservation_search_raises_before_any_write(self, driver, error):
driver.session.get.return_value = _make_json_response(KEA_SUBNETS_RESPONSE)
driver.session.post.side_effect = [
error, # searchReservation
_make_json_response({"result": "saved", "uuid": "new-uuid-123"}),
_make_json_response({"status": "ok"}),
]
with pytest.raises(RuntimeError, match="searchReservation") as raised:
driver.create_dhcp_reservation(mac="02:aa:bb:cc:dd:ee", ip="172.22.8.253")
assert raised.value.__cause__ is error
assert [c.args[0] for c in driver.session.post.call_args_list] == [
"https://opnsense.example.com/api/kea/dhcpv4/searchReservation"
]
# --------------------------------------------------------------------------- # ---------------------------------------------------------------------------
# delete_dhcp_reservation_and_lease() # delete_dhcp_reservation_and_lease()
@@ -3005,6 +3038,43 @@ class TestHostOverrideReadFailure:
driver.get_dns_entries() driver.get_dns_entries()
class TestDnsServiceDetection:
"""A failed service search raises: None would say neither Unbound nor Dnsmasq runs (#39)."""
def test_get_dns_entries_raises_when_the_service_search_fails(self, driver):
driver.session.get.side_effect = requests.exceptions.ConnectionError("reset by peer")
with pytest.raises(requests.exceptions.ConnectionError):
driver.get_dns_entries()
driver.session.post.assert_not_called()
def test_sync_dns_zone_reports_the_api_error_and_writes_nothing(self, driver):
driver.session.get.side_effect = requests.exceptions.HTTPError("502 Bad Gateway")
with pytest.raises(requests.exceptions.HTTPError, match="502"):
driver.sync_dns_zone(
"office.local",
[{"hostname": "nas", "ip": "172.22.40.8", "record_type": "A", "enabled": True}],
)
driver.session.post.assert_not_called()
def test_get_dns_entries_is_empty_when_neither_service_runs(self, driver):
driver.session.get.return_value = _make_json_response(
{
"rows": [
{"name": "unbound", "running": 0},
{"name": "dnsmasq", "running": 0},
{"name": "sshd", "running": 1},
]
}
)
assert driver.get_dns_entries() == []
driver.session.post.assert_not_called()
# --------------------------------------------------------------------------- # ---------------------------------------------------------------------------
# uninstall_package – says what it cannot do # uninstall_package – says what it cannot do
# --------------------------------------------------------------------------- # ---------------------------------------------------------------------------
+24 -1
View File
@@ -1,6 +1,11 @@
"""Matching Kea reservations and leases on address and MAC (#26).""" """Matching Kea reservations and leases on address and MAC (#26)."""
from napalm_opnsense.kea_reservations import lease_held, reservation_unchanged, split_by_mac from napalm_opnsense.kea_reservations import (
lease_held,
reservation_unchanged,
split_by_mac,
subnet_containing,
)
def _row(mac, uuid="u-1"): def _row(mac, uuid="u-1"):
@@ -65,3 +70,21 @@ class TestReservationUnchanged:
def test_the_same_reservation_is_unchanged(self): def test_the_same_reservation_is_unchanged(self):
row = dict(self.WANTED, hw_address="02-AA-BB-CC-DD-EE", subnet="172.22.8.0/24") row = dict(self.WANTED, hw_address="02-AA-BB-CC-DD-EE", subnet="172.22.8.0/24")
assert reservation_unchanged(row, self.WANTED, "172.22.8.0/24") is True assert reservation_unchanged(row, self.WANTED, "172.22.8.0/24") is True
class TestSubnetContaining:
ROWS = [
{"uuid": "s-broken", "subnet": "not-a-cidr"},
{"uuid": "s-nocidr"},
{"uuid": "s-8", "subnet": " 172.22.8.0/24 "},
{"uuid": "s-wide", "subnet": "172.22.0.0/16"},
]
def test_first_subnet_holding_the_address_wins(self):
assert subnet_containing(self.ROWS, "172.22.8.253") == self.ROWS[2]
def test_rows_without_a_readable_subnet_are_skipped(self):
assert subnet_containing(self.ROWS, "172.22.9.1") == self.ROWS[3]
def test_none_when_no_subnet_holds_the_address(self):
assert subnet_containing(self.ROWS, "10.99.99.99") is None