Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added support for configuring options through an Action<T> parameter #5

Open
wants to merge 4 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 16 additions & 0 deletions Readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -69,3 +69,19 @@ public static T GetConfig<T>(this IConfiguration configuration, string sectionNa
```
Gets config of type `T` from configuration, validates and returns it.
Use this method when you don't need to add IOptions and you want to get validated config inside `ConfigureServices` method and use right away

#### Configure
```csharp
public static IServiceCollection Configure<T>(this IServiceCollection services, Action<T> configure)
where T : class, new()
```
Supports configuring your service through the provision of an `Action<T>` parameter.

Example usage:
```csharp
services.Configure(options => configuration.Bind(options));
```
Or:
```csharp
services.Configure(options => options.BaseAddress = new Uri("http://localhost:443"))
```
11 changes: 9 additions & 2 deletions src/Rtl.Configuration.Validation/ServiceCollectionExtensions.cs
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
using System.Linq;
using System;
using System.Linq;
using Microsoft.AspNetCore.Hosting;
using Microsoft.Extensions.Configuration;
using Microsoft.Extensions.DependencyInjection;
Expand All @@ -16,6 +17,12 @@ public static IServiceCollection AddConfig<T>(this IServiceCollection services,

public static IServiceCollection AddConfig<T>(this IServiceCollection services, IConfiguration configuration)
where T : class, new()
{
return services.ConfigureWithValidation<T>(options => configuration.Bind(options));
}

public static IServiceCollection ConfigureWithValidation<T>(this IServiceCollection services, Action<T> configure)
where T : class, new()
{
if (services.Any(x => x.ServiceType == typeof(IConfigureOptions<T>)))
{
Expand All @@ -27,7 +34,7 @@ public static IServiceCollection AddConfig<T>(this IServiceCollection services,
services.AddTransient<IStartupFilter, StartupFilter>();
}

services.Configure<T>(configuration);
services.Configure(configure);
services.AddTransient<IOptionsValidator, OptionsValidator<T>>();

return services;
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
using System;
using System.Threading.Tasks;
using Rtl.Configuration.Validation.Tests.Configs;
using Rtl.Configuration.Validation.Tests.Helpers;
using Xunit;

namespace Rtl.Configuration.Validation.Tests
{
public class ConfigureTests
{
[Fact]
public async Task ConfigureWithValidationDoesntThrow()
{
await TestHelpers.ValidationSucceeds(null, services =>
services.ConfigureWithValidation<TestConfiguration>(option =>
{
option.Name = "asd";
option.Value = 5;
}));
}

[Fact]
public void ConfigureWithValidationThrows()
{
TestHelpers.ValidationThrows(null, services =>
services.ConfigureWithValidation<TestConfiguration>(option =>
option.Name = string.Empty));
}
}
}
30 changes: 22 additions & 8 deletions tests/Rtl.Configuration.Validation.Tests/Helpers/TestHelpers.cs
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@
using System.ComponentModel.DataAnnotations;
using System.Threading;
using System.Threading.Tasks;
using Microsoft.Extensions.DependencyInjection;
using Xunit;

namespace Rtl.Configuration.Validation.Tests.Helpers
Expand All @@ -15,19 +16,25 @@ static class TestHelpers
public static void ValidationThrows<TConfig>(Dictionary<string, string> settings, string sectionName = "test")
where TConfig : class, new()
{
IConfiguration configuration = null;
IConfiguration configuration = new ConfigurationBuilder()
.AddInMemoryCollection(settings)
.Build();

ValidationThrows(settings, services => services.AddConfig<TConfig>(configuration, sectionName));
}

public static void ValidationThrows(Dictionary<string, string> settings, Action<IServiceCollection> configure)
{
Assert.Throws<ValidationException>(() =>
{
var webHost = WebHost.CreateDefaultBuilder()
.ConfigureAppConfiguration((hostingContext, config) =>
{
config.AddInMemoryCollection(settings);
configuration = config.Build();
})
.ConfigureServices(services =>
{
services.AddConfig<TConfig>(configuration, sectionName);
configure(services);
})
.Configure(app =>
{
Expand All @@ -40,21 +47,28 @@ public static void ValidationThrows<TConfig>(Dictionary<string, string> settings
});
}

public static async Task ValidationSucceeds<TConfig>(Dictionary<string, string> settings, string sectionName = "test")
public static Task ValidationSucceeds<TConfig>(Dictionary<string, string> settings, string sectionName = "test")
where TConfig : class, new()
{
IConfiguration configuration = null;
IConfiguration configuration = new ConfigurationBuilder()
.AddInMemoryCollection(settings)
.Build();

return ValidationSucceeds(settings, services => services.AddConfig<TConfig>(configuration, sectionName));
}

public static async Task ValidationSucceeds(Dictionary<string, string> settings, Action<IServiceCollection> configure)
{
using (var cts = new CancellationTokenSource())
{
var webHost = WebHost.CreateDefaultBuilder()
.ConfigureAppConfiguration((hostingContext, config) =>
{
config.AddInMemoryCollection(settings);
configuration = config.Build();
})
.ConfigureServices(services =>
{
services.AddConfig<TConfig>(configuration, sectionName);
configure(services);
})
.Configure(app =>
{
Expand All @@ -67,4 +81,4 @@ public static async Task ValidationSucceeds<TConfig>(Dictionary<string, string>
}
}
}
}
}