feat: add hole-punching tests based on mininet

.dockerignore

@@ -1 +1,2 @@
 target
+**/Dockerfile**

.github/workflows/ci.yml

@@ -111,6 +111,26 @@ jobs:
       - name: Run all tests
         run: ./wasm-tests/run-all.sh
 
+  holepunch_tests:
+    name: Run all holepunch tests
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+
+      - uses: dtolnay/rust-toolchain@stable
+
+      - uses: Swatinem/rust-cache@dd05243424bd5c0e585e4b55eb2d7615cdd32f1f # v2.5.1
+
+      - run: sudo apt-get install -y openvswitch-switch
+
+      - run: |
+          cargo build
+          python -m venv ./venv
+          source venv/bin/activate
+          pip install -r requirements.txt
+          sudo ./venv/bin/python ./relay-test.py ../target/debug/relay ../target/debug/hp_client
+        working-directory: ./hole-punching-tests
+
   cross:
     name: Compile on ${{ matrix.target }}
     strategy:

Cargo.toml

@@ -56,6 +56,7 @@ members = [
     "transports/websocket",
     "transports/webtransport-websys",
     "wasm-tests/webtransport-tests",
+    "hole-punching-tests"
 ]
 resolver = "2"
 

hole-punching-tests/.gitignore

@@ -0,0 +1 @@
+venv

hole-punching-tests/Cargo.toml

@@ -0,0 +1,16 @@
+[package]
+name = "hole-punching-tests"
+version = "0.1.0"
+edition = "2021"
+publish = false
+license = "MIT"
+
+[dependencies]
+clap = { version = "4.3.8", features = ["derive", "env"] }
+env_logger = "0.10.0"
+futures = "0.3.28"
+libp2p = { path = "../libp2p", features = ["tokio", "dcutr", "identify", "macros", "noise", "ping", "relay", "tcp", "yamux", "quic"] }
+log = "0.4"
+redis = { version = "0.23.0", default-features = false, features = ["tokio-comp"] }
+tokio = { version = "1.29.1", features = ["full"] }
+anyhow = "1"

hole-punching-tests/Dockerfile

@@ -0,0 +1,24 @@
+# syntax=docker/dockerfile:1.5-labs
+FROM rust:1.72.0 as builder
+
+RUN rustup target add x86_64-unknown-linux-musl
+RUN --mount=type=cache,target=/var/cache/apt apt-get update && apt-get install -y musl-dev musl-tools
+
+# Run with access to the target cache to speed up builds
+WORKDIR /workspace
+ADD . .
+RUN --mount=type=cache,target=./target \
+    --mount=type=cache,target=/usr/local/cargo/registry \
+    cargo build --release --package hole-punching-tests --target x86_64-unknown-linux-musl
+
+RUN --mount=type=cache,target=./target \
+    mv ./target/x86_64-unknown-linux-musl/release/hole-punching-tests /usr/local/bin/hole-punching-tests
+
+FROM alpine:3
+
+ARG DEBIAN_FRONTEND=noninteractive
+RUN --mount=type=cache,target=/var/cache/apk apk add nftables
+
+COPY --from=builder /usr/local/bin/hole-punching-tests /usr/bin/hole-punching-tests
+
+ENV RUST_BACKTRACE=1

hole-punching-tests/docker-compose.yml

