#262 Drafted the implementation of support user secrets

Author: Arash-Sabet

examples/Xunit.Microsoft.DependencyInjection.ExampleTests/Fixtures/TestProjectFixture.cs

@@ -7,7 +7,8 @@ protected override void AddServices(IServiceCollection services, IConfiguration?
         .AddTransient<ICalculator, Calculator>()
         .AddKeyedTransient<ICarMaker, Porsche>("Porsche")
         .AddKeyedTransient<ICarMaker, Toyota>("Toyota")
-        .Configure<Options>(config => configuration?.GetSection("Options").Bind(config));
+        .Configure<Options>(config => configuration?.GetSection("Options").Bind(config))
+        .Configure<SecretValues>(config => configuration?.GetSection(nameof(SecretValues)));
 
     protected override ValueTask DisposeAsyncCore()
         => new();
@@ -16,4 +17,7 @@ protected override IEnumerable<TestAppSettings> GetTestAppSettings()
     {
         yield return new() { Filename = "appsettings.json", IsOptional = false };
     }
+
+    protected override void AddUserSecrets(IConfigurationBuilder configurationBuilder) 
+        => configurationBuilder.AddUserSecrets<TestProjectFixture>();
 }

examples/Xunit.Microsoft.DependencyInjection.ExampleTests/SecretValues.cs

@@ -0,0 +1,7 @@
+namespace Xunit.Microsoft.DependencyInjection.ExampleTests;
+
+public record SecretValues
+{
+    public string? Secret1 { get; set; }
+    public string? Secret2 { get; set; }
+}

examples/Xunit.Microsoft.DependencyInjection.ExampleTests/UserSecretTests.cs

@@ -0,0 +1,15 @@
+
+using Microsoft.Extensions.Options;
+
+namespace Xunit.Microsoft.DependencyInjection.ExampleTests;
+
+public class UserSecretTests(ITestOutputHelper testOutputHelper, TestProjectFixture fixture) : TestBed<TestProjectFixture>(testOutputHelper, fixture)
+{
+    [Fact]
+    public void TestSecretValues()
+    {
+        var secretValues = _fixture.GetService<IOptions<SecretValues>>(_testOutputHelper)!.Value;
+        Assert.NotEmpty(secretValues?.Secret1 ?? string.Empty);
+        Assert.NotEmpty(secretValues?.Secret1 ?? string.Empty);
+    }
+}

examples/Xunit.Microsoft.DependencyInjection.ExampleTests/Xunit.Microsoft.DependencyInjection.ExampleTests.csproj

@@ -6,12 +6,14 @@
 		<IsPackable>false</IsPackable>
 		<Nullable>enable</Nullable>
 		<ImplicitUsings>enable</ImplicitUsings>
+		<UserSecretsId>59bdc82c-5628-47c8-a5ec-3630c3a2bc45</UserSecretsId>
 	</PropertyGroup>
 
 	<ItemGroup>
+		<PackageReference Include="Microsoft.Extensions.Configuration.UserSecrets" Version="6.0.1" />
 		<PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.10.0" />
-		<PackageReference Include="xunit" Version="2.8.1" />
-		<PackageReference Include="xunit.runner.visualstudio" Version="2.8.1">
+		<PackageReference Include="xunit" Version="2.9.0" />
+		<PackageReference Include="xunit.runner.visualstudio" Version="2.8.2">
 		  <PrivateAssets>all</PrivateAssets>
 		  <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
 		</PackageReference>

src/Abstracts/TestBedFixture.cs

@@ -14,6 +14,7 @@ protected TestBedFixture()
 	{
 		_services = new ServiceCollection();
 		ConfigurationBuilder = new ConfigurationBuilder().SetBasePath(Directory.GetCurrentDirectory());
+		AddUserSecrets(ConfigurationBuilder);
 		Configuration = GetConfigurationRoot();
 		_servicesAdded = false;
 	}
@@ -30,9 +31,10 @@ public ServiceProvider GetServiceProvider(ITestOutputHelper testOutputHelper)
 		if(!_servicesAdded)
 		{
 			AddServices(_services, Configuration);
+			_services.AddLogging(loggingBuilder => AddLoggingProvider(loggingBuilder, new OutputLoggerProvider(testOutputHelper)));
+			_services.AddOptions();
 			_servicesAdded = true;
 		}
-		_services.AddLogging(loggingBuilder => AddLoggingProvider(loggingBuilder, new OutputLoggerProvider(testOutputHelper)));
 		return _serviceProvider = _services.BuildServiceProvider();
 	}
 
@@ -55,12 +57,38 @@ public AsyncServiceScope GetAsyncScope(ITestOutputHelper testOutputHelper)
 	public T? GetKeyedService<T>([DisallowNull] string key, ITestOutputHelper testOutputHelper)
 		=> GetServiceProvider(testOutputHelper).GetKeyedService<T>(key);
 
+	// // TODO: override finalizer only if 'Dispose(bool disposing)' has code to free unmanaged resources
+	// ~AbstractDependencyInjectionFixture()
+	// {
+	//     // Do not change this code. Put cleanup code in 'Dispose(bool disposing)' method
+	//     Dispose(disposing: false);
+	// }
+
+	public void Dispose()
+	{
+		// Do not change this code. Put cleanup code in 'Dispose(bool disposing)' method
+		Dispose(disposing: true);
+		GC.SuppressFinalize(this);
+	}
+
+	public async ValueTask DisposeAsync()
+	{
+		if (!_disposedAsync)
+		{
+			await DisposeAsyncCore();
+			Dispose();
+			_disposedAsync = true;
+		}
+	}
+
 	protected abstract void AddServices(IServiceCollection services, IConfiguration? configuration);
 	protected abstract IEnumerable<TestAppSettings> GetTestAppSettings();
 
 	protected virtual ILoggingBuilder AddLoggingProvider(ILoggingBuilder loggingBuilder, ILoggerProvider loggerProvider)
 		=> loggingBuilder.AddProvider(loggerProvider);
 
+	protected virtual void AddUserSecrets(IConfigurationBuilder configurationBuilder) { }
+
 	private IConfigurationRoot? GetConfigurationRoot()
 	{
 		var testAppSettings = GetTestAppSettings();
@@ -100,29 +128,5 @@ protected virtual void Dispose(bool disposing)
 		}
 	}
 
-	// // TODO: override finalizer only if 'Dispose(bool disposing)' has code to free unmanaged resources
-	// ~AbstractDependencyInjectionFixture()
-	// {
-	//     // Do not change this code. Put cleanup code in 'Dispose(bool disposing)' method
-	//     Dispose(disposing: false);
-	// }
-
-	public void Dispose()
-	{
-		// Do not change this code. Put cleanup code in 'Dispose(bool disposing)' method
-		Dispose(disposing: true);
-		GC.SuppressFinalize(this);
-	}
-
-	public async ValueTask DisposeAsync()
-	{
-		if (!_disposedAsync)
-		{
-			await DisposeAsyncCore();
-			Dispose();
-			_disposedAsync = true;
-		}
-	}
-
 	protected abstract ValueTask DisposeAsyncCore();
 }