Test Partial Message in interop tester

.github/workflows/gossipsub-interop-pr.yml

@@ -0,0 +1,62 @@
+name: Gossipsub Interoperability Tests (PR)
+
+on:
+  pull_request:
+    paths:
+      - 'gossipsub-interop/**'
+      - '.github/workflows/gossipsub-interop-pr.yml'
+  workflow_dispatch:
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  test:
+    runs-on: ubuntu-22.04
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Set up Go
+        uses: actions/setup-go@v5
+        with:
+          go-version-file: gossipsub-interop/go-libp2p/go.mod
+          cache: true
+
+      - name: Set up Rust
+        uses: dtolnay/rust-toolchain@stable
+
+      - name: Install uv
+        run: |
+          curl -LsSf https://astral.sh/uv/install.sh | sh
+          echo "$HOME/.local/bin" >> $GITHUB_PATH
+
+      - name: Install Shadow simulator
+        run: |
+          # Install Shadow dependencies
+          sudo apt-get update
+          sudo apt-get install -y \
+            cmake \
+            findutils \
+            libclang-dev \
+            libc-dbg \
+            libglib2.0-0 \
+            libglib2.0-dev \
+            make \
+            netbase \
+            python3 \
+            python3-networkx \
+            xz-utils
+
+          # Build and install Shadow v3.3.0 from source
+          git clone --depth 1 --branch v3.3.0 https://github.com/shadow/shadow.git shadow-simulator
+          cd shadow-simulator
+          git checkout v3.3.0
+          ./setup build --clean
+          ./setup install
+          echo "$HOME/.local/bin" >> $GITHUB_PATH
+
+      - name: Run gossipsub interop tests
+        working-directory: gossipsub-interop
+        run: make test

gossipsub-interop/.gitignore

@@ -1,5 +1,7 @@
 *.swp
 /shadow.data
