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.

Sign up for GitHub

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

Jump to bottom

Scan keyed assemblies as keyed assemblies. #89

Draft
wants to merge 2 commits into
base: master
Choose a base branch
from
+478 −437
Draft

Scan keyed assemblies as keyed assemblies. #89

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
321e631
Scan keyed assemblies as keyed assemblies.
ElanHasson May 10, 2024
b140580
fix whitespace
ElanHasson May 10, 2024
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
4 changes: 4 additions & 0 deletions src/Oakton/Oakton.csproj
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,10 @@
<PackageReference Include="Microsoft.Extensions.Hosting" Version="[6.0.0,9.0.0)" />
</ItemGroup>

<ItemGroup Condition="'$(TargetFrameworkIdentifier)' == 'NET8_0_OR_GREATER'">
<PackageReference Include="Microsoft.Extensions.DependencyInjection.Abstractions" Version="8.0.0" />
</ItemGroup>

<ItemGroup>
<None Include="jasper-icon.png" Pack="true" PackagePath="" />
</ItemGroup>
Expand Down
259 changes: 132 additions & 127 deletions src/Oakton/Resources/ResourceHostExtensions.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,128 +1,133 @@
using System.Linq;
using System.Threading;
using System.Threading.Tasks;
using Microsoft.Extensions.DependencyInjection;
using Microsoft.Extensions.Hosting;

namespace Oakton.Resources;

public enum StartupAction
{
/// <summary>
/// Only check that each resource is set up and functional
/// </summary>
SetupOnly,

/// <summary>
/// Check that each resource is set up, functional, and clear off
/// any existing state. This is mainly meant for automated testing scenarios
/// </summary>
ResetState
}

