Fix vulnerabilities and add go linter

eclipse · Jul 20, 2023 · d886dec · d886dec
1 parent 2b2a908
commit d886dec
Show file tree

Hide file tree

Showing 8 changed files with 245 additions and 150 deletions.
diff --git a/.github/workflows/kuksa-go.yml b/.github/workflows/kuksa-go.yml
@@ -43,4 +43,9 @@ jobs:
           export PATH=$PATH:$HOME/go/bin
           go generate .
           go test .
+      - name: golangci-lint
+        uses: golangci/golangci-lint-action@v3
+        with:
+          version: latest
+          working-directory: kuksa_go_client
 
diff --git a/kuksa-client/kuksa_client/grpc/__init__.py b/kuksa-client/kuksa_client/grpc/__init__.py
@@ -555,8 +555,8 @@ def _load_creds(self) -> Optional[grpc.ChannelCredentials]:
             if self.private_key and self.certificate_chain:
                 private_key = self.private_key.read_bytes()
                 certificate_chain = self.certificate_chain.read_bytes()
-                logger.info(f"Using private client key {self.private_key} "
-                                 f"and chain/certificate {self.certificate_chain}")
+                # As of today there is no option in KUKSA.val Databroker to require client authentication
+                logger.info("Using client private key and certificates, mutual TLS supported if supported by server")
                 return grpc.ssl_channel_credentials(root_certificates, private_key, certificate_chain)
             else:
                 logger.info(f"No client certificates provided, mutual TLS not supported!")

diff --git a/kuksa_go_client/README.md b/kuksa_go_client/README.md
@@ -79,3 +79,7 @@ go mod tidy
 
 This will update `go.mod`and `go.sum`.
 
