Merge pull request #787 from jinlinGuan/issue-4985

feat!: Remove consul dependency

bootstrap/config/config.go

@@ -171,18 +171,13 @@ func (cp *Processor) Process(
 			configProviderInfo.SetHost(remoteHosts[1])
 		}
 
-		getAccessToken, err := cp.getAccessTokenCallback(serviceKey, secretProvider, err, configProviderInfo)
-		if err != nil {
-			return err
-		}
-
-		if err := cp.loadCommonConfig(configStem, getAccessToken, configProviderInfo, serviceConfig, serviceType, CreateProviderClient); err != nil {
+		if err := cp.loadCommonConfig(configStem, configProviderInfo, serviceConfig, serviceType, CreateProviderClient); err != nil {
 			return err
 		}
 
 		cp.lc.Info("Common configuration loaded from the Configuration Provider. No overrides applied")
 
-		privateConfigClient, err = CreateProviderClient(cp.lc, serviceKey, configStem, getAccessToken, configProviderInfo.ServiceConfig())
+		privateConfigClient, err = CreateProviderClient(cp.lc, serviceKey, configStem, configProviderInfo.ServiceConfig())
 		if err != nil {
 			return fmt.Errorf("failed to create Configuration Provider client: %s", err.Error())
 		}
@@ -405,7 +400,6 @@ type createProviderCallback func(
 	logger.LoggingClient,
 	string,
 	string,
-	types.GetAccessTokenCallback,
 	types.ServiceConfig) (configuration.Client, error)
 
 // loadCommonConfig will pull up to two separate common configs from the config provider
@@ -414,7 +408,6 @@ type createProviderCallback func(
 // if there are separate configs, these will get merged into the serviceConfig
 func (cp *Processor) loadCommonConfig(
 	configStem string,
-	getAccessToken types.GetAccessTokenCallback,
 	configProviderInfo *ProviderInfo,
 	serviceConfig interfaces.Configuration,
 	serviceType string,
@@ -424,7 +417,7 @@ func (cp *Processor) loadCommonConfig(
 	// check that common config is loaded into the provider
 	// this need a separate config provider client here because the config ready variable is stored at the common config level
 	// load the all services section of the common config
-	cp.commonConfigClient, err = createProvider(cp.lc, utils.BuildBaseKey(common.CoreCommonConfigServiceKey, allServicesKey), configStem, getAccessToken, configProviderInfo.ServiceConfig())
+	cp.commonConfigClient, err = createProvider(cp.lc, utils.BuildBaseKey(common.CoreCommonConfigServiceKey, allServicesKey), configStem, configProviderInfo.ServiceConfig())
 	if err != nil {
 		return fmt.Errorf("failed to create provider for %s: %s", allServicesKey, err.Error())
 	}
@@ -451,7 +444,7 @@ func (cp *Processor) loadCommonConfig(
 		if err != nil {
 			return fmt.Errorf("failed to copy the configuration structure for %s: %s", appServicesKey, err.Error())
 		}
-		cp.appConfigClient, err = createProvider(cp.lc, serviceTypeSectionKey, configStem, getAccessToken, configProviderInfo.ServiceConfig())
+		cp.appConfigClient, err = createProvider(cp.lc, serviceTypeSectionKey, configStem, configProviderInfo.ServiceConfig())
 		if err != nil {
 			return fmt.Errorf("failed to create provider for %s: %s", appServicesKey, err.Error())
 		}
@@ -471,7 +464,7 @@ func (cp *Processor) loadCommonConfig(
 		if err != nil {
 			return fmt.Errorf("failed to copy the configuration structure for %s: %s", deviceServicesKey, err.Error())
 		}
-		cp.deviceConfigClient, err = createProvider(cp.lc, serviceTypeSectionKey, configStem, getAccessToken, configProviderInfo.ServiceConfig())
+		cp.deviceConfigClient, err = createProvider(cp.lc, serviceTypeSectionKey, configStem, configProviderInfo.ServiceConfig())
 		if err != nil {
 			return fmt.Errorf("failed to create provider for %s: %s", deviceServicesKey, err.Error())
 		}
@@ -552,32 +545,6 @@ func (cp *Processor) loadCommonConfigFromFile(
 	return err
 }
 
-func (cp *Processor) getAccessTokenCallback(serviceKey string, secretProvider interfaces.SecretProviderExt, err error, configProviderInfo *ProviderInfo) (types.GetAccessTokenCallback, error) {
-	var accessToken string
-	var getAccessToken types.GetAccessTokenCallback
-
-	// secretProvider will be nil if not configured to be used. In that case, no access token required.
-	if secretProvider != nil {
-		// Define the callback function to retrieve the Access Token
-		getAccessToken = func() (string, error) {
-			accessToken, err = secretProvider.GetAccessToken(configProviderInfo.serviceConfig.Type, serviceKey)
-			if err != nil {
-				return "", fmt.Errorf(
-					"failed to get Configuration Provider (%s) access token: %s",
-					configProviderInfo.serviceConfig.Type,
-					err.Error())
-			}
-
-			cp.lc.Debugf("Using Configuration Provider access token of length %d", len(accessToken))
-			return accessToken, nil
-		}
-
-	} else {
-		cp.lc.Debug("Not configured to use Config Provider access token")
-	}
-	return getAccessToken, err
-}
-
 // LoadCustomConfigSection loads the specified custom configuration section from file or Configuration provider.
 // Section will be seed if Configuration provider does yet have it. This is used for structures custom configuration
 // in App and Device services
@@ -743,25 +710,15 @@ func CreateProviderClient(
 	lc logger.LoggingClient,
 	serviceKey string,
 	configStem string,
-	getAccessToken types.GetAccessTokenCallback,
 	providerConfig types.ServiceConfig) (configuration.Client, error) {
 
-	var err error
-
 	// The passed in configStem already contains the trailing '/' in most cases so must verify and add if missing.
 	if configStem[len(configStem)-1] != '/' {
 		configStem = configStem + "/"
 	}
 
 	// Note: Can't use filepath.Join as it uses `\` on Windows which Consul doesn't recognize as a path separator.
 	providerConfig.BasePath = fmt.Sprintf("%s%s", configStem, serviceKey)
-	if getAccessToken != nil {
-		providerConfig.AccessToken, err = getAccessToken()
-		if err != nil {
-			return nil, err
-		}
-		providerConfig.GetAccessToken = getAccessToken
-	}
 
 	lc.Info(fmt.Sprintf(
 		"Using Configuration provider (%s) from: %s with base path of %s",

bootstrap/config/config_test.go

@@ -116,18 +116,15 @@ func TestGetSecretNamesChanged(t *testing.T) {
 }
 
 func TestLoadCommonConfig(t *testing.T) {
-	getAccessToken := func() (string, error) {
-		return "", nil
-	}
 	// set up configs for use in tests
 	serviceConfig := ConfigurationMockStruct{
 		Writable: WritableInfo{
 			LogLevel: "INFO",
 		},
 		Registry: config.RegistryInfo{
 			Host: "localhost",
-			Port: 8500,
-			Type: "consul",
+			Port: 59890,
+			Type: "keeper",
 		},
 	}
 
@@ -208,7 +205,6 @@ func TestLoadCommonConfig(t *testing.T) {
 			providerClientCreator := func(logger.LoggingClient,
 				string,
 				string,
-				types.GetAccessTokenCallback,
 				types.ServiceConfig) (configuration.Client, error) {
 				return providerClientMock, tc.providerClientErr
 			}
@@ -241,7 +237,7 @@ func TestLoadCommonConfig(t *testing.T) {
 				providerClientMock.On("GetConfigurationKeys", mock.Anything).Return(configKeys, nil).Once()
 			}
 			// call load common config
-			err = proc.loadCommonConfig(common.ConfigStemAll, getAccessToken, &ProviderInfo{}, &serviceConfigMock, tc.serviceType, providerClientCreator)
+			err = proc.loadCommonConfig(common.ConfigStemAll, &ProviderInfo{}, &serviceConfigMock, tc.serviceType, providerClientCreator)
 			// make assertions
 			providerClientMock.AssertExpectations(t)
 			require.NotNil(t, cancel)

bootstrap/config/provider_test.go

@@ -26,12 +26,12 @@ import (
 
 const (
 	envKeyConfigUrl = "EDGEX_CONFIG_PROVIDER"
-	goodUrlValue    = "consul.http://localhost:8500"
+	goodUrlValue    = "keeper.http://localhost:59890"
 	badUrlValue     = "Not a url"
 
-	expectedTypeValue     = "consul"
+	expectedTypeValue     = "keeper"
 	expectedHostValue     = "localhost"
-	expectedPortValue     = 8500
+	expectedPortValue     = 59890
 	expectedProtocolValue = "http"
 )
 

bootstrap/config/testdata/all-service-config.yaml

@@ -17,8 +17,6 @@ all-services:
         # Common Security Service Metrics
         SecuritySecretsRequested: false
         SecuritySecretsStored: false
-        SecurityConsulTokensRequested: false
-        SecurityConsulTokenDuration: false
       Tags: # Contains the service level tags to be attached to all the service's metrics
       #  Gateway: "my-iot-gateway" # Tag must be added here or via Consul Env Override can only change existing value, not added new ones.
 
@@ -40,8 +38,8 @@ all-services:
 
   Registry:
     Host: "localhost"
-    Port: 8500
-    Type: "consul"
+    Port: 59890
+    Type: "keeper"
 
   Database:
     Host: "localhost"

bootstrap/config/testdata/configuration.yaml

@@ -17,8 +17,6 @@ all-services:
         # Common Security Service Metrics
         SecuritySecretsRequested: false
         SecuritySecretsStored: false
-        SecurityConsulTokensRequested: false
-        SecurityConsulTokenDuration: false
 #     Tags: # Contains the service level tags to be attached to all the service's metrics
       #  Gateway: "my-iot-gateway" # Tag must be added here or via Consul Env Override can only change existing value, not added new ones.
 
@@ -40,8 +38,8 @@ all-services:
 
   Registry:
     Host: "localhost"
-    Port: 8500
-    Type: "consul"
+    Port: 59890
+    Type: "keeper"
 
   Database:
     Host: "localhost"

bootstrap/environment/variables_test.go

@@ -35,12 +35,12 @@ import (
 )
 
 const (
-	goodUrlValue = "consul.http://localhost:8500"
+	goodUrlValue = "keeper.http://localhost:59890"
 	badUrlValue  = "Not a url"
 
-	expectedTypeValue     = "consul"
+	expectedTypeValue     = "keeper"
 	expectedHostValue     = "localhost"
-	expectedPortValue     = 8500
+	expectedPortValue     = 59890
 	expectedProtocolValue = "http"
 
 	defaultHostValue     = "defaultHost"
@@ -364,8 +364,8 @@ func TestOverrideConfigurationExactCase(t *testing.T) {
 	}{
 		Registry: config.RegistryInfo{
 			Host: "localhost",
-			Port: 8500,
-			Type: "consul",
+			Port: 59890,
+			Type: "keeper",
 		},
 		List:     []string{"val1"},
 		FloatVal: float32(11.11),
@@ -374,8 +374,8 @@ func TestOverrideConfigurationExactCase(t *testing.T) {
 	// only all upper case environment variable names now, so none of these overrides should have worked.
 	expectedOverrideCount := 0
 
-	expectedHost := "edgex-core-consul"
-	expectedPort := 98500
+	expectedHost := "edgex-core-keeper"
+	expectedPort := 59890
 	expectedFloatVal := float32(24.234)
 	expectedAuthType := "secure"
 
@@ -397,7 +397,7 @@ func TestOverrideConfigurationUppercase(t *testing.T) {
 	_, lc := initializeTest()
 
 	expectedOverrideCount := 4
-	expectedRegistryHost := "edgex-core-consul"
+	expectedRegistryHost := "edgex-core-keeper"
 	expectedCoreDataHost := "edgex-core-data"
 	expectedList := []string{"joe", "mary", "bob"}
 	expectedFloatVal := float32(24.234)
@@ -412,8 +412,8 @@ func TestOverrideConfigurationUppercase(t *testing.T) {
 	}{
 		Registry: config.RegistryInfo{
 			Host: "localhost",
-			Port: 8500,
-			Type: "consul",
+			Port: 59890,
+			Type: "keeper",
 		},
 		List:     []string{"val1"},
 		FloatVal: float32(11.11),
@@ -458,8 +458,8 @@ func TestOverrideConfigurationWithBlankValue(t *testing.T) {
 	}{
 		Registry: config.RegistryInfo{
 			Host: "localhost",
-			Port: 8500,
-			Type: "consul",
+			Port: 59890,
+			Type: "keeper",
 		},
 		List:     []string{"val1"},
 		FloatVal: float32(11.11),

bootstrap/file/file_test.go

@@ -25,7 +25,7 @@ func TestLoadFile(t *testing.T) {
 		ExpectedErr        string
 		expectedSecretData map[string]string
 	}{
-		{"Valid - load from YAML file", path.Join("..", "config", "testdata", "configuration.yaml"), 4533, "", nil},
+		{"Valid - load from YAML file", path.Join("..", "config", "testdata", "configuration.yaml"), 4446, "", nil},
 		{"Valid - load from JSON file", path.Join(".", "testdata", "configuration.json"), 142, "", nil},
 		{"Valid - load from HTTP", "http://raw.githubusercontent.com/edgexfoundry/go-mod-bootstrap/main/bootstrap/config/testdata/configuration.yaml", 4533, "", nil},
 		{"Valid - load from HTTPS", "https://raw.githubusercontent.com/edgexfoundry/go-mod-bootstrap/main/bootstrap/config/testdata/configuration.yaml", 4533, "", nil},

bootstrap/flags/flags.go

@@ -23,7 +23,7 @@ import (
 )
 
 const (
-	DefaultConfigProvider = "consul.http://localhost:8500"
+	DefaultConfigProvider = "keeper.http://localhost:59890"
 	DefaultConfigFile     = "configuration.yaml"
 )
 
@@ -175,7 +175,7 @@ func (d *Default) helpCallback() {
 		"Usage: %s [options]\n"+
 			"Server Options:\n"+
 			"    -cp, --configProvider        Indicates to use Configuration Provider service at specified URL.\n"+
-			"                                 URL Format: {type}.{protocol}://{host}:{port} ex: consul.http://localhost:8500\n"+
+			"                                 URL Format: {type}.{protocol}://{host}:{port} ex: keeper.http://localhost:59890\n"+
 			"    -cc, --commonConfig          Takes the location where the common configuration is loaded from when\n"+
 			"                                 not using the Configuration Provider\n"+
 			"    -o, --overwrite              Overwrite configuration in provider with local configuration\n"+

bootstrap/flags/flags_test.go

@@ -71,7 +71,7 @@ func TestNewDefaultForCP(t *testing.T) {
 }
 
 func TestNewOverrideForCP(t *testing.T) {
-	expectedConfigProviderUrl := "consul.http://docker-core-consul:8500"
+	expectedConfigProviderUrl := "keeper.http://docker-core-keeper:59890"
 
 	actual := newSUT([]string{"-cp=" + expectedConfigProviderUrl})
 
@@ -85,7 +85,7 @@ func TestNewDefaultForConfigProvider(t *testing.T) {
 }
 
 func TestNewOverrideConfigProvider(t *testing.T) {
-	expectedConfigProviderUrl := "consul.http://docker-core-consul:8500"
+	expectedConfigProviderUrl := "keeper.http://docker-core-keeper:59890"
 
 	actual := newSUT([]string{"-configProvider=" + expectedConfigProviderUrl})
 
@@ -107,10 +107,10 @@ func TestConfigDirEquals(t *testing.T) {
 }
 
 func TestConfigCommonScenario(t *testing.T) {
-	expectedConfigProviderUrl := "consul.http://edgex-core-consul:8500"
+	expectedConfigProviderUrl := "keeper.http://docker-core-keeper:59890"
 	expectedConfigDirectory := "/res"
 
-	actual := newSUT([]string{"-cp=consul.http://edgex-core-consul:8500", "--registry", "--configDir=/res"})
+	actual := newSUT([]string{"-cp=keeper.http://docker-core-keeper:59890", "--registry", "--configDir=/res"})
 
 	assert.Equal(t, expectedConfigProviderUrl, actual.ConfigProviderUrl())
 	assert.True(t, actual.UseRegistry())

bootstrap/interfaces/configuration.go

@@ -18,7 +18,7 @@ package interfaces
 import "github.com/edgexfoundry/go-mod-bootstrap/v4/config"
 
 // UpdatableConfig interface allows service to have their custom configuration populated from configuration stored
-// in the Configuration Provider (aka Consul). A service using custom configuration must implement this interface
+// in the Configuration Provider (aka keeper). A service using custom configuration must implement this interface
 // on the custom configuration, even if not using Configuration Provider. If not using the Configuration Provider
 // it can have dummy implementations of this interface.
 type UpdatableConfig interface {

bootstrap/interfaces/secret.go

@@ -57,10 +57,6 @@ type SecretProviderExt interface {
 	// SecretsUpdated sets the secrets last updated time to current time.
 	SecretsUpdated()
 
-	// GetAccessToken return an access token for the specified token type and service key.
-	// Service key is use as the access token role which must have be previously setup.
-	GetAccessToken(tokenType string, serviceKey string) (string, error)
-
 	// SecretUpdatedAtSecretName performs updates and callbacks for an updated secret or secretName.
 	SecretUpdatedAtSecretName(secretName string)