api: explicitly disable future go versions (#19)

Julio-Guerra · eliottness · web-flow · commit 445523d31db1 · 2023-07-18T12:41:22.000+02:00
purego is panic'ing on go1.21's release candidate, which will be
released in August.
With this PR, we will start enforcing the set of Go versions we know we
support and explicitly disable future Go versions until we tested them
ourselves. As a result, Go 1.21 is disabled for now until a fix is
figured out.

---------

Co-authored-by: Eliott Bouhana &lt;eliott.bouhana@datadoghq.com&gt;
Co-authored-by: Julio Guerra&lt;julio.guerra@datadoghq.com&gt;
diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
@@ -9,58 +9,55 @@ on:
       - main
 env:
   DD_APPSEC_WAF_TIMEOUT: 5s
-  GODEBUG: cgocheck=2 # highest level of run-time cgo checks
 jobs:
   native:
     strategy:
+      fail-fast: false
       matrix:
         runs-on: [ macos-13, macos-12, macos-11, ubuntu-22.04, ubuntu-20.04, windows-latest ]
         go-version: [ "1.20", "1.19", "1.18" ]
-        cgo_enabled: # test it compiles with and without cgo
-          - 0
-          - 1
-      fail-fast: false
+        cgo_enabled: [ "0", "1" ] # test it compiles with and without cgo
+        include:
+          - env:
+              GODEBUG=cgocheck=2
     runs-on: ${{ matrix.runs-on }}
     steps:
       - uses: actions/checkout@v3
-      - uses: actions/setup-go@v3
+      - uses: actions/setup-go@v4
         with:
           go-version: ${{ matrix.go-version }}
           cache: true
 
-      - name: Go modules cache
-        uses: actions/cache@v3
-        with:
-          path: ~/go/pkg/mod
-          key: go-pkg-mod-${{ hashFiles('**/go.sum') }}
-          restore-keys: go-pkg-mod-
-
       - name: go test
         shell: bash
         run: |
           # Install gotestsum
           env GOBIN=$PWD go install gotest.tools/gotestsum@latest
           # Run the tests with gotestsum
-          env CGO_ENABLED=${{ matrix.cgo_enabled }} ./gotestsum -- -v -count=10 -shuffle=on ./...
+          env ${{ matrix.env }} CGO_ENABLED=${{ matrix.cgo_enabled }} ./gotestsum -- -v -count=10 -shuffle=on ./...
 
   # Same tests but on the official golang container for linux
   golang-linux-container:
     runs-on: ubuntu-latest
     container:
       image: golang:${{ matrix.go-version }}-${{ matrix.distribution }}
     strategy:
-      matrix:
-        go-version: [ "1.20", "1.19", "1.18" ]
-        distribution: [ bullseye, buster, alpine ]
-        cgo_enabled: # test it compiles with and without cgo
-          - 0
-          - 1
       fail-fast: false
+      matrix:
+        go-version: [ "1.21-rc", "1.20", "1.19", "1.18" ]
+        distribution: [ bookworm, bullseye, buster, alpine ]
+        cgo_enabled: [ "0", "1" ] # test it compiles with and without cgo
+        exclude:
+          - go-version: 1.18
+            distribution: bookworm
+          - go-version: 1.21-rc
+            distribution: buster
     steps:
       - uses: actions/checkout@v3
+
       # Install gcc and the libc headers on alpine images
       - if: ${{ matrix.distribution == 'alpine' }}
-        run: apk add gcc musl-dev libc6-compat git
+        run: apk add gcc musl-dev libc6-compat
 
       - name: Go modules cache
         uses: actions/cache@v3
@@ -80,9 +77,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        cgo_enabled: # test it compiles with and without the cgo
-          - 0
-          - 1
+        cgo_enabled: [ "0", "1" ] # test it compiles with and without the cgo
       fail-fast: false
     steps:
       - uses: actions/checkout@v3
diff --git a/ctypes_test.go b/ctypes_test.go
@@ -4,7 +4,7 @@
 // Copyright 2016-present Datadog, Inc.
 
 // Purego only works on linux/macOS with amd64 and arm64 from now
-//go:build (linux || darwin) && (amd64 || arm64)
+//go:build (linux || darwin) && (amd64 || arm64) && !go1.21
 
 package waf
 
diff --git a/embed_darwin_amd64.go b/embed_darwin_amd64.go
@@ -3,7 +3,7 @@
 // This product includes software developed at Datadog (https://www.datadoghq.com/).
 // Copyright 2016-present Datadog, Inc.
 
-//go:build darwin && amd64
+//go:build darwin && amd64 && !go1.21
 
 package waf
 
diff --git a/embed_darwin_arm64.go b/embed_darwin_arm64.go
@@ -3,7 +3,7 @@
 // This product includes software developed at Datadog (https://www.datadoghq.com/).
 // Copyright 2016-present Datadog, Inc.
 
-//go:build darwin && arm64
+//go:build darwin && arm64 && !go1.21
 
 package waf
 
diff --git a/embed_linux_amd64.go b/embed_linux_amd64.go
@@ -3,7 +3,7 @@
 // This product includes software developed at Datadog (https://www.datadoghq.com/).
 // Copyright 2016-present Datadog, Inc.
 
-//go:build linux && amd64
+//go:build linux && amd64 && !go1.21
 
 package waf
 
diff --git a/embed_linux_arm64.go b/embed_linux_arm64.go
@@ -3,7 +3,7 @@
 // This product includes software developed at Datadog (https://www.datadoghq.com/).
 // Copyright 2016-present Datadog, Inc.
 
-//go:build linux && arm64
+//go:build linux && arm64 && !go1.21
 
 package waf
 
diff --git a/lib_dl.go b/lib_dl.go
@@ -4,7 +4,7 @@
 // Copyright 2016-present Datadog, Inc.
 
 // Purego only works on linux/macOS with amd64 and arm64 from now
-//go:build (linux || darwin) && (amd64 || arm64)
+//go:build (linux || darwin) && (amd64 || arm64) && !go1.21
 
 package waf
 
diff --git a/symbols_linux_cgo.go b/symbols_linux_cgo.go
@@ -3,7 +3,7 @@
 // This product includes software developed at Datadog (https://www.datadoghq.com/).
 // Copyright 2016-present Datadog, Inc.
 
-//go:build cgo && linux
+//go:build cgo && linux && !go1.21
 
 package waf
 
diff --git a/symbols_linux_purego.go b/symbols_linux_purego.go
@@ -3,7 +3,7 @@
 // This product includes software developed at Datadog (https://www.datadoghq.com/).
 // Copyright 2016-present Datadog, Inc.
 
-//go:build !cgo && linux
+//go:build !cgo && linux && !go1.21
 
 package waf
 
diff --git a/waf_dl.go b/waf_dl.go
@@ -3,7 +3,7 @@
 // This product includes software developed at Datadog (https://www.datadoghq.com/).
 // Copyright 2016-present Datadog, Inc.
 
-//go:build (linux || darwin) && (amd64 || arm64)
+//go:build (linux || darwin) && (amd64 || arm64) && !go1.21
 
 package waf
 
diff --git a/waf_dl_test.go b/waf_dl_test.go
@@ -3,7 +3,7 @@
 // This product includes software developed at Datadog (https://www.datadoghq.com/).
 // Copyright 2016-present Datadog, Inc.
 
-//go:build (linux || darwin) && (amd64 || arm64)
+//go:build (linux || darwin) && (amd64 || arm64) && !go1.21
 
 package waf
 
diff --git a/waf_dl_unsupported.go b/waf_dl_unsupported.go
@@ -4,19 +4,12 @@
 // Copyright 2016-present Datadog, Inc.
 
 // Build when the target OS or architecture are not supported
-//go:build (!linux && !darwin) || (!amd64 && !arm64)
+//go:build (!linux && !darwin) || (!amd64 && !arm64) || go1.21
 
 package waf
 
-import (
-	"fmt"
-	"runtime"
-)
-
 type wafDl struct{}
 
-var unsupportedTargetErr = &UnsupportedTargetError{fmt.Errorf("the target operating-system %s or architecture %s are not supported", runtime.GOOS, runtime.GOARCH)}
-
 func newWafDl() (dl *wafDl, err error) {
 	return nil, unsupportedTargetErr
 }
diff --git a/waf_test.go b/waf_test.go
@@ -3,7 +3,7 @@
 // This product includes software developed at Datadog (https://www.datadoghq.com/).
 // Copyright 2016-present Datadog, Inc.
 
-//go:build (amd64 || arm64) && (linux || darwin)
+//go:build (amd64 || arm64) && (linux || darwin) && !go1.21
 
 package waf
 
diff --git a/waf_unsupported_go.go b/waf_unsupported_go.go
@@ -0,0 +1,17 @@
+// Unless explicitly stated otherwise all files in this repository are licensed
+// under the Apache License Version 2.0.
+// This product includes software developed at Datadog (https://www.datadoghq.com/).
+// Copyright 2016-present Datadog, Inc.
+
+// Supported OS/Arch but unsupported Go version
+//           Supported OS        Supported Arch     Bad Go Version
+//go:build (linux || darwin) && (amd64 || arm64) && go1.21
+
+package waf
+
+import (
+	"fmt"
+	"runtime"
+)
+
+var unsupportedTargetErr = &UnsupportedTargetError{fmt.Errorf("the Go version %s is not supported", runtime.Version())}
diff --git a/waf_unsupported_target.go b/waf_unsupported_target.go
@@ -0,0 +1,17 @@
+// Unless explicitly stated otherwise all files in this repository are licensed
+// under the Apache License Version 2.0.
+// This product includes software developed at Datadog (https://www.datadoghq.com/).
+// Copyright 2016-present Datadog, Inc.
+
+// Unsupported target OS or architecture on a supported Go version
+//            Unsupported OS        Unsupported Arch      Good Go Version
+//go:build ((!linux && !darwin) || (!amd64 && !arm64)) && !go1.21
+
+package waf
+
+import (
+	"fmt"
+	"runtime"
+)
+
+var unsupportedTargetErr = &UnsupportedTargetError{fmt.Errorf("the target operating-system %s or architecture %s are not supported", runtime.GOOS, runtime.GOARCH)}
diff --git a/waf_unsupported_test.go b/waf_unsupported_test.go
@@ -4,7 +4,7 @@
 // Copyright 2016-present Datadog, Inc.
 
 // Build when the target OS or Arch are not supported
-//go:build (!linux && !darwin) || (!amd64 && !arm64)
+//go:build (!linux && !darwin) || (!amd64 && !arm64) || go1.21
 
 package waf_test
 
