"""`read_log`: the filters, the defaults, and what it says about a live log. The log is built here from the ulogcat format rather than fetched, so none of this touches the aircraft or the captured file. """ import pytest from fastmcp import Client from test_ulog import entry from mcbebop.config import Settings from mcbebop.server import build_server from mcbebop.tools import _common, logs def synthetic_log() -> bytes: return b"".join( [ entry("Booting Linux on physical CPU 0", tag="KERNEL", uptime_us=0), entry("AM I HOST mode for 5 s", tag="shp_usbmode", uptime_us=1_000_000), entry("AM I HOST mode for 5 s", tag="shp_usbmode", uptime_us=6_000_000), entry("Cmd Tx : battery level <62%>", tag="COMMANDS", uptime_us=10_000_000), entry("Magneto calibration state (1-required) : 0", tag="COMMANDS", uptime_us=11_000_000), entry("eth0: no IPv6 routers present", tag="KERNEL", priority="W", uptime_us=12_000_000), entry("fileOpen: error: cannot open file", tag="colibry", priority="E", uptime_us=13_000_000), ] ) def records(): from mcbebop.files import ulog return list(ulog.parse(synthetic_log())) # --- the filters, without a server ------------------------------------------ def test_a_tag_filter_is_exact_and_case_insensitive(): kept, matched = logs.select(records(), tag="kernel") assert matched == 2 assert {r.tag for r in kept} == {"KERNEL"} def test_a_substring_is_a_valid_regex_and_behaves_like_one(): kept, _ = logs.select(records(), match="battery") assert [r.tag for r in kept] == ["COMMANDS"] def test_a_broken_regex_says_it_was_read_as_a_regex(): from fastmcp.exceptions import ToolError with pytest.raises(ToolError, match="regular expression"): logs.select(records(), match="unclosed (") def test_a_severity_filter_keeps_that_level_and_worse(): kept, _ = logs.select(records(), min_level="warning") assert [r.level for r in kept] == ["warning", "error"] kept, _ = logs.select(records(), min_level="error") assert [r.level for r in kept] == ["error"] def test_the_limit_takes_the_newest_matches_not_the_first(): kept, matched = logs.select(records(), limit=2) assert matched == 7 assert [r.uptime_us for r in kept] == [12_000_000, 13_000_000] def test_the_noisy_poll_is_excluded_by_default_and_can_be_asked_for(): assert "shp_usbmode" in logs.NOISY_TAGS kept, _ = logs.select(records(), exclude_tags=logs.NOISY_TAGS) assert "shp_usbmode" not in {r.tag for r in kept} kept, _ = logs.select(records(), exclude_tags=[]) assert "shp_usbmode" in {r.tag for r in kept} def test_naming_a_tag_explicitly_beats_the_default_exclusion(): # Asking for a tag by name and getting nothing because a default hid it # would be the worst kind of helpful. kept, matched = logs.select(records(), tag="shp_usbmode", exclude_tags=logs.NOISY_TAGS) assert matched == 2 assert {r.tag for r in kept} == {"shp_usbmode"} # --- through the server ----------------------------------------------------- @pytest.fixture def served(monkeypatch, tmp_path): """A server whose FTP fetch hands back a synthetic log.""" log = tmp_path / "ckcm.bin" log.write_bytes(synthetic_log()) asked: dict = {} def fake_fetch(area, path, *, host, capture_dir, max_bytes=0, timeout=0.0): asked.update(area=area, path=path, host=host) return log monkeypatch.setattr("mcbebop.files.ftp.fetch", fake_fetch) return build_server(Settings(capture_dir=tmp_path)), asked @pytest.fixture async def client(served): server, asked = served async with Client(server) as c: # No connect(): the log comes off the aircraft's FTP server, which # answers whether or not a command session is open. _common.app().target = "192.0.2.1" yield c, asked async def test_read_log_fetches_from_the_log_area_and_returns_parsed_entries(client): c, asked = client result = await c.call_tool("read_log", {}) body = result.structured_content assert asked == {"area": logs.LOG_AREA, "path": logs.LOG_PATH, "host": "192.0.2.1"} assert body["parsed"] == 7 assert body["returned"] == 5, "the usb poll should be excluded by default" assert body["entries"][0]["message"].startswith("fileOpen"), "newest first by default" assert body["tags"]["KERNEL"] == 2 async def test_read_log_reports_which_tags_it_hid(client): c, _ = client body = (await c.call_tool("read_log", {})).structured_content assert "shp_usbmode" in body["note"] assert "exclude_tags=[]" in body["note"] async def test_read_log_can_order_oldest_first_while_still_taking_the_newest(client): c, _ = client body = (await c.call_tool("read_log", {"limit": 2, "newest_first": False})).structured_content assert [e["uptime"] for e in body["entries"]] == [12.0, 13.0] async def test_the_whole_file_tag_census_survives_the_filters(client): c, _ = client body = (await c.call_tool("read_log", {"tag": "colibry"})).structured_content assert body["matched"] == 1 assert body["parsed"] == 7, "parsed counts the file, not the filter" assert set(body["tags"]) == {"KERNEL", "shp_usbmode", "COMMANDS", "colibry"} async def test_an_absent_tag_says_which_tags_are_present(client): c, _ = client body = (await c.call_tool("read_log", {"tag": "NETMON"})).structured_content assert body["returned"] == 0 assert "NETMON" in body["note"] and "KERNEL" in body["note"] async def test_the_log_is_not_reachable_on_the_simulator(client): from fastmcp.exceptions import ToolError c, _ = client _common.app().target = "sim" with pytest.raises(ToolError, match="simulator"): await c.call_tool("read_log", {})