testprotocols 0.1.0__py3-none-any.whl

testprotocols/__init__.py

@@ -0,0 +1,217 @@
+"""testprotocols — capability and device Protocols for telco resources under test."""
+
+__version__ = "0.1.0"
+
+from testprotocols.aftr_gateway import AftrGateway
+from testprotocols.appliance_nat import ApplianceNat
+from testprotocols.appliance_uplinks import ApplianceUplinks
+from testprotocols.appliance_vlans import ApplianceVlans
+from testprotocols.arp_client import ArpClient
+from testprotocols.bgp import Bgp
+from testprotocols.conntrack import Conntrack, ConntrackWhiteBox
+from testprotocols.content_filtering import ContentFiltering
+from testprotocols.device_lifecycle import DeviceLifecycle
+from testprotocols.device_management import DeviceManagement
+from testprotocols.devices.base import BaseDeviceProtocol
+from testprotocols.devices.client import (
+    LanClientDevice,
+    QoeClientDevice,
+    WlanClientDevice,
+)
+from testprotocols.devices.cpe import CpeDevice
+from testprotocols.devices.infra import (
+    AcsDevice,
+    ProvisionerDevice,
+    TftpDevice,
+)
+from testprotocols.devices.sdwan import SdwanApplianceDevice, SdwanRouterDevice
+from testprotocols.devices.switch import L2Switch, L3Switch, L3SwitchRouted
+from testprotocols.devices.traffic import (
+    IperfTrafficGeneratorDevice,
+    TrafficControllerDevice,
+)
+from testprotocols.devices.voice import (
+    SipPhoneDevice,
+    SipServerDevice,
+)
+from testprotocols.devices.wan import WanServerDevice
+from testprotocols.dhcp_client import DhcpClient
+from testprotocols.dhcp_server import DhcpServer
+from testprotocols.discovery import Discovery
+from testprotocols.dns_client import DnsClient
+from testprotocols.file_transfer import FileTransfer
+from testprotocols.firewall import Firewall, FirewallWhiteBox
+from testprotocols.firewall_zones import FirewallZones
+from testprotocols.first_hop_security import FirstHopSecurity
+from testprotocols.gateway_redundancy import GatewayRedundancy
+from testprotocols.http_client import HttpClient
+from testprotocols.http_server import HttpServer
+from testprotocols.hw_console import HwConsole
+from testprotocols.infra_controller import InfraController
+from testprotocols.interface_dhcp import InterfaceDhcp
+from testprotocols.ip_interface import IpInterface
+from testprotocols.ip_routing import IpRouting
+from testprotocols.iperf_client import IperfClient
+from testprotocols.iperf_generator import IperfGenerator
+from testprotocols.iperf_server import IperfServer
+from testprotocols.l3_firewall import L3Firewall
+from testprotocols.l7_firewall import L7Firewall
+from testprotocols.link_aggregation import LinkAggregation
+from testprotocols.mac_table import MacTable
+from testprotocols.multicast_client import MulticastClient
+from testprotocols.nat import Nat
+from testprotocols.netem_controller import NetemController
+from testprotocols.nmap_scanner import NmapScanner
+from testprotocols.ntp_client import NtpClient
+from testprotocols.ntp_config import NtpConfig
+from testprotocols.ospf import Ospf
+from testprotocols.packet_filter import PacketFilter, PacketFilterWhiteBox
+from testprotocols.pcap_capture import PcapCapture
+from testprotocols.pdu_controller import PduController
+from testprotocols.port_poe import PortPoe
+from testprotocols.port_security import PortSecurity
+from testprotocols.port_status import PortStatus
+from testprotocols.qoe_browser import QoeBrowser
+from testprotocols.radius_client import RadiusClient
+from testprotocols.radius_server import RadiusServer
+from testprotocols.routed_interfaces import RoutedInterfaces
+from testprotocols.router import Router
+from testprotocols.routing_read import RoutingRead
+from testprotocols.sdwan_policy_manager import SdwanPolicyManager
+from testprotocols.sip_phone import SipPhone
+from testprotocols.sip_server import SipServer
+from testprotocols.site_to_site_vpn import SiteToSiteVpn
+from testprotocols.snmp_client import SnmpClient
+from testprotocols.spanning_tree import SpanningTree
+from testprotocols.static_routes import StaticRoutes
+from testprotocols.storm_control import StormControl
+from testprotocols.streaming_server import StreamingServer
+from testprotocols.switch_acl import SwitchAcl
+from testprotocols.switch_ports import SwitchPorts
+from testprotocols.switch_qos import SwitchQos
+from testprotocols.switch_vlans import SwitchVlans
+from testprotocols.syslog_config import SyslogConfig
+from testprotocols.tftp_server import TftpServer
+from testprotocols.threat_prevention import ThreatPrevention
+from testprotocols.tr069_client import Tr069Client
+from testprotocols.tr069_server import Tr069Server
+from testprotocols.traffic_shaping import TrafficShaping
+from testprotocols.upnp_client import UpnpClient
+from testprotocols.vlan_client import VlanClient
+from testprotocols.wan_link_admin import WanLinkAdmin
+from testprotocols.wifi_bss import WifiBss
+from testprotocols.wifi_client import WifiClient
+from testprotocols.wifi_mesh import WifiMesh, WifiMeshWhiteBox
+from testprotocols.wifi_onboarding import WifiOnboarding
+from testprotocols.wifi_radio import WifiRadio, WifiRadioWhiteBox
+from testprotocols.wifi_rf import WifiRf
+from testprotocols.wifi_stations import WifiStations
+from testprotocols.wifi_transitions import WifiTransitions
+
+__all__ = [
+    "AcsDevice",
+    "AftrGateway",
+    "ApplianceNat",
+    "ApplianceUplinks",
+    "ApplianceVlans",
+    "ArpClient",
+    "BaseDeviceProtocol",
+    "Bgp",
+    "Conntrack",
+    "ConntrackWhiteBox",
+    "ContentFiltering",
+    "CpeDevice",
+    "DeviceLifecycle",
+    "DeviceManagement",
+    "DhcpClient",
+    "DhcpServer",
+    "Discovery",
+    "DnsClient",
+    "FileTransfer",
+    "Firewall",
+    "FirewallWhiteBox",
+    "FirewallZones",
+    "FirstHopSecurity",
+    "GatewayRedundancy",
+    "HttpClient",
+    "HttpServer",
+    "HwConsole",
+    "InfraController",
+    "InterfaceDhcp",
+    "IpInterface",
+    "IpRouting",
+    "IperfClient",
+    "IperfGenerator",
+    "IperfServer",
+    "IperfTrafficGeneratorDevice",
+    "L2Switch",
+    "L3Firewall",
+    "L3Switch",
+    "L3SwitchRouted",
+    "L7Firewall",
+    "LanClientDevice",
+    "LinkAggregation",
+    "MacTable",
+    "MulticastClient",
+    "Nat",
+    "NetemController",
+    "NmapScanner",
+    "NtpClient",
+    "NtpConfig",
+    "Ospf",
+    "PacketFilter",
+    "PacketFilterWhiteBox",
+    "PcapCapture",
+    "PduController",
+    "PortPoe",
+    "PortSecurity",
+    "PortStatus",
+    "ProvisionerDevice",
+    "QoeBrowser",
+    "QoeClientDevice",
+    "RadiusClient",
+    "RadiusServer",
+    "RoutedInterfaces",
+    "Router",
+    "RoutingRead",
+    "SdwanApplianceDevice",
+    "SdwanPolicyManager",
+    "SdwanRouterDevice",
+    "SipPhone",
+    "SipPhoneDevice",
+    "SipServer",
+    "SipServerDevice",
+    "SiteToSiteVpn",
+    "SnmpClient",
+    "SpanningTree",
+    "StaticRoutes",
+    "StormControl",
+    "StreamingServer",
+    "SwitchAcl",
+    "SwitchPorts",
+    "SwitchQos",
+    "SwitchVlans",
+    "SyslogConfig",
+    "TftpDevice",
+    "TftpServer",
+    "ThreatPrevention",
+    "Tr069Client",
+    "Tr069Server",
+    "TrafficControllerDevice",
+    "TrafficShaping",
+    "UpnpClient",
+    "VlanClient",
+    "WanLinkAdmin",
+    "WanServerDevice",
+    "WifiBss",
+    "WifiClient",
+    "WifiMesh",
+    "WifiMeshWhiteBox",
+    "WifiOnboarding",
+    "WifiRadio",
+    "WifiRadioWhiteBox",
+    "WifiRf",
+    "WifiStations",
+    "WifiTransitions",
+    "WlanClientDevice",
+]

