Update Go & JS tests to conform to the multidim interop test spec. (#121

)

* Update Go test implementations to match new spec

* Update JS test implementation

* Update Rust test Implementation

* Update root Makefile

* Update runner to new spec

* Use composite action and S3 caching

* Not using GHA cache anymore

* Try removing access key from env

* Test workflow without cache keys (#131)

* Test if it works without s3 cache keys

* Fix if statement

* Fix if statement

* Always use buildkit

* Undo debug change

* Add no cache workflow

* Skip test in no-cache workflow

* Update .github/workflows/no-cache-multidim-interop.yml

* Same workflow; use CACHING_OPTIONS

* Add Browser WebRTC test (#130)

* Add webrtc to JS test

* Add onlyDial to all queries

* Update versions.ts

* Remove unneeded timeout overrides

.github/actions/run-interop-ping-test/action.yml

@@ -9,9 +9,38 @@ inputs:
     description: "Space-separated paths to JSON files describing additional images"
     required: false
     default: ""
+  s3-cache-bucket:
+    description: "Which S3 bucket to use for container layer caching"
+    required: false
+    default: ""
+  s3-access-key-id:
+    description: "S3 Access key id for the cache"
+    required: false
+    default: ""
+  s3-secret-access-key:
+    description: "S3 secret key id for the cache"
+    required: false
+    default: ""
+  aws-region:
+    description: "Which AWS region to use"
+    required: false
+    default: "us-east-1"
 runs:
   using: "composite"
   steps:
+    - run: |
+        echo "AWS_BUCKET=${{ inputs.s3-cache-bucket }}" >> $GITHUB_ENV
+        echo "AWS_REGION=${{ inputs.aws-region }}" >> $GITHUB_ENV
+      shell: bash
+
+    - name: Configure AWS credentials for S3 build cache
+      if: inputs.s3-access-key-id != '' && inputs.s3-secret-access-key != ''
+      uses: aws-actions/configure-aws-credentials@v1
+      with:
+        aws-access-key-id: ${{ inputs.s3-access-key-id }}
+        aws-secret-access-key: ${{ inputs.s3-secret-access-key}}
+        aws-region: ${{ env.AWS_REGION }}
+
     # This depends on where this file is within this repository. This walks up
     # from here to the multidim-interop folder
     - run: |
@@ -24,9 +53,6 @@ runs:
       with:
         node-version: 18
 
-    - name: Expose GitHub Runtime # Needed for docker buildx to cache properly (See https://docs.docker.com/build/cache/backends/gha/#authentication)
-      uses: crazy-max/ghaction-github-runtime@v2
-
     - name: Set up Docker Buildx
       id: buildx
       uses: docker/setup-buildx-action@v2

.github/workflows/multidim-interop.yml

@@ -9,11 +9,20 @@ name: libp2p multidimensional interop test
 
 jobs:
   run-multidim-interop:
-    uses: "./.github/workflows/run-testplans.yml"
-    with:
-      dir: "multidim-interop"
-  run-multidim-interop-ng:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v3
       - uses: ./.github/actions/run-interop-ping-test
+        with:
+          s3-cache-bucket: libp2p-by-tf-aws-bootstrap
+          s3-access-key-id: ${{ vars.S3_AWS_ACCESS_KEY_ID }}
+          s3-secret-access-key: ${{ secrets.S3_AWS_SECRET_ACCESS_KEY }}
+  build-without-cache:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      # Purposely not using cache to replicate how forks will behave.
+      - uses: ./.github/actions/run-interop-ping-test
+        with:
+          # It's okay to not run the tests, we only care to check if the tests build without cache.
+          test-filter: '"no test matches this, skip all"'

multidim-interop/Makefile

@@ -1,13 +1,14 @@
 GO_SUBDIRS := $(wildcard go/*/.)
 JS_SUBDIRS := $(wildcard js/*/.)
+RUST_SUBDIRS := $(wildcard rust/*/.)
 
-all: $(GO_SUBDIRS) $(JS_SUBDIRS)  rust/.
+all: $(GO_SUBDIRS) $(JS_SUBDIRS) $(RUST_SUBDIRS)
 $(JS_SUBDIRS):
 	$(MAKE) -C $@
 $(GO_SUBDIRS):
 	$(MAKE) -C $@
-rust/.:
+$(RUST_SUBDIRS):
 	$(MAKE) -C $@
 
 
-.PHONY: $(GO_SUBDIRS) $(JS_SUBDIRS) rust/. all
+.PHONY: $(GO_SUBDIRS) $(JS_SUBDIRS) $(RUST_SUBDIRS) all

multidim-interop/dockerBuildWrapper.sh

@@ -1,13 +1,13 @@
 #!/usr/bin/env /bin/bash
 
-# If in CI use caching
-if [[ -n "${CI}" ]]; then
-    docker buildx build \
-    --load \
-    -t $IMAGE_NAME \
-    --cache-to type=gha,mode=max,scope=$GITHUB_REF_NAME-$IMAGE_NAME \
-    --cache-from type=gha,scope=$GITHUB_REF_NAME-$IMAGE_NAME "$@"
-else
-	docker build -t $IMAGE_NAME "$@"
+CACHING_OPTIONS=""
+# If in CI and we have a defined cache bucket, use caching
+if [[ -n "${CI}" ]] && [[ -n "${AWS_BUCKET}" ]]; then
+    CACHING_OPTIONS="\
+        --cache-to   type=s3,mode=max,bucket=$AWS_BUCKET,region=$AWS_REGION,prefix=buildCache,name=$IMAGE_NAME \
+        --cache-from type=s3,mode=max,bucket=$AWS_BUCKET,region=$AWS_REGION,prefix=buildCache,name=$IMAGE_NAME"
 fi
 
+docker buildx build \
+    --load \
+    -t $IMAGE_NAME $CACHING_OPTIONS "$@"

multidim-interop/go/v0.22/main.go

@@ -2,7 +2,9 @@ package main
 
 import (
 	"context"
+	"encoding/json"
 	"fmt"
+	"log"
 	"os"
 	"strconv"
 	"time"
@@ -24,22 +26,26 @@ import (
 func main() {
 	var (
 		transport      = os.Getenv("transport")
-		secureChannel  = os.Getenv("security")
 		muxer          = os.Getenv("muxer")
+		secureChannel  = os.Getenv("security")
 		isDialerStr    = os.Getenv("is_dialer")
 		ip             = os.Getenv("ip")
-		testTimeoutStr = os.Getenv("test_timeout")
-		redisAddr      = os.Getenv("REDIS_ADDR")
+		redisAddr      = os.Getenv("redis_addr")
+		testTimeoutStr = os.Getenv("test_timeout_seconds")
 	)
 
-	var testTimeout = 10 * time.Second
+	var testTimeout = 3 * time.Minute
 	if testTimeoutStr != "" {
 		secs, err := strconv.ParseInt(testTimeoutStr, 10, 32)
 		if err == nil {
 			testTimeout = time.Duration(secs) * time.Second
 		}
 	}
 
+	if ip == "" {
+		ip = "0.0.0.0"
+	}
+
 	if redisAddr == "" {
 		redisAddr = "redis:6379"
 	}
@@ -80,56 +86,70 @@ func main() {
 		options = append(options, libp2p.Transport(libp2pquic.NewTransport))
 		listenAddr = fmt.Sprintf("/ip4/%s/udp/0/quic", ip)
 	default:
-		panic("Unsupported transport")
+		log.Fatalf("Unsupported transport: %s", transport)
 	}
 	options = append(options, libp2p.ListenAddrStrings(listenAddr))
 
-	switch secureChannel {
-	case "tls":
-		options = append(options, libp2p.Security(libp2ptls.ID, libp2ptls.New))
-	case "noise":
-		options = append(options, libp2p.Security(noise.ID, noise.New))
+	// Skipped for certain transports
+	var skipMuxer bool
+	var skipSecureChannel bool
+	switch transport {
 	case "quic":
-	default:
-		panic("Unsupported secure channel")
+		skipMuxer = true
+		skipSecureChannel = true
 	}
 
-	switch muxer {
-	case "yamux":
-		options = append(options, libp2p.Muxer("/yamux/1.0.0", yamux.DefaultTransport))
-	case "mplex":
-		options = append(options, libp2p.Muxer("/mplex/6.7.0", mplex.DefaultTransport))
-	case "quic":
-	default:
-		panic("Unsupported muxer")
+	if !skipSecureChannel {
+		switch secureChannel {
+		case "tls":
+			options = append(options, libp2p.Security(libp2ptls.ID, libp2ptls.New))
+		case "noise":
+			options = append(options, libp2p.Security(noise.ID, noise.New))
+		default:
+			log.Fatalf("Unsupported secure channel: %s", secureChannel)
+		}
+	}
+
+	if !skipMuxer {
+		switch muxer {
+		case "yamux":
+			options = append(options, libp2p.Muxer("/yamux/1.0.0", yamux.DefaultTransport))
+		case "mplex":
+			options = append(options, libp2p.Muxer("/mplex/6.7.0", mplex.DefaultTransport))
+		default:
+			log.Fatalf("Unsupported muxer: %s", muxer)
+		}
 	}
 
 	host, err := libp2p.New(options...)
 
 	if err != nil {
-		panic(fmt.Sprintf("failed to instantiate libp2p instance: %s", err))
+		log.Fatalf("failed to instantiate libp2p instance: %s", err)
 	}
 	defer host.Close()
 
+	log.Println("My multiaddr is: ", host.Addrs())
+
 	if is_dialer {
 		val, err := rClient.BLPop(ctx, testTimeout, "listenerAddr").Result()
 		if err != nil {
-			panic("Failed to wait for listener to be ready")
+			log.Fatal("Failed to wait for listener to be ready")
 		}
 		otherMa := ma.StringCast(val[1])
-		fmt.Println("My multiaddr is: ", host.Addrs())
-		fmt.Println("Other peer multiaddr is: ", otherMa)
+		log.Println("Other peer multiaddr is: ", otherMa)
 		otherMa, p2pComponent := ma.SplitLast(otherMa)
 		otherPeerId, err := peer.Decode(p2pComponent.Value())
 		if err != nil {
-			panic("Failed to get peer id from multiaddr")
+			log.Fatal("Failed to get peer id from multiaddr")
 		}
+
+		handshakeStartInstant := time.Now()
 		err = host.Connect(ctx, peer.AddrInfo{
 			ID:    otherPeerId,
 			Addrs: []ma.Multiaddr{otherMa},
 		})
 		if err != nil {
-			panic("Failed to connect to other peer")
+			log.Fatal("Failed to connect to other peer")
 		}
 
 		ping := ping.NewPingService(host)
@@ -138,19 +158,27 @@ func main() {
 		if res.Error != nil {
 			panic(res.Error)
 		}
+		handshakePlusOneRTT := time.Since(handshakeStartInstant)
+
+		testResult := struct {
+			HandshakePlusOneRTTMillis float32 `json:"handshakePlusOneRTTMillis"`
+			PingRTTMilllis            float32 `json:"pingRTTMilllis"`
+		}{
+			HandshakePlusOneRTTMillis: float32(handshakePlusOneRTT.Microseconds()) / 1000,
+			PingRTTMilllis:            float32(res.RTT.Microseconds()) / 1000,
+		}
 
-		fmt.Println("Ping successful: ", res.RTT)
-
-		rClient.RPush(ctx, "dialerDone", "").Result()
-	} else {
-		_, err := rClient.RPush(ctx, "listenerAddr", host.Addrs()[0].Encapsulate(ma.StringCast("/p2p/"+host.ID().String())).String()).Result()
+		testResultJSON, err := json.Marshal(testResult)
 		if err != nil {
-			panic("Failed to send listener address")
+			log.Fatalf("Failed to marshal test result: %v", err)
 		}
-		_, err = rClient.BLPop(ctx, testTimeout, "dialerDone").Result()
+		fmt.Println(string(testResultJSON))
+	} else {
+		_, err := rClient.RPush(ctx, "listenerAddr", host.Addrs()[0].Encapsulate(ma.StringCast("/p2p/"+host.ID().String())).String()).Result()
 		if err != nil {
-			panic("Failed to wait for dialer conclusion")
+			log.Fatal("Failed to send listener address")
 		}
-
+		time.Sleep(testTimeout)
+		os.Exit(1)
 	}
 }