In progress support for ConfigurationClient

Author: graemerocher

ROADMAP.adoc

@@ -48,6 +48,10 @@ These should be built on the `Endpoint` API.
 
 ### HTTP Server
 
+#### Misc TODO Items
+
+* URI variable values passed to Controller methods should be URI decoded
+
 #### Content Negotiation
 
 Content negotiation must be supported

configurations/netflix-ribbon/src/test/groovy/io/micronaut/configurations/ribbon/MockConsulServer.groovy

@@ -15,17 +15,21 @@
  */
 package io.micronaut.configurations.ribbon
 
+import io.micronaut.context.annotation.Parameter
 import io.micronaut.core.async.publisher.Publishers
 import io.micronaut.discovery.consul.client.v1.CatalogEntry
 import io.micronaut.discovery.consul.client.v1.ConsulOperations
 import io.micronaut.discovery.consul.client.v1.HealthEntry
+import io.micronaut.discovery.consul.client.v1.KeyValue
 import io.micronaut.discovery.consul.client.v1.NewServiceEntry
 import io.micronaut.discovery.consul.client.v1.ServiceEntry
 import io.micronaut.http.HttpStatus
 import io.micronaut.http.annotation.*
 import io.micronaut.runtime.server.EmbeddedServer
+import io.reactivex.Flowable
 import org.reactivestreams.Publisher
 
+import javax.annotation.Nullable
 import javax.inject.Singleton
 import javax.validation.constraints.NotNull
 import java.util.concurrent.ConcurrentHashMap
@@ -53,18 +57,35 @@ class MockConsulServer implements ConsulOperations {
     }
 
     @Override