public static class ResourceHostExtensions
{
/// <summary>
/// Add a hosted service that will do setup on all registered stateful resources
/// </summary>
/// <param name="services"></param>
/// <param name="action">Configure the startup action. The default is SetupOnly</param>
/// <returns></returns>
public static IServiceCollection AddResourceSetupOnStartup(this IServiceCollection services,
StartupAction action = StartupAction.SetupOnly)
{
if (!services.Any(x =>
x.ServiceType == typeof(IHostedService) &&
x.ImplementationType == typeof(ResourceSetupHostService)))
{
services.Insert(0,
new ServiceDescriptor(typeof(IHostedService), typeof(ResourceSetupHostService),
ServiceLifetime.Singleton));
services.AddLogging();
}

var options = new ResourceSetupOptions { Action = action };
services.AddSingleton(options);

return services;
}

/// <summary>
/// Add a hosted service that will do setup on all registered stateful resources
/// </summary>
/// <param name="builder"></param>
/// <param name="action">Configure the startup action. The default is SetupOnly</param>
/// <returns></returns>
public static IHostBuilder UseResourceSetupOnStartup(this IHostBuilder builder,
StartupAction action = StartupAction.SetupOnly)
{
return builder.ConfigureServices(s => s.AddResourceSetupOnStartup(action));
}

/// <summary>
/// Add a hosted service that will do setup on all registered stateful resources, but only
/// if the environment name is "Development"
/// </summary>
/// <param name="builder"></param>
/// <param name="action">Configure the startup action. The default is SetupOnly</param>
/// <returns></returns>
public static IHostBuilder UseResourceSetupOnStartupInDevelopment(this IHostBuilder builder,
StartupAction action = StartupAction.SetupOnly)
{
return builder.ConfigureServices((context, services) =>
{
if (context.HostingEnvironment.IsDevelopment())
{
services.AddResourceSetupOnStartup(action);
}
});
}

/// <summary>
/// Executes SetUp(), then ClearState() on all stateful resources. Useful for automated testing scenarios to
/// ensure all resources are in a good, known state
/// </summary>
/// <param name="host"></param>
/// <param name="cancellation"></param>
/// <param name="resourceType">Optional filter on resource type name</param>
/// <param name="resourceName">Optional filter on resource name</param>
public static async Task ResetResourceState(this IHost host, CancellationToken cancellation = default,
string resourceType = null, string resourceName = null)
{
var resources = ResourcesCommand.FindResources(host.Services, resourceType, resourceName);
foreach (var resource in resources)
{
await resource.Setup(cancellation);
await resource.ClearState(cancellation);
}
}

/// <summary>
/// Executes SetUp() on all stateful resources. Useful for automated testing scenarios to
/// ensure all resources are in a good, known state
/// </summary>
/// <param name="host"></param>
/// <param name="cancellation"></param>
/// <param name="resourceType">Optional filter on resource type name</param>
/// <param name="resourceName">Optional filter on resource name</param>
public static async Task SetupResources(this IHost host, CancellationToken cancellation = default,
string resourceType = null, string resourceName = null)
{
var resources = ResourcesCommand.FindResources(host.Services, resourceType, resourceName);
foreach (var resource in resources) await resource.Setup(cancellation);
}

/// <summary>
/// Executes Teardown() on all stateful resources
/// </summary>
/// <param name="host"></param>
/// <param name="cancellation"></param>
/// <param name="resourceType">Optional filter on resource type name</param>
/// <param name="resourceName">Optional filter on resource name</param>
public static async Task TeardownResources(this IHost host, CancellationToken cancellation = default,
string resourceType = null, string resourceName = null)
{
var resources = ResourcesCommand.FindResources(host.Services, resourceType, resourceName);
foreach (var resource in resources) await resource.Teardown(cancellation);
}
using Microsoft.Extensions.DependencyInjection;
using Microsoft.Extensions.Hosting;
using System.Linq;
using System.Threading;
using System.Threading.Tasks;

namespace Oakton.Resources;

public enum StartupAction
{
/// <summary>
/// Only check that each resource is set up and functional
/// </summary>
SetupOnly,

/// <summary>
/// Check that each resource is set up, functional, and clear off
/// any existing state. This is mainly meant for automated testing scenarios
/// </summary>
ResetState
}

public static class ResourceHostExtensions
{
/// <summary>
/// Add a hosted service that will do setup on all registered stateful resources
/// </summary>
/// <param name="services"></param>
/// <param name="action">Configure the startup action. The default is SetupOnly</param>
/// <returns></returns>
public static IServiceCollection AddResourceSetupOnStartup(this IServiceCollection services,
StartupAction action = StartupAction.SetupOnly)
{
if (!services.Any(x =>
x.ServiceType == typeof(IHostedService) &&
#if NET8_0_OR_GREATER
x.ServiceKey is not null ?
x.KeyedImplementationType == typeof(ResourceSetupHostService) &&
#else
x.ImplementationType == typeof(ResourceSetupHostService)))
#endif
{
services.Insert(0,
new ServiceDescriptor(typeof(IHostedService), typeof(ResourceSetupHostService),
ServiceLifetime.Singleton));
services.AddLogging();
}

var options = new ResourceSetupOptions { Action = action };
services.AddSingleton(options);

return services;
}

/// <summary>
/// Add a hosted service that will do setup on all registered stateful resources
/// </summary>
/// <param name="builder"></param>
/// <param name="action">Configure the startup action. The default is SetupOnly</param>
/// <returns></returns>
public static IHostBuilder UseResourceSetupOnStartup(this IHostBuilder builder,
StartupAction action = StartupAction.SetupOnly)
{
return builder.ConfigureServices(s => s.AddResourceSetupOnStartup(action));
}

/// <summary>
/// Add a hosted service that will do setup on all registered stateful resources, but only
/// if the environment name is "Development"
/// </summary>
/// <param name="builder"></param>
/// <param name="action">Configure the startup action. The default is SetupOnly</param>
/// <returns></returns>
public static IHostBuilder UseResourceSetupOnStartupInDevelopment(this IHostBuilder builder,
StartupAction action = StartupAction.SetupOnly)
{
return builder.ConfigureServices((context, services) =>
{
if (context.HostingEnvironment.IsDevelopment())
{
services.AddResourceSetupOnStartup(action);
}
});
}

/// <summary>
/// Executes SetUp(), then ClearState() on all stateful resources. Useful for automated testing scenarios to
/// ensure all resources are in a good, known state
/// </summary>
/// <param name="host"></param>
/// <param name="cancellation"></param>
/// <param name="resourceType">Optional filter on resource type name</param>
/// <param name="resourceName">Optional filter on resource name</param>
public static async Task ResetResourceState(this IHost host, CancellationToken cancellation = default,
string resourceType = null, string resourceName = null)
{
var resources = ResourcesCommand.FindResources(host.Services, resourceType, resourceName);
foreach (var resource in resources)
{
await resource.Setup(cancellation);
await resource.ClearState(cancellation);
}
}

/// <summary>
/// Executes SetUp() on all stateful resources. Useful for automated testing scenarios to
/// ensure all resources are in a good, known state
/// </summary>
/// <param name="host"></param>
/// <param name="cancellation"></param>
/// <param name="resourceType">Optional filter on resource type name</param>
/// <param name="resourceName">Optional filter on resource name</param>
public static async Task SetupResources(this IHost host, CancellationToken cancellation = default,
string resourceType = null, string resourceName = null)
{
var resources = ResourcesCommand.FindResources(host.Services, resourceType, resourceName);
foreach (var resource in resources) await resource.Setup(cancellation);
}

/// <summary>
/// Executes Teardown() on all stateful resources
/// </summary>
/// <param name="host"></param>
/// <param name="cancellation"></param>
/// <param name="resourceType">Optional filter on resource type name</param>
/// <param name="resourceName">Optional filter on resource name</param>
public static async Task TeardownResources(this IHost host, CancellationToken cancellation = default,
string resourceType = null, string resourceName = null)
{
var resources = ResourcesCommand.FindResources(host.Services, resourceType, resourceName);
foreach (var resource in resources) await resource.Teardown(cancellation);
}
}
Loading