Update to C# 8. (#87)

Author: Choc13

.travis.yml

@@ -11,12 +11,12 @@ env:
 matrix:
   include:
     - os: linux
-      dist: xenial
+      dist: bionic
       sudo: required
       dotnet: 3.0
     - os: osx 
       osx_image: xcode11.2
-      dotnet: 3.0.100
+      dotnet: 3.0.101
       before_install:
         - ulimit -n 4096
 script:

Directory.Build.props

@@ -0,0 +1,15 @@
+<Project>
+  <PropertyGroup>
+    <Authors>Winton</Authors>
+    <Company>Winton</Company>
+    <Copyright>Copyright 2019 Winton</Copyright>
+    <CodeAnalysisRuleSet>$(MSBuildThisFileDirectory)Rules.ruleset</CodeAnalysisRuleSet>
+    <LangVersion>8.0</LangVersion>
+    <Nullable>enable</Nullable>
+    <TreatWarningsAsErrors>True</TreatWarningsAsErrors>
+  </PropertyGroup>
+
+  <ItemGroup>
+    <PackageReference Include="StyleCop.Analyzers" Version="1.1.118" PrivateAssets="All" />
+  </ItemGroup>
+</Project>

Rules.ruleset

@@ -0,0 +1,11 @@
+<?xml version="1.0" encoding="utf-8"?>
+<RuleSet Name="Rules" Description=" " ToolsVersion="16.0">
+  <Rules AnalyzerId="Microsoft.CodeQuality.Analyzers" RuleNamespace="Microsoft.CodeQuality.Analyzers">
+    <Rule Id="CA2007" Action="None" />
+  </Rules>
+  <Rules AnalyzerId="StyleCop.Analyzers" RuleNamespace="StyleCop.Analyzers">
+    <Rule Id="SA1101" Action="None" />
+    <Rule Id="SA1309" Action="None" />
+    <Rule Id="SA1413" Action="None" />
+  </Rules>
+</RuleSet>

Winton.Extensions.Configuration.Consul.sln

@@ -10,15 +10,21 @@ Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Solution Items", "Solution
 		appveyor.yml = appveyor.yml
 		build.sh = build.sh
 		CONTRIBUTING.md = CONTRIBUTING.md
+		Directory.Build.props = Directory.Build.props
 		GitVersion.yml = GitVersion.yml
 		LICENSE = LICENSE
 		README.md = README.md
+		Rules.ruleset = Rules.ruleset
 		stylecop.json = stylecop.json
 	EndProjectSection
 EndProject
 Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "src", "src", "{03739F78-2460-4F1E-92F2-807CBD8C8AB5}"
 EndProject
 Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "test", "test", "{972A51CA-2686-4B9B-8BBB-503B2A1BA630}"
+	ProjectSection(SolutionItems) = preProject
+		test\Directory.Build.props = test\Directory.Build.props
+		test\Rules.ruleset = test\Rules.ruleset
+	EndProjectSection
 EndProject
 Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Winton.Extensions.Configuration.Consul", "src\Winton.Extensions.Configuration.Consul\Winton.Extensions.Configuration.Consul.csproj", "{B5C08CE5-B60B-485F-B78F-A119B8AA8508}"
 EndProject

Winton.Extensions.Configuration.Consul.sln.DotSettings

@@ -414,9 +414,9 @@
   </TypePattern>
 &lt;/Patterns&gt;</s:String>
 
