test: add linter for manager api

.github/workflows/golang-lint.yml

@@ -0,0 +1,16 @@
+name: golang-lint
+on:
+  push:
+    branches:
+      - master
+  pull_request:
+    branches:
+      - master
+jobs:
+  golangci:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+
+      - name: run lint
+        run: make golang-lint

Makefile

@@ -15,11 +15,31 @@
 # limitations under the License.
 #
 
+SHELL := /bin/bash -o pipefail
+
+
+### help:             Show Makefile rules
+.PHONY: help
+help:
+	@echo Makefile rules:
+	@echo
+	@grep -E '^### [-A-Za-z0-9_]+:' Makefile | sed 's/###/   /'
+
 ### license-check:    Check apisix-dashboard source codes for Apache License
 .PHONY: license-check
 license-check:
 ifeq ("$(wildcard .actions/openwhisk-utilities/scancode/scanCode.py)", "")
 	git clone https://github.com/apache/openwhisk-utilities.git .actions/openwhisk-utilities
 	cp .actions/ASF* .actions/openwhisk-utilities/scancode/
 endif
-	.actions/openwhisk-utilities/scancode/scanCode.py --config .actions/ASF-Release.cfg ./
+	.actions/openwhisk-utilities/scancode/scanCode.py --config .actions/ASF-Release.cfg ./
+
+### golang-lint:             Lint Go source code
+.PHONY: golang-lint
+golang-lint: ## Run the golangci-lint application (install if not found)
+	@#Brew - MacOS
+	@if [ "$(shell command -v golangci-lint)" = "" ] && [ "$(shell command -v brew)" != "" ]; then brew install golangci-lint; fi;
+	@#has sudo
+	@if [ "$(shell command -v golangci-lint)" = "" ]; then curl -sSfL https://raw.githubusercontent.com/golangci/golangci-lint/master/install.sh | sh -s v1.32.0 && sudo cp ./bin/golangci-lint $(go env GOPATH)/bin/; fi;
+	@echo "running golangci-lint..."
+	@cd api && golangci-lint run --tests=false ./...

api/conf/conf.go

@@ -36,8 +36,8 @@ const (
 	EnvDEV   = "dev"
 	EnvLOCAL = "local"
 
-	confPath   = "/go/manager-api/conf.json"
-	schemaPath = "/go/manager-api/schema.json"
+	confJsonPath = "/go/manager-api/conf.json"
+	schemaPath   = "/go/manager-api/schema.json"
 )
 
 var (
@@ -103,7 +103,7 @@ func configurationPath() string {
 	} else if ENV == EnvLOCAL {
 		return filepath.Join(filepath.Dir(basePath), "conf.json")
 	} else {
-		return confPath
+		return confJsonPath
 	}
 }
 

api/filter/logging.go

