Remove ConfigQueryResult type and clean up ConsulConfigurationProviderTests. (#28)

Author: Choc13

src/Winton.Extensions.Configuration.Consul/ConfigQueryResult.cs

@@ -26,11 +26,11 @@ public ConsulConfigurationClient(IConsulClientFactory consulClientFactory, ICons
             _source = source;
         }
 
-        public async Task<IConfigQueryResult> GetConfig()
+        public async Task<QueryResult<KVPair>> GetConfig()
         {
             QueryResult<KVPair> result = await GetKvPair().ConfigureAwait(false);
             UpdateLastIndex(result);
-            return new ConfigQueryResult(result);
+            return result;
         }
 
         public IChangeToken Watch(Action<ConsulWatchExceptionContext> onException)

src/Winton.Extensions.Configuration.Consul/ConsulConfigurationClient.cs

@@ -5,8 +5,10 @@
 using System.Collections.Generic;
 using System.IO;
 using System.Threading.Tasks;
+using Consul;
 using Microsoft.Extensions.Configuration;
 using Microsoft.Extensions.Primitives;
+using Winton.Extensions.Configuration.Consul.Extensions;
 
 namespace Winton.Extensions.Configuration.Consul
 {
@@ -51,12 +53,27 @@ public override void Load()
             }
         }
 
+        private Dictionary<string, string> ConvertResultToDictionary(QueryResult<KVPair> queryResult)
+        {
+            if (!queryResult.HasValue())
+            {
+                return new Dictionary<string, string>(StringComparer.OrdinalIgnoreCase);
+            }
+
+            using (var configStream = new MemoryStream(queryResult.Value()))
+            {
+                return new Dictionary<string, string>(
+                    _source.Parser.Parse(configStream),
+                    StringComparer.OrdinalIgnoreCase);
+            }
+        }
+
         private async Task DoLoad(bool reloading)
         {
             try
             {
-                IConfigQueryResult configQueryResult = await _consulConfigClient.GetConfig().ConfigureAwait(false);
-                if (!configQueryResult.Exists && !_source.Optional)
+                QueryResult<KVPair> queryResult = await _consulConfigClient.GetConfig().ConfigureAwait(false);
+                if (!queryResult.HasValue() && !_source.Optional)
                 {
                     if (!reloading)
                     {
@@ -68,36 +85,15 @@ private async Task DoLoad(bool reloading)
                     return;
                 }
 
-                LoadIntoMemory(configQueryResult);
+                Data = ConvertResultToDictionary(queryResult);
             }
             catch (Exception exception)
             {
-                HandleLoadException(exception);
-            }
-        }
-
-        private void HandleLoadException(Exception exception)
-        {
-            var exceptionContext = new ConsulLoadExceptionContext(_source, exception);
-            _source.OnLoadException?.Invoke(exceptionContext);
-            if (!exceptionContext.Ignore)
-            {
-                throw exception;
-            }
-        }
-
-        private void LoadIntoMemory(IConfigQueryResult configQueryResult)
-        {
-            if (!configQueryResult.Exists)
-            {
-                Data = new Dictionary<string, string>(StringComparer.OrdinalIgnoreCase);
-            }
-            else
-            {
-                using (var configStream = new MemoryStream(configQueryResult.Value))
+                var exceptionContext = new ConsulLoadExceptionContext(_source, exception);
+                _source.OnLoadException?.Invoke(exceptionContext);
+                if (!exceptionContext.Ignore)
                 {
-                    IDictionary<string, string> parsedData = _source.Parser.Parse(configStream);
-                    Data = new Dictionary<string, string>(parsedData, StringComparer.OrdinalIgnoreCase);
+                    throw;
                 }
             }
         }

src/Winton.Extensions.Configuration.Consul/ConsulConfigurationProvider.cs

@@ -0,0 +1,22 @@
+// Copyright (c) Winton. All rights reserved.
+// Licensed under the Apache License, Version 2.0. See LICENCE in the project root for license information.
+
+using System.Net;
+using Consul;
+
+namespace Winton.Extensions.Configuration.Consul.Extensions
+{
+    internal static class KvPairQueryResultExtensions
+    {
+        internal static bool HasValue(this QueryResult<KVPair> queryResult)
+        {
+            return queryResult?.StatusCode != HttpStatusCode.NotFound
+                   && queryResult.Value()?.Length > 0;
+        }
+
+        internal static byte[] Value(this QueryResult<KVPair> queryResult)
+        {
+            return queryResult?.Response?.Value;
+        }
+    }
+}

src/Winton.Extensions.Configuration.Consul/Extensions/KvPairQueryResultExtensions.cs

@@ -3,6 +3,7 @@
 
 using System;
 using System.Threading.Tasks;
+using Consul;
 using Microsoft.Extensions.Primitives;
 
 namespace Winton.Extensions.Configuration.Consul
@@ -11,8 +12,8 @@ namespace Winton.Extensions.Configuration.Consul
     internal interface IConsulConfigurationClient
     {
         /// <summary>Gets the config from consul asynchronously.</summary>
-        /// <returns>A Task containing the result of the query for the config.</returns>
-        Task<IConfigQueryResult> GetConfig();
+        /// <returns>A task containing the result of the query for the config.</returns>
+        Task<QueryResult<KVPair>> GetConfig();
 
         /// <summary>Watches the config for changes.</summary>
         /// <param name="onException">An action to be invoked if an exception occurs during the watch.</param>

src/Winton.Extensions.Configuration.Consul/IConfigQueryResult.cs

@@ -7,7 +7,7 @@ public class Program
     {
         public static void Main(string[] args)
         {
-            var host = new WebHostBuilder()
+            IWebHost host = new WebHostBuilder()
                 .UseKestrel()
                 .UseContentRoot(Directory.GetCurrentDirectory())
                 .UseIISIntegration()
@@ -17,4 +17,4 @@ public static void Main(string[] args)
             host.Run();
         }
     }
-}
+}

