upgrade to go 1.21

Author: ChrisScotMartin

go.mod

@@ -1,20 +1,27 @@
 module github.com/Clever/sphinx
 
-go 1.15
+go 1.21
 
 require (
 	github.com/Clever/leakybucket v1.1.0
 	github.com/aws/aws-sdk-go v1.29.34
+	github.com/pborman/uuid v0.0.0-20180906182336-adf5a7427709
+	github.com/stretchr/testify v1.5.1
+	gopkg.in/Clever/kayvee-go.v6 v6.24.0
+	gopkg.in/tylerb/graceful.v1 v1.2.15
+	gopkg.in/yaml.v1 v1.0.0-20140924161607-9f9df34309c0
+)
+
+require (
+	github.com/davecgh/go-spew v1.1.1 // indirect
 	github.com/eapache/go-resiliency v1.2.0 // indirect
 	github.com/garyburd/redigo v1.6.0 // indirect
 	github.com/google/uuid v1.1.1 // indirect
-	github.com/pborman/uuid v0.0.0-20180906182336-adf5a7427709
+	github.com/jmespath/go-jmespath v0.0.0-20180206201540-c2b33e8439af // indirect
+	github.com/pmezard/go-difflib v1.0.0 // indirect
 	github.com/stretchr/objx v0.2.0 // indirect
-	github.com/stretchr/testify v1.5.1
 	github.com/xeipuuv/gojsonpointer v0.0.0-20190905194746-02993c407bfb // indirect
+	github.com/xeipuuv/gojsonreference v0.0.0-20180127040603-bd5ef7bd5415 // indirect
 	github.com/xeipuuv/gojsonschema v1.2.1-0.20200118195451-b537c054d4b4 // indirect
-	gopkg.in/Clever/kayvee-go.v6 v6.24.0
-	gopkg.in/tylerb/graceful.v1 v1.2.15
-	gopkg.in/yaml.v1 v1.0.0-20140924161607-9f9df34309c0
 	gopkg.in/yaml.v2 v2.2.8 // indirect
 )

golang.mk

@@ -1,7 +1,7 @@
 # This is the default Clever Golang Makefile.
 # It is stored in the dev-handbook repo, github.com/Clever/dev-handbook
 # Please do not alter this file directly.
-GOLANG_MK_VERSION := 1.0.0
+GOLANG_MK_VERSION := 1.2.1
 
 SHELL := /bin/bash
 SYSTEM := $(shell uname -a | cut -d" " -f1 | tr '[:upper:]' '[:lower:]')
@@ -11,7 +11,7 @@ SYSTEM := $(shell uname -a | cut -d" " -f1 | tr '[:upper:]' '[:lower:]')
 export TZ=UTC
 
 # go build flags for use across all commands which accept them
-GO_BUILD_FLAGS := "-mod=mod"
+export GOFLAGS := -mod=vendor $(GOFLAGS)
 
 # if the gopath includes several directories, use only the first
 GOPATH=$(shell echo $$GOPATH | cut -d: -f1)
@@ -39,17 +39,19 @@ endef
 # so we're defended against it breaking or changing in the future.
 FGT := $(GOPATH)/bin/fgt
 $(FGT):
-	go get github.com/GeertJohan/fgt@262f7b11eec07dc7b147c44641236f3212fee89d
+	go install -mod=readonly github.com/GeertJohan/fgt@262f7b11eec07dc7b147c44641236f3212fee89d
 
 golang-ensure-curl-installed:
 	@command -v curl >/dev/null 2>&1 || { echo >&2 "curl not installed. Please install curl."; exit 1; }
 
 # Golint is a tool for linting Golang code for common errors.
 # We pin its version because an update could add a new lint check which would make
 # previously passing tests start failing without changing our code.
+# this package is deprecated and frozen
+# Infra recomendation is to eventaully move to https://github.com/golangci/golangci-lint so don't fail on linting error for now
 GOLINT := $(GOPATH)/bin/golint
 $(GOLINT):
-	go get golang.org/x/lint/golint@738671d3881b9731cc63024d5d88cf28db875626
+	go install -mod=readonly golang.org/x/lint/golint@738671d3881b9731cc63024d5d88cf28db875626
 
 # golang-fmt-deps requires the FGT tool for checking output
 golang-fmt-deps: $(FGT)
@@ -74,22 +76,14 @@ endef
 # golang-lint-deps-strict requires the golint tool for golang linting.
 golang-lint-deps-strict: $(GOLINT) $(FGT)
 
