sync: update CI config files (#190)

* bump go.mod to Go 1.19 and run go fix * update .github/workflows/go-test.yml * update .github/workflows/go-check.yml * update .github/workflows/release-check.yml * stop using math/rand.Seed, convert fuzz functions to actual fuzzers --------- Co-authored-by: web3-bot <web3-bot@users.noreply.github.com> Co-authored-by: Marten Seemann <martenseemann@gmail.com>
multiformats · Jun 29, 2023 · 44887f8 · 44887f8
1 parent d0ee450
commit 44887f8
Show file tree

Hide file tree

Showing 5 changed files with 43 additions and 67 deletions.
diff --git a/.github/workflows/go-check.yml b/.github/workflows/go-check.yml
@@ -8,26 +8,20 @@ jobs:
   unit:
     runs-on: ubuntu-latest
     name: All
-    env:
-      RUNGOGENERATE: false
     steps:
       - uses: actions/checkout@v3
         with:
           submodules: recursive
+      - id: config
+        uses: protocol/.github/.github/actions/read-config@master
       - uses: actions/setup-go@v3
         with:
-          go-version: "1.19.x"
+          go-version: 1.20.x
       - name: Run repo-specific setup
         uses: ./.github/actions/go-check-setup
         if: hashFiles('./.github/actions/go-check-setup') != ''
-      - name: Read config
-        if: hashFiles('./.github/workflows/go-check-config.json') != ''
-        run: |
-          if jq -re .gogenerate ./.github/workflows/go-check-config.json; then
-            echo "RUNGOGENERATE=true" >> $GITHUB_ENV
-          fi
       - name: Install staticcheck
-        run: go install honnef.co/go/tools/cmd/staticcheck@376210a89477dedbe6fdc4484b233998650d7b3c # 2022.1.3 (v0.3.3)
+        run: go install honnef.co/go/tools/cmd/staticcheck@4970552d932f48b71485287748246cf3237cebdf # 2023.1 (v0.4.0)
       - name: Check that go.mod is tidy
         uses: protocol/multiple-go-modules@v1.2
         with:
@@ -39,32 +33,32 @@ jobs:
             fi
             git diff --exit-code -- go.sum go.mod
       - name: gofmt
-        if: ${{ success() || failure() }} # run this step even if the previous one failed
+        if: success() || failure() # run this step even if the previous one failed
         run: |
           out=$(gofmt -s -l .)
           if [[ -n "$out" ]]; then
             echo $out | awk '{print "::error file=" $0 ",line=0,col=0::File is not gofmt-ed."}'
             exit 1
           fi
       - name: go vet
-        if: ${{ success() || failure() }} # run this step even if the previous one failed
+        if: success() || failure() # run this step even if the previous one failed
         uses: protocol/multiple-go-modules@v1.2
         with:
           run: go vet ./...
       - name: staticcheck
-        if: ${{ success() || failure() }} # run this step even if the previous one failed
+        if: success() || failure() # run this step even if the previous one failed
         uses: protocol/multiple-go-modules@v1.2
         with:
           run: |
             set -o pipefail
             staticcheck ./... | sed -e 's@\(.*\)\.go@./\1.go@g'
       - name: go generate
         uses: protocol/multiple-go-modules@v1.2
-        if: (success() || failure()) && env.RUNGOGENERATE == 'true'
+        if: (success() || failure()) && fromJSON(steps.config.outputs.json).gogenerate == true
         with:
           run: |
             git clean -fd # make sure there aren't untracked files / directories
-            go generate ./...
+            go generate -x ./...
             # check if go generate modified or added any files
             if ! $(git add . && git diff-index HEAD --exit-code --quiet); then
               echo "go generated caused changes to the repository:"

diff --git a/.github/workflows/go-test.yml b/.github/workflows/go-test.yml
@@ -10,15 +10,17 @@ jobs:
       fail-fast: false
       matrix:
         os: [ "ubuntu", "windows", "macos" ]
-        go: [ "1.18.x", "1.19.x" ]
+        go: ["1.19.x","1.20.x"]
     env:
       COVERAGES: ""
-    runs-on: ${{ format('{0}-latest', matrix.os) }}
+    runs-on: ${{ fromJSON(vars[format('UCI_GO_TEST_RUNNER_{0}', matrix.os)] || format('"{0}-latest"', matrix.os)) }}
     name: ${{ matrix.os }} (go ${{ matrix.go }})
     steps:
       - uses: actions/checkout@v3
         with:
           submodules: recursive
+      - id: config
+        uses: protocol/.github/.github/actions/read-config@master
       - uses: actions/setup-go@v3
         with:
           go-version: ${{ matrix.go }}
@@ -27,7 +29,7 @@ jobs:
           go version
           go env
       - name: Use msys2 on windows
-        if: ${{ matrix.os == 'windows' }}
+        if: matrix.os == 'windows'
         shell: bash
         # The executable for msys2 is also called bash.cmd
         #   https://github.com/actions/virtual-environments/blob/main/images/win/Windows2019-Readme.md#shells
@@ -38,31 +40,37 @@ jobs:
         uses: ./.github/actions/go-test-setup
         if: hashFiles('./.github/actions/go-test-setup') != ''
       - name: Run tests
+        if: contains(fromJSON(steps.config.outputs.json).skipOSes, matrix.os) == false
         uses: protocol/multiple-go-modules@v1.2
         with:
           # Use -coverpkg=./..., so that we include cross-package coverage.
           # If package ./A imports ./B, and ./A's tests also cover ./B,
           # this means ./B's coverage will be significantly higher than 0%.
           run: go test -v -shuffle=on -coverprofile=module-coverage.txt -coverpkg=./... ./...
       - name: Run tests (32 bit)
-        if: ${{ matrix.os != 'macos' }} # can't run 32 bit tests on OSX.
+        # can't run 32 bit tests on OSX.
+        if: matrix.os != 'macos' &&
+          fromJSON(steps.config.outputs.json).skip32bit != true &&
+          contains(fromJSON(steps.config.outputs.json).skipOSes, matrix.os) == false
         uses: protocol/multiple-go-modules@v1.2
         env:
           GOARCH: 386
         with:
           run: |
-            export "PATH=${{ env.PATH_386 }}:$PATH"
+            export "PATH=$PATH_386:$PATH"
             go test -v -shuffle=on ./...
       - name: Run tests with race detector
-        if: ${{ matrix.os == 'ubuntu' }} # speed things up. Windows and OSX VMs are slow
+        # speed things up. Windows and OSX VMs are slow
+        if: matrix.os == 'ubuntu' &&
+          contains(fromJSON(steps.config.outputs.json).skipOSes, matrix.os) == false
         uses: protocol/multiple-go-modules@v1.2
         with:
           run: go test -v -race ./...
       - name: Collect coverage files
         shell: bash
         run: echo "COVERAGES=$(find . -type f -name 'module-coverage.txt' | tr -s '\n' ',' | sed 's/,$//')" >> $GITHUB_ENV
       - name: Upload coverage to Codecov
-        uses: codecov/codecov-action@81cd2dc8148241f03f5839d295e000b8f761e378 # v3.1.0
+        uses: codecov/codecov-action@d9f34f8cd5cb3b3eb79b3e4b5dae3a16df499a70 # v3.1.1
         with:
           files: '${{ env.COVERAGES }}'
           env_vars: OS=${{ matrix.os }}, GO=${{ matrix.go }}
diff --git a/.github/workflows/release-check.yml b/.github/workflows/release-check.yml
@@ -3,9 +3,11 @@
 
 name: Release Checker
 on:
-  pull_request:
+  pull_request_target:
     paths: [ 'version.json' ]
 
 jobs:
   release-check:
     uses: protocol/.github/.github/workflows/release-check.yml@master
+    with:
+      go-version: 1.20.x
diff --git a/go.mod b/go.mod
@@ -1,6 +1,6 @@
 module github.com/multiformats/go-multiaddr
 
-go 1.18
+go 1.19
 
 require (
 	github.com/ipfs/go-cid v0.0.7

diff --git a/multiaddr_test.go b/multiaddr_test.go
@@ -3,15 +3,11 @@ package multiaddr
 import (
 	"bytes"
 	"encoding/hex"
-	"math/rand"
-	"strings"
 	"testing"
-	"time"
-
-	"github.com/stretchr/testify/require"
 
 	"github.com/ipfs/go-cid"
 	mh "github.com/multiformats/go-multihash"
+	"github.com/stretchr/testify/require"
 )
 
 func newMultiaddr(t *testing.T, a string) Multiaddr {
@@ -501,56 +497,32 @@ func TestGetValue(t *testing.T) {
 	assertValueForProto(t, a, P_UNIX, "/a/b/c/d")
 }
 
-func TestFuzzBytes(t *testing.T) {
-	rand.Seed(time.Now().UnixNano())
-	// Bump up these numbers if you want to stress this
-	buf := make([]byte, 256)
-	for i := 0; i < 2000; i++ {
-		l := rand.Intn(len(buf))
-		rand.Read(buf[:l])
-
-		// just checking that it doesnt panic
-		ma, err := NewMultiaddrBytes(buf[:l])
+func FuzzNewMultiaddrBytes(f *testing.F) {
+	f.Fuzz(func(_ *testing.T, b []byte) {
+		// just checking that it doesn't panic
+		ma, err := NewMultiaddrBytes(b)
 		if err == nil {
 			// for any valid multiaddrs, make sure these calls don't panic
 			_ = ma.String()
 			ma.Protocols()
 		}
-	}
+	})
 }
 
-func randMaddrString() string {
-	good_corpus := []string{"tcp", "ip", "udp", "ipfs", "0.0.0.0", "127.0.0.1", "12345", "QmbHVEEepCi7rn7VL7Exxpd2Ci9NNB6ifvqwhsrbRMgQFP"}
-
-	size := rand.Intn(256)
-	parts := make([]string, 0, size)
-	for i := 0; i < size; i++ {
-		switch rand.Intn(5) {
-		case 0, 1, 2:
-			parts = append(parts, good_corpus[rand.Intn(len(good_corpus))])
-		default:
-			badbuf := make([]byte, rand.Intn(256))
-			rand.Read(badbuf)
-			parts = append(parts, string(badbuf))
-		}
-	}
-
-	return "/" + strings.Join(parts, "/")
-}
-
-func TestFuzzString(t *testing.T) {
-	rand.Seed(time.Now().UnixNano())
-	// Bump up these numbers if you want to stress this
-	for i := 0; i < 2000; i++ {
-
-		// just checking that it doesnt panic
-		ma, err := NewMultiaddr(randMaddrString())
+func FuzzNewMultiaddrString(f *testing.F) {
+	f.Add("/ip4/0.0.0.0/udp/12345/utp")
+	f.Add("/ip4/1.2.3.4/udp/12345/quic")
+	f.Add("/ip4/127.0.0.1/tcp/12345")
+	f.Add("/ip4/127.0.0.1/udp/1234/quic-v1/webtransport/certhash/uEiDDq4_xNyDorZBH3TlGazyJdOWSwvo4PUo5YHFMrvDE8g")
+	f.Fuzz(func(_ *testing.T, s string) {
+		// just checking that it doesn't panic
+		ma, err := NewMultiaddr(s)
 		if err == nil {
 			// for any valid multiaddrs, make sure these calls don't panic
 			_ = ma.String()
 			ma.Protocols()
 		}
-	}
+	})
 }
 
 func TestBinaryRepresentation(t *testing.T) {