testprotocols/aftr_gateway.py

@@ -0,0 +1,22 @@
+"""AFTR / Gateway template.
+
+Defines the abstract contract for Address Family Transition Router (AFTR)
+gateway operations used in DS-Lite deployments.
+"""
+
+from __future__ import annotations
+
+from typing import Protocol, runtime_checkable
+
+
+@runtime_checkable
+class AftrGateway(Protocol):
+    """Abstract contract for AFTR gateway operations."""
+
+    def configure_aftr(self) -> None:
+        """Apply the AFTR configuration on the gateway."""
+        ...
+
+    def restart_aftr_process(self) -> None:
+        """Restart the AFTR process on the gateway."""
+        ...

testprotocols/appliance_nat.py

@@ -0,0 +1,52 @@
+"""NAT template — managed SD-WAN appliance edition.
+
+Defines the abstract contract for an appliance's NAT surfaces: 1:1 NAT, 1:Many
+(PAT), and port-forwarding (DNAT). Each is an ordered list read and replaced as
+a whole — the appliance-native shape, distinct from the host-tier ``nat.Nat``
+(iptables SNAT/DNAT primitives, add/remove by name) used by the Linux digital
+twin.
+
+In scope: read/replace the 1:1, 1:Many, and port-forwarding rule lists.
+
+Out of scope: low-level iptables NAT primitives (see ``nat``), firewall rules
+(see ``l3_firewall`` / ``l7_firewall``).
+"""
+
+from __future__ import annotations
+
+from typing import Protocol, runtime_checkable
+
+from testprotocols.models.sdwan_appliance import (
+    OneToManyNatRule,
+    OneToOneNatRule,
+    PortForwardRule,
+)
+
+
+@runtime_checkable
+class ApplianceNat(Protocol):
+    """Abstract contract for an appliance's NAT rule sets."""
+
+    def set_one_to_one_rules(self, rules: list[OneToOneNatRule]) -> None:
+        """Replace the 1:1 NAT mapping list with *rules*."""
+        ...
+
+    def get_one_to_one_rules(self) -> list[OneToOneNatRule]:
+        """Return the 1:1 NAT mappings."""
+        ...
+
+    def set_one_to_many_rules(self, rules: list[OneToManyNatRule]) -> None:
+        """Replace the 1:Many (PAT) mapping list with *rules*."""
+        ...
+
+    def get_one_to_many_rules(self) -> list[OneToManyNatRule]:
+        """Return the 1:Many (PAT) mappings."""
+        ...
+
+    def set_port_forwarding_rules(self, rules: list[PortForwardRule]) -> None:
+        """Replace the port-forwarding rule list with *rules*."""
+        ...
+
+    def get_port_forwarding_rules(self) -> list[PortForwardRule]:
+        """Return the port-forwarding rules."""
+        ...