@@ -0,0 +1,97 @@
+version: "3.5"
+
+services:
+  # The relay, sitting on the "public internet"
+  relay:
+    depends_on: [redis]
+    build:
+      dockerfile: ./hole-punching-tests/Dockerfile
+      context: ..
+    container_name: relay
+    init: true
+    command: /usr/bin/hole-punching-tests relay
+    environment:
+      LISTEN_ADDR: 17.0.0.10
+    networks:
+      internet:
+        ipv4_address: 17.0.0.10
+      control:
+
+  # Alice's LAN
+  alice_router:
+    build: ./router
+    container_name: alice_router
+    init: true
+    networks:
+      alice_lan:
+        ipv4_address: 192.168.0.10
+      internet:
+        ipv4_address: 17.0.0.11
+    cap_add: 
+      - NET_ADMIN
+  alice:
+    depends_on: [redis, relay]
+    build:
+      dockerfile: ./hole-punching-tests/Dockerfile
+      context: ..
+    container_name: alice
+    command: ["/bin/sh", "-c", "ip route add 17.0.0.0/16 via 192.168.0.10 dev eth0 && /usr/bin/hole-punching-tests dial"]
+    environment:
+      TRANSPORT: tcp
+    networks:
+      alice_lan:
+        ipv4_address: 192.168.0.11
+      control:
+    cap_add:
+      - NET_ADMIN
+
+  # Bob's LAN
+  bob_router:
+    build: ./router
+    container_name: bob_router
+    init: true
+    networks:
+      bob_lan:
+        ipv4_address: 192.168.1.10
+      internet:
+    cap_add:
+      - NET_ADMIN
+  bob:
+    depends_on: [redis, relay]
+    build:
+      dockerfile: ./hole-punching-tests/Dockerfile
+      context: ..
+    container_name: bob
+    command: ["/bin/sh", "-c", "ip route add 17.0.0.0/16 via 192.168.1.10 dev eth0 && /usr/bin/hole-punching-tests listen"]
+    environment:
+      TRANSPORT: tcp
+    networks:
+      bob_lan:
+        ipv4_address: 192.168.1.11
+      control:
+    cap_add: 
+      - NET_ADMIN
+
+  # Redis for test coordination
+  redis:
+    image: redis
+    networks:
+      control:
+
+networks:
+  alice_lan:
+    ipam:
+      config:
+        - subnet: 192.168.0.0/24
+  bob_lan:
+    ipam:
+      config:
+        - subnet: 192.168.1.0/24
+  internet:
+    ipam:
+      config:
+        - subnet: 17.0.0.0/16
+  control: # Control network to facilitate the test setup
+    ipam:
+      config:
+        - subnet: 10.0.0.0/24

hole-punching-tests/router/Dockerfile

@@ -0,0 +1,13 @@
+FROM ubuntu:jammy
+
+ARG DEBIAN_FRONTEND=noninteractive
+RUN --mount=type=cache,target=/var/cache/apt apt-get update && apt-get -y install iproute2 nftables ulogd2 jq
+
+# Debugging tools
+RUN --mount=type=cache,target=/var/cache/apt apt-get update && apt-get -y install tcpdump iputils-ping
+
+COPY *.sh /scripts/
+RUN chmod +x /scripts/*.sh
+COPY ulogd.conf /etc/ulogd.conf
+
+ENTRYPOINT ["./scripts/run.sh"]

hole-punching-tests/router/run.sh

@@ -0,0 +1,16 @@
+#!/bin/sh
+
+set -ex
+
+ADDR_EXTERNAL=$(ip -json addr show eth1 | jq '.[0].addr_info[0].local' -r)
+SUBNET_INTERNAL=$(ip -json addr show eth0 | jq '.[0].addr_info[0].local + "/" + (.[0].addr_info[0].prefixlen | tostring)' -r)
+
+nft add table ip nat
+nft add chain ip nat postrouting { type nat hook postrouting priority 100 \; }
+nft add rule ip nat postrouting ip saddr $SUBNET_INTERNAL oifname "eth1" snat $ADDR_EXTERNAL
+
+tc qdisc add dev eth1 root netem delay 50ms
+
+tcpdump -i eth0 -n -w /dump.pcap &
+
+ulogd

hole-punching-tests/router/ulogd.conf

@@ -0,0 +1,12 @@
+[global]
+
+logfile="/var/log/ulogd.log"
+
+stack=log1:NFLOG,base1:BASE,ifi1:IFINDEX,ip2str1:IP2STR,print1:PRINTPKT,emu1:LOGEMU
+
+[log1]
+group=1
+
+[emu1]
+file="/var/log/ulogd_syslogemu.log"
+sync=1