+## Linters
+
+Our Continuous Integration verifies that the code pass the [Golang Linter](https://golangci-lint.run/usage/install).
+To avoid failing PR builds it is recommended to run the linter manually before creating a Pull Request.
diff --git a/kuksa_go_client/client_test.go b/kuksa_go_client/client_test.go
@@ -1,4 +1,3 @@
-
 //********************************************************************************
 // Copyright (c) 2022 Contributors to the Eclipse Foundation
 //
@@ -15,8 +14,8 @@
 package main
 
 import (
-	"testing"
 	"github.com/eclipse/kuksa.val/kuksa_go_client/kuksa_client"
+	"testing"
 )
 
 // Note: Go support two methods to write a string
@@ -32,96 +31,171 @@ import (
 func TestArrayParseNoQuote(t *testing.T) {
 
 	array, _ := kuksa_client.GetArrayFromInput[string](`[say hello, abc]`)
-	if len(array) != 2 { t.Fail()}
-	if array[0] != "say hello" { t.Fail()}
-	if array[1] != "abc" { t.Fail()}
+	if len(array) != 2 {
+		t.Fail()
+	}
+	if array[0] != "say hello" {
+		t.Fail()
+	}
+	if array[1] != "abc" {
+		t.Fail()
+	}
 }
 
 func TestArrayParseNoInsideQuote(t *testing.T) {
 
 	array, _ := kuksa_client.GetArrayFromInput[string](`["say hello","abc"]`)
-	if len(array) != 2 { t.Fail()}
-	if array[0] != "say hello" { t.Fail()}
-	if array[1] != "abc" { t.Fail()}
+	if len(array) != 2 {
+		t.Fail()
+	}
+	if array[0] != "say hello" {
+		t.Fail()
+	}
+	if array[1] != "abc" {
+		t.Fail()
+	}
 }
 
 func TestArrayParseNoInsideQuoteSingle(t *testing.T) {
 
 	array, _ := kuksa_client.GetArrayFromInput[string](`['say hello','abc']`)
-	if len(array) != 2 { t.Fail()}
-	if array[0] != "say hello" { t.Fail()}
-	if array[1] != "abc" { t.Fail()}
+	if len(array) != 2 {
+		t.Fail()
+	}
+	if array[0] != "say hello" {
+		t.Fail()
+	}
+	if array[1] != "abc" {
+		t.Fail()
+	}
 }
 
 func TestArrayParseDoubleQuote(t *testing.T) {
 
 	array, _ := kuksa_client.GetArrayFromInput[string](`["say \"hello\"","abc"]`)
-	if len(array) != 2 { t.Fail()}
-	if array[0] != `say "hello"` { t.Fail()}
-	if array[1] != "abc" { t.Fail()}
+	if len(array) != 2 {
+		t.Fail()
+	}
+	if array[0] != `say "hello"` {
+		t.Fail()
+	}
+	if array[1] != "abc" {
+		t.Fail()
+	}
 }
 
 func TestArrayParseSingleQuote(t *testing.T) {
 
 	array, _ := kuksa_client.GetArrayFromInput[string](`[say \'hello\',"abc"]`)
-	if len(array) != 2 { t.Fail()}
-	if array[0] != `say 'hello'` { t.Fail()}
-	if array[1] != "abc" { t.Fail()}
+	if len(array) != 2 {
+		t.Fail()
+	}
+	if array[0] != `say 'hello'` {
+		t.Fail()
+	}
+	if array[1] != "abc" {
+		t.Fail()
+	}
 }
-	
+
 func TestArrayParseComma(t *testing.T) {
 
 	array, _ := kuksa_client.GetArrayFromInput[string](`["say, hello","abc"]`)
-	if len(array) != 2 { t.Fail()}
-	if array[0] != `say, hello` { t.Fail()}
-	if array[1] != "abc" { t.Fail()}
+	if len(array) != 2 {
+		t.Fail()
+	}
+	if array[0] != `say, hello` {
+		t.Fail()
+	}
+	if array[1] != "abc" {
+		t.Fail()
+	}
 }
 
 func TestArraySquare(t *testing.T) {
 
 	array, _ := kuksa_client.GetArrayFromInput[string](`[say hello[], abc]`)
-	if len(array) != 2 { t.Fail()}
-	if array[0] != `say hello[]` { t.Fail()}
-	if array[1] != "abc" { t.Fail()}
+	if len(array) != 2 {
+		t.Fail()
+	}
+	if array[0] != `say hello[]` {
+		t.Fail()
+	}
+	if array[1] != "abc" {
+		t.Fail()
+	}
 }
 
 func TestArrayEmptyStringQuoted(t *testing.T) {
 
 	array, _ := kuksa_client.GetArrayFromInput[string](`["", abc]`)
-	if len(array) != 2 { t.Fail()}
-	if array[0] != `` { t.Fail()}
-	if array[1] != "abc" { t.Fail()}
+	if len(array) != 2 {
+		t.Fail()
+	}
+	if array[0] != `` {
+		t.Fail()
+	}
+	if array[1] != "abc" {
+		t.Fail()
+	}
 }
 
 func TestArrayEmptyStringNotQuoted(t *testing.T) {
 	// First item shall be ignored
 	array, _ := kuksa_client.GetArrayFromInput[string](`[, abc]`)
-	if len(array) != 1 { t.Fail()}
-	if array[0] != "abc" { t.Fail()}
+	if len(array) != 1 {
+		t.Fail()
+	}
+	if array[0] != "abc" {
+		t.Fail()
+	}
 }
 
 func TestDoubleComma(t *testing.T) {
 	// In this case the middle item is ignored
 	array, _ := kuksa_client.GetArrayFromInput[string](`[def,, abc]`)
-	if len(array) != 2 { t.Fail()}
-	if array[0] != "def" { t.Fail()}
-	if array[1] != "abc" { t.Fail()}
+	if len(array) != 2 {
+		t.Fail()
+	}
+	if array[0] != "def" {
+		t.Fail()
+	}
+	if array[1] != "abc" {
+		t.Fail()
+	}
 }
 
 func TestQuotesInStringValues(t *testing.T) {
 	array, _ := kuksa_client.GetArrayFromInput[string](`["dtc1, dtc2", dtc3, \" dtc4, dtc4\"]`)
-	if len(array) != 4 { t.Fail()}
-	if array[0] != "dtc1, dtc2" { t.Fail()}
-	if array[1] != "dtc3" { t.Fail()}
-	if array[2] != "\" dtc4" { t.Fail()}
-	if array[3] != "dtc4\"" { t.Fail()}
+	if len(array) != 4 {
+		t.Fail()
+	}
+	if array[0] != "dtc1, dtc2" {
+		t.Fail()
+	}
+	if array[1] != "dtc3" {
+		t.Fail()
+	}
+	if array[2] != "\" dtc4" {
+		t.Fail()
+	}
+	if array[3] != "dtc4\"" {
+		t.Fail()
+	}
 }
 
 func TestQuotesInStringValues2(t *testing.T) {
 	array, _ := kuksa_client.GetArrayFromInput[string]("['dtc1, dtc2', dtc3, \" dtc4, dtc4\"]")
-	if len(array) != 3 { t.Fail()}
-	if array[0] != "dtc1, dtc2" { t.Fail()}
-	if array[1] != "dtc3" { t.Fail()}
-	if array[2] != " dtc4, dtc4" { t.Fail()}
+	if len(array) != 3 {
+		t.Fail()
+	}
+	if array[0] != "dtc1, dtc2" {
+		t.Fail()
+	}
+	if array[1] != "dtc3" {
+		t.Fail()
+	}
+	if array[2] != " dtc4, dtc4" {
+		t.Fail()
+	}
 }
-
diff --git a/kuksa_go_client/kuksa_client/commn.go b/kuksa_go_client/kuksa_client/commn.go
@@ -130,7 +130,10 @@ func (cc *KuksaClientCommWs) startCommunication() error {
 		for {
 			req, ok := <-cc.sendChannel
 			if ok {
-				cc.connSocket.WriteMessage(websocket.TextMessage, []byte(req))
+				err := cc.connSocket.WriteMessage(websocket.TextMessage, []byte(req))
+				if err != nil {
+					log.Fatal("WriteMessage error: ", err)
+		}
 			}
 		}
 	}()

diff --git a/kuksa_go_client/kuksa_client/grpc.go b/kuksa_go_client/kuksa_client/grpc.go
@@ -420,7 +420,11 @@ func (cg *KuksaClientCommGrpc) UnsubscribeFromKuksaVal(id string) error {
 	cancel := *cg.cancel[id]
 	cancel()
 	client := *cg.subsChannel[id]
-	client.CloseSend()
+	err := client.CloseSend()
+	if err != nil {
+		log.Fatal("Error with CloseSend: ", err)
+		return err
+	}
 
 	return nil
 }