Turns Spring Profiles into App Configuration labels. (Azure#18577)

Author: mrm9084

sdk/appconfiguration/azure-spring-cloud-appconfiguration-config/src/main/java/com/microsoft/azure/spring/cloud/config/AppConfigurationBootstrapConfiguration.java

@@ -2,17 +2,9 @@
 // Licensed under the MIT License.
 package com.microsoft.azure.spring.cloud.config;
 
-import com.microsoft.azure.spring.cloud.config.properties.AppConfigurationProperties;
-import com.microsoft.azure.spring.cloud.config.properties.AppConfigurationProviderProperties;
-import com.microsoft.azure.spring.cloud.config.properties.ConfigStore;
-import com.microsoft.azure.spring.cloud.config.resource.AppConfigManagedIdentityProperties;
-import com.microsoft.azure.spring.cloud.config.resource.Connection;
-import com.microsoft.azure.spring.cloud.config.resource.ConnectionPool;
-import com.microsoft.azure.spring.cloud.config.stores.ClientStore;
 import java.util.List;
 import java.util.Optional;
-import org.apache.http.impl.client.CloseableHttpClient;
-import org.apache.http.impl.client.HttpClients;
+
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 import org.springframework.boot.autoconfigure.condition.ConditionalOnClass;
@@ -24,6 +16,14 @@
 import org.springframework.util.Assert;
 import org.springframework.util.StringUtils;
 
+import com.microsoft.azure.spring.cloud.config.properties.AppConfigurationProperties;
+import com.microsoft.azure.spring.cloud.config.properties.AppConfigurationProviderProperties;
+import com.microsoft.azure.spring.cloud.config.properties.ConfigStore;
+import com.microsoft.azure.spring.cloud.config.resource.AppConfigManagedIdentityProperties;
+import com.microsoft.azure.spring.cloud.config.resource.Connection;
+import com.microsoft.azure.spring.cloud.config.resource.ConnectionPool;
+import com.microsoft.azure.spring.cloud.config.stores.ClientStore;
+
 @Configuration
 @EnableConfigurationProperties({AppConfigurationProperties.class, AppConfigurationProviderProperties.class})
 @ConditionalOnClass(AppConfigurationPropertySourceLocator.class)
@@ -56,11 +56,6 @@ public ConnectionPool initConnectionString(AppConfigurationProperties properties
         return pool;
     }
 
-    @Bean
-    public CloseableHttpClient closeableHttpClient() {
-        return HttpClients.createSystem();
-    }
-
     @Bean
     public AppConfigurationPropertySourceLocator sourceLocator(AppConfigurationProperties properties,
         AppConfigurationProviderProperties appProperties, ClientStore clients, ApplicationContext context,

sdk/appconfiguration/azure-spring-cloud-appconfiguration-config/src/main/java/com/microsoft/azure/spring/cloud/config/AppConfigurationPropertySourceLocator.java

@@ -2,14 +2,6 @@
 // Licensed under the MIT License.
 package com.microsoft.azure.spring.cloud.config;
 
-import com.azure.data.appconfiguration.models.ConfigurationSetting;
-import com.azure.data.appconfiguration.models.SettingSelector;
-import com.microsoft.azure.spring.cloud.config.feature.management.entity.FeatureSet;
-import com.microsoft.azure.spring.cloud.config.properties.AppConfigurationProperties;
-import com.microsoft.azure.spring.cloud.config.properties.AppConfigurationProviderProperties;
-import com.microsoft.azure.spring.cloud.config.properties.AppConfigurationStoreTrigger;
-import com.microsoft.azure.spring.cloud.config.properties.ConfigStore;
-import com.microsoft.azure.spring.cloud.config.stores.ClientStore;
 import java.util.ArrayList;
 import java.util.Arrays;
 import java.util.Collections;
@@ -19,6 +11,7 @@
 import java.util.Map;
 import java.util.concurrent.ConcurrentHashMap;
 import java.util.concurrent.atomic.AtomicBoolean;
+
 import org.apache.commons.lang3.time.DateUtils;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
@@ -31,31 +24,46 @@
 import org.springframework.util.ReflectionUtils;
 import org.springframework.util.StringUtils;
 
+import com.azure.data.appconfiguration.models.ConfigurationSetting;
+import com.azure.data.appconfiguration.models.SettingSelector;
+import com.microsoft.azure.spring.cloud.config.feature.management.entity.FeatureSet;
+import com.microsoft.azure.spring.cloud.config.properties.AppConfigurationProperties;
+import com.microsoft.azure.spring.cloud.config.properties.AppConfigurationProviderProperties;
+import com.microsoft.azure.spring.cloud.config.properties.AppConfigurationStoreTrigger;
+import com.microsoft.azure.spring.cloud.config.properties.ConfigStore;
+import com.microsoft.azure.spring.cloud.config.stores.ClientStore;
+
 public class AppConfigurationPropertySourceLocator implements PropertySourceLocator {
 
     private static final Logger LOGGER = LoggerFactory.getLogger(AppConfigurationPropertySourceLocator.class);
 
     private static final String SPRING_APP_NAME_PROP = "spring.application.name";
 
     private static final String PROPERTY_SOURCE_NAME = "azure-config-store";
-
+    
     private static final String PATH_SPLITTER = "/";
+
     private final AppConfigurationProperties properties;
-    private final String profileSeparator;
+
     private final List<ConfigStore> configStores;
+
     private final Map<String, List<String>> storeContextsMap = new ConcurrentHashMap<>();
+
     private final AppConfigurationProviderProperties appProperties;
+
     private final ClientStore clients;
+
     private final KeyVaultCredentialProvider keyVaultCredentialProvider;
+
     private final SecretClientBuilderSetup keyVaultClientProvider;
+
     private static AtomicBoolean startup = new AtomicBoolean(true);
 
     public AppConfigurationPropertySourceLocator(AppConfigurationProperties properties,
         AppConfigurationProviderProperties appProperties, ClientStore clients,
         KeyVaultCredentialProvider keyVaultCredentialProvider, SecretClientBuilderSetup keyVaultClientProvider) {
         this.properties = properties;
         this.appProperties = appProperties;
-        this.profileSeparator = properties.getProfileSeparator();
         this.configStores = properties.getStores();
         this.clients = clients;
         this.keyVaultCredentialProvider = keyVaultCredentialProvider;
@@ -102,21 +110,20 @@ public Map<String, List<String>> getStoreContextsMap() {
     /**
      * Adds a new Property Source
      *
-     * @param composite        PropertySource being added
-     * @param store            Config Store the PropertySource is being generated from
-     * @param applicationName  Name of the application
-     * @param profiles         Active profiles in the Store
+     * @param composite PropertySource being added
+     * @param store Config Store the PropertySource is being generated from
+     * @param applicationName Name of the application
+     * @param profiles Active profiles in the Store
      * @param storeContextsMap the Map storing the storeName -> List of contexts map
-     * @param initFeatures     determines if Feature Management is set in the PropertySource. When generating more than
-     *                         one it needs to be in the last one.
+     * @param initFeatures determines if Feature Management is set in the PropertySource. When generating more than one
+     * it needs to be in the last one.
      */
     private void addPropertySource(CompositePropertySource composite, ConfigStore store, String applicationName,
         List<String> profiles, Map<String, List<String>> storeContextsMap, boolean initFeatures) {
         /*
-         * Generate which contexts(key prefixes) will be used for key-value items search
-         * If key prefix is empty, default context is: application, current application
-         * name is: foo, active profile is: dev, profileSeparator is: _ Will generate
-         * these contexts: /application/, /application_dev/, /foo/, /foo_dev/
+         * Generate which contexts(key prefixes) will be used for key-value items search If key prefix is empty, default
+         * context is: application, current application name is: foo, active profile is: dev, profileSeparator is: _
+         * Will generate these contexts: /application/, /application_dev/, /foo/, /foo_dev/
          */
         List<String> contexts = new ArrayList<>();
         contexts.addAll(generateContexts(this.properties.getDefaultContext(), profiles, store));
@@ -132,7 +139,7 @@ private void addPropertySource(CompositePropertySource composite, ConfigStore st
         Collections.reverse(contexts);
         for (String sourceContext : contexts) {
             try {
-                sourceList.addAll(create(sourceContext, store, storeContextsMap, initFeatures, featureSet));
+                sourceList.addAll(create(sourceContext, store, storeContextsMap, profiles, initFeatures, featureSet));
 
                 LOGGER.debug("PropertySource context [{}] is added.", sourceContext);
             } catch (Exception e) {
@@ -166,7 +173,6 @@ private List<String> generateContexts(String applicationName, List<String> profi
 
         String prefixedContext = propWithAppName(prefix, applicationName);
         result.add(prefixedContext + PATH_SPLITTER);
-        profiles.forEach(profile -> result.add(propWithProfile(prefixedContext, profile)));
 
         return result;
     }
@@ -180,26 +186,25 @@ private String propWithAppName(String prefix, String applicationName) {
         return PATH_SPLITTER + applicationName;
     }
 
-    private String propWithProfile(String context, String profile) {
-        return context + this.profileSeparator + profile + PATH_SPLITTER;
-    }
-
     /**
      * Creates a new set of AppConfigurationProertySources, 1 per Label.
      *
-     * @param context          Context of the application, part of uniquely define a PropertySource
-     * @param store            Config Store the PropertySource is being generated from
+     * @param context Context of the application, part of uniquely define a PropertySource
+     * @param store Config Store the PropertySource is being generated from
      * @param storeContextsMap the Map storing the storeName -> List of contexts map
-     * @param initFeatures     determines if Feature Management is set in the PropertySource. When generating more than
-     *                         one it needs to be in the last one.
+     * @param initFeatures determines if Feature Management is set in the PropertySource. When generating more than one
+     * it needs to be in the last one.
      * @return a list of AppConfigurationPropertySources
      */
     private List<AppConfigurationPropertySource> create(String context, ConfigStore store,
-        Map<String, List<String>> storeContextsMap, boolean initFeatures, FeatureSet featureSet) throws Exception {
+        Map<String, List<String>> storeContextsMap, List<String> profiles, boolean initFeatures, FeatureSet featureSet)
+        throws Exception {
         List<AppConfigurationPropertySource> sourceList = new ArrayList<>();
 
         try {
-            for (String label : store.getLabels()) {
+            String[] labels = store.getLabels(profiles);
+            
+            for (String label : labels) {
                 putStoreContext(store.getEndpoint(), context, storeContextsMap);
                 AppConfigurationPropertySource propertySource = new AppConfigurationPropertySource(context, store,
                     label, properties, clients, appProperties, keyVaultCredentialProvider, keyVaultClientProvider);
@@ -234,8 +239,8 @@ private List<AppConfigurationPropertySource> create(String context, ConfigStore
     /**
      * Put certain context to the store contexts map
      *
-     * @param storeName        the name of the configuration store
-     * @param context          the context text for the PropertySource, e.g., "/application"
+     * @param storeName the name of the configuration store
+     * @param context the context text for the PropertySource, e.g., "/application"
      * @param storeContextsMap the Map storing the storeName -> List of contexts map
      */
     private void putStoreContext(String storeName, String context,

sdk/appconfiguration/azure-spring-cloud-appconfiguration-config/src/main/java/com/microsoft/azure/spring/cloud/config/properties/AppConfigurationProperties.java

@@ -2,13 +2,13 @@
 // Licensed under the MIT License.
 package com.microsoft.azure.spring.cloud.config.properties;
 
-import com.microsoft.azure.spring.cloud.config.resource.AppConfigManagedIdentityProperties;
 import java.util.ArrayList;
 import java.util.List;
 import java.util.stream.Collectors;
+
 import javax.annotation.PostConstruct;
 import javax.validation.constraints.NotEmpty;
-import javax.validation.constraints.Pattern;
+
 import org.springframework.boot.context.properties.ConfigurationProperties;
 import org.springframework.boot.context.properties.NestedConfigurationProperty;
 import org.springframework.context.annotation.Import;
@@ -17,9 +17,11 @@
 import org.springframework.util.StringUtils;
 import org.springframework.validation.annotation.Validated;
 
+import com.microsoft.azure.spring.cloud.config.resource.AppConfigManagedIdentityProperties;
+
 @Validated
 @ConfigurationProperties(prefix = AppConfigurationProperties.CONFIG_PREFIX)
-@Import({AppConfigurationProviderProperties.class})
+@Import({ AppConfigurationProviderProperties.class })
 public class AppConfigurationProperties {
 
     public static final String CONFIG_PREFIX = "spring.cloud.azure.appconfiguration";
@@ -41,11 +43,6 @@ public class AppConfigurationProperties {
     @NestedConfigurationProperty
     private AppConfigManagedIdentityProperties managedIdentity;
 
-    // Profile separator for the key name, e.g., /foo-app_dev/db.connection.key
-    @NotEmpty
-    @Pattern(regexp = "^[a-zA-Z0-9_@]+$")
-    private String profileSeparator = "_";
-
     private boolean pushRefresh = true;
 
     public boolean isEnabled() {
@@ -89,14 +86,6 @@ public void setManagedIdentity(AppConfigManagedIdentityProperties managedIdentit
         this.managedIdentity = managedIdentity;
     }
 
-    public String getProfileSeparator() {
-        return profileSeparator;
-    }
-
-    public void setProfileSeparator(String profileSeparator) {
-        this.profileSeparator = profileSeparator;
-    }
-
     /**
      * @return the pushRefresh
      */
@@ -118,8 +107,7 @@ public void validateAndInit() {
         this.stores.forEach(store -> {
             Assert.isTrue(
                 StringUtils.hasText(store.getEndpoint()) || StringUtils.hasText(store.getConnectionString()),
-                "Either configuration store name or connection string should be configured."
-            );
+                "Either configuration store name or connection string should be configured.");
             store.validateAndInit();
         });
 

sdk/appconfiguration/azure-spring-cloud-appconfiguration-config/src/main/java/com/microsoft/azure/spring/cloud/config/properties/ConfigStore.java

@@ -131,10 +131,13 @@ public void validateAndInit() {
     }
 
     /**
+     * @param profiles List of current Spring profiles to default to using is null label is set.
      * @return List of reversed label values, which are split by the separator, the latter label has higher priority
      */
-    public String[] getLabels() {
-        if (!StringUtils.hasText(this.getLabel())) {
+    public String[] getLabels(List<String> profiles) {
+        if (this.getLabel() == null && profiles.size() > 0) {
+            return profiles.toArray(new String[profiles.size()]);
+        } else if (!StringUtils.hasText(this.getLabel())) {
             return EMPTY_LABEL_ARRAY;
         }
 

sdk/appconfiguration/azure-spring-cloud-appconfiguration-config/src/test/java/com/microsoft/azure/spring/cloud/config/AppConfigurationPropertiesTest.java

@@ -9,7 +9,6 @@
 import static com.microsoft.azure.spring.cloud.config.TestConstants.FAIL_FAST_PROP;
 import static com.microsoft.azure.spring.cloud.config.TestConstants.LABEL_PROP;
 import static com.microsoft.azure.spring.cloud.config.TestConstants.PREFIX_PROP;
-import static com.microsoft.azure.spring.cloud.config.TestConstants.SEPARATOR_PROP;
 import static com.microsoft.azure.spring.cloud.config.TestConstants.STORE_ENDPOINT_PROP;
 import static com.microsoft.azure.spring.cloud.config.TestConstants.TEST_CONN_STRING;
 import static com.microsoft.azure.spring.cloud.config.TestUtils.propPair;
@@ -18,10 +17,9 @@
 import static org.junit.Assert.fail;
 import static org.mockito.Mockito.when;
 
-import com.fasterxml.jackson.databind.ObjectMapper;
-import com.microsoft.azure.spring.cloud.config.properties.AppConfigurationProperties;
 import java.io.InputStream;
 import java.util.Arrays;
+
 import org.apache.http.HttpEntity;
 import org.apache.http.ProtocolVersion;
 import org.apache.http.RequestLine;
@@ -40,13 +38,15 @@
 import org.springframework.boot.test.context.runner.ApplicationContextRunner;
 import org.springframework.context.ApplicationContext;
 
+import com.fasterxml.jackson.databind.ObjectMapper;
+import com.microsoft.azure.spring.cloud.config.properties.AppConfigurationProperties;
+
 public class AppConfigurationPropertiesTest {
 
     private static final String NO_ENDPOINT_CONN_STRING = "Id=fake-conn-id;Secret=ZmFrZS1jb25uLXNlY3JldA==";
     private static final String NO_ID_CONN_STRING = "Endpoint=https://fake.test.config.io;Secret=ZmFrZS1jb25uLXNlY3JldA==";
     private static final String NO_SECRET_CONN_STRING = "Endpoint=https://fake.test.config.io;Id=fake-conn-id;";
     private static final String[] ILLEGAL_PREFIXES = {"/ config", "config"};
-    private static final String[] ILLEGAL_PROFILE_SEPARATOR = {"/", "\\", "."};
     private static final String ILLEGAL_LABELS = "*,my-label";
     @InjectMocks
     private ApplicationContextRunner contextRunner = new ApplicationContextRunner()
@@ -139,18 +139,6 @@ public void prefixShouldFollowPattern() {
         });
     }
 
-    @Test
-    public void profileSeparatorShouldFollowPattern() {
-        Arrays.asList(ILLEGAL_PROFILE_SEPARATOR).stream().forEach(separator -> {
-            this.contextRunner
-                .withPropertyValues(
-                    propPair(CONN_STRING_PROP, TEST_CONN_STRING),
-                    propPair(SEPARATOR_PROP, separator)
-                )
-                .run(context -> assertInvalidField(context, "profileSeparator"));
-        });
-    }
-
     @Test
     public void asteriskShouldNotBeIncludedInTheLabels() {
         this.contextRunner