testprotocols/appliance_uplinks.py

@@ -0,0 +1,32 @@
+"""WAN uplink template — managed SD-WAN appliance.
+
+Defines the abstract contract for observing an appliance's WAN uplinks: their
+operational state and addressing. Read-only — uplink *configuration* (static vs
+DHCP, PPPoE, etc.) is a separate concern not yet modelled (add on evidence).
+
+This replaces, for a managed appliance, the Linux-host ``ip_interface`` surface
+(per-interface ``ip addr``/``link``/``mtu``/``mac``) which a cloud-managed
+appliance does not expose.
+"""
+
+from __future__ import annotations
+
+from typing import Protocol, runtime_checkable
+
+from testprotocols.models.sdwan_appliance import UplinkStatus
+
+
+@runtime_checkable
+class ApplianceUplinks(Protocol):
+    """Abstract contract for observing an appliance's WAN uplinks."""
+
+    def get_uplinks(self) -> list[UplinkStatus]:
+        """Return the status of every WAN uplink."""
+        ...
+
+    def get_uplink(self, name: str) -> UplinkStatus:
+        """Return the status of the named uplink (e.g. ``"wan1"``).
+
+        Raises KeyError if no uplink with that name exists.
+        """
+        ...

testprotocols/appliance_vlans.py

