refactor: the root reads' transports in a module of their own
driver / lint (pull_request) Successful in 13s
driver / standard (pull_request) Successful in 14s
driver / types (pull_request) Successful in 1m0s
driver / test (3.13) (pull_request) Successful in 58s
driver / test (3.12) (pull_request) Successful in 1m4s
driver / lowest (pull_request) Successful in 28s
driver / build (pull_request) Successful in 27s
driver / security (pull_request) Successful in 1m4s
CI / driver (pull_request) Successful in 2m16s
driver / publish (pull_request) Skipped

linux.py is over the file size limit and may not grow (quality ratchet).
Listening sockets and log sources share one transport -- through sudo where
the driver can, else as the login user -- so both move to _readings.py as
LinuxProcessReadingsMixin; linux.py shrinks from 2048 to 2039 lines.

Refs NetOrk/netork#2049
This commit is contained in:
Christian Manivong committed 2026-11-05 00:35:19 +01:00
1 parent 2b153cd61c
commit c532a66260
3 files changed
+41 -24

No files matched your search

+37
View File
@@ -0,0 +1,37 @@
"""Readings that need root to see every process: listening sockets and log sources.
Both commands are napalm-device-types' and read-only. Root only widens what they
see -- ``ss`` names every process behind a socket, ``/proc/<pid>/fd`` shows every
process's open files -- so both go through sudo where the driver can, and as the
login user where it cannot; the mixins then say the reading is not ``attributed``.
"""
from __future__ import annotations
from typing import TYPE_CHECKING
from napalm_device_types import ListeningSocketsMixin, LogSourcesMixin
#: Seconds either reading may take; a busy host lists thousands of descriptors.
_READ_TIMEOUT = 60
class LinuxProcessReadingsMixin(ListeningSocketsMixin, LogSourcesMixin):
"""The transports for ``get_listening_sockets`` and ``get_log_sources``."""
if TYPE_CHECKING: # pragma: no cover - the driver's own, declared for type checkers
def _send(self, command: str, read_timeout: float = 100) -> str: ...
def _run_privileged(self, command: str, timeout: float = 100) -> str: ...
def _read_as_root_if_possible(self, command: str, privileged: bool) -> str:
if privileged:
return self._run_privileged(command, _READ_TIMEOUT)
return self._send(command, read_timeout=_READ_TIMEOUT)
def _run_listening_sockets_command(self, command: str, *, privileged: bool) -> str:
return self._read_as_root_if_possible(command, privileged)
def _run_log_sources_command(self, command: str, *, privileged: bool) -> str:
return self._read_as_root_if_possible(command, privileged)
+3 -23
View File
@@ -38,9 +38,7 @@ from napalm_device_types import (
HostFirewallMixin,
HostStatusMixin,
KernelFactsMixin,
ListeningSocketsMixin,
LldpNeighborDict,
LogSourcesMixin,
OpenSshServerMixin,
OSDriver,
PosixScheduledJobsMixin,
@@ -80,6 +78,7 @@ from napalm_linux._dpkg import DPKG_QUERY_COMMAND, parse_dpkg_query
from napalm_linux._hostname import HostnameMixin
from napalm_linux._local_accounts import LinuxLocalAccountsMixin
from napalm_linux._ping import parse_ping, ping_command
from napalm_linux._readings import LinuxProcessReadingsMixin
from napalm_linux._routes import IP_ROUTE_COMMANDS, IpRoute, parse_ip_route, with_length
from napalm_linux._shell import expect_for, prepare_shell, sudo_without_password
from napalm_linux._sudo_history import LinuxSudoHistoryMixin
@@ -304,8 +303,7 @@ class LinuxDriver(
AptProxyMixin,
KernelFactsMixin,
ServicePackagesMixin,
ListeningSocketsMixin,
LogSourcesMixin,
LinuxProcessReadingsMixin,
HostFirewallMixin,
VirtualIpsMixin,
ServiceClustersMixin,
@@ -1088,27 +1086,9 @@ class LinuxDriver(
return self.run_command(f"sh -c {_shlex_quote(command)}", timeout=120).stdout
# ------------------------------------------------------------------
# ListeningSocketsMixin – the transport for get_listening_sockets
# HostFirewallMixin – the transport for get_host_firewall
# ------------------------------------------------------------------
def _run_listening_sockets_command(self, command: str, *, privileged: bool) -> str:
"""The transport for ``ListeningSocketsMixin.get_listening_sockets``.
Read-only either way; root only so that ``ss`` names every process.
"""
if privileged:
return self._run_privileged(command, 60)
return self._send(command, read_timeout=60)
def _run_log_sources_command(self, command: str, *, privileged: bool) -> str:
"""The transport for ``LogSourcesMixin.get_log_sources``.
Read-only either way; root only so that every process shows its open files.
"""
if privileged:
return self._run_privileged(command, 60)
return self._send(command, read_timeout=60)
def _run_host_firewall_command(self, command: str, *, privileged: bool) -> str:
"""The transport for ``HostFirewallMixin.get_host_firewall``: an exec channel.
+1 -1
View File
@@ -20,7 +20,7 @@
"napalm_linux.linux"
],
"python_file_lines": {
"napalm_linux/linux.py": 2048
"napalm_linux/linux.py": 2039
},
"untyped_public": []
}