mirror of
https://github.com/ChuckBuilds/LEDMatrix.git
synced 2026-05-01 21:13:01 +00:00
test(wifi): add unit tests for AP mode — open network, iptables, LED, cleanup ordering
Six pytest unit tests covering the five review scenarios. All subprocess and filesystem side-effects are mocked so the tests run without root, hardware, or a Pi OS environment. 1. test_nmcli_ap_profile_has_no_security_params — asserts the nmcli connection add command has no key-mgmt / psk / WPA arguments and sets mode=ap. 2. test_iptables_nat_rules_added_on_ap_start — verifies _setup_iptables_redirect emits a PREROUTING REDIRECT 80→5000 rule and an INPUT ACCEPT rule for port 5000 (not 80, which never hits INPUT after PREROUTING rewrites it). 3. test_iptables_rules_and_ip_forward_reverted_on_teardown — verifies the -D PREROUTING/-D INPUT calls and that sysctl restores the saved ip_forward value and removes the save file. 4. test_ip_forward_not_restored_when_save_file_absent — verifies teardown skips sysctl when the save file was never written, preventing blind ip_forward=0 on systems using ip_forward for VPNs or NM shared mode. 5. test_led_message_shows_ssid_no_password_and_url — asserts the LED message includes the SSID, 'No password', and the 192.168.4.1:5000 setup URL. 6. test_existing_ap_profiles_deleted_before_new_profile_created — asserts all known profile names are targeted for deletion before 'nmcli connection add'. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
This commit is contained in:
324
test/test_wifi_manager_ap.py
Normal file
324
test/test_wifi_manager_ap.py
Normal file
@@ -0,0 +1,324 @@
|
|||||||
|
"""
|
||||||
|
Unit tests for WiFi AP mode — src.wifi_manager.
|
||||||
|
|
||||||
|
Each test exercises logic that can be verified through the subprocess calls the
|
||||||
|
manager emits, without requiring root access, hardware, or a running Pi.
|
||||||
|
|
||||||
|
Scenarios covered:
|
||||||
|
1. nmcli AP profile is created with no security parameters (open/passwordless).
|
||||||
|
2. iptables PREROUTING and INPUT rules are added when the nmcli AP starts.
|
||||||
|
3. iptables rules and ip_forward are reverted when the AP is torn down.
|
||||||
|
4. LED matrix message includes the SSID, 'No password', and the setup URL.
|
||||||
|
5. Known AP profile names are deleted before the new profile is created.
|
||||||
|
"""
|
||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
import json
|
||||||
|
from pathlib import Path
|
||||||
|
from unittest.mock import MagicMock, patch
|
||||||
|
|
||||||
|
import pytest
|
||||||
|
|
||||||
|
from src.wifi_manager import WiFiManager
|
||||||
|
|
||||||
|
|
||||||
|
# ---------------------------------------------------------------------------
|
||||||
|
# Helpers
|
||||||
|
# ---------------------------------------------------------------------------
|
||||||
|
|
||||||
|
def _ok(stdout: str = "", stderr: str = "") -> MagicMock:
|
||||||
|
r = MagicMock()
|
||||||
|
r.returncode = 0
|
||||||
|
r.stdout = stdout
|
||||||
|
r.stderr = stderr
|
||||||
|
return r
|
||||||
|
|
||||||
|
|
||||||
|
def _fail(stdout: str = "", stderr: str = "error") -> MagicMock:
|
||||||
|
r = MagicMock()
|
||||||
|
r.returncode = 1
|
||||||
|
r.stdout = stdout
|
||||||
|
r.stderr = stderr
|
||||||
|
return r
|
||||||
|
|
||||||
|
|
||||||
|
def _find_path_side_effect(name: str) -> str:
|
||||||
|
"""Deterministic fake for _find_command_path."""
|
||||||
|
return {"iptables": "/usr/sbin/iptables", "sysctl": "/usr/sbin/sysctl"}.get(
|
||||||
|
name, f"/usr/bin/{name}"
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
# ---------------------------------------------------------------------------
|
||||||
|
# Fixtures
|
||||||
|
# ---------------------------------------------------------------------------
|
||||||
|
|
||||||
|
@pytest.fixture()
|
||||||
|
def wifi_config(tmp_path: Path) -> Path:
|
||||||
|
"""Minimal wifi_config.json in a temporary directory."""
|
||||||
|
cfg_dir = tmp_path / "config"
|
||||||
|
cfg_dir.mkdir()
|
||||||
|
cfg = {
|
||||||
|
"ap_ssid": "LEDMatrix-Setup",
|
||||||
|
"ap_channel": 7,
|
||||||
|
"auto_enable_ap_mode": True,
|
||||||
|
"saved_networks": [],
|
||||||
|
}
|
||||||
|
p = cfg_dir / "wifi_config.json"
|
||||||
|
p.write_text(json.dumps(cfg))
|
||||||
|
return p
|
||||||
|
|
||||||
|
|
||||||
|
@pytest.fixture()
|
||||||
|
def manager(wifi_config: Path, tmp_path: Path) -> WiFiManager:
|
||||||
|
"""
|
||||||
|
WiFiManager with all system calls stubbed out during construction and the
|
||||||
|
ip_forward save file redirected to a per-test temporary path.
|
||||||
|
"""
|
||||||
|
with patch("src.wifi_manager.subprocess.run", return_value=_ok(stdout="wlan0\n")), \
|
||||||
|
patch.object(WiFiManager, "_detect_trixie", return_value=False):
|
||||||
|
mgr = WiFiManager(config_path=wifi_config)
|
||||||
|
|
||||||
|
# Force clean, deterministic state regardless of what __init__ inferred
|
||||||
|
mgr._wifi_interface = "wlan0"
|
||||||
|
mgr.has_nmcli = True
|
||||||
|
mgr.has_hostapd = False
|
||||||
|
mgr.has_dnsmasq = False
|
||||||
|
mgr.has_iwlist = False
|
||||||
|
mgr._is_trixie = False
|
||||||
|
# Redirect the ip_forward save file to tmp so tests never share state
|
||||||
|
mgr._IP_FORWARD_SAVE_PATH = tmp_path / "ip_fwd_saved"
|
||||||
|
return mgr
|
||||||
|
|
||||||
|
|
||||||
|
# ---------------------------------------------------------------------------
|
||||||
|
# 1. AP profile is open (no password)
|
||||||
|
# ---------------------------------------------------------------------------
|
||||||
|
|
||||||
|
@pytest.mark.unit
|
||||||
|
def test_nmcli_ap_profile_has_no_security_params(manager: WiFiManager) -> None:
|
||||||
|
"""
|
||||||
|
The 'nmcli connection add' command must not include key-mgmt, psk, or any
|
||||||
|
WPA-related parameter. On Bookworm/Trixie, NM creates a WPA2-protected
|
||||||
|
hotspot even when those values are set to 'none'/empty via a later
|
||||||
|
'connection modify', so the profile must be created without a security
|
||||||
|
section from the start.
|
||||||
|
"""
|
||||||
|
captured: list[list[str]] = []
|
||||||
|
|
||||||
|
def _run(cmd, **kw):
|
||||||
|
captured.append(list(cmd))
|
||||||
|
return _ok()
|
||||||
|
|
||||||
|
with patch("src.wifi_manager.subprocess.run", side_effect=_run), \
|
||||||
|
patch.object(manager, "disconnect_from_network", return_value=(True, "ok")), \
|
||||||
|
patch.object(manager, "_setup_iptables_redirect", return_value=True), \
|
||||||
|
patch.object(manager, "_get_ap_status_nmcli",
|
||||||
|
return_value={"active": True, "ip": "192.168.4.1"}), \
|
||||||
|
patch.object(manager, "_show_led_message"):
|
||||||
|
|
||||||
|
success, _ = manager._enable_ap_mode_nmcli_hotspot()
|
||||||
|
|
||||||
|
assert success, "AP enable should report success"
|
||||||
|
|
||||||
|
add_calls = [c for c in captured if "nmcli" in c and "connection" in c and "add" in c]
|
||||||
|
assert add_calls, "Expected at least one 'nmcli connection add' invocation"
|
||||||
|
|
||||||
|
add_str = " ".join(add_calls[0])
|
||||||
|
assert "key-mgmt" not in add_str, "AP profile must not set key-mgmt"
|
||||||
|
assert "psk" not in add_str, "AP profile must not include a PSK/password"
|
||||||
|
assert "wpa" not in add_str.lower(), "AP profile must not reference WPA"
|
||||||
|
assert "802-11-wireless.mode" in add_str, "AP profile must declare wireless mode"
|
||||||
|
assert "ap" in add_calls[0], "Wireless mode value must be 'ap'"
|
||||||
|
|
||||||
|
|
||||||
|
# ---------------------------------------------------------------------------
|
||||||
|
# 2. iptables NAT rules are added when the AP starts
|
||||||
|
# ---------------------------------------------------------------------------
|
||||||
|
|
||||||
|
@pytest.mark.unit
|
||||||
|
def test_iptables_nat_rules_added_on_ap_start(manager: WiFiManager) -> None:
|
||||||
|
"""
|
||||||
|
_setup_iptables_redirect must add:
|
||||||
|
- a PREROUTING REDIRECT rule that maps incoming TCP port 80 to port 5000, and
|
||||||
|
- an INPUT ACCEPT rule for port 5000 (the post-redirect destination port,
|
||||||
|
NOT port 80 which never hits the INPUT chain after PREROUTING rewrites it).
|
||||||
|
"""
|
||||||
|
captured: list[list[str]] = []
|
||||||
|
|
||||||
|
def _run(cmd, **kw):
|
||||||
|
captured.append(list(cmd))
|
||||||
|
# iptables -C (check) → rc=1 so the -A (add) branch executes
|
||||||
|
if "iptables" in " ".join(str(x) for x in cmd) and "-C" in cmd:
|
||||||
|
return _fail()
|
||||||
|
return _ok()
|
||||||
|
|
||||||
|
# Patch Path.read_text so /proc/sys/net/ipv4/ip_forward is readable on any OS
|
||||||
|
with patch("src.wifi_manager.subprocess.run", side_effect=_run), \
|
||||||
|
patch.object(manager, "_find_command_path", side_effect=_find_path_side_effect), \
|
||||||
|
patch("pathlib.Path.read_text", return_value="0\n"):
|
||||||
|
|
||||||
|
result = manager._setup_iptables_redirect()
|
||||||
|
|
||||||
|
assert result, "_setup_iptables_redirect must return True on success"
|
||||||
|
|
||||||
|
prerouting_adds = [c for c in captured if "iptables" in " ".join(c) and "-A" in c and "PREROUTING" in c]
|
||||||
|
assert prerouting_adds, "Expected 'iptables -A PREROUTING' invocation"
|
||||||
|
pr_str = " ".join(prerouting_adds[0])
|
||||||
|
assert "--dport" in pr_str and "80" in pr_str, "PREROUTING rule must match dport 80"
|
||||||
|
assert "5000" in pr_str, "PREROUTING rule must redirect to port 5000"
|
||||||
|
assert "REDIRECT" in pr_str, "PREROUTING rule must use REDIRECT target"
|
||||||
|
|
||||||
|
input_adds = [c for c in captured if "iptables" in " ".join(c) and "-A" in c and "INPUT" in c]
|
||||||
|
assert input_adds, "Expected 'iptables -A INPUT' invocation"
|
||||||
|
in_str = " ".join(input_adds[0])
|
||||||
|
assert "5000" in in_str, "INPUT rule must accept port 5000 (post-PREROUTING destination)"
|
||||||
|
assert "ACCEPT" in in_str, "INPUT rule must use ACCEPT target"
|
||||||
|
|
||||||
|
# Port 80 must NOT be used in the INPUT rule (it is already redirected by PREROUTING)
|
||||||
|
input_80 = [c for c in captured if "iptables" in " ".join(c) and "INPUT" in c and "--dport" in c and "80" in c]
|
||||||
|
assert not input_80, "INPUT rule must target port 5000, not port 80"
|
||||||
|
|
||||||
|
|
||||||
|
# ---------------------------------------------------------------------------
|
||||||
|
# 3a. iptables rules and ip_forward reverted on teardown
|
||||||
|
# ---------------------------------------------------------------------------
|
||||||
|
|
||||||
|
@pytest.mark.unit
|
||||||
|
def test_iptables_rules_and_ip_forward_reverted_on_teardown(manager: WiFiManager) -> None:
|
||||||
|
"""
|
||||||
|
_teardown_iptables_redirect must:
|
||||||
|
- remove the PREROUTING and INPUT iptables rules, and
|
||||||
|
- restore ip_forward to the exact value recorded in the save file.
|
||||||
|
"""
|
||||||
|
original_fwd = "0"
|
||||||
|
manager._IP_FORWARD_SAVE_PATH.write_text(original_fwd)
|
||||||
|
|
||||||
|
captured: list[list[str]] = []
|
||||||
|
|
||||||
|
with patch("src.wifi_manager.subprocess.run",
|
||||||
|
side_effect=lambda cmd, **kw: (captured.append(list(cmd)) or _ok())), \
|
||||||
|
patch.object(manager, "_find_command_path", side_effect=_find_path_side_effect):
|
||||||
|
|
||||||
|
manager._teardown_iptables_redirect()
|
||||||
|
|
||||||
|
assert [c for c in captured if "iptables" in " ".join(c) and "-D" in c and "PREROUTING" in c], \
|
||||||
|
"Expected 'iptables -D PREROUTING' invocation"
|
||||||
|
|
||||||
|
assert [c for c in captured if "iptables" in " ".join(c) and "-D" in c and "INPUT" in c], \
|
||||||
|
"Expected 'iptables -D INPUT' invocation"
|
||||||
|
|
||||||
|
restore_calls = [
|
||||||
|
c for c in captured
|
||||||
|
if "sysctl" in " ".join(c) and f"ip_forward={original_fwd}" in " ".join(c)
|
||||||
|
]
|
||||||
|
assert restore_calls, f"Expected sysctl to restore ip_forward to {original_fwd!r}"
|
||||||
|
|
||||||
|
assert not manager._IP_FORWARD_SAVE_PATH.exists(), \
|
||||||
|
"Save file must be removed after successful teardown"
|
||||||
|
|
||||||
|
|
||||||
|
# ---------------------------------------------------------------------------
|
||||||
|
# 3b. ip_forward untouched when no save file exists
|
||||||
|
# ---------------------------------------------------------------------------
|
||||||
|
|
||||||
|
@pytest.mark.unit
|
||||||
|
def test_ip_forward_not_restored_when_save_file_absent(manager: WiFiManager) -> None:
|
||||||
|
"""
|
||||||
|
When the save file is missing (setup never wrote it, e.g. because /proc was
|
||||||
|
unreadable or the write failed), teardown must NOT call sysctl so it does not
|
||||||
|
accidentally clobber ip_forward state owned by a VPN or NetworkManager.
|
||||||
|
"""
|
||||||
|
assert not manager._IP_FORWARD_SAVE_PATH.exists()
|
||||||
|
|
||||||
|
captured: list[list[str]] = []
|
||||||
|
|
||||||
|
with patch("src.wifi_manager.subprocess.run",
|
||||||
|
side_effect=lambda cmd, **kw: (captured.append(list(cmd)) or _ok())), \
|
||||||
|
patch.object(manager, "_find_command_path", side_effect=_find_path_side_effect):
|
||||||
|
|
||||||
|
manager._teardown_iptables_redirect()
|
||||||
|
|
||||||
|
sysctl_calls = [
|
||||||
|
c for c in captured
|
||||||
|
if "sysctl" in " ".join(c) and "ip_forward" in " ".join(c)
|
||||||
|
]
|
||||||
|
assert not sysctl_calls, \
|
||||||
|
"sysctl must not be called when no ip_forward save file exists"
|
||||||
|
|
||||||
|
|
||||||
|
# ---------------------------------------------------------------------------
|
||||||
|
# 4. LED message content
|
||||||
|
# ---------------------------------------------------------------------------
|
||||||
|
|
||||||
|
@pytest.mark.unit
|
||||||
|
def test_led_message_shows_ssid_no_password_and_url(manager: WiFiManager) -> None:
|
||||||
|
"""
|
||||||
|
When the nmcli AP activates, the LED message must include:
|
||||||
|
- the AP SSID ('LEDMatrix-Setup')
|
||||||
|
- the string 'No password'
|
||||||
|
- the AP IP address (192.168.4.1) and Flask port (5000)
|
||||||
|
"""
|
||||||
|
led_messages: list[str] = []
|
||||||
|
|
||||||
|
with patch("src.wifi_manager.subprocess.run", return_value=_ok()), \
|
||||||
|
patch.object(manager, "disconnect_from_network", return_value=(True, "ok")), \
|
||||||
|
patch.object(manager, "_setup_iptables_redirect", return_value=True), \
|
||||||
|
patch.object(manager, "_get_ap_status_nmcli",
|
||||||
|
return_value={"active": True, "ip": "192.168.4.1"}), \
|
||||||
|
patch.object(manager, "_show_led_message",
|
||||||
|
side_effect=lambda msg, **kw: led_messages.append(msg)):
|
||||||
|
|
||||||
|
success, _ = manager._enable_ap_mode_nmcli_hotspot()
|
||||||
|
|
||||||
|
assert success, "AP enable should report success"
|
||||||
|
assert led_messages, "Expected at least one _show_led_message call"
|
||||||
|
|
||||||
|
combined = "\n".join(led_messages)
|
||||||
|
assert "No password" in combined, "LED message must say 'No password'"
|
||||||
|
assert "LEDMatrix-Setup" in combined, "LED message must include the AP SSID"
|
||||||
|
assert "192.168.4.1" in combined, "LED message must include the AP IP address"
|
||||||
|
assert "5000" in combined, "LED message must include the Flask port"
|
||||||
|
|
||||||
|
|
||||||
|
# ---------------------------------------------------------------------------
|
||||||
|
# 5. Stale AP profiles deleted before the new one is created
|
||||||
|
# ---------------------------------------------------------------------------
|
||||||
|
|
||||||
|
@pytest.mark.unit
|
||||||
|
def test_existing_ap_profiles_deleted_before_new_profile_created(manager: WiFiManager) -> None:
|
||||||
|
"""
|
||||||
|
Before 'nmcli connection add', the manager must issue
|
||||||
|
'nmcli connection down/delete' for every known AP profile name so stale
|
||||||
|
profiles (from a previous crash or partial setup) cannot block the new one.
|
||||||
|
"""
|
||||||
|
captured: list[list[str]] = []
|
||||||
|
|
||||||
|
def _run(cmd, **kw):
|
||||||
|
captured.append(list(cmd))
|
||||||
|
return _ok()
|
||||||
|
|
||||||
|
with patch("src.wifi_manager.subprocess.run", side_effect=_run), \
|
||||||
|
patch.object(manager, "disconnect_from_network", return_value=(True, "ok")), \
|
||||||
|
patch.object(manager, "_setup_iptables_redirect", return_value=True), \
|
||||||
|
patch.object(manager, "_get_ap_status_nmcli",
|
||||||
|
return_value={"active": True, "ip": "192.168.4.1"}), \
|
||||||
|
patch.object(manager, "_show_led_message"):
|
||||||
|
|
||||||
|
success, _ = manager._enable_ap_mode_nmcli_hotspot()
|
||||||
|
|
||||||
|
assert success
|
||||||
|
|
||||||
|
cmd_strs = [" ".join(c) for c in captured]
|
||||||
|
|
||||||
|
for profile in ("LEDMatrix-Setup-AP", "Hotspot", "TickerSetup-AP"):
|
||||||
|
assert any("connection delete" in s and profile in s for s in cmd_strs), \
|
||||||
|
f"Expected 'nmcli connection delete {profile}' before creating the new profile"
|
||||||
|
|
||||||
|
add_indices = [i for i, s in enumerate(cmd_strs) if "connection add" in s]
|
||||||
|
del_indices = [i for i, s in enumerate(cmd_strs) if "connection delete" in s]
|
||||||
|
|
||||||
|
assert add_indices, "Expected 'nmcli connection add' call"
|
||||||
|
assert del_indices, "Expected 'nmcli connection delete' calls"
|
||||||
|
assert max(del_indices) < min(add_indices), \
|
||||||
|
"All connection deletions must complete before the new profile is created"
|
||||||
Reference in New Issue
Block a user