@@ -0,0 +1,50 @@
+"""LAN VLAN + DHCP template — managed SD-WAN appliance.
+
+Defines the abstract contract for a managed appliance's LAN side: per-VLAN
+subnet/addressing and DHCP configuration, plus observed DHCP leases. This is the
+appliance counterpart to a Linux host's interface + DHCP-server surfaces — an
+appliance configures DHCP per VLAN, not via a host daemon.
+
+In scope: list/get/set VLAN configuration (incl. per-VLAN DHCP), and read DHCP
+leases.
+
+Out of scope: WAN uplink status (see ``appliance_uplinks``), L3 firewall
+(see ``l3_firewall``), and host-style per-interface config (see ``ip_interface``).
+"""
+
+from __future__ import annotations
+
+from typing import Protocol, runtime_checkable
+
+from testprotocols.models.sdwan_appliance import DhcpLease, VlanConfig
+
+
+@runtime_checkable
+class ApplianceVlans(Protocol):
+    """Abstract contract for an appliance's LAN VLANs and DHCP."""
+
+    def list_vlans(self) -> list[VlanConfig]:
+        """Return every configured LAN VLAN."""
+        ...
+
+    def get_vlan(self, vlan_id: int) -> VlanConfig:
+        """Return the VLAN with *vlan_id*.
+
+        Raises KeyError if no VLAN with that id exists.
+        """
+        ...
+
+    def set_vlan(self, config: VlanConfig) -> None:
+        """Create or replace the VLAN identified by ``config.vlan_id``."""
+        ...
+
+    def get_dhcp_leases(self, vlan_id: int | None = None) -> list[DhcpLease]:
+        """Return current DHCP leases, optionally filtered to one *vlan_id*.
+
+        Best-effort read: several management planes publish no true lease
+        table, so a driver may approximate from observed-client visibility
+        (no expiry / binding state) or raise unsupported-capability. Tests
+        should treat the result as observational evidence, not an exact
+        lease-table assertion.
+        """
+        ...

testprotocols/arp_client.py

@@ -0,0 +1,26 @@
+"""ARP / Client template.
+
+Defines the abstract contract for ARP client operations including cache
+management and table inspection.
+"""
+
+from __future__ import annotations
+
+from typing import Protocol, runtime_checkable
+
+
+@runtime_checkable
+class ArpClient(Protocol):
+    """Abstract contract for ARP client operations."""
+
+    def flush_arp_cache(self) -> None:
+        """Flush all entries from the ARP cache."""
+        ...
+
+    def get_arp_table(self) -> str:
+        """Return the current ARP table as a string."""
+        ...
+
+    def delete_arp_table_entry(self, ip: str, intf: str) -> None:
+        """Delete the ARP table entry for *ip* on interface *intf*."""
+        ...

testprotocols/bgp.py