-# golang-lint-strict calls golint on all golang files in the pkg and fails if any lint
-# errors are found.
-# arg1: pkg path
-define golang-lint-strict
-@echo "LINTING $(1)..."
-@PKG_PATH=$$(go list -f '{{.Dir}}' $(1)); find $${PKG_PATH}/*.go -type f | grep -v gen_ | xargs $(FGT) $(GOLINT)
-endef
-
 # golang-test-deps is here for consistency
 golang-test-deps:
 
 # golang-test uses the Go toolchain to run all tests in the pkg.
 # arg1: pkg path
 define golang-test
 @echo "TESTING $(1)..."
-@go test $(GO_BUILD_FLAGS) -v $(1)
+@go test -v $(1)
 endef
 
 # golang-test-strict-deps is here for consistency
@@ -99,7 +93,22 @@ golang-test-strict-deps:
 # arg1: pkg path
 define golang-test-strict
 @echo "TESTING $(1)..."
-@go test -v $(GO_BUILD_FLAGS) -race $(1)
+@go test -v -race $(1)
+endef
+
+# golang-test-strict-cover-deps is here for consistency
+golang-test-strict-cover-deps:
+
+# golang-test-strict-cover uses the Go toolchain to run all tests in the pkg with the race and cover flag.
+# appends coverage results to coverage.txt
+# arg1: pkg path
+define golang-test-strict-cover
+@echo "TESTING $(1)..."
+@go test -v -race -cover -coverprofile=profile.tmp -covermode=atomic $(1)
+@if [ -f profile.tmp ]; then \
+  cat profile.tmp | tail -n +2 >> coverage.txt; \
+  rm profile.tmp; \
+fi;
 endef
 
 # golang-vet-deps is here for consistency
@@ -109,7 +118,7 @@ golang-vet-deps:
 # arg1: pkg path
 define golang-vet
 @echo "VETTING $(1)..."
-@go vet $(GO_BUILD_FLAGS) $(1)
+@go vet $(1)
 endef
 
 # golang-test-all-deps installs all dependencies needed for different test cases.
@@ -132,24 +141,41 @@ golang-test-all-strict-deps: golang-fmt-deps golang-lint-deps-strict golang-test
 # arg1: pkg path
 define golang-test-all-strict
 $(call golang-fmt,$(1))
-$(call golang-lint-strict,$(1))
+$(call golang-lint,$(1))
 $(call golang-vet,$(1))
 $(call golang-test-strict,$(1))
 endef
 
+# golang-test-all-strict-cover-deps: installs all dependencies needed for different test cases.
+golang-test-all-strict-cover-deps: golang-fmt-deps golang-lint-deps-strict golang-test-strict-cover-deps golang-vet-deps
+
+# golang-test-all-strict-cover calls fmt, lint, vet and test on the specified pkg with strict and cover
+# requirements that no errors are thrown while linting.
+# arg1: pkg path
+define golang-test-all-strict-cover
+$(call golang-fmt,$(1))
+$(call golang-lint,$(1))
+$(call golang-vet,$(1))
+$(call golang-test-strict-cover,$(1))
+endef
+
 # golang-build: builds a golang binary. ensures CGO build is done during CI. This is needed to make a binary that works with a Docker alpine image.
 # arg1: pkg path
 # arg2: executable name
 define golang-build
-@echo "BUILDING..."
+@echo "BUILDING $(2)..."
 @if [ -z "$$CI" ]; then \
-	go build $(GO_BUILD_FLAGS) -o bin/$(2) $(1); \
+	go build -o bin/$(2) $(1); \
 else \
 	echo "-> Building CGO binary"; \
-	CGO_ENABLED=0 go build $(GO_BUILD_FLAGS) -installsuffix cgo -o bin/$(2) $(1); \
+	CGO_ENABLED=0 go build -installsuffix cgo -o bin/$(2) $(1); \
 fi;
 endef
 
+# golang-setup-coverage: set up the coverage file
+golang-setup-coverage:
+	@echo "mode: atomic" > coverage.txt
+
 # golang-update-makefile downloads latest version of golang.mk
 golang-update-makefile:
 	@wget https://raw.githubusercontent.com/Clever/dev-handbook/master/make/golang-v1.mk -O /tmp/golang.mk 2>/dev/null

handlers/http_test.go

@@ -101,8 +101,8 @@ func constructHTTPRateLimiter() httpRateLimiter {
 
 func TestParsesHeaders(t *testing.T) {
 	request := common.HTTPToSphinxRequest(constructMockRequestWithHeaders(map[string][]string{
-		"Authorization":   []string{"Bearer 12345"},
-		"X-Forwarded-For": []string{"IP1", "IP2"},
+		"Authorization":   {"Bearer 12345"},
+		"X-Forwarded-For": {"IP1", "IP2"},
 	}))
 	if len(request["headers"].(http.Header)) != 2 {
 		t.Fatalf("expected 2 headers, recevied %d", len(request["headers"].(http.Header)))

limitkeys/headerlimitkey_test.go

@@ -17,7 +17,7 @@ func TestKeysWithHeaders(t *testing.T) {
 	}
 
 	request := getRequest(map[string][]string{
-		"Authorization": []string{"Bearer 12345"},
+		"Authorization": {"Bearer 12345"},
 	})
 	if key, err := limitkey.Key(request); err != nil || key != "Authorization:Bearer 12345" {
 		t.Error("HeaderKey did not match")
@@ -31,7 +31,7 @@ func TestKeysWithHeaders(t *testing.T) {
 	}
 
 	request = getRequest(map[string][]string{
-		"X-Forwarded-For": []string{"127.0.0.1", "172.0.0.1"},
+		"X-Forwarded-For": {"127.0.0.1", "172.0.0.1"},
 	})
 	if key, err := limitkey.Key(request); err != nil || key !=
 		"X-Forwarded-For:127.0.0.1;172.0.0.1" {
@@ -46,7 +46,7 @@ func TestKeysWithHeadersSalt(t *testing.T) {
 	}
 
 	request := getRequest(map[string][]string{
-		"Authorization": []string{"Bearer 12345"},
+		"Authorization": {"Bearer 12345"},
 	})
 	if key, err := limitkey.Key(request); err != nil {
 		t.Fatal(err)
@@ -62,7 +62,7 @@ func TestKeysWithHeadersSalt(t *testing.T) {
 	}
 
 	request = getRequest(map[string][]string{
-		"X-Forwarded-For": []string{"127.0.0.1", "172.0.0.1"},
+		"X-Forwarded-For": {"127.0.0.1", "172.0.0.1"},
 	})
 	if key, err := limitkey.Key(request); err != nil || key !=
 		"X-Forwarded-For:127.0.0.1;172.0.0.1" {
@@ -78,7 +78,7 @@ func TestKeysWithoutHeaders(t *testing.T) {
 
 	// returns custom error when no key is found
 	request := getRequest(map[string][]string{
-		"X-Forwarded-For": []string{"127.0.0.1"},
+		"X-Forwarded-For": {"127.0.0.1"},
 	})
 	key, err := limitkey.Key(request)
 	if key != "" {

matchers/headermatcher_test.go

@@ -96,29 +96,29 @@ headers:
 		t.Fatalf("Failed to create HeaderMatcher: %s", err)
 	}
 	request := getRequest(map[string][]string{
-		"Authorization": []string{"Bearer 12345"},
+		"Authorization": {"Bearer 12345"},
 	})
 
 	if !headermatcher.Match(request) {
 		t.Fatalf("Should have matched Header Authorization")
 	}
 
 	request = getRequest(map[string][]string{
-		"Authorization": []string{"Basic 12345"},
+		"Authorization": {"Basic 12345"},
 	})
 	if headermatcher.Match(request) {
 		t.Fatalf("Should NOT have matched Header Authorization Basic")
 	}
 
 	request = getRequest(map[string][]string{
-		"X-Forwarded-For": []string{"192.0.0.1", "127.0.0.1"},
-		"Authorization":   []string{"Basic 12345"},
+		"X-Forwarded-For": {"192.0.0.1", "127.0.0.1"},
+		"Authorization":   {"Basic 12345"},
 	})
 	if !headermatcher.Match(request) {
 		t.Fatalf("Should have matched X-Forwarded-For")
 	}
 	request = getRequest(map[string][]string{
-		"Authorization": []string{"Basic 12345"},
+		"Authorization": {"Basic 12345"},
 	})
 	if headermatcher.Match(request) {
 		t.Fatalf("Should NOT have matched Header Authorization Basic")
@@ -137,14 +137,14 @@ headers:
 	}
 
 	request := getRequest(map[string][]string{
-		"Authorization": []string{"Bearer 12345"},
+		"Authorization": {"Bearer 12345"},
 	})
 	if !headermatcher.Match(request) {
 		t.Fatalf("Should have matched Header Authorization")
 	}
 
 	request = getRequest(map[string][]string{
-		"X-Forwarded-For": []string{"192.0.0.1"},
+		"X-Forwarded-For": {"192.0.0.1"},
 	})
 	if headermatcher.Match(request) {
 		t.Fatalf("Should NOT have matched Header X-Forwarded-For")

ratelimiter/ratelimiter_test.go

@@ -80,7 +80,7 @@ func TestSimpleAdd(t *testing.T) {
 	}
 	if err = checkLastStatusForRequests(
 		ratelimiter, request, 5, []Status{
-			Status{Remaining: 195, Name: "bearer-special"}}); err != nil {
+			{Remaining: 195, Name: "bearer-special"}}); err != nil {
 		t.Error(err)
 	}
 
@@ -93,7 +93,7 @@ func TestSimpleAdd(t *testing.T) {
 
 	if err = checkLastStatusForRequests(
 		ratelimiter, request, 1, []Status{
-			Status{Remaining: 195, Name: "basic-simple"}}); err != nil {
+			{Remaining: 195, Name: "basic-simple"}}); err != nil {
 		t.Error(err)
 	}