Files
napalm-linux/napalm_linux/_readings.py
T
Christian Manivong c532a66260
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
refactor: the root reads' transports in a module of their own
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
2026-11-05 00:35:19 +01:00

38 lines
1.6 KiB
Python

"""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)