@@ -0,0 +1,55 @@
+"""BGP template — WAN edge (twin and managed appliance).
+
+Defines the abstract contract for a WAN edge's BGP: whole-replace
+configuration (local AS + neighbors + advertised networks) plus operational
+reads of neighbor session state and learned prefixes.
+
+The config/read split is deliberate and per-method: configuration write and
+read-back are universal across the reviewed management planes, while the
+two *operational* reads are not — a product without a published BGP state
+read raises unsupported-capability on those methods rather than
+approximating.
+
+In scope: BGP process configuration (whole-replace, idempotent), neighbor
+session status, learned-prefix read.
+
+Out of scope: RIB reads (see ``router``), static routes (see
+``static_routes``), route maps / filters / per-neighbor policy (grow on
+evidence), and other dynamic routing protocols (no driving test).
+"""
+
+from __future__ import annotations
+
+from typing import Protocol, runtime_checkable
+
+from testprotocols.models.sdwan_appliance import BgpConfig, BgpPeerStatus
+from testprotocols.models.wan_edge import RouteEntry
+
+
+@runtime_checkable
+class Bgp(Protocol):
+    """Abstract contract for a WAN edge's BGP configuration and state."""
+
+    def set_bgp_config(self, config: BgpConfig) -> None:
+        """Replace the BGP configuration with *config* (idempotent)."""
+        ...
+
+    def get_bgp_config(self) -> BgpConfig:
+        """Return the current BGP configuration (config read-back)."""
+        ...
+
+    def get_bgp_neighbors(self) -> list[BgpPeerStatus]:
+        """Return the operational status of every configured neighbor.
+
+        Operational read — products without a published BGP state read
+        raise unsupported-capability rather than approximating.
+        """
+        ...
+
+    def get_learned_routes(self) -> list[RouteEntry]:
+        """Return BGP-learned prefixes (operational read; same convention).
+
+        ``gateway`` carries the peer next-hop; ``interface`` may be empty
+        when not reported.
+        """
+        ...

testprotocols/conntrack.py

@@ -0,0 +1,147 @@
+"""Firewall / Conntrack template.
+
+Defines the abstract contract for inspecting and administering
+connection-tracking state on a stateful device. Read-mostly; the only
+write operations are explicit flushes (test-scenario reset), per-flow
+drop, and table-size limit configuration.
+
+In scope: aggregate stats, per-flow listing / lookup / drop, full-table
+flush, table-size limit configuration.
+
+Out of scope: rule installation (see ``packet_filter`` / ``firewall``
+and ``nat``), helper-module loading (driver-internal concern), and
+per-flow accounting deltas over time (operations layer can subtract
+two snapshots).
+
+Devices that do not track connections (e.g. stateless bridges) should
+not compose this template.
+"""
+
+from __future__ import annotations
+
+from typing import Protocol, runtime_checkable
+
+from testprotocols.models.firewall import Connection, ConntrackStats
+
+
+@runtime_checkable
+class Conntrack(Protocol):
+    """Abstract contract for connection-tracking observability and admin."""
+
+    # --- Aggregate stats ---
+
+    def get_stats(self) -> ConntrackStats:
+        """Return current conntrack table aggregate counters."""
+        ...
+
+    # --- Per-flow inspection ---
+
+    def list_connections(
+        self,
+        *,
+        protocol: str | None = None,
+        src_ip: str | None = None,
+        dst_ip: str | None = None,
+        dst_port: int | None = None,
+        state: str | None = None,
+    ) -> list[Connection]:
+        """Return tracked flows, optionally filtered.
+
+        Filters compose with AND. *protocol*, when set, must be one of
+        ``"tcp"``, ``"udp"``, ``"icmp"`` — raises ValueError otherwise.
+        Empty list when no flow matches.
+        """
+        ...
+
+    def count_connections(
+        self,
+        *,
+        protocol: str | None = None,
+        state: str | None = None,
+    ) -> int:
+        """Return the number of tracked flows matching the optional filters.
+
+        *protocol*, when set, must be one of ``"tcp"``, ``"udp"``,
+        ``"icmp"`` — raises ValueError otherwise. Cheaper than
+        ``len(list_connections(...))`` on drivers that can ask the
+        kernel directly.
+        """
+        ...
+
+    def get_connection(
+        self,
+        protocol: str,
+        src_ip: str,
+        dst_ip: str,
+        src_port: int | None,
+        dst_port: int | None,
+    ) -> Connection:
+        """Return the tracked flow exactly matching the supplied 5-tuple.
+
+        *src_port* / *dst_port* are ``None`` for ICMP.
+
+        Raises KeyError if no flow matches.
+        """
+        ...
+
+    # --- Per-flow administration ---
+
+    def drop_connection(
+        self,
+        protocol: str,
+        src_ip: str,
+        dst_ip: str,
+        src_port: int | None,
+        dst_port: int | None,
+    ) -> None:
+        """Drop the tracked flow exactly matching the supplied 5-tuple.
+
+        *src_port* / *dst_port* are ``None`` for ICMP.
+
+        Raises KeyError if no flow matches.
+        """
+        ...
+
+    def flush_connections(self) -> None:
+        """Remove every tracked flow from the conntrack table."""
+        ...
+
+    # --- Table size limit ---
+
+    def set_max_connections(self, max_connections: int) -> None:
+        """Set the conntrack table size limit.
+
+        Raises ValueError if *max_connections* < 1.
+        Drivers that do not expose a configurable limit raise
+        NotImplementedError.
+        """
+        ...
+
+    def get_max_connections(self) -> int:
+        """Return the current conntrack table size limit."""
+        ...
+
+
+@runtime_checkable
+class ConntrackWhiteBox(Conntrack, Protocol):
+    """White-box extension of Conntrack for raw kernel-table introspection.
+
+    Linux drivers that can shell into the box satisfy this extension by
+    capturing ``conntrack -L`` (the netfilter conntrack utility) output.
+    Vendor-RTOS or locked-down devices typically satisfy only the base
+    ``Conntrack`` Protocol; tests requiring raw connection-tuple
+    verification should pin against ``ConntrackWhiteBox`` and accept
+    the collection-skip on drivers that don't satisfy it (per the
+    ``@white_box`` scenario tag rule).
+    """
+
+    def get_raw_conntrack_dump(self) -> str:
+        """Return the raw ``conntrack -L`` output for the current namespace.
+
+        Format is the standard ``conntrack -L`` serialisation (one line per
+        flow, with proto / src / dst / sport / dport / state / mark fields).
+        Tests parse this to verify flow tuples landed at the kernel level
+        rather than only in the driver's intermediate state — useful for
+        debugging NAT-translation discrepancies and stuck-flow diagnostics.
+        """
+        ...