src/Winton.Extensions.Configuration.Consul/IConsulConfigurationClient.cs

@@ -11,59 +11,47 @@ namespace Winton.Extensions.Configuration.Consul.Website
 {
     public class Startup
     {
-        private readonly CancellationTokenSource _consulConfigCancellationTokenSource = new CancellationTokenSource();
         private readonly IConfigurationRoot _configuration;
+        private readonly CancellationTokenSource _consulConfigCancellationTokenSource = new CancellationTokenSource();
 
         public Startup(IHostingEnvironment env, ILoggerFactory loggerFactory)
         {
             loggerFactory
                 .AddConsole(LogLevel.Debug)
                 .AddDebug(LogLevel.Debug);
 
-            var builder = new ConfigurationBuilder()
+            IConfigurationBuilder builder = new ConfigurationBuilder()
                 .SetBasePath(env.ContentRootPath)
                 .AddConsul(
                     "appsettings.json",
                     _consulConfigCancellationTokenSource.Token,
                     options =>
                     {
-                        options.ConsulConfigurationOptions = cco =>
-                        {
-                            cco.Address = new Uri("http://consul:8500");
-                        };
+                        options.ConsulConfigurationOptions = cco => { cco.Address = new Uri("http://consul:8500"); };
                         options.Optional = true;
                         options.ReloadOnChange = true;
-                        options.OnLoadException = (exceptionContext) =>
-                        {
-                            exceptionContext.Ignore = true;
-                        };
+                        options.OnLoadException = exceptionContext => { exceptionContext.Ignore = true; };
                     })
                 .AddEnvironmentVariables();
             _configuration = builder.Build();
         }
 
-        public void ConfigureServices(IServiceCollection services)
-        {
-            services
-                .AddSwaggerGen(c =>
-                {
-                    c.SwaggerDoc("v1", new Info { Title = "Test Website", Version = "v1" });
-                })
-                .AddSingleton(_configuration)
-                .AddMvc();
-        }
-
         public void Configure(IApplicationBuilder app, IApplicationLifetime appLifetime)
         {
             app
                 .UseMvc()
                 .UseSwagger()
-                .UseSwaggerUI(c =>
-                {
-                    c.SwaggerEndpoint("/swagger/v1/swagger.json", "Test Website");
-                });
+                .UseSwaggerUI(c => { c.SwaggerEndpoint("/swagger/v1/swagger.json", "Test Website"); });
 
             appLifetime.ApplicationStopping.Register(_consulConfigCancellationTokenSource.Cancel);
         }
+
+        public void ConfigureServices(IServiceCollection services)
+        {
+            services
+                .AddSwaggerGen(c => { c.SwaggerDoc("v1", new Info { Title = "Test Website", Version = "v1" }); })
+                .AddSingleton(_configuration)
+                .AddMvc();
+        }
     }
-}
+}