fix: Plus stubs, Plus ping, Smart optional_args and message (#9, #5, #7) #18

Merged
christianmanivong merged 3 commits from fix/bugs-2026-11 into main 2026-11-01 22:00:32 +00:00
7 changed files with 93 additions and 53 deletions

No files matched your search

+17
View File
@@ -17,6 +17,23 @@ All notable changes to this driver. The format follows
napalm-device-types' `ARP_AGE_UNKNOWN`) instead of `0.0`, which means "confirmed
just now". The "Age (min)" column of `show arp` is not parsed until real switch
output confirms its format (NetOrk/netork#1327).
- A Netgear Plus switch is no longer offered as a ping-sweep source
(`supports_ping()` is `False`): its `ping` only raised, so every target of a sweep
came back as an error. `ping` still raises `NotImplementedError`, now NAPALM's own.
- The Smart driver no longer adds its connection defaults (`conn_timeout`,
`banner_timeout`, `disabled_algorithms`) to the `optional_args` dict the caller
passed in.
- An unexpected error while connecting to a Smart switch is reported in English
("Cannot connect to <host>: <reason>").
- `requirements.txt` is gone: it repeated the dependencies of `pyproject.toml` with
older floors (napalm 4.0, napalm-device-types 4.16) than the driver needs.
### Removed
- **Breaking:** the Netgear Plus driver no longer has `set_vlan`, `delete_vlan` and
`set_interface`. They only raised `NotImplementedError`; an application that tells
what a switch can do by whether the method exists offered VLAN and port editing on
Plus switches, and the action then failed. A caller that caught
`NotImplementedError` from them now finds no such attribute.
## [0.6.0] - 2026-10-23
-42
View File
@@ -511,24 +511,6 @@ class NetgearPlusDriver(FirmwareOfferMixin, SwitchDriver):
for vid, info in detail.items()
}
def set_vlan(self, vlan_id: int, config: dict) -> None:
"""Create or update a VLAN.
Not supported via HTTP API.
"""
raise NotImplementedError(
"VLAN management is not supported for Netgear Plus switches via HTTP."
)
def delete_vlan(self, vlan_id: int) -> None:
"""Delete a VLAN.
Not supported via HTTP API.
"""
raise NotImplementedError(
"VLAN management is not supported for Netgear Plus switches via HTTP."
)
def get_config(
self,
retrieve: str = "all",
@@ -566,23 +548,6 @@ class NetgearPlusDriver(FirmwareOfferMixin, SwitchDriver):
def has_pending_commit(self) -> bool:
return False
def ping(
self,
destination: str,
source: str = "",
ttl: int = 255,
timeout: int = 2,
size: int = 100,
count: int = 5,
vrf: str = "",
source_interface: str = "",
) -> dict[str, Any]:
"""Execute ping.
Not supported on Netgear Plus switches via HTTP.
"""
raise NotImplementedError("ping() is not supported for Netgear Plus switches.")
def traceroute(
self,
destination: str,
@@ -723,13 +688,6 @@ class NetgearPlusDriver(FirmwareOfferMixin, SwitchDriver):
raise ValueError(f"{interface} is not a PoE port on this switch.")
self._connector.power_cycle_poe_port(port_number)
def set_interface(self, interface: str, config: dict) -> None:
"""Configure an interface.
Not supported via HTTP API.
"""
raise NotImplementedError("set_interface() is not supported for Netgear Plus switches.")
# ── SNMP / Health ──────────────────────────────────────────────────────────
def get_snmp_config(self):
+3 -6
View File
@@ -102,8 +102,8 @@ class NetgearSmartDriver(ConfigLifecycleMixin, SnmpAgentMixin, SwitchDriver):
self.timeout = timeout
self.device: ConnectHandler | None = None
if optional_args is None:
optional_args = {}
# A copy: the defaults below must not end up in the caller's dict (#7).
optional_args = dict(optional_args or {})
self.force_no_enable = optional_args.get("force_no_enable", False)
self.port = optional_args.get("port", 22)
@@ -165,10 +165,7 @@ class NetgearSmartDriver(ConfigLifecycleMixin, SnmpAgentMixin, SwitchDriver):
except NetmikoAuthenticationException as exc:
raise ConnectionException(f"Authentication failed for {self.hostname}: {exc}") from exc
except Exception as exc:
raise ConnectionException(
f"Verbindungsaufbau fehlgeschlagen (ConnectionException): "
f"Cannot connect to {self.hostname}:\n{exc}"
) from exc
raise ConnectionException(f"Cannot connect to {self.hostname}: {exc}") from exc
def close(self) -> None:
"""Close the SSH connection."""
-4
View File
@@ -1,4 +0,0 @@
napalm>=4.0.0
napalm-device-types>=4.16.0
netmiko>=4.0.0
netaddr
+1 -1
View File
@@ -31,7 +31,7 @@
"napalm_netgear.netgear_smart"
],
"python_file_lines": {
"napalm_netgear/netgear_smart.py": 2070
"napalm_netgear/netgear_smart.py": 2067
},
"untyped_public": [
"napalm_netgear/netgear_plus.py::NetgearPlusDriver.get_snmp_config",
+29
View File
@@ -0,0 +1,29 @@
"""Netgear Plus only has the methods it can carry out.
An application reads a capability from the method being there: netOrk offers
"Add VLAN" and the port VLAN editor when ``set_vlan`` / ``set_interface`` are
callable (#9), and napalm-device-types takes a driver with a ``ping`` of its
own as a ping-sweep source (#5). A method that only raises NotImplementedError
made the HTTP-only Plus switches look able to do it.
"""
from __future__ import annotations
import pytest
from napalm_netgear.netgear_plus import NetgearPlusDriver
from napalm_netgear.netgear_smart import NetgearSmartDriver
@pytest.mark.parametrize("method", ["set_vlan", "delete_vlan", "set_interface"])
def test_plus_has_no_vlan_or_port_writes(method):
assert not callable(getattr(NetgearPlusDriver, method, None))
def test_plus_is_no_ping_sweep_source():
"""Its ping only raised, so every sweep target came back as an error (#5)."""
assert NetgearPlusDriver.supports_ping() is False
def test_smart_still_is_a_ping_sweep_source():
assert NetgearSmartDriver.supports_ping() is True
+43
View File
@@ -0,0 +1,43 @@
"""The Smart driver leaves the caller's optional_args alone and speaks English (#7)."""
from __future__ import annotations
from unittest.mock import patch
import pytest
from napalm.base.exceptions import ConnectionException
from napalm_netgear.netgear_smart import NetgearSmartDriver
def test_the_callers_optional_args_are_not_changed():
args = {"port": 2222}
driver = NetgearSmartDriver("10.0.0.8", "admin", "pw", optional_args=args)
assert args == {"port": 2222}
assert driver.netmiko_optional_args["conn_timeout"] == 20
assert driver.netmiko_optional_args["banner_timeout"] == 20
assert driver.netmiko_optional_args["disabled_algorithms"] == {
"pubkeys": ["rsa-sha2-256", "rsa-sha2-512"]
}
def test_the_callers_own_values_still_win():
args = {"conn_timeout": 5, "disabled_algorithms": {}}
driver = NetgearSmartDriver("10.0.0.8", "admin", "pw", optional_args=args)
assert driver.netmiko_optional_args["conn_timeout"] == 5
assert driver.netmiko_optional_args["disabled_algorithms"] == {}
def test_an_unexpected_connect_error_is_reported_in_english():
driver = NetgearSmartDriver("10.0.0.8", "admin", "pw")
with patch(
"napalm_netgear.netgear_smart.ConnectHandler", side_effect=OSError("no route to host")
):
with pytest.raises(ConnectionException) as exc_info:
driver.open()
assert str(exc_info.value) == "Cannot connect to 10.0.0.8: no route to host"