testprotocols/content_filtering.py

@@ -0,0 +1,47 @@
+"""Content-filtering template — URL / category blocking for a managed appliance.
+
+Defines the abstract contract for an SD-WAN appliance's web content filter:
+blocking by normalized content category and by explicit allow/block URL
+patterns.
+
+Categories are the normalized ``ContentCategory`` taxonomy owned by commons; the
+driver maps each to its product's category id. URL patterns are free strings
+(host / glob patterns), passed through to the appliance.
+
+In scope: the blocked-category set and the allow / block URL-pattern lists.
+
+Out of scope: application-aware (L7) rules (see ``l7_firewall``) and L3 5-tuple
+filtering (see ``l3_firewall``).
+"""
+
+from __future__ import annotations
+
+from typing import Protocol, runtime_checkable
+
+from testprotocols.models.sdwan_appliance import ContentCategory
+
+
+@runtime_checkable
+class ContentFiltering(Protocol):
+    """Abstract contract for an appliance's web content filter."""
+
+    def set_blocked_categories(self, categories: list[ContentCategory]) -> None:
+        """Replace the set of blocked content categories with *categories*."""
+        ...
+
+    def get_blocked_categories(self) -> list[ContentCategory]:
+        """Return the currently blocked content categories."""
+        ...
+
+    def set_url_rules(self, allowed: list[str], blocked: list[str]) -> None:
+        """Replace the explicit allow / block URL-pattern lists.
+
+        *allowed* takes precedence over both *blocked* and category blocks, per
+        the usual content-filter precedence; the driver maps that intent to its
+        product's allow/deny-list semantics.
+        """
+        ...
+
+    def get_url_rules(self) -> tuple[list[str], list[str]]:
+        """Return ``(allowed, blocked)`` URL-pattern lists."""
+        ...