-    Publisher<HttpStatus> pass(String checkId, Optional<String> note) {
+    Publisher<Boolean> putValue(String key, @Body String value) {
+        return Flowable.just(true)
+    }
+
+    @Override
+    Publisher<List<KeyValue>> readValues(String key) {
+        return Flowable.just(Collections.emptyList())
+    }
+
+    @Override
+    Publisher<List<KeyValue>> readValues(String key,
+                                         @Nullable @Parameter("dc") String datacenter,
+                                         @Nullable Boolean raw, @Nullable String seperator) {
+        return Flowable.just(Collections.emptyList())
+    }
+
+    @Override
+    Publisher<HttpStatus> pass(String checkId, @Nullable String note) {
         passingReports.add(checkId)
         return Publishers.just(HttpStatus.OK)
     }
 
     @Override
-    Publisher<HttpStatus> warn(String checkId, Optional<String> note) {
+    Publisher<HttpStatus> warn(String checkId, @Nullable String note) {
         return Publishers.just(HttpStatus.OK)
     }
 
     @Override
-    Publisher<HttpStatus> fail(String checkId, Optional<String> note) {
+    Publisher<HttpStatus> fail(String checkId, @Nullable String note) {
         return Publishers.just(HttpStatus.OK)
     }
 

core/src/main/java/io/micronaut/core/naming/Described.java

@@ -0,0 +1,30 @@
+/*
+ * Copyright 2018 original authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package io.micronaut.core.naming;
+
+/**
+ * An interface for types that are described by a description
+ * @author graemerocher
+ * @since 1.0
+ */
+public interface Described {
+    /**
+     * A description that describes this object
+     *
+     * @return The description
+     */
+    String getDescription();
+}

discovery-client/src/main/java/io/micronaut/discovery/client/DiscoveryClientConfiguration.java

@@ -31,10 +31,7 @@
 import java.net.URI;
 import java.net.URISyntaxException;
 import java.net.URL;
-import java.util.ArrayList;
-import java.util.Collections;
-import java.util.List;
-import java.util.Map;
+import java.util.*;
 import java.util.function.Function;
 import java.util.stream.Collectors;
 import java.util.stream.Stream;
@@ -48,6 +45,7 @@
 public abstract class DiscoveryClientConfiguration extends HttpClientConfiguration {
 
 
+    private final ApplicationConfiguration applicationConfiguration;
     private List<ServiceInstance> defaultZone = Collections.emptyList();
     private List<ServiceInstance> otherZones = Collections.emptyList();
 
@@ -56,12 +54,23 @@ public abstract class DiscoveryClientConfiguration extends HttpClientConfigurati
     private boolean secure;
 
     public DiscoveryClientConfiguration() {
+        this.applicationConfiguration = null;
     }
 
     public DiscoveryClientConfiguration(ApplicationConfiguration applicationConfiguration) {
         super(applicationConfiguration);
+        this.applicationConfiguration = applicationConfiguration;
     }
 
+    /**
+     * @return Resolves the service ID to use
+     */
+    public Optional<String> getServiceId() {
+        if(applicationConfiguration != null) {
+            return applicationConfiguration.getName();
+        }
+        return Optional.empty();
+    }
     /**
      * @return The Discovery servers within the default zone
      */

discovery-client/src/main/java/io/micronaut/discovery/consul/ConsulConfiguration.java

@@ -17,6 +17,7 @@
 
 import io.micronaut.context.annotation.ConfigurationProperties;
 import io.micronaut.core.util.Toggleable;
+import io.micronaut.discovery.config.ConfigDiscoveryConfiguration;
 import io.micronaut.discovery.consul.client.v1.ConsulClient;
 import io.micronaut.discovery.consul.condition.RequiresConsul;
 import io.micronaut.http.HttpMethod;
@@ -57,6 +58,8 @@ public class ConsulConfiguration extends DiscoveryClientConfiguration {
 
     private ConsulDiscoveryConfiguration discovery = new ConsulDiscoveryConfiguration();
 
+    private ConsulConfigDiscoveryConfiguration configuration = new ConsulConfigDiscoveryConfiguration();
+
     public ConsulConfiguration() {
         setPort(8500);
     }
@@ -67,6 +70,18 @@ public ConsulConfiguration(ApplicationConfiguration applicationConfiguration) {
         setPort(8500);
     }
 
+    /**
+     * @return The configuration discovery configuration
+     */
+    public ConsulConfigDiscoveryConfiguration getConfiguration() {
+        return configuration;
+    }
+
+    public void setConfiguration(ConsulConfigDiscoveryConfiguration configuration) {
+        if(configuration != null)
+            this.configuration = configuration;
+    }
+
     /**
      * @return The token to include in all requests as the {@code X-Consul-Token} header
      */
@@ -91,7 +106,8 @@ public ConsulDiscoveryConfiguration getDiscovery() {
     }
 
     public void setDiscovery(ConsulDiscoveryConfiguration discovery) {
-        this.discovery = discovery;
+        if(discovery != null)
+            this.discovery = discovery;
     }
 
     public void setAslToken(String aslToken) {
@@ -104,7 +120,26 @@ protected String getServiceID() {
     }
 
     public void setRegistration(ConsulRegistrationConfiguration registration) {
-        this.registration = registration;
+        if(registration != null)
+            this.registration = registration;
+    }
+
+    @ConfigurationProperties(ConfigDiscoveryConfiguration.PREFIX)
+    public static class ConsulConfigDiscoveryConfiguration extends ConfigDiscoveryConfiguration {
+
+        private String datacenter;
+
+        /**
+         * The data center to use to read configuration
+         * @return The data center name
+         */
+        public Optional<String> getDatacenter() {
+            return Optional.ofNullable(datacenter);
+        }
+
+        public void setDatacenter(String datacenter) {
+            this.datacenter = datacenter;
+        }
     }
 
     @ConfigurationProperties(DiscoveryConfiguration.PREFIX)

discovery-client/src/main/java/io/micronaut/discovery/consul/client/v1/AbstractConsulClient.java

@@ -16,21 +16,26 @@
 package io.micronaut.discovery.consul.client.v1;
 
 import io.micronaut.context.annotation.Requires;
+import io.micronaut.context.env.Environment;
+import io.micronaut.context.env.PropertySource;
 import io.micronaut.core.async.publisher.Publishers;
+import io.micronaut.core.util.CollectionUtils;
 import io.micronaut.discovery.DiscoveryClient;
 import io.micronaut.discovery.ServiceInstance;
+import io.micronaut.discovery.config.ConfigDiscoveryConfiguration;
+import io.micronaut.discovery.config.ConfigurationClient;
 import io.micronaut.discovery.consul.ConsulConfiguration;
 import io.micronaut.discovery.consul.ConsulServiceInstance;
 import io.micronaut.http.client.Client;
+import io.reactivex.Emitter;
+import io.reactivex.Flowable;
+import io.reactivex.functions.Consumer;
+import io.reactivex.functions.Function;
 import org.reactivestreams.Publisher;
 
-import javax.annotation.Nullable;
 import javax.inject.Inject;
 import java.io.IOException;
-import java.util.ArrayList;
-import java.util.Collections;
-import java.util.List;
-import java.util.Optional;
+import java.util.*;
 
 /**
  * Abstract implementation of {@link ConsulClient} that also implements {@link DiscoveryClient}
@@ -41,7 +46,7 @@
 @SuppressWarnings("unused")
 @Client(id = ConsulClient.SERVICE_ID, path = "/v1", configuration = ConsulConfiguration.class)
 @Requires(beans = ConsulConfiguration.class)
-public abstract class AbstractConsulClient implements ConsulClient {
+public abstract class AbstractConsulClient implements ConsulClient, ConfigurationClient {
 
     private ConsulConfiguration consulConfiguration = new ConsulConfiguration();
 
@@ -56,6 +61,53 @@ public String getDescription() {
         return ConsulClient.SERVICE_ID;
     }
 
+    @Override
+    public Publisher<PropertySource> getPropertySources(Environment environment) {
+        Set<String> activeNames = environment.getActiveNames();
+        Optional<String> serviceId = consulConfiguration.getServiceId();
+        ConsulConfiguration.ConsulConfigDiscoveryConfiguration configDiscoveryConfiguration = consulConfiguration.getConfiguration();
+
+        ConfigDiscoveryConfiguration.Format format = configDiscoveryConfiguration.getFormat();
+        String path = configDiscoveryConfiguration.getPath().orElse(ConfigDiscoveryConfiguration.DEFAULT_PATH);
+        if(!path.endsWith("/")) {
+            path += "/";
+        }
+
+        String commonConfigPath = path + Environment.DEFAULT_NAME;
+        String applicationSpecificPath = null;
+        if(serviceId.isPresent()) {
+            applicationSpecificPath = path + serviceId.get();
+        }
+
+        String dc = configDiscoveryConfiguration.getDatacenter().orElse(null);
+        Flowable<List<KeyValue>> configurationValues = Flowable.fromPublisher(readValues(path, dc, null, null));
+        String finalApplicationSpecificPath = applicationSpecificPath;
+        String finalPath = path;
+        return configurationValues.flatMap(keyValues -> Flowable.generate(emitter -> {
+            if(CollectionUtils.isEmpty(keyValues)) {
+                emitter.onComplete();
+            }
+            else {
+                Map<String, PropertySource> propertySources = new HashMap();
+
+                for (KeyValue keyValue : keyValues) {
+                    String key = keyValue.getKey();
+                    String value = keyValue.getValue();
+
+                    if(key.startsWith(finalPath)) {
+                        key = key.substring(finalPath.length());
+
+                    }
+                }
+
+                for (PropertySource propertySource : propertySources.values()) {
+                    emitter.onNext(propertySource);
+                }
+                emitter.onComplete();
+            }
+        }));
+    }
+
     @Override
     public Publisher<List<ServiceInstance>> getInstances(String serviceId) {
         if(SERVICE_ID.equals(serviceId)) {
@@ -81,8 +133,4 @@ public Publisher<List<ServiceInstance>> getInstances(String serviceId) {
         }
     }
 
-    @Override
-    public void close() throws IOException {
-        // no-op.. will be closed by @Client
-    }
 }

discovery-client/src/main/java/io/micronaut/discovery/consul/client/v1/ConsulClient.java

@@ -18,6 +18,7 @@
 import io.micronaut.core.async.publisher.Publishers;
 import io.micronaut.core.async.publisher.Publishers;
 import io.micronaut.discovery.DiscoveryClient;
+import io.micronaut.discovery.config.ConfigurationClient;
 import io.micronaut.http.HttpStatus;
 import io.micronaut.http.annotation.Body;
 import io.micronaut.http.annotation.Get;
@@ -35,7 +36,7 @@
  * @author Graeme Rocher
  * @since 1.0
  */
-public interface ConsulClient extends ConsulOperations, DiscoveryClient {
+public interface ConsulClient extends ConsulOperations, DiscoveryClient, ConfigurationClient {
     /**
      * The default ID of the consul service
      */