+shadow-outputs/*
+latest
 synctest*.data
 /shadow.yaml
 /graph.gml

gossipsub-interop/Makefile

@@ -7,7 +7,46 @@ binaries:
 
 # Clean all generated shadow simulation files
 clean:
-	rm -rf *.data || true
+	rm -rf shadow-outputs || true
 	rm plots/* || true
 
-.PHONY: binaries all clean
+test:
+	# Testing partial messages
+	@echo "Testing partial messages"
+	@uv run run.py --node_count 32 --composition "rust-and-go" --scenario "partial-messages" && uv run checks/partial_messages.py latest --count 1
+
+	@echo "Testing partial messages chain"
+	@uv run run.py --node_count 8 --composition "rust-and-go" --scenario "partial-messages-chain" && uv run checks/partial_messages.py latest --count 16
+
+	@echo "Testing fanout"
+	uv run run.py --node_count 8 --composition "rust-and-go" --scenario "partial-messages-fanout" && uv run checks/partial_messages.py latest/
+	uv run run.py --node_count 8 --seed 1 --composition "rust-and-go" --scenario "partial-messages-fanout" && uv run checks/partial_messages.py latest/
+	uv run run.py --node_count 8 --seed 2 --composition "rust-and-go" --scenario "partial-messages-fanout" && uv run checks/partial_messages.py latest/
+	uv run run.py --node_count 8 --seed 3 --composition "rust-and-go" --scenario "partial-messages-fanout" && uv run checks/partial_messages.py latest/
+
+test-go:
+	# Testing partial messages
+	@echo "Testing partial messages"
+	@uv run run.py --node_count 8 --composition "all-go" --scenario "partial-messages" && uv run checks/partial_messages.py latest --count 1
+
+	@echo "Testing partial messages chain"
+	@uv run run.py --node_count 8 --composition "all-go" --scenario "partial-messages-chain" && uv run checks/partial_messages.py latest --count 16
+
+	@echo "Testing fanout"
+	@uv run run.py --node_count 2 --composition "all-go" --scenario "partial-messages-fanout" && uv run checks/partial_messages.py latest/
+
+
+test-rust-only:
+	# Testing partial messages
+	@echo "Testing partial messages"
+	@uv run run.py --node_count 8 --composition "all-rust" --scenario "partial-messages" && uv run checks/partial_messages.py latest --count 1
+
+	@echo "Testing partial messages chain"
+	@uv run run.py --node_count 8 --composition "all-rust" --scenario "partial-messages-chain" && uv run checks/partial_messages.py latest --count 16
+
+	@echo "Testing fanout"
+	@uv run run.py --node_count 2 --composition "all-rust" --scenario "partial-messages-fanout" && uv run checks/partial_messages.py latest/
+
+
+
+.PHONY: binaries all clean test

gossipsub-interop/README.md

@@ -95,6 +95,24 @@ After implementing it, make sure to add build commands in the Makefile's `binari
 
 Finally, add it to the `composition` function in `experiment.py`.
 
+## Examples
+
+Minimal test of partial messages
+
+```bash
+uv run run.py --node_count 2 --composition "all-go" --scenario "partial-messages" && uv run checks/partial_messages.py latest/
+```
+
+That command runs the shadow simulation and then verifies the stdout logs have the expected message.
+
+## Tests
+
+```bash
+make test
+```
+
+This runs various shadow simulations and checks.
+
 ## Future work (contributions welcome)
 
 - Add more scenarios.

gossipsub-interop/checks/partial_messages.py

@@ -0,0 +1,98 @@
+#!/usr/bin/env python3
+"""Verify that each node stdout log contains the expected completion message."""
+
+from __future__ import annotations
+
+import argparse
+import sys
+from pathlib import Path
+
+MESSAGE_SUBSTRING = '"msg":"All parts received"'
+
+
+def parse_args() -> argparse.Namespace:
+    parser = argparse.ArgumentParser(
+        description=(
+            "Validate that every node stdout log inside a Shadow output directory "
+            "contains the expected completion message."
+        )
+    )
+    parser.add_argument(
+        "shadow_output",
+        help="Path to the Shadow output directory (the one containing the hosts/ folder).",
+    )
+    parser.add_argument(
+        "--count",
+        type=int,
+        default=1,
+        help="Minimum number of times each stdout log must contain the target message (default: 1).",
+    )
+    return parser.parse_args()
+
+
+def iter_stdout_logs(hosts_dir: Path):
+    """Yield all stdout log files under the given hosts directory."""
+    for stdout_file in sorted(hosts_dir.rglob("*.stdout")):
+        if stdout_file.is_file():
+            yield stdout_file
+
+
+def count_occurrences(path: Path, needle: str) -> int:
+    """Count how many times the string appears inside the file."""
+    if not needle:
+        return 0
+    total = 0
+    with path.open("r", encoding="utf-8", errors="replace") as handle:
+        for line in handle:
+            total += line.count(needle)
+    return total
+
+
+def main() -> int:
+    args = parse_args()
+    base_dir = Path(args.shadow_output).expanduser().resolve()
+    if not base_dir.exists():
+        print(f"shadow output directory does not exist: {base_dir}", file=sys.stderr)
+        return 1
+
+    hosts_dir = base_dir / "hosts"
+    if not hosts_dir.is_dir():
+        print(f"hosts directory not found under: {base_dir}", file=sys.stderr)
+        return 1
+
+    stdout_logs = list(iter_stdout_logs(hosts_dir))
+    if not stdout_logs:
+        print(f"no stdout logs found under: {hosts_dir}", file=sys.stderr)
+        return 1
+
+    missing = []
+    for log_path in stdout_logs:
+        occurrences = count_occurrences(log_path, MESSAGE_SUBSTRING)
+        if occurrences < args.count:
+            missing.append((log_path, occurrences))
+
+    if missing:
+        print(
+            "The following stdout logs do not contain the required message:",
+            file=sys.stderr,
+        )
+        for log_path, occurrences in missing:
+            rel_path = log_path.relative_to(base_dir)
+            print(
+                f"  - {rel_path}: found {occurrences} occurrences (expected >= {args.count})",
+                file=sys.stderr,
+            )
+        print(
+            f"{len(missing)} / {len(stdout_logs)} logs missing the message.",
+            file=sys.stderr,
+        )
+        return 1
+
+    print(
+        f"All {len(stdout_logs)} stdout logs under {hosts_dir} contain the required message."
+    )
+    return 0
+
+
+if __name__ == "__main__":
+    sys.exit(main())