v5.2.0 (#81)

* v5.2.0 - *Enhancement:* Added `TesterBase<TSelf>.UseAdditionalConfiguration` method to enable additional configuration to be specified that overrides the `IHostBuilder` as the host is being built. This leverages the underlying `IConfigurationBuilder.AddInMemoryCollection` capability to add. This is intended to support additional configuration that is not part of the standard `appsettings.json` or `appsettings.unittest.json` configuration. * Tweak the build versions.
Avanade · Jan 20, 2025 · cb08676 · cb08676
1 parent 4a7d0c8
commit cb08676
Show file tree

Hide file tree

Showing 16 changed files with 97 additions and 14 deletions.
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -17,7 +17,6 @@ jobs:
       uses: actions/setup-dotnet@v1
       with:
         dotnet-version: |
-          3.1.x
           6.0.x
           7.0.x
           8.0.x

diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,6 +2,9 @@
 
 Represents the **NuGet** versions.
 
+## v5.2.0
+- *Enhancement:* Added `TesterBase<TSelf>.UseAdditionalConfiguration` method to enable additional configuration to be specified that overrides the `IHostBuilder` as the host is being built. This leverages the underlying `IConfigurationBuilder.AddInMemoryCollection` capability to add. This is intended to support additional configuration that is not part of the standard `appsettings.json` or `appsettings.unittest.json` configuration.
+
 ## v5.1.0
 - *Enhancement:* Where an `HttpRequest` is used for an Azure Functions `HttpTriggerTester` the passed `HttpRequest.PathAndQuery` is checked against that defined by the corresponding `HttpTriggerAttribute.Route` and will result in an error where different. The `HttpTrigger.WithRouteChecK` and `WithNoRouteCheck` methods control the path and query checking as needed.
 

diff --git a/Common.targets b/Common.targets
@@ -1,6 +1,6 @@
 <Project>
 	<PropertyGroup>
-		<Version>5.1.0</Version>
+		<Version>5.2.0</Version>
 		<LangVersion>preview</LangVersion>
 		<Authors>Avanade</Authors>
 		<Company>Avanade</Company>

diff --git a/src/UnitTestEx.Azure.Functions/Azure/Functions/FunctionTesterBase.cs b/src/UnitTestEx.Azure.Functions/Azure/Functions/FunctionTesterBase.cs
@@ -36,7 +36,6 @@ public abstract class FunctionTesterBase<TEntryPoint, TSelf> : TesterBase<TSelf>
 
         private readonly bool? _includeUnitTestConfiguration;
         private readonly bool? _includeUserSecrets;
-        private readonly IEnumerable<KeyValuePair<string, string?>>? _additionalConfiguration;
         private IHost? _host;
         private bool _disposed;
 
@@ -62,7 +61,7 @@ public FunctionTesterBase(TestFrameworkImplementor implementor, bool? includeUni
             Logger = LoggerProvider.CreateLogger(GetType().Name);
             _includeUnitTestConfiguration = includeUnitTestConfiguration;
             _includeUserSecrets = includeUserSecrets;
-            _additionalConfiguration = additionalConfiguration;
+            AdditionalConfiguration = additionalConfiguration;
         }
 
         /// <summary>
@@ -168,8 +167,8 @@ private IHost GetHost()
                         if (!_includeUnitTestConfiguration.HasValue && TestSetUp.FunctionTesterIncludeUnitTestConfiguration || _includeUnitTestConfiguration.HasValue && _includeUnitTestConfiguration.Value)
                             cb.AddJsonFile("appsettings.unittest.json", optional: true);
 
-                        if (_additionalConfiguration != null)
-                            cb.AddInMemoryCollection(_additionalConfiguration);
+                        if (AdditionalConfiguration != null)
+                            cb.AddInMemoryCollection(AdditionalConfiguration);
                     })
                     .ConfigureServices(sc =>
                     {

diff --git a/src/UnitTestEx.Azure.Functions/UnitTestEx.Azure.Functions.csproj b/src/UnitTestEx.Azure.Functions/UnitTestEx.Azure.Functions.csproj
@@ -1,7 +1,7 @@
 <Project Sdk="Microsoft.NET.Sdk">
 
   <PropertyGroup>
-    <TargetFrameworks>net6.0;net7.0;net8.0</TargetFrameworks>
+    <TargetFrameworks>net6.0;net7.0;net8.0;net9.0</TargetFrameworks>
     <RootNamespace>UnitTestEx</RootNamespace>
     <Product>UnitTestEx</Product>
     <Title>UnitTestEx Azure Functions Test Extensions.</Title>

diff --git a/src/UnitTestEx.Azure.ServiceBus/UnitTestEx.Azure.ServiceBus.csproj b/src/UnitTestEx.Azure.ServiceBus/UnitTestEx.Azure.ServiceBus.csproj
@@ -1,7 +1,7 @@
 <Project Sdk="Microsoft.NET.Sdk">
 
   <PropertyGroup>
-    <TargetFrameworks>net6.0;net7.0;net8.0</TargetFrameworks>
+    <TargetFrameworks>net6.0;net7.0;net8.0;net9.0</TargetFrameworks>
     <RootNamespace>UnitTestEx</RootNamespace>
     <Product>UnitTestEx</Product>
     <Title>UnitTestEx Azure Functions Test Extensions.</Title>

diff --git a/src/UnitTestEx.MSTest/UnitTestEx.MSTest.csproj b/src/UnitTestEx.MSTest/UnitTestEx.MSTest.csproj
@@ -1,7 +1,7 @@
 <Project Sdk="Microsoft.NET.Sdk">
 
   <PropertyGroup>
-    <TargetFrameworks>net6.0;net7.0;net8.0</TargetFrameworks>
+    <TargetFrameworks>net6.0;net7.0;net8.0;net9.0</TargetFrameworks>
     <RootNamespace>UnitTestEx.MSTest</RootNamespace>
 	  <Product>UnitTestEx MSTest</Product>
 	  <Title>UnitTestEx MSTest Test Extensions.</Title>

diff --git a/src/UnitTestEx.NUnit/UnitTestEx.NUnit.csproj b/src/UnitTestEx.NUnit/UnitTestEx.NUnit.csproj
@@ -1,7 +1,7 @@
 <Project Sdk="Microsoft.NET.Sdk">
 
   <PropertyGroup>
-    <TargetFrameworks>net6.0;net7.0;net8.0</TargetFrameworks>
+    <TargetFrameworks>net6.0;net7.0;net8.0;net9.0</TargetFrameworks>
     <RootNamespace>UnitTestEx.NUnit</RootNamespace>
 	  <Product>UnitTestEx NUnit</Product>
 	  <Title>UnitTestEx NUnit Test Extensions.</Title>

diff --git a/src/UnitTestEx.Xunit/UnitTestEx.Xunit.csproj b/src/UnitTestEx.Xunit/UnitTestEx.Xunit.csproj
@@ -1,7 +1,7 @@
 <Project Sdk="Microsoft.NET.Sdk">
 
   <PropertyGroup>
-    <TargetFrameworks>net6.0;net7.0;net8.0</TargetFrameworks>
+    <TargetFrameworks>net6.0;net7.0;net8.0;net9.0</TargetFrameworks>
     <RootNamespace>UnitTestEx.Xunit</RootNamespace>
 	  <Product>UnitTestEx Xunit</Product>
 	  <Title>UnitTestEx Xunit Test Extensions.</Title>

diff --git a/src/UnitTestEx/Abstractions/TesterBase.cs b/src/UnitTestEx/Abstractions/TesterBase.cs
@@ -6,6 +6,7 @@
 using System;
 using System.Collections.Generic;
 using System.IO;
+using System.Linq;
 using UnitTestEx.Json;
 using UnitTestEx.Logging;
 
@@ -18,6 +19,7 @@ public abstract class TesterBase
     {
         private string? _userName;
         private readonly List<Action<IServiceCollection>> _configureServices = [];
+        private IEnumerable<KeyValuePair<string, string?>>? _additionalConfiguration;
 
         /// <summary>
         /// Static constructor.
@@ -97,6 +99,19 @@ public string UserName
             protected set => _userName = value;
         }
 
+        /// <summary>
+        /// Gets the additional configuration used at host initialization (see <see cref="MemoryConfigurationBuilderExtensions.AddInMemoryCollection(IConfigurationBuilder, IEnumerable{KeyValuePair{string, string}})"/>).
+        /// </summary>
+        public IEnumerable<KeyValuePair<string, string?>>? AdditionalConfiguration
+        {
+            get => _additionalConfiguration?.ToArray();
+            protected set
+            {
+                _additionalConfiguration = value;
+                ResetHost(false);
+            }
+        }
+
         /// <summary>
         /// Gets the <see cref="IConfiguration"/> from the underlying host.
         /// </summary>
@@ -182,7 +197,7 @@ public void ConfigureServices(Action<IServiceCollection> configureServices, bool
         protected void AddConfiguredServices(IServiceCollection services)
         {
             if (IsHostInstantiated)
-                throw new InvalidOperationException($"Underlying host has been instantiated and as such the {nameof(ConfigureServices)} operations can no longer be used.");
+                throw new InvalidOperationException($"Underlying host has been instantiated and as such the {nameof(ConfigureServices)} operations can no longer be used; consider using '{nameof(ResetHost)}' prior to enable.");
 
             foreach (var configureService in _configureServices)
             {

diff --git a/src/UnitTestEx/Abstractions/TesterBaseT.cs b/src/UnitTestEx/Abstractions/TesterBaseT.cs
@@ -1,8 +1,10 @@
 // Copyright (c) Avanade. Licensed under the MIT License. See https://github.com/Avanade/UnitTestEx
 
+using Microsoft.Extensions.Configuration;
 using Microsoft.Extensions.DependencyInjection;
 using Moq;
 using System;
+using System.Collections.Generic;
 using UnitTestEx.Json;
 
 namespace UnitTestEx.Abstractions
@@ -90,6 +92,27 @@ public TSelf UseJsonComparerOptions(JsonElementComparerOptions options)
             return (TSelf)this;
         }
 
+        /// <summary>
+        /// Updates (replaces) the <see cref="TesterBase.AdditionalConfiguration"/> (see <see cref="MemoryConfigurationBuilderExtensions.AddInMemoryCollection(IConfigurationBuilder, IEnumerable{KeyValuePair{string, string}})"/>).
+        /// </summary>
+        /// <param name="additionalConfiguration">The additional configuration key/value pairs.</param>
+        /// <returns>The <typeparamref name="TSelf"/> to support fluent-style method-chaining.</returns>
+        /// <remarks>Usage will result in a <see cref="TesterBase.ResetHost()"/>.</remarks>
+        public TSelf UseAdditionalConfiguration(IEnumerable<KeyValuePair<string, string?>>? additionalConfiguration)
+        {
+            AdditionalConfiguration = additionalConfiguration;
+            return (TSelf)this;
+        }
+
+        /// <summary>
+        /// Updates (replaces) the <see cref="TesterBase.AdditionalConfiguration"/> (see <see cref="MemoryConfigurationBuilderExtensions.AddInMemoryCollection(IConfigurationBuilder, IEnumerable{KeyValuePair{string, string}})"/>) with specified <paramref name="key"/> and <paramref name="value"/>.
+        /// </summary>
+        /// <param name="key">The additional configuration key.</param>
+        /// <param name="value">The additional configuration value.</param>
+        /// <returns>The <typeparamref name="TSelf"/> to support fluent-style method-chaining.</returns>
+        /// <remarks>Usage will result in a <see cref="TesterBase.ResetHost()"/>.</remarks>
+        public TSelf UseAdditionalConfiguration(string key, string? value) => UseAdditionalConfiguration([new KeyValuePair<string, string?>(key, value)]);
+
         /// <summary>
         /// Resets the underlying host to instantiate a new instance.
         /// </summary>

diff --git a/src/UnitTestEx/AspNetCore/ApiTesterBase.cs b/src/UnitTestEx/AspNetCore/ApiTesterBase.cs
@@ -61,7 +61,12 @@ protected WebApplicationFactory<TEntryPoint> GetWebApplicationFactory()
 
                 return _waf = new WebApplicationFactory<TEntryPoint>().WithWebHostBuilder(whb =>
                     whb.UseSolutionRelativeContentRoot(Environment.CurrentDirectory)
-                        .ConfigureAppConfiguration((_, x) => x.AddJsonFile("appsettings.unittest.json", optional: true))
+                        .ConfigureAppConfiguration((_, cb) =>
+                        {
+                            cb.AddJsonFile("appsettings.unittest.json", optional: true);
+                            if (AdditionalConfiguration != null)
+                                cb.AddInMemoryCollection(AdditionalConfiguration);
+                        })
                         .ConfigureServices(sc =>
                         {
                             sc.AddHttpContextAccessor();

diff --git a/src/UnitTestEx/Generic/GenericTesterCore.cs b/src/UnitTestEx/Generic/GenericTesterCore.cs
@@ -67,6 +67,9 @@ private IHost GetHost()
                         ep.ConfigureAppConfiguration(hbc, cb);
                         cb.AddJsonFile("appsettings.unittest.json", optional: true)
                           .AddEnvironmentVariables();
+
+                        if (AdditionalConfiguration != null)
+                            cb.AddInMemoryCollection(AdditionalConfiguration);
                     })
                     .ConfigureServices(sc =>
                     {

diff --git a/tests/UnitTestEx.NUnit.Test/Other/GenericTest.cs b/tests/UnitTestEx.NUnit.Test/Other/GenericTest.cs
@@ -1,4 +1,5 @@
-using Microsoft.Extensions.DependencyInjection;
+using Microsoft.Extensions.Configuration;
+using Microsoft.Extensions.DependencyInjection;
 using NUnit.Framework;
 using System;
 using System.Threading.Tasks;
@@ -51,6 +52,16 @@ public void Run_Service()
             test.Run<Gin>(gin => gin.StirAsync())
                 .AssertException<DivideByZeroException>("As required by Bond; shaken, not stirred.");
         }
+
+        [Test]
+        public void Configuration_Overrride_Use()
+        {
+            // Demonstrates how to override the configuration settings for a test.
+            using var test = GenericTester.Create();
+            test.UseAdditionalConfiguration([new("SpecialKey", "NotSoSpecial")]);
+            var cv = test.Configuration.GetValue<string>("SpecialKey");
+            Assert.That(cv, Is.EqualTo("NotSoSpecial"));
+        }
     }
 
     [System.Diagnostics.CodeAnalysis.SuppressMessage("Performance", "CA1822:Mark members as static", Justification = "Just for testing aye bro!")]

diff --git a/tests/UnitTestEx.NUnit.Test/ProductControllerTest.cs b/tests/UnitTestEx.NUnit.Test/ProductControllerTest.cs
@@ -101,6 +101,21 @@ public void Configuration()
             Assert.That(cv, Is.EqualTo("OtherValue"));
         }
 
+        [Test]
+        public void Configuration_Use()
+        {
+            using var test = ApiTester.Create<Startup>();
+            test.UseAdditionalConfiguration("SpecialKey", "NotSoSpecial");
+
+            var cv = test.Configuration.GetValue<string>("SpecialKey");
+            Assert.That(cv, Is.EqualTo("NotSoSpecial"));
+
+            // Null to reset.
+            test.UseAdditionalConfiguration(null);
+            cv = test.Configuration.GetValue<string>("SpecialKey");
+            Assert.That(cv, Is.EqualTo("VerySpecialValue"));
+        }
+
         [Test]
         public void DefaultHttpClient()
         {

diff --git a/tests/UnitTestEx.NUnit.Test/ServiceBusFunctionTest.cs b/tests/UnitTestEx.NUnit.Test/ServiceBusFunctionTest.cs
@@ -151,5 +151,15 @@ public void Configuration_Overrride()
             var cv = test.Configuration.GetValue<string>("SpecialKey");
             Assert.That(cv, Is.EqualTo("NotSoSpecial"));
         }
+
+        [Test]
+        public void Configuration_Overrride_Use()
+        {
+            // Demonstrates how to override the configuration settings for a test.
+            using var test = FunctionTester.Create<Startup>();
+            test.UseAdditionalConfiguration([new("SpecialKey", "NotSoSpecial")]);
+            var cv = test.Configuration.GetValue<string>("SpecialKey");
+            Assert.That(cv, Is.EqualTo("NotSoSpecial"));
+        }
     }
 }
-Original file line number
+Diff line change
@@ Expand Up / @@ -17,7 +17,6 @@ jobs: @@
           uses: actions/setup-dotnet@v1
           with:
             dotnet-version: |
-.1.x
 .0.x
 .0.x
 .0.x
@@ Expand Down @@