smoke: deterministic transport smoke suite (c5) (#85)

* feat(smoke): add deterministic cross-transport smoke suite

Introduce the transport-smoke-suite matrix/scenario runner with file-backed scenario claims, smoke CI workflow integration, and deterministic readiness controls in example-streamer-uses binaries/docs while finalizing workspace log-to-tracing migration. This boundary keeps smoke orchestration and fixture-backed contract validation isolated from architecture and benchmark changes.

Key review files: utils/transport-smoke-suite/src/scenario.rs, utils/transport-smoke-suite/src/claims.rs, utils/transport-smoke-suite/src/bin/transport-smoke-matrix.rs, .github/workflows/transport-smoke-capstone.yaml, example-streamer-uses/src/bin/*, example-streamer-uses/Cargo.toml, Cargo.toml, README.md.

Mechanical vs behavioral: combines mechanical dependency/config migration with behavioral smoke determinism and readiness signaling; fixture files are intentionally separate from runner/claims logic for review focus.

* refactor: apply up-rust feedback sweep to smoke delta

Author: PLeVasseur

.gitattributes

@@ -0,0 +1,2 @@
+utils/transport-smoke-suite/tests/fixtures/** linguist-generated=true
+utils/transport-smoke-suite/claims/** linguist-generated=true

.github/workflows/transport-smoke-capstone.yaml

@@ -0,0 +1,82 @@
+# ********************************************************************************
+#  Copyright (c) 2026 Contributors to the Eclipse Foundation
+#
+#  See the NOTICE file(s) distributed with this work for additional
+#  information regarding copyright ownership.
+#
+#  This program and the accompanying materials are made available under the
+#  terms of the Apache License Version 2.0 which is available at
+#  https://www.apache.org/licenses/LICENSE-2.0
+#
+#  SPDX-License-Identifier: Apache-2.0
+# *******************************************************************************/
+
+name: Transport Smoke Capstone
+
+on:
+  workflow_dispatch:
+  schedule:
+    - cron: "0 3 * * *"
+
+concurrency:
+  group: transport-smoke-capstone
+  cancel-in-progress: false
+
+jobs:
+  mqtt-smoke:
+    name: MQTT transport smoke matrix
+    runs-on: ubuntu-22.04
+    timeout-minutes: 45
+
+    steps:
+      - uses: actions/checkout@v4
+      - uses: dtolnay/rust-toolchain@stable
+
+      - name: Install dependencies
+        run: sudo apt-get update && sudo apt-get install -y build-essential cmake libboost-all-dev libclang-dev pkg-config libssl-dev
+
+      - name: Run MQTT scenario subset
+        run: |
+          cargo run -p transport-smoke-suite --bin transport-smoke-matrix -- \
+            --only smoke-zenoh-mqtt-rr-zenoh-client-mqtt-service \
+            --only smoke-zenoh-mqtt-rr-mqtt-client-zenoh-service \
+            --only smoke-zenoh-mqtt-ps-zenoh-publisher-mqtt-subscriber \
+            --only smoke-zenoh-mqtt-ps-mqtt-publisher-zenoh-subscriber \
+            --artifacts-root target/transport-smoke/ci-mqtt
+
+      - name: Upload MQTT artifacts
+        if: always()
+        uses: actions/upload-artifact@v4
+        with:
+          name: transport-smoke-mqtt
+          path: target/transport-smoke/ci-mqtt
+          retention-days: 14
+
+  someip-smoke:
+    name: SOME/IP transport smoke matrix
+    runs-on: ubuntu-22.04
+    timeout-minutes: 60
+
+    steps:
+      - uses: actions/checkout@v4
+      - uses: dtolnay/rust-toolchain@stable
+
+      - name: Install dependencies
+        run: sudo apt-get update && sudo apt-get install -y build-essential cmake libboost-all-dev libclang-dev pkg-config libssl-dev
+
+      - name: Run SOME/IP scenario subset (bundled profile)
+        run: |
+          cargo run -p transport-smoke-suite --bin transport-smoke-matrix -- \
+            --only smoke-zenoh-someip-rr-zenoh-client-someip-service \
+            --only smoke-zenoh-someip-rr-someip-client-zenoh-service \
+            --only smoke-zenoh-someip-ps-zenoh-publisher-someip-subscriber \
+            --only smoke-zenoh-someip-ps-someip-publisher-zenoh-subscriber \
+            --artifacts-root target/transport-smoke/ci-someip
+
+      - name: Upload SOME/IP artifacts
+        if: always()
+        uses: actions/upload-artifact@v4
+        with:
+          name: transport-smoke-someip
+          path: target/transport-smoke/ci-someip
+          retention-days: 14

Cargo.lock

@@ -17,6 +17,7 @@ members = [
     "utils/integration-test-utils",
     "example-streamer-implementations",
     "utils/criterion-guardrail",
+    "utils/transport-smoke-suite",
     "configurable-streamer",
     "up-linux-streamer-plugin",
     "up-streamer",
@@ -35,10 +36,8 @@ license = "Apache-2.0"
 [workspace.dependencies]
 async-trait = { version = "0.1" }
 clap = { version = "4.5" }
-env_logger = { version = "0.10.1" }
 futures = { version = "0.3.30" }
 lazy_static = { version = "1.5.0" }
-log = { version = "0.4.20" }
 json5 = { version = "0.4.1" }
 serde = { version = "1.0.154", features = ["derive"] }
 serde_json = { version = "1.0.94" }

Cargo.toml

@@ -65,3 +65,103 @@ Please reference the documentation for [vsomeip-sys](https://github.com/eclipse-
 * the build requirements for vsomeip in the linked documentation in the COVESA repo
 * the environment variables which must be set
 
+## Deterministic transport smoke capstone
+
+The workspace includes a deterministic smoke runner crate at `utils/transport-smoke-suite`.
+
+Run all 8 canonical scenarios with one command:
+
+```bash
+cargo run -p transport-smoke-suite --bin transport-smoke-matrix -- --all
+```
+
+Run a single deterministic scenario:
+
+```bash
+cargo run -p transport-smoke-suite --bin smoke-zenoh-mqtt-rr-mqtt-client-zenoh-service -- --send-count 12 --send-interval-ms 1000
+```
+
+Scenario claims are file-backed and loaded strictly from JSON:
+
+- Default claims directory: `utils/transport-smoke-suite/claims/`
+- Default per-scenario file: `utils/transport-smoke-suite/claims/<scenario-id>.json`
+- Missing, malformed, or scenario-id-mismatched claim files fail the run (no in-code fallback)
+
+`--claims-path <path>` behavior for scenario and matrix binaries:
+
+- Omitted: use the default per-scenario file in `utils/transport-smoke-suite/claims/`
+- Directory path: load `<path>/<scenario-id>.json`
+- File path: use that exact file for the selected scenario
+
+Matrix restriction:
+
+- `transport-smoke-matrix` rejects `--claims-path <file>` when multiple scenarios are selected
+- Use a directory override for multi-scenario matrix runs, or `--only <scenario-id>` for a single scenario
+
+Single-scenario custom claims file example:
+
+```bash
+cargo run -p transport-smoke-suite --bin smoke-zenoh-mqtt-rr-mqtt-client-zenoh-service -- --claims-path utils/transport-smoke-suite/tests/fixtures/custom-claims/smoke-zenoh-mqtt-rr-mqtt-client-zenoh-service.json --send-count 12 --send-interval-ms 1000
+```
+
+Matrix custom claims directory example:
+
+```bash
+cargo run -p transport-smoke-suite --bin transport-smoke-matrix -- --all --claims-path utils/transport-smoke-suite/claims
+```
+
+Scenario binaries:
+
+- `smoke-zenoh-mqtt-rr-zenoh-client-mqtt-service`
+- `smoke-zenoh-mqtt-rr-mqtt-client-zenoh-service`
+- `smoke-zenoh-mqtt-ps-zenoh-publisher-mqtt-subscriber`
+- `smoke-zenoh-mqtt-ps-mqtt-publisher-zenoh-subscriber`
+- `smoke-zenoh-someip-rr-zenoh-client-someip-service`
+- `smoke-zenoh-someip-rr-someip-client-zenoh-service`
+- `smoke-zenoh-someip-ps-zenoh-publisher-someip-subscriber`
+- `smoke-zenoh-someip-ps-someip-publisher-zenoh-subscriber`
+
+Default artifacts are written under:
+
+- Scenario run: `target/transport-smoke/<scenario-id>/<timestamp>/`
+- Matrix run: `target/transport-smoke/matrix/<timestamp>/`
+
+Each scenario artifact directory includes:
+
+- `streamer.log`
+- endpoint logs (`client.log`/`service.log`/`publisher.log`/`subscriber.log`)
+- `scenario-report.json`
+- `scenario-report.txt`
+
+Matrix output includes:
+
+- `matrix-summary.json`
+- `matrix-summary.txt`
+
+Failure triage order:
+
+1. preflight (missing tools/config/build prerequisites)
+2. readiness (missing `READY streamer_initialized` or `READY listener_registered`)
+3. claims (required evidence below thresholds or forbidden signatures)
+4. teardown (processes failing to stop cleanly)
+
+Rerun one scenario deterministically:
+
+```bash
+cargo run -p transport-smoke-suite --bin <scenario-id> -- --send-count 12 --send-interval-ms 1000
+```
+
+Rerun only failed scenarios from a prior matrix summary:
+
+```bash
+for s in $(jq -r '.failed_scenarios[].scenario_id' target/transport-smoke/matrix/<timestamp>/matrix-summary.json); do
+  cargo run -p transport-smoke-suite --bin "$s" -- --send-count 12 --send-interval-ms 1000
+done
+```
+
+When filing regressions, include:
+
+- the failing scenario ID(s)
+- the exact repro command
+- `scenario-report.json` and `matrix-summary.json`
+- relevant excerpts from `streamer.log` and endpoint logs

README.md

@@ -77,14 +77,13 @@ mqtt-transport = ["up-transport-mqtt5"]
 async-trait = { workspace = true }
 chrono = { version = "0.4" }
 clap = { version = "4.5.9", features = ["derive"] }
-env_logger = { version = "0.10.2" }
 hello-world-protos = { path = "../utils/hello-world-protos" }
-log = { workspace = true }
 json5 = { workspace = true }
 protobuf = { workspace = true }
 serde = { workspace = true }
 tokio = { workspace = true }
 tracing = { workspace = true }
+tracing-subscriber = { workspace = true }
 up-rust = { workspace = true }
 up-transport-zenoh = { workspace = true, optional = true }
 up-transport-vsomeip = { workspace = true, optional = true }

example-streamer-uses/Cargo.toml

@@ -95,6 +95,15 @@ Transport-specific flags:
 - Zenoh binaries: `--endpoint` (existing behavior, now composed with URI overrides)
 - SOME/IP binaries: `--vsomeip-config` and `--remote-authority`
 
+Deterministic sender controls (active client/publisher binaries only):
+
+- `--send-count <n>`
+  - `0` (default) preserves existing infinite-send behavior
+  - any value `>0` performs a bounded send run and then exits
+- `--send-interval-ms <ms>`
+  - defaults to `1000`
+  - controls delay between sends for bounded and unbounded runs
+
 Running with no extra flags keeps prior behavior (defaults are aligned with previous constants).
 
 ### Numeric formats

example-streamer-uses/README.md

@@ -17,9 +17,9 @@ use clap::Parser;
 use common::cli;
 use common::ServiceResponseListener;
 use hello_world_protos::hello_world_service::HelloRequest;
-use log::info;
 use std::sync::Arc;
 use std::time::Duration;
+use tracing::info;
 use up_rust::{UListener, UMessageBuilder, UStatus, UTransport};
 use up_transport_mqtt5::{Mqtt5Transport, Mqtt5TransportOptions, MqttClientOptions};
 
@@ -67,11 +67,17 @@ struct Args {
     /// MQTT broker URI in host:port format
     #[arg(long, default_value = DEFAULT_BROKER_URI)]
     broker_uri: String,
+    /// Number of requests to send before exiting (0 means run forever)
+    #[arg(long, default_value_t = 0)]
+    send_count: u64,
+    /// Milliseconds to wait between request sends
+    #[arg(long, default_value_t = 1000)]
+    send_interval_ms: u64,
 }
 
 #[tokio::main]
 async fn main() -> Result<(), UStatus> {
-    env_logger::init();
+    let _ = tracing_subscriber::fmt::try_init();
 
     let args = Args::parse();
 
@@ -113,12 +119,18 @@ async fn main() -> Result<(), UStatus> {
         .register_listener(&sink, Some(&source), service_response_listener)
         .await?;
 
-    let mut i = 0;
+    let mut i: u64 = 0;
+    let mut sent_count: u64 = 0;
     loop {
-        tokio::time::sleep(Duration::from_millis(1000)).await;
+        if args.send_count > 0 && sent_count >= args.send_count {
+            info!("Completed bounded send run: sent_count={sent_count}");
+            break;
+        }
+
+        tokio::time::sleep(Duration::from_millis(args.send_interval_ms)).await;
 
         let hello_request = HelloRequest {
-            name: format!("mqtt_client@i={}", i).to_string(),
+            name: format!("mqtt_client@i={}", i),
             ..Default::default()
         };
         i += 1;
@@ -129,5 +141,8 @@ async fn main() -> Result<(), UStatus> {
         info!("Sending Request message:\n{request_msg:?}");
 
         client.send(request_msg).await?;
+        sent_count += 1;
     }
+
+    Ok(())
 }