From 45dcb9a71f991ce465d3a710ee7bfece91666e17 Mon Sep 17 00:00:00 2001 From: Martino Ferrari Date: Wed, 1 Jul 2026 22:05:29 +0200 Subject: [PATCH] docs: fix remaining dangling references to retired run_e2e_test.sh README.md and Docs/StreamHub-Developer.md still pointed at the deleted run_e2e_test.sh / Test/E2E/streamhub Go client after their removal in the previous commit; repoint at Test/E2E/suite/run_e2e.sh. --- Docs/StreamHub-Developer.md | 24 ++++++++++-------------- README.md | 2 +- 2 files changed, 11 insertions(+), 15 deletions(-) diff --git a/Docs/StreamHub-Developer.md b/Docs/StreamHub-Developer.md index d357a86..51c38ce 100644 --- a/Docs/StreamHub-Developer.md +++ b/Docs/StreamHub-Developer.md @@ -199,28 +199,24 @@ make -f Makefile.gcc test # SignalRingBuffer (ReadSince / binary-search ReadRange / wrap), # TriggerEngine FSM, LTTB — sources in Test/Applications/StreamHub/ -./run_e2e_test.sh # full-stack E2E (see below) +cd Test/E2E/suite && ./run_e2e.sh # full-stack E2E (see below) ./run_streamhub.sh -w -g # interactive demo stack ``` ### End-to-end test -`./run_e2e_test.sh` builds everything, launches the demo MARTe2 application -(`Test/Configurations/streamhub_demo.cfg`: 3 UDPStreamers — multicast scalars, -FirstSample/LastSample arrays, FullArray + uint64 ns time array) plus a -StreamHub on port 8095 (with history enabled in `/tmp/streamhub_e2e_history`), -then runs the Go WS client `Test/E2E/streamhub` which verifies: -`sources`/`config` events, ≥10 binary v1 pushes with wall-clock and strictly -monotonic time on all streams, `stats` shape, a `zoom` round-trip (reqId echo, -unicast), `historyInfo` broadcast (enabled, duration, decimation, signal count), -a `historyZoom` round-trip (reqId echo, signal data), and a complete trigger -cycle (setTrigger → arm → binary v2 capture → triggered → disarm). Logs land -in `/tmp/streamhub_e2e_{marte,hub}.log`. Exit 0 iff every check passes. +`Test/E2E/suite/run_e2e.sh` is the unified E2E suite covering the whole +streaming + debug chain (`chain`/`direct`/`recorder`/`debug`/`tcplogger` +scenario kinds, see `Test/E2E/suite/scenarios.py`), including StreamHub live +push, zoom, window and trigger checks via the Go `chain-client`. It builds +everything, runs the scenario matrix plus the stress matrix, and produces a +consolidated `report_data.json` + Typst PDF report +(`Test/E2E/suite/E2E_Report.typ`). See the script's `--help` for options. When changing the WS protocol, update **in lockstep**: this hub, the Go hub (`Common/Client/go/wshub`), the browser SPA (`Client/udpstreamer/static`), the -ImGui client (`Client/streamhub/Protocol.cpp`), the E2E client -(`Test/E2E/streamhub`), and [StreamHub-API.md](StreamHub-API.md). +ImGui client (`Client/streamhub/Protocol.cpp`), the E2E `chain-client` +(`Test/E2E/suite/client`), and [StreamHub-API.md](StreamHub-API.md). ## 8. Gotchas diff --git a/README.md b/README.md index 754477d..8216563 100644 --- a/README.md +++ b/README.md @@ -108,7 +108,7 @@ UDPStreamer sources and serves them to oscilloscope clients over WebSocket hub-side trigger engine, per-window zoom. Clients: browser SPA (`Client/webui` + `Client/udpstreamer/static`) and native ImGui desktop client (`Client/streamhub`). Demo: `./run_streamhub.sh -w -g`; E2E test: -`./run_e2e_test.sh`. +`Test/E2E/suite/run_e2e.sh`. See `Docs/StreamHub-UserGuide.md`, `Docs/StreamHub-API.md` and `Docs/StreamHub-Developer.md`.