Compare commits
2 Commits
main
..
4485ec3814
| Author | SHA1 | Date | |
|---|---|---|---|
| 4485ec3814 | |||
| a4abb5d15d |
@@ -0,0 +1,90 @@
|
|||||||
|
name: meshtasticator-e2e
|
||||||
|
|
||||||
|
# Radio-level end-to-end validation against Meshtasticator's interactive
|
||||||
|
# simulator (real MeshtasticD per node + simulated LoRa PHY). Runs on demand
|
||||||
|
# until it is validated green on the runner; afterwards switch `on` to also
|
||||||
|
# trigger on pull_request touching plugin/ and this workflow.
|
||||||
|
#
|
||||||
|
# Docker access follows the deployment examples in
|
||||||
|
# https://git.ericxliu.me/eric/actions-docker (docker is available to jobs);
|
||||||
|
# Meshtasticator's docker mode publishes node TCP API ports (4404+n) from the
|
||||||
|
# meshtastic/meshtasticd container and the simulator connects to them on
|
||||||
|
# localhost. scripts/meshtasticator_e2e/run_e2e.sh starts localhost->daemon
|
||||||
|
# TCP forwards automatically when DOCKER_HOST is a tcp:// daemon, which is how
|
||||||
|
# this job is configured.
|
||||||
|
|
||||||
|
on:
|
||||||
|
workflow_dispatch:
|
||||||
|
# pull_request:
|
||||||
|
# paths:
|
||||||
|
# - 'plugin/**'
|
||||||
|
# - 'scripts/meshtasticator_e2e/**'
|
||||||
|
# - '.gitea/workflows/meshtasticator-e2e.yaml'
|
||||||
|
|
||||||
|
concurrency:
|
||||||
|
# One e2e run at a time: Meshtasticator hardcodes the container/volume name
|
||||||
|
# ("Meshtastic"/"Meshtasticator") on the shared docker daemon.
|
||||||
|
group: meshtasticator-e2e
|
||||||
|
cancel-in-progress: true
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
e2e:
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
timeout-minutes: 60
|
||||||
|
env:
|
||||||
|
DOCKER_HOST: tcp://docker.local:2375
|
||||||
|
MESHTASTICATOR_COMMIT: 17ceb8231079d87b070abc6132181e4c6b20202d
|
||||||
|
steps:
|
||||||
|
- name: Checkout code
|
||||||
|
uses: actions/checkout@v4
|
||||||
|
|
||||||
|
- name: Set up Python 3.13 (matches Hermes image)
|
||||||
|
uses: actions/setup-python@v5
|
||||||
|
with:
|
||||||
|
python-version: '3.13'
|
||||||
|
|
||||||
|
- name: Install uv
|
||||||
|
run: pip install uv
|
||||||
|
|
||||||
|
# --- Hermes gateway contract env (mirrors .gitea/workflows/release.yaml) ---
|
||||||
|
- name: Clone pinned Hermes gateway source (deployed image tag)
|
||||||
|
run: |
|
||||||
|
git clone --depth 1 --branch v2026.8.31 \
|
||||||
|
https://github.com/NousResearch/hermes-agent.git plugin/.hermes-src
|
||||||
|
test "$(git -C plugin/.hermes-src rev-parse HEAD)" = \
|
||||||
|
"29112bef099274229cadff79cdff7bf7b99c4b77"
|
||||||
|
|
||||||
|
- name: Editable install hermes-agent + pytest + plugin (meshtastic client lib)
|
||||||
|
run: |
|
||||||
|
uv venv --python 3.13 plugin/.venv-contract
|
||||||
|
uv pip install --python plugin/.venv-contract/bin/python -e plugin/.hermes-src
|
||||||
|
uv pip install --python plugin/.venv-contract/bin/python pytest
|
||||||
|
uv pip install --python plugin/.venv-contract/bin/python -e plugin
|
||||||
|
|
||||||
|
# --- Simulator env (isolated: meshtasticator pins meshtastic~=2.6.1) ---
|
||||||
|
- name: Clone Meshtasticator at pinned commit
|
||||||
|
run: |
|
||||||
|
git clone https://github.com/meshtastic/meshtasticator.git "$HOME/meshtasticator"
|
||||||
|
git -C "$HOME/meshtasticator" checkout "$MESHTASTICATOR_COMMIT"
|
||||||
|
test "$(git -C "$HOME/meshtasticator" rev-parse HEAD)" = "$MESHTASTICATOR_COMMIT"
|
||||||
|
|
||||||
|
- name: Simulator venv (its own requirements + docker SDK)
|
||||||
|
run: |
|
||||||
|
uv venv --python 3.13 "$HOME/sim-venv"
|
||||||
|
uv pip install --python "$HOME/sim-venv/bin/python" \
|
||||||
|
-r "$HOME/meshtasticator/requirements.txt" docker
|
||||||
|
|
||||||
|
- name: Run Meshtasticator e2e suite
|
||||||
|
run: |
|
||||||
|
export MESHTASTICATOR_DIR="$HOME/meshtasticator"
|
||||||
|
export SIM_VENV="$HOME/sim-venv"
|
||||||
|
export E2E_VENV="plugin/.venv-contract"
|
||||||
|
scripts/meshtasticator_e2e/run_e2e.sh --mode docker
|
||||||
|
|
||||||
|
- name: Print simulator log (on failure)
|
||||||
|
if: failure()
|
||||||
|
run: |
|
||||||
|
echo "===== meshtasticator-sim.log ====="
|
||||||
|
tail -n 200 meshtasticator-sim.log 2>/dev/null || true
|
||||||
|
echo "===== docker ps ====="
|
||||||
|
docker ps -a 2>/dev/null || true
|
||||||
@@ -214,21 +214,13 @@ def get_adapter_class():
|
|||||||
"""Handle incoming text packet from Meshtastic pubsub (worker thread)."""
|
"""Handle incoming text packet from Meshtastic pubsub (worker thread)."""
|
||||||
try:
|
try:
|
||||||
ch = packet.get("channel", 0)
|
ch = packet.get("channel", 0)
|
||||||
my_info = getattr(interface, "myInfo", None)
|
if self.channel_index is not None and ch != self.channel_index:
|
||||||
my_node_num = getattr(my_info, "my_node_num", 0)
|
|
||||||
is_direct_to_me = packet.get("to") == my_node_num
|
|
||||||
is_pki_dm = is_direct_to_me and packet.get("pkiEncrypted", False)
|
|
||||||
if (
|
|
||||||
self.channel_index is not None
|
|
||||||
and ch != self.channel_index
|
|
||||||
and not is_pki_dm
|
|
||||||
):
|
|
||||||
# Ignore packets from different channels (e.g. public channel 0).
|
# Ignore packets from different channels (e.g. public channel 0).
|
||||||
# PKI direct messages omit the channel field and decode as
|
|
||||||
# channel 0 even when sent from a secondary channel.
|
|
||||||
return
|
return
|
||||||
|
|
||||||
from_id = packet.get("fromId") or f"!{packet.get('from', 0):08x}"
|
from_id = packet.get("fromId") or f"!{packet.get('from', 0):08x}"
|
||||||
|
my_info = getattr(interface, "myInfo", None)
|
||||||
|
my_node_num = getattr(my_info, "my_node_num", 0)
|
||||||
if packet.get("from") == my_node_num:
|
if packet.get("from") == my_node_num:
|
||||||
# Prevent self-message loops.
|
# Prevent self-message loops.
|
||||||
return
|
return
|
||||||
@@ -245,7 +237,7 @@ def get_adapter_class():
|
|||||||
return
|
return
|
||||||
|
|
||||||
to_id = packet.get("toId")
|
to_id = packet.get("toId")
|
||||||
is_dm = to_id != "^all" and is_direct_to_me
|
is_dm = to_id != "^all" and packet.get("to") == my_node_num
|
||||||
chat_id = from_id if is_dm else f"channel_{ch}"
|
chat_id = from_id if is_dm else f"channel_{ch}"
|
||||||
chat_type = "dm" if is_dm else "channel"
|
chat_type = "dm" if is_dm else "channel"
|
||||||
|
|
||||||
|
|||||||
@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
|
|||||||
|
|
||||||
[project]
|
[project]
|
||||||
name = "hermes-meshtastic"
|
name = "hermes-meshtastic"
|
||||||
version = "0.1.4"
|
version = "0.1.3"
|
||||||
description = "Meshtastic LoRa mesh gateway adapter plugin for Hermes Agent"
|
description = "Meshtastic LoRa mesh gateway adapter plugin for Hermes Agent"
|
||||||
readme = "README.md"
|
readme = "README.md"
|
||||||
requires-python = ">=3.10"
|
requires-python = ">=3.10"
|
||||||
|
|||||||
@@ -36,7 +36,6 @@ so the gate can never silently skip.
|
|||||||
|
|
||||||
import inspect
|
import inspect
|
||||||
import os
|
import os
|
||||||
from types import SimpleNamespace
|
|
||||||
|
|
||||||
import pytest
|
import pytest
|
||||||
|
|
||||||
@@ -229,40 +228,3 @@ def test_inbound_event_construction_is_valid(registered_entry):
|
|||||||
)
|
)
|
||||||
assert event.source.platform.value == "meshtastic"
|
assert event.source.platform.value == "meshtastic"
|
||||||
assert event.text == "hello over LoRa"
|
assert event.text == "hello over LoRa"
|
||||||
|
|
||||||
|
|
||||||
def test_pki_direct_message_without_channel_reaches_gateway(
|
|
||||||
registered_entry, monkeypatch
|
|
||||||
):
|
|
||||||
"""PKI DMs omit channel and must bypass the secondary-channel filter."""
|
|
||||||
adapter = _make_adapter(registered_entry)
|
|
||||||
adapter._loop = SimpleNamespace(is_running=lambda: True)
|
|
||||||
captured = {}
|
|
||||||
|
|
||||||
async def handle_message(event):
|
|
||||||
captured["event"] = event
|
|
||||||
|
|
||||||
def submit(coro, loop):
|
|
||||||
captured["loop"] = loop
|
|
||||||
with pytest.raises(StopIteration):
|
|
||||||
coro.send(None)
|
|
||||||
|
|
||||||
adapter.handle_message = handle_message
|
|
||||||
monkeypatch.setattr(plugin_adapter.asyncio, "run_coroutine_threadsafe", submit)
|
|
||||||
|
|
||||||
interface = SimpleNamespace(myInfo=SimpleNamespace(my_node_num=0x1BA1BC60))
|
|
||||||
adapter._on_meshtastic_receive(
|
|
||||||
{
|
|
||||||
"from": 0x1BA1496C,
|
|
||||||
"to": 0x1BA1BC60,
|
|
||||||
"toId": "!1ba1bc60",
|
|
||||||
"pkiEncrypted": True,
|
|
||||||
"decoded": {"text": "hello over PKI"},
|
|
||||||
"id": 42,
|
|
||||||
},
|
|
||||||
interface,
|
|
||||||
)
|
|
||||||
|
|
||||||
assert captured["loop"] is adapter._loop
|
|
||||||
assert captured["event"].text == "hello over PKI"
|
|
||||||
assert captured["event"].source.chat_id == "!1ba1496c"
|
|
||||||
|
|||||||
@@ -0,0 +1,266 @@
|
|||||||
|
"""End-to-end tests: hermes-meshtastic adapter against live Meshtasticator nodes.
|
||||||
|
|
||||||
|
What these tests validate (the "radio-level" layer no contract test can):
|
||||||
|
* the adapter's real TCP/protobuf handshake against MeshtasticD (the actual
|
||||||
|
device software, not a mock) as run by the Meshtasticator interactive
|
||||||
|
simulator (https://meshtastic.org/docs/software/meshtasticator/),
|
||||||
|
* inbound text reception across the simulated LoRa mesh,
|
||||||
|
* outbound chunked sends arriving at another simulated node,
|
||||||
|
* the whole path: pubsub callback -> MessageEvent construction (real gateway
|
||||||
|
types) -> handle_message dispatch.
|
||||||
|
|
||||||
|
What they do NOT validate (out of scope even for Meshtasticator): true RF
|
||||||
|
(silicon-level LoRa, real propagation/interference, regulatory duty cycle).
|
||||||
|
|
||||||
|
Running
|
||||||
|
-------
|
||||||
|
1. On a Linux host (or a machine with Docker): clone meshtastic/meshtasticator
|
||||||
|
and boot the interactive simulator (see scripts/meshtasticator_e2e/).
|
||||||
|
2. Point the plugin's own contract venv at the booted nodes and run:
|
||||||
|
cd plugin && MESHTASTICATOR_E2E=1 E2E_PORTS=4404,4405 \
|
||||||
|
E2E_CHANNEL_INDEX=0 .venv-contract/bin/python -m pytest tests/e2e -q
|
||||||
|
|
||||||
|
Environment
|
||||||
|
-----------
|
||||||
|
MESHTASTICATOR_E2E = "1" enables these tests (required; without it the
|
||||||
|
module skips so ordinary unit/CI runs stay fast).
|
||||||
|
E2E_PORTS = comma-separated TCP API ports of the simulated nodes
|
||||||
|
(first = the node the adapter connects to, default 4404).
|
||||||
|
E2E_HOST = host where the simulator exposes the ports (default 127.0.0.1).
|
||||||
|
E2E_CHANNEL_INDEX = Meshtastic channel index the adapter listens/sends on
|
||||||
|
(default 0 = primary channel, matching a stock sim node).
|
||||||
|
|
||||||
|
NOTE: this module is an initial scaffold. Structural validation (imports,
|
||||||
|
fixtures, flow) passes, but a full green run requires a Linux/Docker host with
|
||||||
|
a MeshtasticD build — tracked as the remaining verification step.
|
||||||
|
"""
|
||||||
|
|
||||||
|
import asyncio
|
||||||
|
import os
|
||||||
|
|
||||||
|
import pytest
|
||||||
|
|
||||||
|
if os.environ.get("MESHTASTICATOR_E2E") != "1":
|
||||||
|
pytest.skip(
|
||||||
|
"set MESHTASTICATOR_E2E=1 to run against Meshtasticator nodes "
|
||||||
|
"(see scripts/meshtasticator_e2e/README.md)",
|
||||||
|
allow_module_level=True,
|
||||||
|
)
|
||||||
|
|
||||||
|
# Real Hermes gateway + real Meshtastic client library are required.
|
||||||
|
pytest.importorskip("gateway.platforms.base")
|
||||||
|
pytest.importorskip("meshtastic.tcp_interface")
|
||||||
|
|
||||||
|
from gateway.config import PlatformConfig # noqa: E402
|
||||||
|
from gateway.platform_registry import ( # noqa: E402
|
||||||
|
PlatformEntry,
|
||||||
|
platform_registry,
|
||||||
|
)
|
||||||
|
|
||||||
|
import hermes_meshtastic # noqa: E402
|
||||||
|
from hermes_meshtastic import adapter as plugin_adapter # noqa: E402
|
||||||
|
|
||||||
|
E2E_HOST = os.environ.get("E2E_HOST", "127.0.0.1")
|
||||||
|
E2E_PORTS = [int(p) for p in os.environ.get("E2E_PORTS", "4404,4405").split(",") if p]
|
||||||
|
E2E_CHANNEL_INDEX = int(os.environ.get("E2E_CHANNEL_INDEX", "0"))
|
||||||
|
assert len(E2E_PORTS) >= 2, "E2E_PORTS needs at least two node ports (adapter + peer)"
|
||||||
|
|
||||||
|
NODE0_PORT = E2E_PORTS[0] # the node our adapter connects to
|
||||||
|
NODE1_PORT = E2E_PORTS[1] # the peer node that sends / observes
|
||||||
|
CONNECT_TIMEOUT_S = 30
|
||||||
|
RADIO_SETTLE_S = 2
|
||||||
|
|
||||||
|
|
||||||
|
def _register_meshtastic_platform():
|
||||||
|
"""Register the plugin (mirrors discovery) so Platform('meshtastic') resolves."""
|
||||||
|
if platform_registry.is_registered("meshtastic"):
|
||||||
|
return
|
||||||
|
kwargs = {}
|
||||||
|
|
||||||
|
class _Ctx:
|
||||||
|
def register_platform(self, **kw):
|
||||||
|
kwargs.update(kw)
|
||||||
|
|
||||||
|
hermes_meshtastic.register(_Ctx())
|
||||||
|
platform_registry.register(
|
||||||
|
PlatformEntry(
|
||||||
|
name=kwargs["name"],
|
||||||
|
label=kwargs["label"],
|
||||||
|
adapter_factory=kwargs["adapter_factory"],
|
||||||
|
check_fn=kwargs["check_fn"],
|
||||||
|
required_env=[],
|
||||||
|
max_message_length=kwargs.get("max_message_length", 0),
|
||||||
|
emoji=kwargs.get("emoji", "🔌"),
|
||||||
|
platform_hint=kwargs.get("platform_hint", ""),
|
||||||
|
)
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
class _ProbeAdapter(plugin_adapter.get_adapter_class()):
|
||||||
|
"""MeshtasticAdapter that records inbound MessageEvents instead of
|
||||||
|
dispatching to a Hermes agent handler (no agent runs in these tests)."""
|
||||||
|
|
||||||
|
def __init__(self, config):
|
||||||
|
super().__init__(config)
|
||||||
|
self.received_events = []
|
||||||
|
|
||||||
|
async def handle_message(self, event):
|
||||||
|
self.received_events.append(event)
|
||||||
|
# Intentionally do not call super(): the real base would forward to a
|
||||||
|
# message handler that only exists inside a running Hermes gateway.
|
||||||
|
return None
|
||||||
|
|
||||||
|
|
||||||
|
@pytest.fixture(scope="module")
|
||||||
|
def adapter():
|
||||||
|
_register_meshtastic_platform()
|
||||||
|
cfg = PlatformConfig(
|
||||||
|
enabled=True,
|
||||||
|
extra={
|
||||||
|
"host": E2E_HOST,
|
||||||
|
"port": NODE0_PORT,
|
||||||
|
"channel_index": E2E_CHANNEL_INDEX,
|
||||||
|
},
|
||||||
|
)
|
||||||
|
return _ProbeAdapter(cfg)
|
||||||
|
|
||||||
|
|
||||||
|
@pytest.fixture(scope="module")
|
||||||
|
def loop():
|
||||||
|
"""Long-lived event loop in a background thread.
|
||||||
|
|
||||||
|
The adapter mirrors the Hermes gateway contract: connect()/watchdog/
|
||||||
|
handle_message() assume a *running* loop (the gateway's). A per-call
|
||||||
|
asyncio.run() would close the loop right after connect() and strand both
|
||||||
|
the watchdog and inbound dispatch, so the e2e module keeps one loop alive
|
||||||
|
and drives coroutines into it with run_coroutine_threadsafe.
|
||||||
|
"""
|
||||||
|
import threading
|
||||||
|
|
||||||
|
_loop = asyncio.new_event_loop()
|
||||||
|
thread = threading.Thread(target=_loop.run_forever, daemon=True)
|
||||||
|
thread.start()
|
||||||
|
try:
|
||||||
|
yield _loop
|
||||||
|
finally:
|
||||||
|
_loop.call_soon_threadsafe(_loop.stop)
|
||||||
|
thread.join(timeout=5)
|
||||||
|
|
||||||
|
|
||||||
|
def _run_in_loop(loop, coro, timeout_s=CONNECT_TIMEOUT_S):
|
||||||
|
import concurrent.futures
|
||||||
|
|
||||||
|
try:
|
||||||
|
return asyncio.run_coroutine_threadsafe(coro, loop).result(timeout=timeout_s)
|
||||||
|
except concurrent.futures.TimeoutError:
|
||||||
|
pytest.fail(f"coroutine did not finish within {timeout_s}s")
|
||||||
|
|
||||||
|
|
||||||
|
@pytest.fixture(scope="module")
|
||||||
|
def node0(adapter, loop):
|
||||||
|
"""Connect the adapter to simulated node 0 (retrying while the node's TCP
|
||||||
|
API comes up); disconnect afterwards."""
|
||||||
|
import time
|
||||||
|
|
||||||
|
deadline = time.monotonic() + CONNECT_TIMEOUT_S
|
||||||
|
last_ok = False
|
||||||
|
while time.monotonic() < deadline:
|
||||||
|
last_ok = bool(_run_in_loop(loop, adapter.connect()))
|
||||||
|
if last_ok:
|
||||||
|
break
|
||||||
|
time.sleep(3)
|
||||||
|
assert last_ok, (
|
||||||
|
f"adapter failed to connect to simulated node at {E2E_HOST}:{NODE0_PORT} "
|
||||||
|
"(is the simulator running and the node reachable?)"
|
||||||
|
)
|
||||||
|
try:
|
||||||
|
yield adapter
|
||||||
|
finally:
|
||||||
|
try:
|
||||||
|
_run_in_loop(loop, adapter.disconnect(), timeout_s=10)
|
||||||
|
except Exception: # loop teardown must not mask test failures
|
||||||
|
pass
|
||||||
|
|
||||||
|
|
||||||
|
def _wait_for(predicate, timeout_s=15.0, interval_s=0.5, what="condition"):
|
||||||
|
"""Poll until *predicate* (callable -> bool) is true, else pytest.fail."""
|
||||||
|
import time
|
||||||
|
|
||||||
|
deadline = time.monotonic() + timeout_s
|
||||||
|
while time.monotonic() < deadline:
|
||||||
|
if predicate():
|
||||||
|
return
|
||||||
|
time.sleep(interval_s)
|
||||||
|
pytest.fail(f"timed out waiting for {what}")
|
||||||
|
|
||||||
|
|
||||||
|
# ---------------------------------------------------------------------------
|
||||||
|
# Radio-level flows
|
||||||
|
# ---------------------------------------------------------------------------
|
||||||
|
|
||||||
|
|
||||||
|
def test_adapter_receives_broadcast_from_peer(node0):
|
||||||
|
"""Peer node 1 broadcasts text over the simulated mesh; the adapter must
|
||||||
|
receive it as a real gateway MessageEvent."""
|
||||||
|
import time
|
||||||
|
|
||||||
|
from meshtastic import tcp_interface
|
||||||
|
|
||||||
|
sent = f"e2e-inbound-{int(time.time())}"
|
||||||
|
|
||||||
|
peer = tcp_interface.TCPInterface(hostname=E2E_HOST, portNumber=NODE1_PORT)
|
||||||
|
try:
|
||||||
|
time.sleep(RADIO_SETTLE_S)
|
||||||
|
|
||||||
|
def _got():
|
||||||
|
return any(getattr(e, "text", None) == sent for e in node0.received_events)
|
||||||
|
|
||||||
|
# Radio delivery is not guaranteed per attempt; retry a few times.
|
||||||
|
for _ in range(3):
|
||||||
|
if _got():
|
||||||
|
break
|
||||||
|
peer.localNode.sendText(
|
||||||
|
text=sent, destinationId="^all", channelIndex=E2E_CHANNEL_INDEX
|
||||||
|
)
|
||||||
|
time.sleep(1)
|
||||||
|
_wait_for(_got, timeout_s=25, what="inbound broadcast from peer node")
|
||||||
|
finally:
|
||||||
|
peer.close()
|
||||||
|
|
||||||
|
|
||||||
|
def test_adapter_chunked_send_reaches_peer(node0, loop):
|
||||||
|
"""A long outbound message must be chunked and arrive at the peer node."""
|
||||||
|
import time
|
||||||
|
|
||||||
|
from meshtastic import tcp_interface
|
||||||
|
from pubsub import pub
|
||||||
|
|
||||||
|
content = " ".join(f"word{n}" for n in range(60)) # well over 180 chars -> chunks
|
||||||
|
received = []
|
||||||
|
|
||||||
|
def _on_receive(packet, interface):
|
||||||
|
decoded = packet.get("decoded", {}) or {}
|
||||||
|
text = decoded.get("text", "")
|
||||||
|
if text:
|
||||||
|
received.append(text)
|
||||||
|
|
||||||
|
peer = tcp_interface.TCPInterface(hostname=E2E_HOST, portNumber=NODE1_PORT)
|
||||||
|
try:
|
||||||
|
time.sleep(RADIO_SETTLE_S)
|
||||||
|
pub.subscribe(_on_receive, "meshtastic.receive.text")
|
||||||
|
|
||||||
|
async def _send():
|
||||||
|
result = await node0.send("channel_e2e", content)
|
||||||
|
assert result.success, f"adapter.send failed: {result.error}"
|
||||||
|
|
||||||
|
_run_in_loop(loop, _send(), timeout_s=60)
|
||||||
|
|
||||||
|
def _all_chunks_arrived():
|
||||||
|
# Adapter frames multi-part sends as "(i/n) <chunk>"; the final
|
||||||
|
# chunk carries the message tail.
|
||||||
|
return any(str(r).rstrip().endswith("word59") for r in received)
|
||||||
|
|
||||||
|
_wait_for(_all_chunks_arrived, timeout_s=45, what="chunked outbound send at peer")
|
||||||
|
finally:
|
||||||
|
pub.unsubscribe(_on_receive, "meshtastic.receive.text")
|
||||||
|
peer.close()
|
||||||
@@ -0,0 +1,133 @@
|
|||||||
|
# Meshtasticator e2e — radio-level validation for hermes-meshtastic
|
||||||
|
|
||||||
|
This directory is the **radio-level counterpart** to the contract suite
|
||||||
|
(`plugin/tests/contract`). The contract suite guarantees the adapter matches
|
||||||
|
the Hermes gateway API; it cannot prove the adapter actually talks to a
|
||||||
|
Meshtastic node. These e2e tests boot the
|
||||||
|
[Meshtasticator](https://meshtastic.org/docs/software/meshtasticator/)
|
||||||
|
interactive simulator — which runs the **real MeshtasticD device software**
|
||||||
|
per node with a simulated LoRa PHY — and drive the adapter against a live
|
||||||
|
simulated node.
|
||||||
|
|
||||||
|
| Layer | Validated by |
|
||||||
|
|---|---|
|
||||||
|
| Adapter ↔ Hermes gateway API | `plugin/tests/contract` (no deployment) |
|
||||||
|
| Adapter ↔ real MeshtasticD TCP/protobuf session | **this suite** |
|
||||||
|
| Inbound text across the (simulated) LoRa mesh | **this suite** |
|
||||||
|
| Outbound chunked sends arriving at another node | **this suite** |
|
||||||
|
| True RF (silicon LoRa, real propagation, duty cycle) | physical radio only |
|
||||||
|
|
||||||
|
## Layout
|
||||||
|
|
||||||
|
```
|
||||||
|
scripts/meshtasticator_e2e/
|
||||||
|
run_e2e.sh orchestrator: boots N nodes, runs pytest, tears down
|
||||||
|
tcp_forward.py localhost->daemon TCP forward (remote docker daemons)
|
||||||
|
README.md this file
|
||||||
|
plugin/tests/e2e/
|
||||||
|
test_meshtasticator_e2e.py the e2e assertions (skip-gated)
|
||||||
|
.gitea/workflows/
|
||||||
|
meshtasticator-e2e.yaml on-demand CI job (docker-enabled runner)
|
||||||
|
```
|
||||||
|
|
||||||
|
## Prerequisites
|
||||||
|
|
||||||
|
* **uv** + Python 3.13.
|
||||||
|
* A contract venv with the real gateway **and** the plugin (with deps) installed:
|
||||||
|
```bash
|
||||||
|
scripts/contract-test.sh # creates plugin/.venv-contract (hermes-agent pinned)
|
||||||
|
uv pip install --python plugin/.venv-contract/bin/python -e plugin
|
||||||
|
```
|
||||||
|
(`-e plugin` installs the meshtastic client library the tests also use.)
|
||||||
|
* A clone of Meshtasticator: `git clone https://github.com/meshtastic/meshtasticator`
|
||||||
|
* Runtime for the simulator — pick one:
|
||||||
|
* **Docker** (simplest, works on macOS/Windows): the simulator pulls the
|
||||||
|
`meshtastic/meshtasticd` image on first run (slow once). Node TCP API ports
|
||||||
|
are published on your docker host's localhost, which is what the simulator
|
||||||
|
itself expects.
|
||||||
|
* **Linux native**: build MeshtasticD's `native` PlatformIO target and pass
|
||||||
|
the build dir with `--program`.
|
||||||
|
* Optional but recommended: an isolated simulator venv, because Meshtasticator
|
||||||
|
pins old client libs (`meshtastic~=2.6.1` in its requirements.txt):
|
||||||
|
```bash
|
||||||
|
uv venv --python 3.13 /tmp/sim-venv
|
||||||
|
uv pip install --python /tmp/sim-venv/bin/python \
|
||||||
|
-r <meshtasticator>/requirements.txt docker
|
||||||
|
export SIM_VENV=/tmp/sim-venv # else the script uses plain `python3`
|
||||||
|
```
|
||||||
|
|
||||||
|
## Run
|
||||||
|
|
||||||
|
```bash
|
||||||
|
# Docker mode (default)
|
||||||
|
MESHTASTICATOR_DIR=/path/to/meshtasticator \
|
||||||
|
scripts/meshtasticator_e2e/run_e2e.sh
|
||||||
|
|
||||||
|
# Linux native mode
|
||||||
|
MESHTASTICATOR_DIR=/path/to/meshtasticator \
|
||||||
|
scripts/meshtasticator_e2e/run_e2e.sh \
|
||||||
|
--mode native --program /path/to/firmware/.pio/build/native
|
||||||
|
|
||||||
|
# Tune the scenario
|
||||||
|
... --nodes 3 --channel-index 0 --host 127.0.0.1
|
||||||
|
```
|
||||||
|
|
||||||
|
The orchestrator boots the simulator, waits until `N` node TCP API ports accept
|
||||||
|
connections (Meshtasticator assigns node *n* → port `4404 + n`), then runs
|
||||||
|
`pytest plugin/tests/e2e` with `MESHTASTICATOR_E2E=1`. Simulator output lands in
|
||||||
|
`meshtasticator-sim.log` at the repo root.
|
||||||
|
|
||||||
|
**Remote docker daemon** (`DOCKER_HOST=tcp://host:2375`): the simulator's own
|
||||||
|
control connections assume nodes listen on localhost, so the script starts a
|
||||||
|
`tcp_forward.py` per node port (localhost → daemon host) before booting the
|
||||||
|
simulator. Nothing is forwarded when the daemon is local (unset/unix
|
||||||
|
`DOCKER_HOST`).
|
||||||
|
|
||||||
|
Without `MESHTASTICATOR_E2E=1` the e2e module skips, so ordinary unit/CI runs
|
||||||
|
stay fast and gateway-free.
|
||||||
|
|
||||||
|
## CI
|
||||||
|
|
||||||
|
`.gitea/workflows/meshtasticator-e2e.yaml` runs the whole flow on a
|
||||||
|
docker-enabled runner (on demand via `workflow_dispatch` until validated, then
|
||||||
|
flip on the commented `pull_request` trigger): it builds the Hermes contract
|
||||||
|
env (pinned like `release.yaml`), installs the plugin with deps, clones
|
||||||
|
Meshtasticator at a pinned commit, installs the simulator's own requirements in
|
||||||
|
an isolated venv, and calls `run_e2e.sh --mode docker`. Simulator logs print on
|
||||||
|
failure. Only one e2e run at a time (the sim hardcodes the `Meshtastic`
|
||||||
|
container/volume name on the shared daemon).
|
||||||
|
|
||||||
|
## What the tests do
|
||||||
|
|
||||||
|
1. **Inbound**: peer node 1 broadcasts text; the adapter (connected to node 0)
|
||||||
|
must receive it as a real gateway `MessageEvent` (`host/port/channel_index`
|
||||||
|
come from `E2E_PORTS`/`E2E_HOST`/`E2E_CHANNEL_INDEX`).
|
||||||
|
2. **Outbound**: the adapter sends a >180-char message; it must be chunked and
|
||||||
|
the final chunk (`(i/n) … word59`) must arrive at peer node 1.
|
||||||
|
|
||||||
|
A `_ProbeAdapter` subclass records inbound events instead of dispatching to a
|
||||||
|
Hermes agent handler (no agent runs in these tests; dispatch is already covered
|
||||||
|
by the contract suite).
|
||||||
|
|
||||||
|
## Status / open items (v1 scaffold)
|
||||||
|
|
||||||
|
This is an initial, structurally validated scaffold. A full green run still
|
||||||
|
needs to happen on a Linux/Docker host with a MeshtasticD build, and these
|
||||||
|
items are expected to need iteration there:
|
||||||
|
|
||||||
|
* **Node adjacency**: the simulator's default random placement may put nodes out
|
||||||
|
of range. For deterministic tests, seed close-together coordinates (the sim
|
||||||
|
supports `--from-file` with an `out/nodeConfig.yaml`).
|
||||||
|
* **Channel semantics**: tests default to channel index 0 (stock primary
|
||||||
|
channel). Mirroring production (channel 1 / private channel) requires
|
||||||
|
configuring matching channels on the simulated nodes.
|
||||||
|
* **Reconnect flow**: killing/restarting a single simulated node needs per-node
|
||||||
|
lifecycle control (native mode subprocesses; docker mode currently runs all
|
||||||
|
nodes in one container), so the adapter's watchdog reconnect is **not** yet
|
||||||
|
exercised here. See the watchdog unit coverage in the adapter for now.
|
||||||
|
* **CI validation run**: `.gitea/workflows/meshtasticator-e2e.yaml` is drafted
|
||||||
|
and on-demand only; it still needs a first green run on the docker-enabled
|
||||||
|
runner (topology assumptions: docker reachable from the job, node ports on
|
||||||
|
the job's localhost via the automatic tcp forwards). Trigger it via
|
||||||
|
`workflow_dispatch`, watch the sim log step, and only then enable the
|
||||||
|
`pull_request` trigger.
|
||||||
@@ -0,0 +1,175 @@
|
|||||||
|
#!/usr/bin/env bash
|
||||||
|
# Boot N Meshtasticator nodes and run the plugin's radio-level e2e tests
|
||||||
|
# (plugin/tests/e2e) against node 0.
|
||||||
|
#
|
||||||
|
# Meshtasticator's interactive simulator (https://meshtastic.org/docs/software/meshtasticator/)
|
||||||
|
# runs the real MeshtasticD device software per node and simulates the LoRa
|
||||||
|
# PHY, so these tests exercise the adapter's real TCP/protobuf session,
|
||||||
|
# inbound/outbound text flow across the simulated mesh, and chunked sends —
|
||||||
|
# without physical radios. It cannot validate silicon-level RF.
|
||||||
|
#
|
||||||
|
# Prerequisites
|
||||||
|
# * Linux host, OR Docker (macOS/Windows): the simulator auto-falls back to
|
||||||
|
# Docker on non-Linux and can build MeshtasticD itself (`-d`).
|
||||||
|
# * Native Linux mode: build MeshtasticD's 'native' target (PlatformIO,
|
||||||
|
# select 'native') and pass --program <dir containing binary 'program'>.
|
||||||
|
# * uv + python 3.13 for the contract venv (plugin/.venv-contract).
|
||||||
|
#
|
||||||
|
# Docker on a remote daemon: if DOCKER_HOST points at a tcp:// daemon, the
|
||||||
|
# simulator's own control connections assume nodes listen on localhost, so
|
||||||
|
# this script starts lightweight localhost->daemon TCP forwarders for the node
|
||||||
|
# ports first (scripts/meshtasticator_e2e/tcp_forward.py). Nothing is
|
||||||
|
# forwarded when the daemon is local (unset/unix DOCKER_HOST).
|
||||||
|
#
|
||||||
|
# Usage
|
||||||
|
# MESHTASTICATOR_DIR=/path/to/meshtasticator scripts/meshtasticator_e2e/run_e2e.sh
|
||||||
|
# # docker mode (default): ... run_e2e.sh --mode docker
|
||||||
|
# # native mode: ... run_e2e.sh --mode native --program /path/to/firmware/.pio/build/native
|
||||||
|
# # node count / channel: ... run_e2e.sh --nodes 3 --channel-index 0
|
||||||
|
#
|
||||||
|
# Environment
|
||||||
|
# MESHTASTICATOR_DIR path to a clone of github.com/meshtastic/meshtasticator
|
||||||
|
# E2E_VENV python env with hermes-agent + plugin deps installed
|
||||||
|
# (default: plugin/.venv-contract — see scripts/contract-test.sh,
|
||||||
|
# then `uv pip install --python plugin/.venv-contract/bin/python -e plugin`)
|
||||||
|
# SIM_VENV optional python env holding the simulator's deps
|
||||||
|
# (meshtasticator/requirements.txt + `pip install docker`);
|
||||||
|
# defaults to plain `python3`.
|
||||||
|
set -euo pipefail
|
||||||
|
|
||||||
|
REPO_ROOT="$(cd "$(dirname "${BASH_SOURCE[0]}")/../.." && pwd)"
|
||||||
|
SIM_DIR="${MESHTASTICATOR_DIR:?set MESHTASTICATOR_DIR to a meshtasticator clone}"
|
||||||
|
NODES=3
|
||||||
|
MODE=docker
|
||||||
|
PROGRAM=""
|
||||||
|
CHANNEL_INDEX=0
|
||||||
|
HOST=127.0.0.1
|
||||||
|
VENV="${E2E_VENV:-$REPO_ROOT/plugin/.venv-contract}"
|
||||||
|
if [ -n "${SIM_VENV:-}" ]; then
|
||||||
|
SIM_PYTHON="$SIM_VENV/bin/python"
|
||||||
|
else
|
||||||
|
SIM_PYTHON="${SIM_PYTHON:-python3}"
|
||||||
|
fi
|
||||||
|
|
||||||
|
while [ $# -gt 0 ]; do
|
||||||
|
case "$1" in
|
||||||
|
--nodes) NODES="$2"; shift 2 ;;
|
||||||
|
--mode) MODE="$2"; shift 2 ;;
|
||||||
|
--program) PROGRAM="$2"; shift 2 ;;
|
||||||
|
--channel-index) CHANNEL_INDEX="$2"; shift 2 ;;
|
||||||
|
--host) HOST="$2"; shift 2 ;;
|
||||||
|
*) echo "unknown arg: $1" >&2; exit 2 ;;
|
||||||
|
esac
|
||||||
|
done
|
||||||
|
|
||||||
|
command -v uv >/dev/null 2>&1 || { echo "uv required" >&2; exit 1; }
|
||||||
|
[ -d "$SIM_DIR" ] || { echo "meshtasticator not found at $SIM_DIR" >&2; exit 1; }
|
||||||
|
[ -x "$VENV/bin/python" ] || { echo "e2e venv missing at $VENV (see scripts/contract-test.sh)" >&2; exit 1; }
|
||||||
|
|
||||||
|
export MPLBACKEND=Agg # headless matplotlib (no display needed)
|
||||||
|
|
||||||
|
# ---------------------------------------------------------------------------
|
||||||
|
# Remote-daemon port forwarding: Meshtasticator talks to nodes on localhost.
|
||||||
|
# ---------------------------------------------------------------------------
|
||||||
|
DOCKER_TARGET=""
|
||||||
|
if [[ "${DOCKER_HOST:-}" == tcp://* ]]; then
|
||||||
|
DOCKER_TARGET="${DOCKER_HOST#tcp://}"
|
||||||
|
DOCKER_TARGET="${DOCKER_TARGET%%:*}"
|
||||||
|
if [ "$DOCKER_TARGET" = "127.0.0.1" ] || [ "$DOCKER_TARGET" = "localhost" ]; then
|
||||||
|
DOCKER_TARGET=""
|
||||||
|
fi
|
||||||
|
fi
|
||||||
|
FWD_PIDS=()
|
||||||
|
PORT_BASE=4404 # matches meshtasticator lib/interactive.py TCP_PORT_OFFSET
|
||||||
|
|
||||||
|
start_forwards() {
|
||||||
|
for ((i = 0; i < NODES; i++)); do
|
||||||
|
port=$((PORT_BASE + i))
|
||||||
|
"$VENV/bin/python" "$REPO_ROOT/scripts/meshtasticator_e2e/tcp_forward.py" \
|
||||||
|
--listen "127.0.0.1:$port" --target "$DOCKER_TARGET:$port" >/dev/null 2>&1 &
|
||||||
|
FWD_PIDS+=("$!")
|
||||||
|
done
|
||||||
|
sleep 1
|
||||||
|
}
|
||||||
|
|
||||||
|
SIM_LOG="$REPO_ROOT/meshtasticator-sim.log"
|
||||||
|
SIM_ARGS=("$NODES")
|
||||||
|
if [ "$MODE" = native ]; then
|
||||||
|
[ -n "$PROGRAM" ] && [ -d "$PROGRAM" ] || { echo "--mode native needs --program <dir>" >&2; exit 2; }
|
||||||
|
SIM_ARGS+=(-p "$PROGRAM")
|
||||||
|
else
|
||||||
|
SIM_ARGS+=(-d)
|
||||||
|
fi
|
||||||
|
|
||||||
|
if [ -n "$DOCKER_TARGET" ]; then
|
||||||
|
echo "== remote docker daemon detected ($DOCKER_TARGET): starting localhost port forwards =="
|
||||||
|
start_forwards
|
||||||
|
fi
|
||||||
|
|
||||||
|
echo "== booting Meshtasticator ($MODE) with $NODES node(s) from $SIM_DIR =="
|
||||||
|
(
|
||||||
|
cd "$SIM_DIR"
|
||||||
|
"$SIM_PYTHON" interactiveSim.py "${SIM_ARGS[@]}" >"$SIM_LOG" 2>&1
|
||||||
|
) &
|
||||||
|
SIM_PID=$!
|
||||||
|
|
||||||
|
cleanup() {
|
||||||
|
echo "== tearing down simulator (pid $SIM_PID) =="
|
||||||
|
kill "$SIM_PID" 2>/dev/null || true
|
||||||
|
wait "$SIM_PID" 2>/dev/null || true
|
||||||
|
for pid in "${FWD_PIDS[@]:-}"; do
|
||||||
|
kill "$pid" 2>/dev/null || true
|
||||||
|
done
|
||||||
|
if [ "$MODE" = docker ]; then
|
||||||
|
# The sim names its container/volume (auto_remove only fires on stop).
|
||||||
|
docker rm -f Meshtastic >/dev/null 2>&1 || true
|
||||||
|
docker volume rm Meshtasticator >/dev/null 2>&1 || true
|
||||||
|
fi
|
||||||
|
}
|
||||||
|
trap cleanup EXIT
|
||||||
|
|
||||||
|
echo "== waiting for $NODES node TCP API port(s) to accept connections =="
|
||||||
|
READY=""
|
||||||
|
for _ in $(seq 1 180); do # up to ~5 min: docker pulls meshtastic/meshtasticd on first run
|
||||||
|
READY="$("$VENV/bin/python" - "$HOST" "$NODES" <<'PY' || true
|
||||||
|
import socket, sys
|
||||||
|
host, count = sys.argv[1], int(sys.argv[2])
|
||||||
|
found = []
|
||||||
|
# Meshtasticator assigns node n -> TCP port starting at 4404 (see
|
||||||
|
# lib/interactive.py TCP_PORT_OFFSET); probe a small window to be safe.
|
||||||
|
for port in range(4403, 4403 + 16):
|
||||||
|
try:
|
||||||
|
with socket.create_connection((host, port), timeout=0.5):
|
||||||
|
found.append(port)
|
||||||
|
except OSError:
|
||||||
|
pass
|
||||||
|
if len(found) >= count:
|
||||||
|
break
|
||||||
|
print(",".join(map(str, found[:count])))
|
||||||
|
PY
|
||||||
|
)"
|
||||||
|
if [ -n "$READY" ]; then
|
||||||
|
break
|
||||||
|
fi
|
||||||
|
sleep 2
|
||||||
|
done
|
||||||
|
if [ -z "$READY" ]; then
|
||||||
|
echo "error: no Meshtasticator node ports became reachable on $HOST (see $SIM_LOG)" >&2
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
|
echo " node ports: $READY"
|
||||||
|
|
||||||
|
# Ports accept before the node firmware finished booting inside the container;
|
||||||
|
# give meshtasticd a moment to open its TCP API for real.
|
||||||
|
echo "== settling (node firmware boot) =="
|
||||||
|
sleep 15
|
||||||
|
|
||||||
|
echo "== running radio-level e2e tests =="
|
||||||
|
(
|
||||||
|
cd "$REPO_ROOT"
|
||||||
|
MESHTASTICATOR_E2E=1 \
|
||||||
|
E2E_HOST="$HOST" \
|
||||||
|
E2E_PORTS="$READY" \
|
||||||
|
E2E_CHANNEL_INDEX="$CHANNEL_INDEX" \
|
||||||
|
"$VENV/bin/python" -m pytest plugin/tests/e2e -q "$@"
|
||||||
|
)
|
||||||
@@ -0,0 +1,70 @@
|
|||||||
|
#!/usr/bin/env python3
|
||||||
|
"""Minimal TCP forwarder used by run_e2e.sh when the Docker daemon is remote.
|
||||||
|
|
||||||
|
Meshtasticator's interactive simulator always connects to its simulated nodes
|
||||||
|
at localhost:<port> (lib/interactive.py init_communication). On a Gitea
|
||||||
|
Actions runner whose Docker daemon is remote (e.g. DOCKER_HOST=tcp://docker.local:2375)
|
||||||
|
the container-published node ports live on the *daemon* host, not the job's
|
||||||
|
localhost — so we bind 127.0.0.1:<port> in the job and forward to the daemon
|
||||||
|
host, restoring the localhost view the simulator (and our e2e tests) expect.
|
||||||
|
|
||||||
|
Usage: tcp_forward.py --listen 127.0.0.1:4404 --target docker.local:4404
|
||||||
|
"""
|
||||||
|
|
||||||
|
import argparse
|
||||||
|
import socket
|
||||||
|
import threading
|
||||||
|
|
||||||
|
|
||||||
|
def _forward(src: socket.socket, dst: socket.socket):
|
||||||
|
try:
|
||||||
|
while True:
|
||||||
|
data = src.recv(65536)
|
||||||
|
if not data:
|
||||||
|
break
|
||||||
|
dst.sendall(data)
|
||||||
|
except OSError:
|
||||||
|
pass
|
||||||
|
finally:
|
||||||
|
try:
|
||||||
|
dst.shutdown(socket.SHUT_WR)
|
||||||
|
except OSError:
|
||||||
|
pass
|
||||||
|
|
||||||
|
|
||||||
|
def _handle(client: socket.socket, target_addr):
|
||||||
|
try:
|
||||||
|
upstream = socket.create_connection(target_addr, timeout=10)
|
||||||
|
except OSError:
|
||||||
|
client.close()
|
||||||
|
return
|
||||||
|
t = threading.Thread(target=_forward, args=(client, upstream), daemon=True)
|
||||||
|
t.start()
|
||||||
|
_forward(upstream, client)
|
||||||
|
client.close()
|
||||||
|
upstream.close()
|
||||||
|
|
||||||
|
|
||||||
|
def main():
|
||||||
|
ap = argparse.ArgumentParser(description=__doc__)
|
||||||
|
ap.add_argument("--listen", required=True, help="local bind, e.g. 127.0.0.1:4404")
|
||||||
|
ap.add_argument("--target", required=True, help="forward target, e.g. docker.local:4404")
|
||||||
|
args = ap.parse_args()
|
||||||
|
|
||||||
|
lhost, lport = args.listen.rsplit(":", 1)
|
||||||
|
thost, tport = args.target.rsplit(":", 1)
|
||||||
|
target_addr = (thost, int(tport))
|
||||||
|
|
||||||
|
listener = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
|
||||||
|
listener.setsockopt(socket.SOL_SOCKET, socket.SO_REUSEADDR, 1)
|
||||||
|
listener.bind((lhost, int(lport)))
|
||||||
|
listener.listen(16)
|
||||||
|
print(f"forwarding {args.listen} -> {args.target}", flush=True)
|
||||||
|
|
||||||
|
while True:
|
||||||
|
client, _ = listener.accept()
|
||||||
|
threading.Thread(target=_handle, args=(client, target_addr), daemon=True).start()
|
||||||
|
|
||||||
|
|
||||||
|
if __name__ == "__main__":
|
||||||
|
main()
|
||||||
Reference in New Issue
Block a user