feat: enable gosec and default linter set (#353)

* feat: enable gosec and default linter set

fixes: #352

Signed-off-by: jpwhitemn <[email protected]>

.golangci.yml

@@ -0,0 +1,4 @@
+linters:
+  disable:
+  enable:
+    - gosec

Makefile

@@ -1,10 +1,12 @@
-.PHONY: build test clean prepare update docker
+.PHONY: build test unittest lint clean prepare update docker
 
 GO=CGO_ENABLED=0 GO111MODULE=on go
 GOCGO=GCO_ENABLED=1 GO111MODULE=on go
 
 MICROSERVICES=cmd/device-mqtt
 
+ARCH=$(shell uname -m)
+
 .PHONY: $(MICROSERVICES)
 
 DOCKERS=docker_device_mqtt_go
@@ -24,8 +26,15 @@ build: $(MICROSERVICES)
 cmd/device-mqtt:
 	$(GOCGO) build $(GOFLAGS) -o $@ ./cmd
 
-test:
-	$(GOCGO) test ./... -coverprofile=coverage.out
+unittest:
+	$(GOCGO) test ./... -coverprofile=coverage.out ./...
+
+
+lint:
+	@which golangci-lint >/dev/null || echo "WARNING: go linter not installed. To install, run\n  curl -sSfL https://raw.githubusercontent.com/golangci/golangci-lint/master/install.sh | sh -s -- -b \$$(go env GOPATH)/bin v1.42.1"
+	@if [ "z${ARCH}" = "zx86_64" ] && which golangci-lint >/dev/null ; then golangci-lint run --config .golangci.yml ; else echo "WARNING: Linting skipped (not on x86_64 or linter not installed)"; fi
+
+test: unittest lint
 	$(GOCGO) vet ./...
 	gofmt -l $$(find . -type f -name '*.go'| grep -v "/vendor/")
 	[ "`gofmt -l $$(find . -type f -name '*.go'| grep -v "/vendor/")`" = "" ]

internal/driver/driver.go

@@ -21,7 +21,7 @@ import (
 	"github.com/edgexfoundry/go-mod-core-contracts/v2/errors"
 	"github.com/edgexfoundry/go-mod-core-contracts/v2/models"
 
-	"github.com/eclipse/paho.mqtt.golang"
+	mqtt "github.com/eclipse/paho.mqtt.golang"
 	"github.com/google/uuid"
 	"github.com/spf13/cast"
 )
@@ -150,7 +150,12 @@ func (d *Driver) handleReadCommandRequest(req sdkModel.CommandRequest, topic str
 	driver.Logger.Debugf("Parse command response: %v", cmdResponse)
 
 	var response map[string]interface{}
-	json.Unmarshal([]byte(cmdResponse), &response)
+	err = json.Unmarshal([]byte(cmdResponse), &response)
+	if err != nil {
+		driver.Logger.Errorf("Error unmarshaling response: %s", err)
+		return nil, errors.NewCommonEdgeX(errors.KindIOError, "Error umarshaling the response", err)
+	}
+
 	reading, ok := response[cmd]
 	if !ok {
 		return nil, errors.NewCommonEdgeX(errors.KindContractInvalid, fmt.Sprintf("'%s' field not found in the response %s", cmd, cmdResponse), nil)

internal/driver/incominglistener.go

@@ -14,7 +14,7 @@ import (
 	"github.com/edgexfoundry/device-sdk-go/v2/pkg/models"
 	"github.com/edgexfoundry/device-sdk-go/v2/pkg/service"
 
-	"github.com/eclipse/paho.mqtt.golang"
+	mqtt "github.com/eclipse/paho.mqtt.golang"
 )
 
 const (
@@ -42,8 +42,11 @@ func (d *Driver) onIncomingDataReceived(client mqtt.Client, message mqtt.Message
 		reading = string(message.Payload())
 	} else {
 		var data map[string]interface{}
-		json.Unmarshal(message.Payload(), &data)
-
+		err := json.Unmarshal(message.Payload(), &data)
+		if err != nil {
+			driver.Logger.Errorf("Error unmarshaling payload: %s", err)
+			return
+		}
 		nameVal, ok := data[name]
 		if !ok {
 			driver.Logger.Errorf("[Incoming listener] Incoming reading ignored, reading data `%v` should contain the field `%s` to indicate the device name", data, name)

internal/driver/readingchecker.go

@@ -45,20 +45,20 @@ func checkUintValueRange(valueType string, val uint64) bool {
 	var isValid = false
 	switch valueType {
 	case common.ValueTypeUint8:
-		if val >= 0 && val <= math.MaxUint8 {
+		if val <= math.MaxUint8 {
 			isValid = true
 		}
 	case common.ValueTypeUint16:
-		if val >= 0 && val <= math.MaxUint16 {
+		if val <= math.MaxUint16 {
 			isValid = true
 		}
 	case common.ValueTypeUint32:
-		if val >= 0 && val <= math.MaxUint32 {
+		if val <= math.MaxUint32 {
 			isValid = true
 		}
 	case common.ValueTypeUint64:
 		maxiMum := uint64(math.MaxUint64)
-		if val >= 0 && val <= maxiMum {
+		if val <= maxiMum {
 			isValid = true
 		}
 	}
@@ -81,9 +81,7 @@ func checkIntValueRange(valueType string, val int64) bool {
 			isValid = true
 		}
 	case common.ValueTypeInt64:
-		if val >= math.MinInt64 && val <= math.MaxInt64 {
-			isValid = true
-		}
+		isValid = true
 	}
 	return isValid
 }

internal/driver/responselistener.go

@@ -10,7 +10,7 @@ import (
 	"encoding/json"
 	"strings"
 
-	"github.com/eclipse/paho.mqtt.golang"
+	mqtt "github.com/eclipse/paho.mqtt.golang"
 )
 
 func (d *Driver) onCommandResponseReceived(client mqtt.Client, message mqtt.Message) {
@@ -30,7 +30,11 @@ func (d *Driver) onCommandResponseReceived(client mqtt.Client, message mqtt.Mess
 		var response map[string]interface{}
 		var ok bool
 
-		json.Unmarshal(message.Payload(), &response)
+		err := json.Unmarshal(message.Payload(), &response)
+		if err != nil {
+			driver.Logger.Errorf("Error unmarshaling payload: %s", err)
+			return
+		}
 		uuid, ok = response["uuid"].(string)
 		if !ok {
 			driver.Logger.Errorf("[Response listener] Command response ignored. No UUID found in the message: topic=%v msg=%v", message.Topic(), string(message.Payload()))

mock/device.go

@@ -14,7 +14,7 @@ import (
 	"net/url"
 	"time"
 
-	"github.com/eclipse/paho.mqtt.golang"
+	mqtt "github.com/eclipse/paho.mqtt.golang"
 )
 
 const (
@@ -91,14 +91,14 @@ func runDataSender() {
 	data["method"] = "get"
 
 	for {
-		data["randnum"] = rand.Float64()
+		data["randnum"] = rand.Float64() //nolint:gosec
 		jsonData, err := json.Marshal(data)
 		if err != nil {
 			fmt.Println(err)
 		}
 		client.Publish(topic, qos, false, jsonData)
 
-		fmt.Println(fmt.Sprintf("Send response: %v", string(jsonData)))
+		fmt.Printf("Send response: %v", string(jsonData))
 
 		time.Sleep(time.Second * time.Duration(30))
 	}
@@ -108,7 +108,11 @@ func runDataSender() {
 func onCommandReceivedFromBroker(client mqtt.Client, message mqtt.Message) {
 	var request map[string]interface{}
 
-	json.Unmarshal(message.Payload(), &request)
+	err := json.Unmarshal(message.Payload(), &request)
+	if err != nil {
+		log.Println(fmt.Sprintf("Error unmarshaling payload: %s", err))
+		return
+	}
 	uuid, ok := request["uuid"]
 	if ok {
 		log.Println(fmt.Sprintf("Command response received: topic=%v uuid=%v msg=%v", message.Topic(), uuid, string(message.Payload())))
@@ -121,10 +125,10 @@ func onCommandReceivedFromBroker(client mqtt.Client, message mqtt.Message) {
 				request["ping"] = "pong"
 				sendTestData(request)
 			case "randfloat32":
-				request["randfloat32"] = rand.Float32()
+				request["randfloat32"] = rand.Float32() //nolint:gosec
 				sendTestData(request)
 			case "randfloat64":
-				request["randfloat64"] = rand.Float64()
+				request["randfloat64"] = rand.Float64() //nolint:gosec
 				sendTestData(request)
 			case "message":
 				request["message"] = "test-message"
@@ -159,24 +163,24 @@ func sendTestData(response map[string]interface{}) {
 	}
 	client.Publish(topic, qos, false, jsonData)
 
-	fmt.Println(fmt.Sprintf("Send response: %v", string(jsonData)))
+	fmt.Printf("Send response: %v", string(jsonData))
 }
 
 func createMqttClient(clientID string, uri *url.URL) (mqtt.Client, error) {
-	fmt.Println(fmt.Sprintf("Create MQTT client and connection: uri=%v clientID=%v ", uri.String(), clientID))
+	fmt.Printf("Create MQTT client and connection: uri=%v clientID=%v ", uri.String(), clientID)
 	opts := mqtt.NewClientOptions()
 	opts.AddBroker(fmt.Sprintf("%s://%s", uri.Scheme, uri.Host))
 	opts.SetClientID(clientID)
 	opts.SetUsername(uri.User.Username())
 	password, _ := uri.User.Password()
 	opts.SetPassword(password)
 	opts.SetConnectionLostHandler(func(client mqtt.Client, e error) {
-		fmt.Println(fmt.Sprintf("Connection lost : %v", e))
+		fmt.Printf("Connection lost : %v", e)
 		token := client.Connect()
 		if token.Wait() && token.Error() != nil {
-			fmt.Println(fmt.Sprintf("Reconnection failed : %v", e))
+			fmt.Printf("Reconnection failed : %v", e)
 		} else {
-			fmt.Println(fmt.Sprintf("Reconnection sucessful : %v", e))
+			fmt.Printf("Reconnection sucessful : %v", e)
 		}
 	})