-	<s:String x:Key="/Default/CodeStyle/CSharpVarKeywordUsage/ForBuiltInTypes/@EntryValue">UseVarWhenEvident</s:String>
-	<s:String x:Key="/Default/CodeStyle/CSharpVarKeywordUsage/ForOtherTypes/@EntryValue">UseVarWhenEvident</s:String>
-	<s:String x:Key="/Default/CodeStyle/CSharpVarKeywordUsage/ForSimpleTypes/@EntryValue">UseVarWhenEvident</s:String>
+	<s:String x:Key="/Default/CodeStyle/CSharpVarKeywordUsage/ForBuiltInTypes/@EntryValue">UseVar</s:String>
+	<s:String x:Key="/Default/CodeStyle/CSharpVarKeywordUsage/ForOtherTypes/@EntryValue">UseVar</s:String>
+	<s:String x:Key="/Default/CodeStyle/CSharpVarKeywordUsage/ForSimpleTypes/@EntryValue">UseVar</s:String>
 	<s:String x:Key="/Default/CodeStyle/Naming/CSharpNaming/PredefinedNamingRules/=PrivateConstants/@EntryIndexedValue">&lt;Policy Inspect="True" Prefix="_" Suffix="" Style="AaBb" /&gt;</s:String>
 	<s:String x:Key="/Default/CodeStyle/Naming/CSharpNaming/PredefinedNamingRules/=PrivateInstanceFields/@EntryIndexedValue">&lt;Policy Inspect="True" Prefix="_" Suffix="" Style="aaBb" /&gt;</s:String>
 	<s:String x:Key="/Default/CodeStyle/Naming/JavaScriptNaming/UserRules/=JS_005FBLOCK_005FSCOPE_005FCONSTANT/@EntryIndexedValue">&lt;Policy Inspect="True" Prefix="" Suffix="" Style="aaBb" /&gt;</s:String>

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

@@ -1,8 +1,7 @@
 // Copyright (c) Winton. All rights reserved.
-// Licensed under the Apache License, Version 2.0. See LICENCE in the project root for license information.
+// Licensed under the Apache License, Version 2.0. See LICENSE in the project root for license information.
 
 using System;
-using System.Threading;
 using Microsoft.Extensions.Configuration;
 
 namespace Winton.Extensions.Configuration.Consul
@@ -45,4 +44,4 @@ public static IConfigurationBuilder AddConsul(
             return builder.Add(consulConfigSource);
         }
     }
-}
+}

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

@@ -1,5 +1,5 @@
 // Copyright (c) Winton. All rights reserved.
-// Licensed under the Apache License, Version 2.0. See LICENCE in the project root for license information.
+// Licensed under the Apache License, Version 2.0. See LICENSE in the project root for license information.
 
 using Consul;
 

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

@@ -1,5 +1,5 @@
 // Copyright (c) Winton. All rights reserved.
-// Licensed under the Apache License, Version 2.0. See LICENCE in the project root for license information.
+// Licensed under the Apache License, Version 2.0. See LICENSE in the project root for license information.
 
 using System;
 using System.Net;
