go 1.24.3 + deprecation fixes + minor tooling updates (#68)

* go 1.24.3

* replace hub with gh

* use golangci lint

* golangci fmt

* ioutil deprecation

* remove usage of external errors pkg

* w.HeaderMap is deprecated

* remove the loops (staticcheck)

* error strings should not be capitalized (staticcheck)

* ineffectual assignment to err fixes

* fix ci

Author: kelvin-acosta

.github/workflows/ci.yml

@@ -10,9 +10,14 @@ jobs:
   build:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
-      - uses: actions/setup-go@v2
+      - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
+      - uses: actions/setup-go@d35c59abb061a4a6fb18e82ac0862c26744d6ab5 # v.5.5.0
         with:
-          go-version: '^1.17.5'
+          go-version: '^1.24.3'
+      - name: golangci-lint
+        uses: golangci/golangci-lint-action@4afd733a84b1f43292c63897423277bb7f4313a9 # v8.0.0
+        with:
+          version: latest
+          args: --timeout=5m
       - run: make test
 

.go-version

@@ -0,0 +1 @@
+1.24.3

.golangci.yml

@@ -0,0 +1,11 @@
+# https://golangci-lint.run/usage/configuration/
+version: '2'
+linters:
+  default: standard
+  disable:
+    - errcheck
+    - unused
+formatters:
+  enable:
+    - gofmt
+    - goimports

Brewfile

@@ -1,2 +1,2 @@
 brew 'go'
-brew 'hub'
+brew 'gh'

Makefile

@@ -1,56 +1,44 @@
 SHELL = /bin/sh
 
-VERSION=1.6.1
+VERSION=1.7.0
 BUILD=`git rev-parse HEAD`
 
 LDFLAGS=-ldflags "-w -s \
 				-X github.com/Betterment/testtrack-cli/cmds.version=${VERSION} \
 				-X github.com/Betterment/testtrack-cli/cmds.build=${BUILD}"
 
 PACKAGES=$$(find . -maxdepth 1 -type d ! -path '.' ! -path './.*' ! -path './vendor' ! -path './dist' ! -path './script' ! -path './doc')
-LINTEXCLUDES="123nothingyet123"
 
 all: test
 
 install:
 	@go install ${LDFLAGS} github.com/Betterment/testtrack-cli/testtrack
 
 dist:
-	@mkdir dist &&\
-		GOOS=linux GOARCH=amd64 go build -o "dist/testtrack.linux" ${LDFLAGS} github.com/Betterment/testtrack-cli/testtrack &&\
-		GOOS=darwin GOARCH=amd64 go build -o "dist/testtrack.darwin-amd64" ${LDFLAGS} github.com/Betterment/testtrack-cli/testtrack &&\
+	@mkdir dist && \
+		GOOS=linux GOARCH=amd64 go build -o "dist/testtrack.linux" ${LDFLAGS} github.com/Betterment/testtrack-cli/testtrack && \
+		GOOS=darwin GOARCH=amd64 go build -o "dist/testtrack.darwin-amd64" ${LDFLAGS} github.com/Betterment/testtrack-cli/testtrack && \
 		GOOS=darwin GOARCH=arm64 go build -o "dist/testtrack.darwin-arm64" ${LDFLAGS} github.com/Betterment/testtrack-cli/testtrack
 
 release: distclean dist
-	@hub release create\
-		-a dist/testtrack.linux\
-		-a dist/testtrack.darwin-amd64\
-		-a dist/testtrack.darwin-arm64\
-		-m "TestTrack CLI ${VERSION}"\
-		-t "${BUILD}"\
-		v${VERSION}
+	@(gh release view v${VERSION} > /dev/null 2>&1 \
+		&& echo "v${VERSION} has already been released.") \
+		|| gh release create v${VERSION} \
+			dist/testtrack.linux \
+			dist/testtrack.darwin-amd64 \
+			dist/testtrack.darwin-arm64 \
+			--title "TestTrack CLI ${VERSION}" \
+			--target "${BUILD}" \
+			--generate-notes
 
 test:
-	@go install golang.org/x/tools/cmd/goimports@latest
-	@go install golang.org/x/lint/golint@latest
-	@GOIMPORTS_RESULT=$$($$(go env GOPATH)/bin/goimports -l ${PACKAGES} | grep -v ${LINTEXCLUDES});\
-		if [ $$(echo "$$GOIMPORTS_RESULT\c" | head -c1 | wc -c) -ne 0 ];\
-			then\
-				echo "Style violations found. Run the following command to fix:";\
-				echo;\
-				echo "$$(go env GOPATH)/bin/goimports -w" $$GOIMPORTS_RESULT;\
-				echo;\
-				exit 1;\
-			fi
-	@go vet ${PACKAGES}
-	@GOLINT_RESULT=$$($$(go env GOPATH)/bin/golint ${PACKAGES} | grep -v ${LINTEXCLUDES});\
-		if [ $$(echo "$$GOLINT_RESULT\c" | head -c1 | wc -c) -ne 0 ];\
-			then\
-				echo $$GOLINT_RESULT;\
-				exit 1;\
-			fi
 	@go test ${PACKAGES}
 
+lint:
+	golangci-lint version &>/dev/null || brew install golangci-lint
+	golangci-lint fmt --verbose
+	golangci-lint run --verbose --timeout 5m
+
 cover:
 	@echo "What package do you want a coverage report for? \c"
 	@read PACKAGE &&\
@@ -68,4 +56,4 @@ clean:
 distclean: clean
 	@rm -rf dist
 
-.PHONY: all build install check clean distclean test
+.PHONY: all build install clean distclean test

cmds/generate_build_timestamp.go

@@ -1,7 +1,6 @@
 package cmds
 
 import (
-	"io/ioutil"
 	"os"
 	"time"
 
@@ -36,5 +35,5 @@ func generateBuildTimestamp() error {
 		return err
 	}
 
-	return ioutil.WriteFile("testtrack/build_timestamp", timestamp, 0644)
+	return os.WriteFile("testtrack/build_timestamp", timestamp, 0644)
 }

cmds/init_project.go

@@ -1,7 +1,6 @@
 package cmds
 
 import (
-	"io/ioutil"
 	"log"
 	"os"
 
@@ -40,7 +39,7 @@ func initProject() error {
 	}
 	keepfile.Close()
 
-	if err := ioutil.WriteFile("testtrack/.gitignore", []byte("build_timestamp\n"), 0644); err != nil {
+	if err := os.WriteFile("testtrack/.gitignore", []byte("build_timestamp\n"), 0644); err != nil {
 		log.Fatal(err)
 	}
 

fakeassignments/fakeassignments.go

@@ -1,11 +1,9 @@
 package fakeassignments
 
 import (
-	"io/ioutil"
 	"os"
 
 	"github.com/Betterment/testtrack-cli/paths"
-
 	"gopkg.in/yaml.v2"
 )
 
@@ -20,12 +18,12 @@ func Read() (*map[string]string, error) {
 		if err != nil {
 			return nil, err
 		}
-		err = ioutil.WriteFile(*configDir+"/assignments.yml", []byte("{}"), 0644)
+		err = os.WriteFile(*configDir+"/assignments.yml", []byte("{}"), 0644)
 		if err != nil {
 			return nil, err
 		}
 	}
-	assignmentsBytes, err := ioutil.ReadFile(*configDir + "/assignments.yml")
+	assignmentsBytes, err := os.ReadFile(*configDir + "/assignments.yml")
 	if err != nil {
 		return nil, err
 	}
@@ -47,7 +45,7 @@ func Write(assignments *map[string]string) error {
 	if err != nil {
 		return err
 	}
-	err = ioutil.WriteFile(*configDir+"/assignments.yml", bytes, 0644)
+	err = os.WriteFile(*configDir+"/assignments.yml", bytes, 0644)
 	if err != nil {
 		return err
 	}

fakeserver/routes.go

@@ -3,7 +3,7 @@ package fakeserver
 import (
 	"encoding/json"
 	"fmt"
-	"io/ioutil"
+	"io"
 	"net/http"
 	"strings"
 
@@ -341,7 +341,7 @@ func postV1AssignmentOverride(r *http.Request) error {
 			Variant:   r.PostForm.Get("variant"),
 		}
 	case strings.HasPrefix(contentType, "application/json"):
-		requestBytes, err := ioutil.ReadAll(r.Body)
+		requestBytes, err := io.ReadAll(r.Body)
 		if err != nil {
 			return err
 		}
@@ -353,6 +353,10 @@ func postV1AssignmentOverride(r *http.Request) error {
 		return fmt.Errorf("got unexpected content type %s", contentType)
 	}
 	assignments, err := fakeassignments.Read()
+	if err != nil {
+		return err
+	}
+
 	(*assignments)[assignment.SplitName] = assignment.Variant
 	err = fakeassignments.Write(assignments)
 	if err != nil {
@@ -366,7 +370,7 @@ func postV2AssignmentOverride(r *http.Request) error {
 	contentType := r.Header.Get("content-type")
 	switch {
 	case strings.HasPrefix(contentType, "application/json"):
-		requestBytes, err := ioutil.ReadAll(r.Body)
+		requestBytes, err := io.ReadAll(r.Body)
 		if err != nil {
 			return err
 		}
@@ -380,6 +384,10 @@ func postV2AssignmentOverride(r *http.Request) error {
 		return fmt.Errorf("got unexpected content type %s", contentType)
 	}
 	storedAssignments, err := fakeassignments.Read()
+	if err != nil {
+		return err
+	}
+
 	for _, assignment := range assignments {
 		(*storedAssignments)[assignment.SplitName] = assignment.Variant
 	}
@@ -453,12 +461,12 @@ func getV1SplitDetail() (interface{}, error) {
 		Location:           "location",
 		Platform:           "platform",
 		VariantDetails: []v1VariantDetail{
-			v1VariantDetail{
+			{
 				Name:          "variant_a",
 				Description:   "this is a fake description",
 				ScreenshotURL: "https://example.org/a",
 			},
-			v1VariantDetail{
+			{
 				Name:          "variant_b",
 				Description:   "this is another fake description",
 				ScreenshotURL: "https://example.org/b",

fakeserver/server_test.go

@@ -2,7 +2,6 @@ package fakeserver
 
 import (
 	"bytes"
-	"io/ioutil"
 	"log"
 	"net/http"
 	"net/http/httptest"
@@ -41,7 +40,7 @@ something_something_enabled: "true"
 func TestMain(m *testing.M) {
 	current, exists := os.LookupEnv("TESTTRACK_FAKE_SERVER_CONFIG_DIR")
 
-	dir, err := ioutil.TempDir("", "testtrack-cli")
+	dir, err := os.MkdirTemp("", "testtrack-cli")
 	if err != nil {
 		log.Fatal(err)
 	}
@@ -53,12 +52,12 @@ func TestMain(m *testing.M) {
 	}
 
 	schemaContent := []byte(testSchema)
-	if err := ioutil.WriteFile(filepath.Join(schemasDir, "test.yml"), schemaContent, 0644); err != nil {
+	if err := os.WriteFile(filepath.Join(schemasDir, "test.yml"), schemaContent, 0644); err != nil {
 		log.Fatal(err)
 	}
 
 	assignmentsContent := []byte(testAssignments)
-	if err := ioutil.WriteFile(filepath.Join(dir, "assignments.yml"), assignmentsContent, 0644); err != nil {
+	if err := os.WriteFile(filepath.Join(dir, "assignments.yml"), assignmentsContent, 0644); err != nil {
 		log.Fatal(err)
 	}
 
@@ -230,7 +229,7 @@ func TestCors(t *testing.T) {
 		h.ServeHTTP(w, request)
 
 		require.Equal(t, http.StatusOK, w.Code)
-		require.Equal(t, "", w.HeaderMap.Get("Access-Control-Allow-Origin"))
+		require.Equal(t, "", w.Result().Header.Get("Access-Control-Allow-Origin"))
 	})
 
 	t.Run("it passes cors with an allowed origin", func(t *testing.T) {
@@ -243,7 +242,7 @@ func TestCors(t *testing.T) {
 		h.ServeHTTP(w, request)
 
 		require.Equal(t, http.StatusOK, w.Code)
-		require.Equal(t, "http://www.allowed.com", w.HeaderMap.Get("Access-Control-Allow-Origin"))
+		require.Equal(t, "http://www.allowed.com", w.Result().Header.Get("Access-Control-Allow-Origin"))
 	})
 
 	t.Run("it passes cors from localhost", func(t *testing.T) {
@@ -256,7 +255,7 @@ func TestCors(t *testing.T) {
 		h.ServeHTTP(w, request)
 
 		require.Equal(t, http.StatusOK, w.Code)
-		require.Equal(t, "http://localhost:3000", w.HeaderMap.Get("Access-Control-Allow-Origin"))
+		require.Equal(t, "http://localhost:3000", w.Result().Header.Get("Access-Control-Allow-Origin"))
 	})
 
 	t.Run("it passes cors from loopback ip", func(t *testing.T) {
@@ -269,7 +268,7 @@ func TestCors(t *testing.T) {
 		h.ServeHTTP(w, request)
 
 		require.Equal(t, http.StatusOK, w.Code)
-		require.Equal(t, "http://127.0.0.1:3000", w.HeaderMap.Get("Access-Control-Allow-Origin"))
+		require.Equal(t, "http://127.0.0.1:3000", w.Result().Header.Get("Access-Control-Allow-Origin"))
 	})
 
 	os.Unsetenv("TESTTRACK_ALLOWED_ORIGINS")
@@ -305,11 +304,11 @@ func TestPersistAssignmentV2(t *testing.T) {
 
 		overrides := v2AssignmentOverrideRequestBody{
 			Assignments: []v1Assignment{
-				v1Assignment{
+				{
 					SplitName: "test.test_experiment",
 					Variant:   "control",
 				},
-				v1Assignment{
+				{
 					SplitName: "test.test2_experiment",
 					Variant:   "treatment",
 				},