mirror of
https://github.com/bitwarden/server
synced 2026-01-14 22:43:19 +00:00
f144828a87
We want to reduce the amount of business critical test data in the company. One way of doing that is to generate test data on demand prior to client side testing. Clients will request a scene to be set up with a JSON body set of options, specific to a given scene. Successful seed requests will be responded to with a mangleMap which maps magic strings present in the request to the mangled, non-colliding versions inserted into the database. This way, the server is solely responsible for understanding uniqueness requirements in the database. scenes also are able to return custom data, depending on the scene. For example, user creation would benefit from a return value of the userId for further test setup on the client side. Clients will indicate they are running tests by including a unique header, x-play-id which specifies a unique testing context. The server uses this PlayId as the seed for any mangling that occurs. This allows the client to decide it will reuse a given PlayId if the test context builds on top of previously executed tests. When a given context is no longer needed, the API user will delete all test data associated with the PlayId by calling a delete endpoint. --------- Co-authored-by: Matt Gibson <mgibson@bitwarden.com>
77 lines
2.9 KiB
C#
77 lines
2.9 KiB
C#
using System.Reflection;
|
|
using Bit.Seeder;
|
|
using Bit.SeederApi.Commands;
|
|
using Bit.SeederApi.Commands.Interfaces;
|
|
using Bit.SeederApi.Execution;
|
|
using Bit.SeederApi.Queries;
|
|
using Bit.SeederApi.Queries.Interfaces;
|
|
using Microsoft.Extensions.DependencyInjection.Extensions;
|
|
|
|
namespace Bit.SeederApi.Extensions;
|
|
|
|
public static class ServiceCollectionExtensions
|
|
{
|
|
/// <summary>
|
|
/// Registers SeederApi executors, commands, and queries.
|
|
/// </summary>
|
|
public static IServiceCollection AddSeederApiServices(this IServiceCollection services)
|
|
{
|
|
services.AddScoped<ISceneExecutor, SceneExecutor>();
|
|
services.AddScoped<IQueryExecutor, QueryExecutor>();
|
|
|
|
services.AddScoped<IDestroySceneCommand, DestroySceneCommand>();
|
|
services.AddScoped<IDestroyBatchScenesCommand, DestroyBatchScenesCommand>();
|
|
|
|
services.AddScoped<IGetAllPlayIdsQuery, GetAllPlayIdsQuery>();
|
|
|
|
return services;
|
|
}
|
|
|
|
/// <summary>
|
|
/// Dynamically registers all scene types that implement IScene<TRequest> from the Seeder assembly.
|
|
/// Scenes are registered as keyed scoped services using their class name as the key.
|
|
/// </summary>
|
|
public static IServiceCollection AddScenes(this IServiceCollection services)
|
|
{
|
|
var iSceneType1 = typeof(IScene<>);
|
|
var iSceneType2 = typeof(IScene<,>);
|
|
var isIScene = (Type t) => t == iSceneType1 || t == iSceneType2;
|
|
|
|
var seederAssembly = Assembly.Load("Seeder");
|
|
var sceneTypes = seederAssembly.GetTypes()
|
|
.Where(t => t is { IsClass: true, IsAbstract: false } &&
|
|
t.GetInterfaces().Any(i => i.IsGenericType &&
|
|
isIScene(i.GetGenericTypeDefinition())));
|
|
|
|
foreach (var sceneType in sceneTypes)
|
|
{
|
|
services.TryAddScoped(sceneType);
|
|
services.TryAddKeyedScoped(typeof(IScene), sceneType.Name, (sp, _) => sp.GetRequiredService(sceneType));
|
|
}
|
|
|
|
return services;
|
|
}
|
|
|
|
/// <summary>
|
|
/// Dynamically registers all query types that implement IQuery<TRequest> from the Seeder assembly.
|
|
/// Queries are registered as keyed scoped services using their class name as the key.
|
|
/// </summary>
|
|
public static IServiceCollection AddQueries(this IServiceCollection services)
|
|
{
|
|
var iQueryType = typeof(IQuery<,>);
|
|
var seederAssembly = Assembly.Load("Seeder");
|
|
var queryTypes = seederAssembly.GetTypes()
|
|
.Where(t => t is { IsClass: true, IsAbstract: false } &&
|
|
t.GetInterfaces().Any(i => i.IsGenericType &&
|
|
i.GetGenericTypeDefinition() == iQueryType));
|
|
|
|
foreach (var queryType in queryTypes)
|
|
{
|
|
services.TryAddScoped(queryType);
|
|
services.TryAddKeyedScoped(typeof(IQuery), queryType.Name, (sp, _) => sp.GetRequiredService(queryType));
|
|
}
|
|
|
|
return services;
|
|
}
|
|
}
|