@@ -18,6 +18,7 @@ package filter
 
 import (
 	"bytes"
+	"fmt"
 	"io/ioutil"
 	"time"
 
@@ -42,16 +43,17 @@ func RequestLogHandler() gin.HandlerFunc {
 
 		param, _ := c.Get("requestBody")
 
-		switch param.(type) {
+		switch paramType := param.(type) {
 		case []byte:
 			param = string(param.([]byte))
+			fmt.Printf("type of param: %#v", paramType)
 		default:
 		}
 
 		blw := &bodyLogWriter{body: bytes.NewBufferString(""), ResponseWriter: c.Writer}
 		c.Writer = blw
 		c.Next()
-		latency := time.Now().Sub(start) / 1000000
+		latency := time.Since(start) / 1000000
 		statusCode := c.Writer.Status()
 		respBody := blw.body.String()
 		if uuid == "" {

api/internal/core/entity/format_test.go

@@ -28,7 +28,9 @@ func TestConsumer(t *testing.T) {
     "127.0.0.1:8080": 1
   }`
 	nodesMap := map[string]float64{}
-	json.Unmarshal([]byte(nodesStr), &nodesMap)
+	err := json.Unmarshal([]byte(nodesStr), &nodesMap)
+	assert.Nil(t, err)
+
 	res := NodesFormat(nodesMap)
 	nodes := res.([]*Node)
 

api/internal/core/store/store_test.go

@@ -580,7 +580,8 @@ func TestGenericStore_Create(t *testing.T) {
 			createCalled = true
 			assert.Equal(t, tc.wantKey, args[1], tc.caseDesc)
 			input := TestStruct{}
-			_ = json.Unmarshal([]byte(args[2].(string)), &input)
+			err := json.Unmarshal([]byte(args[2].(string)), &input)
+			assert.Nil(t, err)
 			assert.Equal(t, tc.giveObj.Field1, input.Field1, tc.caseDesc)
 			assert.Equal(t, tc.giveObj.Field2, input.Field2, tc.caseDesc)
 			assert.NotEqual(t, 0, len(input.ID), tc.caseDesc)
@@ -689,7 +690,8 @@ func TestGenericStore_Update(t *testing.T) {
 			createCalled = true
 			assert.Equal(t, tc.wantKey, args[1], tc.caseDesc)
 			input := TestStruct{}
-			_ = json.Unmarshal([]byte(args[2].(string)), &input)
+			err := json.Unmarshal([]byte(args[2].(string)), &input)
+			assert.Nil(t, err)
 			assert.Equal(t, tc.giveObj.Field1, input.Field1, tc.caseDesc)
 			assert.Equal(t, tc.giveObj.Field2, input.Field2, tc.caseDesc)
 			assert.NotEqual(t, 0, input.UpdateTime, tc.caseDesc)

api/internal/core/store/validate.go

@@ -20,6 +20,7 @@ import (
 	"errors"
 	"fmt"
 	"io/ioutil"
+	"log"
 
 	"github.com/xeipuuv/gojsonschema"
 	"go.uber.org/zap/buffer"
@@ -88,14 +89,17 @@ func NewAPISIXJsonSchemaValidator(jsonPath string) (Validator, error) {
 }
 
 func getPlugins(reqBody interface{}) map[string]interface{} {
-	switch reqBody.(type) {
+	switch bodyType := reqBody.(type) {
 	case *entity.Route:
+		log.Printf("type of reqBody: %#v", bodyType)
 		route := reqBody.(*entity.Route)
 		return route.Plugins
 	case *entity.Service:
+		log.Printf("type of reqBody: %#v", bodyType)
 		service := reqBody.(*entity.Service)
 		return service.Plugins
 	case *entity.Consumer:
+		log.Printf("type of reqBody: %#v", bodyType)
 		consumer := reqBody.(*entity.Consumer)
 		return consumer.Plugins
 	}
@@ -109,7 +113,7 @@ func cHashKeySchemaCheck(upstream *entity.UpstreamDef) error {
 	if upstream.HashOn != "vars" &&
 		upstream.HashOn != "header" &&
 		upstream.HashOn != "cookie" {
-		fmt.Errorf("invalid hash_on type: %s", upstream.HashOn)
+		return fmt.Errorf("invalid hash_on type: %s", upstream.HashOn)
 	}
 
 	var schemaDef string
@@ -187,9 +191,10 @@ func checkUpstream(upstream *entity.UpstreamDef) error {
 }
 
 func checkConf(reqBody interface{}) error {
-	switch reqBody.(type) {
+	switch bodyType := reqBody.(type) {
 	case *entity.Route:
 		route := reqBody.(*entity.Route)
+		fmt.Printf("type of reqBody: %#v", bodyType)
 		if err := checkUpstream(route.Upstream); err != nil {
 			return err
 		}
@@ -231,33 +236,31 @@ func (v *APISIXJsonSchemaValidator) Validate(obj interface{}) error {
 
 	//check plugin json schema
 	plugins := getPlugins(obj)
-	if plugins != nil {
-		for pluginName, pluginConf := range plugins {
-			schemaDef := conf.Schema.Get("plugins." + pluginName).String()
-			if schemaDef == "" {
-				return fmt.Errorf("scheme validate failed: schema not found, path: %s", "plugins."+pluginName)
-			}
+	for pluginName, pluginConf := range plugins {
+		schemaDef := conf.Schema.Get("plugins." + pluginName).String()
+		if schemaDef == "" {
+			return fmt.Errorf("scheme validate failed: schema not found, path: %s", "plugins."+pluginName)
+		}
 
-			s, err := gojsonschema.NewSchema(gojsonschema.NewStringLoader(schemaDef))
-			if err != nil {
-				return fmt.Errorf("scheme validate failed: %w", err)
-			}
+		s, err := gojsonschema.NewSchema(gojsonschema.NewStringLoader(schemaDef))
+		if err != nil {
+			return fmt.Errorf("scheme validate failed: %w", err)
+		}
 
-			ret, err := s.Validate(gojsonschema.NewGoLoader(pluginConf))
-			if err != nil {
-				return fmt.Errorf("scheme validate failed: %w", err)
-			}
+		ret, err := s.Validate(gojsonschema.NewGoLoader(pluginConf))
+		if err != nil {
+			return fmt.Errorf("scheme validate failed: %w", err)
+		}
 
-			if !ret.Valid() {
-				errString := buffer.Buffer{}
-				for i, vErr := range ret.Errors() {
-					if i != 0 {
-						errString.AppendString("\n")
-					}
-					errString.AppendString(vErr.String())
+		if !ret.Valid() {
+			errString := buffer.Buffer{}
+			for i, vErr := range ret.Errors() {
+				if i != 0 {
+					errString.AppendString("\n")
 				}
-				return fmt.Errorf("scheme validate failed: %s", errString.String())
+				errString.AppendString(vErr.String())
 			}
+			return fmt.Errorf("scheme validate failed: %s", errString.String())
 		}
 	}