ci: enable golangci-lint

Author: aramase

.gitignore

@@ -28,3 +28,6 @@ _output/
 
 # e2e output
 tests/e2e/generated_manifests/*
+
+# Go tools
+.tools/

.golangci.yml

@@ -0,0 +1,26 @@
+run:
+  timeout: 5m
+  skip-dirs:
+  skip-files:
+
+linters:
+  disable-all: true
+  enable:
+    - deadcode
+    - goconst
+    - gocyclo
+    - gofmt
+    - goimports
+    - golint
+    - gosec
+    - gosimple
+    - govet
+    - ineffassign
+    - maligned
+    - misspell
+    - nakedret
+    - prealloc
+    - staticcheck
+    - structcheck
+    - unused
+    - varcheck

.pipelines/unit-tests-template.yml

@@ -13,6 +13,8 @@ jobs:
           version: 1.15
       - script: make build
         displayName: Build
+      - script: make lint
+        displayName: Run lint
       - script: make unit-test
         displayName: Run unit tests
       - script: |

Makefile

@@ -17,6 +17,10 @@ BUILD_DATE := $$(date +%Y-%m-%d-%H:%M)
 GIT_VAR := $(REPO_PATH)/pkg/version.GitCommit
 GIT_HASH := $$(git rev-parse --short HEAD)
 
+GO_FILES=$(shell go list ./... | grep -v /test/e2e)
+TOOLS_MOD_DIR := ./tools
+TOOLS_DIR := $(abspath ./.tools)
+
 # docker env var
 DOCKER_BUILDKIT = 1
 export DOCKER_BUILDKIT
@@ -28,6 +32,14 @@ BATS_VERSION ?= 1.2.1
 
 GO_BUILD_OPTIONS := --tags "netgo osusergo"  -ldflags "-s -X $(BUILD_VERSION_VAR)=$(IMAGE_VERSION) -X $(GIT_VAR)=$(GIT_HASH) -X $(BUILD_DATE_VAR)=$(BUILD_DATE) -extldflags '-static'"
 
+$(TOOLS_DIR)/golangci-lint: $(TOOLS_MOD_DIR)/go.mod $(TOOLS_MOD_DIR)/go.sum $(TOOLS_MOD_DIR)/tools.go
+	cd $(TOOLS_MOD_DIR) && \
+	go build -o $(TOOLS_DIR)/golangci-lint github.com/golangci/golangci-lint/cmd/golangci-lint
+
+.PHONY: lint
+lint: $(TOOLS_DIR)/golangci-lint
+	$(TOOLS_DIR)/golangci-lint run --timeout=5m -v
+
 .PHONY: build
 build:
 	$Q GOOS=linux CGO_ENABLED=0 go build $(GO_BUILD_OPTIONS) -o _output/kubernetes-kms ./cmd/server/

go.mod

@@ -8,8 +8,6 @@ require (
 	github.com/Azure/go-autorest/autorest/adal v0.8.2
 	github.com/Azure/go-autorest/autorest/to v0.4.0 // indirect
 	github.com/Azure/go-autorest/autorest/validation v0.3.0 // indirect
-	github.com/golang/mock v1.3.1
-	github.com/golang/protobuf v1.4.2
 	golang.org/x/crypto v0.0.0-20200622213623-75b288015ac9
 	golang.org/x/net v0.0.0-20200707034311-ab3426394381
 	google.golang.org/grpc v1.27.0

pkg/plugin/mock_keyvault/keyvault_mock.go

@@ -3,7 +3,7 @@
 // This source code is licensed under the MIT license found in the
 // LICENSE file in the root directory of this source tree.
 
-package mock_keyvault
+package mockkeyvault
 
 import (
 	"context"
@@ -36,13 +36,11 @@ func (kvc *KeyVaultClient) SetEncryptResponse(encryptOut []byte, err error) {
 	defer kvc.mutex.Unlock()
 	kvc.encryptOut = encryptOut
 	kvc.encryptErr = err
-	return
 }
 
 func (kvc *KeyVaultClient) SetDecryptResponse(decryptOut []byte, err error) {
 	kvc.mutex.Lock()
 	defer kvc.mutex.Unlock()
 	kvc.decryptOut = decryptOut
 	kvc.decryptErr = err
-	return
 }

pkg/plugin/server_test.go

@@ -12,7 +12,7 @@ import (
 
 	k8spb "k8s.io/apiserver/pkg/storage/value/encrypt/envelope/v1beta1"
 
-	"github.com/Azure/kubernetes-kms/pkg/plugin/mock_keyvault"
+	mockkeyvault "github.com/Azure/kubernetes-kms/pkg/plugin/mock_keyvault"
 	"github.com/Azure/kubernetes-kms/pkg/version"
 )
 
@@ -39,7 +39,7 @@ func TestEncrypt(t *testing.T) {
 
 	for _, test := range tests {
 		t.Run(test.desc, func(t *testing.T) {
-			kvClient := &mock_keyvault.KeyVaultClient{}
+			kvClient := &mockkeyvault.KeyVaultClient{}
 			kvClient.SetEncryptResponse(test.output, test.err)
 
 			kmsServer := KeyManagementServiceServer{
@@ -82,7 +82,7 @@ func TestDecrypt(t *testing.T) {
 
 	for _, test := range tests {
 		t.Run(test.desc, func(t *testing.T) {
-			kvClient := &mock_keyvault.KeyVaultClient{}
+			kvClient := &mockkeyvault.KeyVaultClient{}
 			kvClient.SetDecryptResponse(test.output, test.err)
 
 			kmsServer := KeyManagementServiceServer{

pkg/version/version.go

@@ -11,7 +11,7 @@ var (
 	BuildDate string
 	// GitCommit is the commit hash when the binary was built
 	GitCommit string
-	// BinaryVersion is the version of the KMS binary
+	// BuildVersion is the version of the KMS binary
 	BuildVersion string
 	APIVersion   = "v1beta1"
 	Runtime      = "Microsoft AzureKMS"

tests/grpc/mock_v1beta1/kmsc_mock.go

@@ -0,0 +1,5 @@
+module github.com/Azure/kubernetes-kms/tools
+
+go 1.15
+
+require github.com/golangci/golangci-lint v1.30.0