fix: Fix unit tests that fail when using Go 1.15 (#485)

* fix: Fixed broken unit tests now failing with Go 1.15.2
Unclear why these didn't fail with Go 1.13.x
closes #463

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

Author: lenny-goodell

go.mod

@@ -23,4 +23,4 @@ require (
 	github.com/xdg/scram v0.0.0-20180814205039-7eeb5667e42c // indirect
 	github.com/xdg/stringprep v1.0.0 // indirect
 	go.mongodb.org/mongo-driver v1.1.1
-)
+)

internal/security/credentials_test.go

@@ -151,6 +151,7 @@ func getSecretsTestData() secretTestData {
 }
 
 func TestGetSecrets(t *testing.T) {
+	os.Clearenv()
 	secretProvider := newMockSecretProvider(nil)
 
 	for i, test := range getSecretsTestData() {
@@ -172,7 +173,7 @@ func TestGetSecrets(t *testing.T) {
 }
 
 func TestGetInsecureSecrets(t *testing.T) {
-
+	os.Clearenv()
 	secretProvider, origEnv := setupGetInsecureSecrets(t)
 
 	for _, test := range getSecretsTestData() {

internal/v2/controller/http/mockprovider_test.go renamed to internal/security/mockprovider.go

@@ -14,7 +14,7 @@
 // SPDX-License-Identifier: Apache-2.0
 //
 
-package http
+package security
 
 import (
 	"context"
@@ -24,7 +24,6 @@ import (
 	"time"
 
 	"github.com/edgexfoundry/app-functions-sdk-go/internal/common"
-	"github.com/edgexfoundry/app-functions-sdk-go/internal/security"
 	"github.com/edgexfoundry/app-functions-sdk-go/internal/store/db"
 )
 
@@ -99,6 +98,6 @@ func (s *SecretProviderMock) SecretsLastUpdated() time.Time {
 
 // isSecurityEnabled determines if security has been enabled.
 func (s *SecretProviderMock) isSecurityEnabled() bool {
-	env := os.Getenv(security.EnvSecretStore)
+	env := os.Getenv(EnvSecretStore)
 	return env != "false"
 }

internal/v2/controller/http/controller_test.go

@@ -179,7 +179,7 @@ func TestSecretsRequest(t *testing.T) {
 	}
 	lc := logger.NewMockClient()
 
-	mockProvider := NewSecretProviderMock(config)
+	mockProvider := security.NewSecretProviderMock(config)
 	target := NewV2HttpController(nil, lc, config, mockProvider)
 	assert.NotNil(t, target)
 

internal/webserver/server_test.go

@@ -24,15 +24,15 @@ import (
 	"net/http/httptest"
 	"testing"
 
-	"github.com/edgexfoundry/app-functions-sdk-go/internal/security"
-
-	"github.com/edgexfoundry/app-functions-sdk-go/internal"
-	"github.com/edgexfoundry/app-functions-sdk-go/internal/common"
-	"github.com/edgexfoundry/app-functions-sdk-go/internal/telemetry"
 	"github.com/edgexfoundry/go-mod-core-contracts/clients"
 	"github.com/edgexfoundry/go-mod-core-contracts/clients/logger"
 	"github.com/gorilla/mux"
 	"github.com/stretchr/testify/assert"
+
+	"github.com/edgexfoundry/app-functions-sdk-go/internal"
+	"github.com/edgexfoundry/app-functions-sdk-go/internal/common"
+	"github.com/edgexfoundry/app-functions-sdk-go/internal/security"
+	"github.com/edgexfoundry/app-functions-sdk-go/internal/telemetry"
 )
 
 var logClient logger.LoggingClient
@@ -116,7 +116,7 @@ func TestConfigureAndConfigRoute(t *testing.T) {
 }
 
 func TestConfigureAndMetricsRoute(t *testing.T) {
-	sp := newMockSecretProvider(logClient, config)
+	sp := security.NewSecretProviderMock(config)
 	webserver := NewWebServer(config, sp, logClient, mux.NewRouter())
 	webserver.ConfigureStandardRoutes()
 
@@ -138,7 +138,7 @@ func TestConfigureAndMetricsRoute(t *testing.T) {
 }
 
 func TestSetupTriggerRoute(t *testing.T) {
-	sp := newMockSecretProvider(logClient, config)
+	sp := security.NewSecretProviderMock(config)
 	webserver := NewWebServer(config, sp, logClient, mux.NewRouter())
 
 	handlerFunctionNotCalled := true
@@ -162,7 +162,7 @@ func TestSetupTriggerRoute(t *testing.T) {
 
 func TestPostSecretRoute(t *testing.T) {
 
-	sp := newMockSecretProvider(logClient, config)
+	sp := security.NewSecretProviderMock(config)
 	webserver := NewWebServer(config, sp, logClient, mux.NewRouter())
 	webserver.ConfigureStandardRoutes()
 
@@ -214,23 +214,3 @@ func TestValidateSecretRoute(t *testing.T) {
 	secretDataGoodPath := SecretData{Path: "/foo/bar", Secrets: []KeyValue{KeyValue{Key: "key", Value: "val"}}}
 	assert.NoError(t, secretDataGoodPath.validateSecretData())
 }
-
-// mockSecretClient is fake vault client
-type mockSecretClient struct {
-}
-
-// NewMockSecretProvider provides a mocked version of the mockSecretClient to avoiding using vault in our tests
-func newMockSecretProvider(loggingClient logger.LoggingClient, configuration *common.ConfigurationStruct) security.SecretProvider {
-	mockSP := security.NewSecretProvider(logClient, config)
-	return mockSP
-}
-
-// GetSecrets mock implementation of GetSecrets
-func (s *mockSecretClient) GetSecrets(path string, keys ...string) (map[string]string, error) {
-	return nil, nil
-}
-
-// StoreSecrets mock implementation of StoreSecrets
-func (s *mockSecretClient) StoreSecrets(path string, secrets map[string]string) error {
-	return nil
-}

pkg/transforms/filter_test.go

@@ -212,7 +212,7 @@ func TestFilterOutByValueDescriptor(t *testing.T) {
 	assert.EqualError(t, res.(error), "no Event Received")
 
 	continuePipeline, res = f1.FilterByValueDescriptor(context, event1)
-	assert.True(t, continuePipeline, "Pipeline should continue")
+	assert.False(t, continuePipeline, "Pipeline should NOT continue")
 	assert.Len(t, res.(models.Event).Readings, 0, "Event should have no readings")
 
 	continuePipeline, res = f1.FilterByValueDescriptor(context, event2)
@@ -224,16 +224,16 @@ func TestFilterOutByValueDescriptor(t *testing.T) {
 	assert.Len(t, res.(models.Event).Readings, 1, "Event should have one reading")
 
 	continuePipeline, res = f12.FilterByValueDescriptor(context, event1)
-	assert.False(t, continuePipeline, "Pipeline should continue")
+	assert.False(t, continuePipeline, "Pipeline should NOT continue")
 	assert.Len(t, res.(models.Event).Readings, 0, "Event should have one reading")
 
 	continuePipeline, res = f12.FilterByValueDescriptor(context, event2)
-	assert.True(t, continuePipeline, "Pipeline should continue")
-	assert.Len(t, res.(models.Event).Readings, 0, "Event should have one reading")
+	assert.False(t, continuePipeline, "Pipeline should NOT continue")
+	assert.Len(t, res.(models.Event).Readings, 0, "Event should have no reading")
 
 	continuePipeline, res = f12.FilterByValueDescriptor(context, event12)
-	assert.True(t, continuePipeline, "Pipeline should continue")
-	assert.Len(t, res.(models.Event).Readings, 0, "Event should have one reading")
+	assert.False(t, continuePipeline, "Pipeline should NOT continue")
+	assert.Len(t, res.(models.Event).Readings, 0, "Event should have no reading")
 
 	continuePipeline, res = f12.FilterByValueDescriptor(context, event3)
 	assert.True(t, continuePipeline, "Event should be filtered out")

pkg/transforms/http_test.go

@@ -107,6 +107,7 @@ func TestHTTPPost(t *testing.T) {
 
 func TestHTTPPostWithSecrets(t *testing.T) {
 
+	expectedValue := "value"
 	handler := func(w http.ResponseWriter, r *http.Request) {
 
 		if r.URL.EscapedPath() == badPath {
@@ -116,9 +117,10 @@ func TestHTTPPostWithSecrets(t *testing.T) {
 
 		w.WriteHeader(http.StatusOK)
 
-		// this should be here on successful secret retrieval
-		if assert.Equal(t, r.Header.Get("Secret-Header-Name"), "value") {
-			t.Errorf("Unexpected header name received %s, expected %s", r.Header.Get("Content-type"), "application/json")
+		actualValue := r.Header.Get("Secret-Header-Name")
+		if actualValue != "" {
+			// Only validate is key was found in the header
+			require.Equal(t, expectedValue, actualValue)
 		}
 	}
 

pkg/transforms/mqttsecret.go

@@ -134,8 +134,10 @@ func (sender *MQTTSecretSender) validateSecrets(secrets mqttSecrets) error {
 		if len(secrets.keypemblock) <= 0 || len(secrets.certpemblock) <= 0 {
 			return errors.New("AuthModeCert selected however the key or cert PEM block was not found at secret path")
 		}
-	} else if sender.mqttConfig.AuthMode == AuthModeCA && len(secrets.capemblock) <= 0 {
-		return errors.New("AuthModeCA selected however no PEM Block was found at secret path")
+	} else if sender.mqttConfig.AuthMode == AuthModeCA {
+		if len(secrets.capemblock) <= 0 {
+			return errors.New("AuthModeCA selected however no PEM Block was found at secret path")
+		}
 	} else if sender.mqttConfig.AuthMode != AuthModeNone {
 		return errors.New("Invalid AuthMode selected")
 	}

pkg/transforms/mqttsecret_test.go

@@ -169,8 +169,11 @@ func TestMQTTClientGetSecrets(t *testing.T) {
 		{"No Auth No error", AuthModeNone, "", nil, false},
 		{"Auth No Secrets found", AuthModeCA, "/notfound", nil, true},
 		{"Auth With Secrets", AuthModeUsernamePassword, "/mqtt", &mqttSecrets{
-			username: "TEST_USER",
-			password: "TEST_PASS",
+			username:     "TEST_USER",
+			password:     "TEST_PASS",
+			keypemblock:  []uint8{},
+			certpemblock: []uint8{},
+			capemblock:   []uint8{},
 		}, false},
 	}
 	// setup mock secret client
@@ -336,12 +339,15 @@ func TestConfigureMQTTClientWithNone(t *testing.T) {
 }
 
 func TestSetRetryDataPersistFalse(t *testing.T) {
+	context.RetryData = nil
 	sender := NewMQTTSecretSender(MQTTSecretConfig{}, false)
 	sender.mqttConfig = MQTTSecretConfig{}
 	sender.setRetryData(context, []byte("data"))
 	assert.Nil(t, context.RetryData)
 }
+
 func TestSetRetryDataPersistTrue(t *testing.T) {
+	context.RetryData = nil
 	sender := NewMQTTSecretSender(MQTTSecretConfig{}, true)
 	sender.mqttConfig = MQTTSecretConfig{}
 	sender.setRetryData(context, []byte("data"))