Merge branch 'DavidLievrouw-ServiceProviderConfigurationScheme'

Author: TomPallister

docs/features/servicediscovery.rst

@@ -25,9 +25,12 @@ Then add the following to your ConfigureServices method.
 The following is required in the GlobalConfiguration. The Provider is required and if you do not specify a host and port the Consul default
 will be used.
 
+Please note the Scheme option defauls to HTTP. It was added in this `PR <https://github.com/ThreeMammals/Ocelot/pull/1154>`_. It defaults to HTTP to not introduce a breaking change.
+
 .. code-block:: json
 
     "ServiceDiscoveryProvider": {
+        "Scheme": "https",
         "Host": "localhost",
         "Port": 8500,
         "Type": "Consul"

src/Ocelot.Provider.Consul/ConsulClientFactory.cs

@@ -9,7 +9,7 @@ public IConsulClient Get(ConsulRegistryConfiguration config)
         {
             return new ConsulClient(c =>
             {
-                c.Address = new Uri($"http://{config.Host}:{config.Port}");
+                c.Address = new Uri($"{config.Scheme}://{config.Host}:{config.Port}");
 
                 if (!string.IsNullOrEmpty(config?.Token))
                 {

src/Ocelot.Provider.Consul/ConsulFileConfigurationRepository.cs

@@ -31,7 +31,7 @@ public ConsulFileConfigurationRepository(
             _configurationKey = string.IsNullOrWhiteSpace(serviceDiscoveryProvider.ConfigurationKey) ? "InternalConfiguration" :
                 serviceDiscoveryProvider.ConfigurationKey;
 
-            var config = new ConsulRegistryConfiguration(serviceDiscoveryProvider.Host,
+            var config = new ConsulRegistryConfiguration(serviceDiscoveryProvider.Scheme, serviceDiscoveryProvider.Host,
                 serviceDiscoveryProvider.Port, _configurationKey, serviceDiscoveryProvider.Token);
 
             _consul = factory.Get(config);

src/Ocelot.Provider.Consul/ConsulProviderFactory.cs

@@ -12,7 +12,7 @@ public static class ConsulProviderFactory
 
             var consulFactory = provider.GetService<IConsulClientFactory>();
 
-            var consulRegistryConfiguration = new ConsulRegistryConfiguration(config.Host, config.Port, reRoute.ServiceName, config.Token);
+            var consulRegistryConfiguration = new ConsulRegistryConfiguration(config.Scheme, config.Host, config.Port, reRoute.ServiceName, config.Token);
 
             var consulServiceDiscoveryProvider = new Consul(consulRegistryConfiguration, factory, consulFactory);
 

src/Ocelot.Provider.Consul/ConsulRegistryConfiguration.cs

@@ -2,15 +2,17 @@
 {
     public class ConsulRegistryConfiguration
     {
-        public ConsulRegistryConfiguration(string host, int port, string keyOfServiceInConsul, string token)
+        public ConsulRegistryConfiguration(string scheme, string host, int port, string keyOfServiceInConsul, string token)
         {
             Host = string.IsNullOrEmpty(host) ? "localhost" : host;
             Port = port > 0 ? port : 8500;
+            Scheme = string.IsNullOrEmpty(scheme) ? "http" : scheme;
             KeyOfServiceInConsul = keyOfServiceInConsul;
             Token = token;
         }
 
         public string KeyOfServiceInConsul { get; }
+        public string Scheme { get; }
         public string Host { get; }
         public int Port { get; }
         public string Token { get; }

src/Ocelot/Configuration/Builder/ServiceProviderConfigurationBuilder.cs

@@ -2,6 +2,7 @@ namespace Ocelot.Configuration.Builder
 {
     public class ServiceProviderConfigurationBuilder
     {
+        private string _serviceDiscoveryProviderScheme;
         private string _serviceDiscoveryProviderHost;
         private int _serviceDiscoveryProviderPort;
         private string _type;
@@ -10,6 +11,12 @@ public class ServiceProviderConfigurationBuilder
         private int _pollingInterval;
         private string _namespace;
 
+        public ServiceProviderConfigurationBuilder WithScheme(string serviceDiscoveryProviderScheme)
+        {
+            _serviceDiscoveryProviderScheme = serviceDiscoveryProviderScheme;
+            return this;
+        }
+
         public ServiceProviderConfigurationBuilder WithHost(string serviceDiscoveryProviderHost)
         {
             _serviceDiscoveryProviderHost = serviceDiscoveryProviderHost;
@@ -54,7 +61,7 @@ public ServiceProviderConfigurationBuilder WithNamespace(string @namespace)
 
         public ServiceProviderConfiguration Build()
         {
-            return new ServiceProviderConfiguration(_type, _serviceDiscoveryProviderHost, _serviceDiscoveryProviderPort, _token, _configurationKey, _pollingInterval, _namespace);
+            return new ServiceProviderConfiguration(_type, _serviceDiscoveryProviderScheme, _serviceDiscoveryProviderHost, _serviceDiscoveryProviderPort, _token, _configurationKey, _pollingInterval, _namespace);
         }
     }
 }

src/Ocelot/Configuration/Creator/ServiceProviderConfigurationCreator.cs

@@ -8,6 +8,7 @@ public class ServiceProviderConfigurationCreator : IServiceProviderConfiguration
         public ServiceProviderConfiguration Create(FileGlobalConfiguration globalConfiguration)
         {
             var port = globalConfiguration?.ServiceDiscoveryProvider?.Port ?? 0;
+            var scheme = globalConfiguration?.ServiceDiscoveryProvider?.Scheme ?? "http";
             var host = globalConfiguration?.ServiceDiscoveryProvider?.Host ?? "localhost";
             var type = !string.IsNullOrEmpty(globalConfiguration?.ServiceDiscoveryProvider?.Type)
                 ? globalConfiguration?.ServiceDiscoveryProvider?.Type
@@ -16,6 +17,7 @@ public ServiceProviderConfiguration Create(FileGlobalConfiguration globalConfigu
             var k8snamespace = globalConfiguration?.ServiceDiscoveryProvider?.Namespace ?? string.Empty;
 
             return new ServiceProviderConfigurationBuilder()
+                .WithScheme(scheme)
                 .WithHost(host)
                 .WithPort(port)
                 .WithType(type)

src/Ocelot/Configuration/File/FileServiceDiscoveryProvider.cs

@@ -2,6 +2,7 @@ namespace Ocelot.Configuration.File
 {
     public class FileServiceDiscoveryProvider
     {
+        public string Scheme { get; set; }
         public string Host { get; set; }
         public int Port { get; set; }
         public string Type { get; set; }

src/Ocelot/Configuration/ServiceProviderConfiguration.cs

@@ -2,9 +2,10 @@
 {
     public class ServiceProviderConfiguration
     {
-        public ServiceProviderConfiguration(string type, string host, int port, string token, string configurationKey, int pollingInterval, string @namespace = "")
+        public ServiceProviderConfiguration(string type, string scheme, string host, int port, string token, string configurationKey, int pollingInterval, string @namespace = "")
         {
             ConfigurationKey = configurationKey;
+            Scheme = scheme;
             Host = host;
             Port = port;
             Token = token;
@@ -13,6 +14,8 @@ public ServiceProviderConfiguration(string type, string host, int port, string t
             Namespace = @namespace;
         }
 
+        public string Scheme { get; }
+
         public string Host { get; }
 
         public int Port { get; }

test/Ocelot.AcceptanceTests/CannotStartOcelotTests.cs

@@ -24,6 +24,7 @@ public void should_throw_exception_if_cannot_start_because_service_discovery_pro
                 {
                     ServiceDiscoveryProvider = new FileServiceDiscoveryProvider
                     {
+                        Scheme = "https",
                         Host = "localhost",
                         Type = "consul",
                         Port = 8500
@@ -66,6 +67,7 @@ public void should_throw_exception_if_cannot_start_because_service_discovery_pro
                 {
                     ServiceDiscoveryProvider = new FileServiceDiscoveryProvider
                     {
+                        Scheme = "https",
                         Host = "localhost",
                         Type = "consul",
                         Port = 8500