@@ -13,7 +13,7 @@ namespace Winton.Extensions.Configuration.Consul
 {
     /// <summary>
     ///     Each instance loads configuration for the key in Consul that is specified in
-    ///     the contained <see cref="IConsulConfigurationSource"/>.
+    ///     the contained <see cref="IConsulConfigurationSource" />.
     ///     It has the ability to automatically reload the config if it changes in Consul.
     /// </summary>
     /// <remarks>
@@ -26,7 +26,7 @@ internal sealed class ConsulConfigurationProvider : ConfigurationProvider, IDisp
         private readonly IConsulClientFactory _consulClientFactory;
         private readonly IConsulConfigurationSource _source;
         private ulong _lastIndex;
-        private Task _pollTask;
+        private Task? _pollTask;
 
         public ConsulConfigurationProvider(
             IConsulConfigurationSource source,
@@ -70,7 +70,7 @@ private async Task DoLoad()
         {
             try
             {
-                QueryResult<KVPair[]> result = await GetKvPairs(false).ConfigureAwait(false);
+                var result = await GetKvPairs(false).ConfigureAwait(false);
 
                 if (result.HasValue())
                 {
@@ -96,30 +96,27 @@ private async Task DoLoad()
 
         private async Task<QueryResult<KVPair[]>> GetKvPairs(bool waitForChange)
         {
-            using (IConsulClient consulClient = _consulClientFactory.Create())
+            using var consulClient = _consulClientFactory.Create();
+            var queryOptions = new QueryOptions
             {
-                var queryOptions = new QueryOptions
-                {
-                    WaitTime = _source.PollWaitTime,
-                    WaitIndex = waitForChange ? _lastIndex : 0
-                };
+                WaitTime = _source.PollWaitTime,
+                WaitIndex = waitForChange ? _lastIndex : 0
+            };
 
-                QueryResult<KVPair[]> result =
-                    await consulClient
-                        .KV
-                        .List(_source.Key, queryOptions, _cancellationTokenSource.Token)
-                        .ConfigureAwait(false);
+            var result =
+                await consulClient
+                    .KV
+                    .List(_source.Key, queryOptions, _cancellationTokenSource.Token)
+                    .ConfigureAwait(false);
 
-                switch (result.StatusCode)
-                {
-                    case HttpStatusCode.OK:
-                    case HttpStatusCode.NotFound:
-                        return result;
-                    default:
-                        throw new Exception(
-                            $"Error loading configuration from consul. Status code: {result.StatusCode}.");
-                }
-            }
+            return result.StatusCode switch
+            {
+                HttpStatusCode.OK => result,
+                HttpStatusCode.NotFound => result,
+                _ =>
+                    throw
+                        new Exception($"Error loading configuration from consul. Status code: {result.StatusCode}.")
+                };
         }
 
         private async Task PollingLoop()
@@ -129,7 +126,7 @@ private async Task PollingLoop()
             {
                 try
                 {
-                    QueryResult<KVPair[]> result = await GetKvPairs(true).ConfigureAwait(false);
+                    var result = await GetKvPairs(true).ConfigureAwait(false);
 
                     if (result.HasValue() && result.LastIndex > _lastIndex)
                     {
@@ -142,7 +139,7 @@ private async Task PollingLoop()
                 }
                 catch (Exception exception)
                 {
-                    TimeSpan wait =
+                    var wait =
                         _source.OnWatchException?.Invoke(
                             new ConsulWatchExceptionContext(exception, ++consecutiveFailureCount, _source)) ??
                         TimeSpan.FromSeconds(5);

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

@@ -1,5 +1,5 @@
 // Copyright (c) Winton. All rights reserved.
-// Licensed under the Apache License, Version 2.0. See LICENCE in the project root for license information.
+// Licensed under the Apache License, Version 2.0. See LICENSE in the project root for license information.
 
 using System;
 using System.Net.Http;
@@ -11,6 +11,8 @@ namespace Winton.Extensions.Configuration.Consul
 {
     internal sealed class ConsulConfigurationSource : IConsulConfigurationSource
     {
+        private string? _keyToRemove;
+
         public ConsulConfigurationSource(string key)
         {
             if (string.IsNullOrWhiteSpace(key))
@@ -19,32 +21,35 @@ public ConsulConfigurationSource(string key)
             }
 
             Key = key;
-            KeyToRemove = Key;
             Parser = new JsonConfigurationParser();
         }
 
-        public Action<ConsulClientConfiguration> ConsulConfigurationOptions { get; set; }
+        public Action<ConsulClientConfiguration>? ConsulConfigurationOptions { get; set; }
 
-        public Action<HttpClientHandler> ConsulHttpClientHandlerOptions { get; set; }
+        public Action<HttpClientHandler>? ConsulHttpClientHandlerOptions { get; set; }
 
-        public Action<HttpClient> ConsulHttpClientOptions { get; set; }
+        public Action<HttpClient>? ConsulHttpClientOptions { get; set; }
 
         public string Key { get; }
 
-        public string KeyToRemove { get; set; }
+        public string KeyToRemove
+        {
+            get => _keyToRemove ?? Key;
+            set => _keyToRemove = value;
+        }
 
-        public Action<ConsulLoadExceptionContext> OnLoadException { get; set; }
+        public Action<ConsulLoadExceptionContext>? OnLoadException { get; set; }
 
-        public Func<ConsulWatchExceptionContext, TimeSpan> OnWatchException { get; set; }
+        public Func<ConsulWatchExceptionContext, TimeSpan>? OnWatchException { get; set; }
 
         public bool Optional { get; set; } = false;
 
         public IConfigurationParser Parser { get; set; }
 
-        public bool ReloadOnChange { get; set; } = false;
-
         public TimeSpan PollWaitTime { get; set; } = TimeSpan.FromMinutes(5);
 
+        public bool ReloadOnChange { get; set; } = false;
+
         public IConfigurationProvider Build(IConfigurationBuilder builder)
         {
             var consulClientFactory = new ConsulClientFactory(this);

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

@@ -1,5 +1,5 @@
 // Copyright (c) Winton. All rights reserved.
-// Licensed under the Apache License, Version 2.0. See LICENCE in the project root for license information.
+// Licensed under the Apache License, Version 2.0. See LICENSE in the project root for license information.
 
 using System;