Move analysis testing to Go module support (#307)

Reference: golang/go#37054

When this Go module was under heavy development, the analysis testing framework in `golang.org/x/tools` only supported `GOPATH` based resolution. Subsequently, dependencies were vendored and a `vendor` symlink was placed in each of the test case directories.

With recent versions of `golang.org/x/tools`, placing a `go.mod` in the `testdata` directory will cause the analysis testing framework to enable Go module support. Only minor import and pathing changes are needed to convert over. Consumers will no longer be burdened with Go module dependencies only needed for testing this Go module.

Author: bflad

.github/workflows/release.yaml

@@ -22,9 +22,6 @@ jobs:
           go mod tidy
           git diff --exit-code -- go.mod go.sum || \
             (echo; echo "Unexpected difference in go.mod/go.sum files. Run 'go mod tidy' command or revert any go.mod/go.sum changes and commit."; exit 1)
-          go mod vendor
-          git diff --compact-summary --exit-code -- vendor || \
-            (echo; echo "Unexpected difference in vendor/ directory. Run 'go mod vendor' command or revert any go.mod/go.sum/vendor changes and commit."; exit 1)
   go_test:
     name: go test
     runs-on: ubuntu-latest

.github/workflows/test.yaml

@@ -12,14 +12,10 @@ jobs:
           go-version-file: 'go.mod'
       - name: go mod
         run: |
-          echo "==> Checking source code with go mod vendor..."
+          echo "==> Checking source code with go mod tidy..."
           go mod tidy
           git diff --exit-code -- go.mod go.sum || \
             (echo; echo "Unexpected difference in go.mod/go.sum files. Run 'go mod tidy' command or revert any go.mod/go.sum changes and commit."; exit 1)
-          echo "==> Checking source code with go mod vendor..."
-          go mod vendor
-          git diff --compact-summary --exit-code -- vendor || \
-            (echo; echo "Unexpected difference in vendor/ directory. Run 'go mod vendor' command or revert any go.mod/go.sum/vendor changes and commit."; exit 1)
   go_test:
     name: go test
     runs-on: ubuntu-latest
@@ -28,6 +24,8 @@ jobs:
       - uses: actions/setup-go@cdcb36043654635271a94b9a6d1392de5bb323a7 # v5.0.1
         with:
           go-version-file: 'go.mod'
+      # Prevent GOPROXY=off errors for analysistest
+      - run: for moddir in {,x}passes/*/testdata; do pushd $moddir; go mod download; popd; done
       - run: go test ./...
   goreleaser:
     name: goreleaser

.goreleaser.yml

@@ -24,7 +24,6 @@ builds:
 -
   env:
   - CGO_ENABLED=0
-  - GOFLAGS=-mod=vendor
   goos:
   - darwin
   - windows
@@ -40,7 +39,6 @@ builds:
   binary: tfproviderlintx
   env:
   - CGO_ENABLED=0
-  - GOFLAGS=-mod=vendor
   goos:
   - darwin
   - windows

README.md

@@ -241,7 +241,6 @@ Currently, that means Go **1.21** or later must be used when including this proj
 
 * Create new analyzer in `passes/` (or `xpasses/` for extra checks)
 * If the `Analyzer` reports issues, add to `AllChecks` variable in `passes/checks.go` (or `xpasses/checks.go` for extra checks)
-* Since the [`analysistest` package](https://godoc.org/golang.org/x/tools/go/analysis/analysistest) does not support Go Modules currently, each analyzer that implements testing must add a symlink to the top level `vendor` directory in the `testdata/src/a` directory. e.g. `ln -s ../../../../../vendor passes/NAME/testdata/src/a/vendor`
 
 ### Implementing SuggestedFixes Testing
 
@@ -256,7 +255,7 @@ import (
 
 func TestAnalyzerFixes(t *testing.T) {
   testdata := analysistest.TestData()
-  analysistest.RunWithSuggestedFixes(t, testdata, Analyzer, "a")
+  analysistest.RunWithSuggestedFixes(t, testdata, Analyzer, "testdata/src/a")
 }
 ```
 

go.mod

@@ -4,69 +4,10 @@ go 1.21
 
 require (
 	github.com/bflad/gopaniccheck v0.1.0
-	github.com/hashicorp/terraform-plugin-sdk/v2 v2.5.0
 	golang.org/x/tools v0.21.0
 )
 
 require (
-	cloud.google.com/go v0.65.0 // indirect
-	cloud.google.com/go/storage v1.10.0 // indirect
-	github.com/agext/levenshtein v1.2.2 // indirect
-	github.com/apparentlymart/go-cidr v1.1.0 // indirect
-	github.com/apparentlymart/go-textseg/v12 v12.0.0 // indirect
-	github.com/apparentlymart/go-textseg/v13 v13.0.0 // indirect
-	github.com/aws/aws-sdk-go v1.37.0 // indirect
-	github.com/bgentry/go-netrc v0.0.0-20140422174119-9fd32a8b3d3d // indirect
-	github.com/davecgh/go-spew v1.1.1 // indirect
-	github.com/fatih/color v1.7.0 // indirect
-	github.com/golang/groupcache v0.0.0-20200121045136-8c9f03a8e57e // indirect
-	github.com/golang/protobuf v1.4.2 // indirect
-	github.com/google/go-cmp v0.6.0 // indirect
-	github.com/googleapis/gax-go/v2 v2.0.5 // indirect
-	github.com/hashicorp/errwrap v1.0.0 // indirect
-	github.com/hashicorp/go-checkpoint v0.5.0 // indirect
-	github.com/hashicorp/go-cleanhttp v0.5.2 // indirect
-	github.com/hashicorp/go-cty v1.4.1-0.20200414143053-d3edf31b6320 // indirect
-	github.com/hashicorp/go-getter v1.5.3 // indirect
-	github.com/hashicorp/go-hclog v0.15.0 // indirect
-	github.com/hashicorp/go-multierror v1.0.0 // indirect
-	github.com/hashicorp/go-plugin v1.4.0 // indirect
-	github.com/hashicorp/go-safetemp v1.0.0 // indirect
-	github.com/hashicorp/go-uuid v1.0.1 // indirect
-	github.com/hashicorp/go-version v1.3.0 // indirect
-	github.com/hashicorp/hcl/v2 v2.8.2 // indirect
-	github.com/hashicorp/logutils v1.0.0 // indirect
-	github.com/hashicorp/terraform-exec v0.13.3 // indirect
-	github.com/hashicorp/terraform-json v0.10.0 // indirect
-	github.com/hashicorp/terraform-plugin-go v0.2.1 // indirect
-	github.com/hashicorp/yamux v0.0.0-20181012175058-2f1d1f20f75d // indirect
-	github.com/jmespath/go-jmespath v0.4.0 // indirect
-	github.com/jstemmer/go-junit-report v0.9.1 // indirect
-	github.com/klauspost/compress v1.11.2 // indirect
-	github.com/mattn/go-colorable v0.1.4 // indirect
-	github.com/mattn/go-isatty v0.0.10 // indirect
-	github.com/mitchellh/copystructure v1.0.0 // indirect
-	github.com/mitchellh/go-homedir v1.1.0 // indirect
-	github.com/mitchellh/go-testing-interface v1.0.4 // indirect
-	github.com/mitchellh/go-wordwrap v1.0.0 // indirect
-	github.com/mitchellh/mapstructure v1.1.2 // indirect
-	github.com/mitchellh/reflectwalk v1.0.1 // indirect
-	github.com/oklog/run v1.0.0 // indirect
-	github.com/ulikunitz/xz v0.5.8 // indirect
-	github.com/vmihailenco/msgpack v4.0.4+incompatible // indirect
-	github.com/zclconf/go-cty v1.8.2 // indirect
-	go.opencensus.io v0.22.4 // indirect
-	golang.org/x/crypto v0.23.0 // indirect
-	golang.org/x/lint v0.0.0-20200302205851-738671d3881b // indirect
 	golang.org/x/mod v0.17.0 // indirect
-	golang.org/x/net v0.25.0 // indirect
-	golang.org/x/oauth2 v0.0.0-20200902213428-5d25da1a8d43 // indirect
 	golang.org/x/sync v0.7.0 // indirect
-	golang.org/x/sys v0.20.0 // indirect
-	golang.org/x/text v0.15.0 // indirect
-	google.golang.org/api v0.34.0 // indirect
-	google.golang.org/appengine v1.6.6 // indirect
-	google.golang.org/genproto v0.0.0-20200904004341-0bd0a958aa1d // indirect
-	google.golang.org/grpc v1.32.0 // indirect
-	google.golang.org/protobuf v1.25.0 // indirect
 )