fix(smart): copy optional_args, report in English, drop requirements
driver / standard (pull_request) Successful in 15s
driver / lint (pull_request) Successful in 12s
driver / types (pull_request) Successful in 1m0s
driver / test (3.12) (pull_request) Successful in 54s
driver / test (3.13) (pull_request) Successful in 51s
driver / lowest (pull_request) Successful in 27s
driver / build (pull_request) Successful in 25s
driver / security (pull_request) Successful in 1m2s
CI / driver (pull_request) Successful in 2m23s
driver / publish (pull_request) Skipped
driver / standard (pull_request) Successful in 15s
driver / lint (pull_request) Successful in 12s
driver / types (pull_request) Successful in 1m0s
driver / test (3.12) (pull_request) Successful in 54s
driver / test (3.13) (pull_request) Successful in 51s
driver / lowest (pull_request) Successful in 27s
driver / build (pull_request) Successful in 25s
driver / security (pull_request) Successful in 1m2s
CI / driver (pull_request) Successful in 2m23s
driver / publish (pull_request) Skipped
The Smart driver's constructor wrote its connection defaults into the optional_args dict the caller passed in, and an unexpected connect error started with a German phrase. requirements.txt repeated pyproject's dependencies with floors older than the driver needs. The issue's other points were already fixed on main: pyproject declares napalm-device-types since34554eaand points its URLs at git.netork.io since10a3b1e. Closes #7
This commit is contained in:
1 parent
3e333d6bfd
commit
09092be5db
5 files changed
+54
-11
No files matched your search
@@ -20,6 +20,13 @@ All notable changes to this driver. The format follows
|
||||
- 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
|
||||
|
||||
@@ -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."""
|
||||
|
||||
@@ -1,4 +0,0 @@
|
||||
napalm>=4.0.0
|
||||
napalm-device-types>=4.16.0
|
||||
netmiko>=4.0.0
|
||||
netaddr
|
||||
@@ -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",
|
||||
|
||||
@@ -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"
|
||||
Reference in new issue
Block a user