test(ibmsm): Look for data races

argoproj-labs · Jun 18, 2023 · dbaf2d0 · dbaf2d0
1 parent 390a13b
commit dbaf2d0
Show file tree

Hide file tree

Showing 3 changed files with 12 additions and 6 deletions.
diff --git a/Dockerfile b/Dockerfile
@@ -1,13 +1,9 @@
-# golang:1.17-alpine
-FROM golang@sha256:f4ece20984a30d1065b04653bf6781f51ab63421b4b8f011565de0401cfe58d7
-
-RUN apk add make git
+FROM index.docker.io/golang:1.17@sha256:55636cf1983628109e569690596b85077f45aca810a77904e8afad48b49aa500
 
 ADD go.mod go.mod
 ADD go.sum go.sum
 
 ENV GOPATH=""
-ENV CGO_ENABLED=0
 RUN go mod download
 
 VOLUME work

diff --git a/Makefile b/Makefile
@@ -4,7 +4,7 @@ default: build
 
 quality:
 	go vet github.com/argoproj-labs/argocd-vault-plugin
-	go test -v -coverprofile cover.out ./...
+	go test -race -v -coverprofile cover.out ./...
 
 build:
 	go build -o ${BINARY} .

diff --git a/pkg/backends/ibmsecretsmanager_test.go b/pkg/backends/ibmsecretsmanager_test.go
@@ -5,6 +5,7 @@ import (
 	"reflect"
 	"strings"
 	"testing"
+	"sync"
 
 	"github.com/IBM/go-sdk-core/v5/core"
 	ibmsm "github.com/IBM/secrets-manager-go-sdk/secretsmanagerv2"
@@ -14,6 +15,11 @@ import (
 
 type MockIBMSMClient struct {
 	ListSecretsOptionCalledWith []*ibmsm.ListSecretsOptions
+
+	// GetSecretLock prevents false data races caused by unsychronized access to the mock state
+	// It is shared b/w both GetSecret and GetSecretVersion for simplicity, even though each writes to a different field
+	GetSecretLock sync.RWMutex
+
 	GetSecretCalledWith         *ibmsm.GetSecretOptions
 	GetSecretCallCount          int
 	GetSecretVersionCalledWith  *ibmsm.GetSecretVersionOptions
@@ -112,8 +118,10 @@ func (m *MockIBMSMClient) ListSecrets(listAllSecretsOptions *ibmsm.ListSecretsOp
 }
 
 func (m *MockIBMSMClient) GetSecret(getSecretOptions *ibmsm.GetSecretOptions) (result ibmsm.SecretIntf, response *core.DetailedResponse, err error) {
+	m.GetSecretLock.Lock()
 	m.GetSecretCalledWith = getSecretOptions
 	m.GetSecretCallCount += 1
+	m.GetSecretLock.Unlock()
 
 	if *getSecretOptions.ID == "arbitrary" {
 		name := "my-secret"
@@ -148,8 +156,10 @@ func (m *MockIBMSMClient) GetSecret(getSecretOptions *ibmsm.GetSecretOptions) (r
 }
 
 func (m *MockIBMSMClient) GetSecretVersion(getSecretOptions *ibmsm.GetSecretVersionOptions) (result ibmsm.SecretVersionIntf, response *core.DetailedResponse, err error) {
+	m.GetSecretLock.Lock()
 	m.GetSecretVersionCalledWith = getSecretOptions
 	m.GetSecretVersionCallCount += 1
+	m.GetSecretLock.Unlock()
 	data := "dummy"
 	id := "public_cert"
 	yes := true