mirror of
https://github.com/bitwarden/server
synced 2026-01-15 06:53:26 +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>
103 lines
3.2 KiB
C#
103 lines
3.2 KiB
C#
using Bit.Core.Services;
|
|
using Bit.SharedWeb.Utilities;
|
|
using Microsoft.AspNetCore.Http;
|
|
using Microsoft.Extensions.Hosting;
|
|
using NSubstitute;
|
|
|
|
namespace SharedWeb.Test;
|
|
|
|
public class PlayIdMiddlewareTests
|
|
{
|
|
private readonly PlayIdService _playIdService;
|
|
private readonly RequestDelegate _next;
|
|
private readonly PlayIdMiddleware _middleware;
|
|
|
|
public PlayIdMiddlewareTests()
|
|
{
|
|
var hostEnvironment = Substitute.For<IHostEnvironment>();
|
|
hostEnvironment.EnvironmentName.Returns(Environments.Development);
|
|
|
|
_playIdService = new PlayIdService(hostEnvironment);
|
|
_next = Substitute.For<RequestDelegate>();
|
|
_middleware = new PlayIdMiddleware(_next);
|
|
}
|
|
|
|
[Fact]
|
|
public async Task Invoke_WithValidPlayId_SetsPlayIdAndCallsNext()
|
|
{
|
|
var context = new DefaultHttpContext();
|
|
context.Request.Headers["x-play-id"] = "test-play-id";
|
|
|
|
await _middleware.Invoke(context, _playIdService);
|
|
|
|
Assert.Equal("test-play-id", _playIdService.PlayId);
|
|
await _next.Received(1).Invoke(context);
|
|
}
|
|
|
|
[Fact]
|
|
public async Task Invoke_WithoutPlayIdHeader_CallsNext()
|
|
{
|
|
var context = new DefaultHttpContext();
|
|
|
|
await _middleware.Invoke(context, _playIdService);
|
|
|
|
Assert.Null(_playIdService.PlayId);
|
|
await _next.Received(1).Invoke(context);
|
|
}
|
|
|
|
[Theory]
|
|
[InlineData("")]
|
|
[InlineData(" ")]
|
|
[InlineData("\t")]
|
|
public async Task Invoke_WithEmptyOrWhitespacePlayId_Returns400(string playId)
|
|
{
|
|
var context = new DefaultHttpContext();
|
|
context.Response.Body = new MemoryStream();
|
|
context.Request.Headers["x-play-id"] = playId;
|
|
|
|
await _middleware.Invoke(context, _playIdService);
|
|
|
|
Assert.Equal(StatusCodes.Status400BadRequest, context.Response.StatusCode);
|
|
await _next.DidNotReceive().Invoke(context);
|
|
}
|
|
|
|
[Fact]
|
|
public async Task Invoke_WithPlayIdExceedingMaxLength_Returns400()
|
|
{
|
|
var context = new DefaultHttpContext();
|
|
context.Response.Body = new MemoryStream();
|
|
var longPlayId = new string('a', 257); // Exceeds 256 character limit
|
|
context.Request.Headers["x-play-id"] = longPlayId;
|
|
|
|
await _middleware.Invoke(context, _playIdService);
|
|
|
|
Assert.Equal(StatusCodes.Status400BadRequest, context.Response.StatusCode);
|
|
await _next.DidNotReceive().Invoke(context);
|
|
}
|
|
|
|
[Fact]
|
|
public async Task Invoke_WithPlayIdAtMaxLength_SetsPlayIdAndCallsNext()
|
|
{
|
|
var context = new DefaultHttpContext();
|
|
var maxLengthPlayId = new string('a', 256); // Exactly 256 characters
|
|
context.Request.Headers["x-play-id"] = maxLengthPlayId;
|
|
|
|
await _middleware.Invoke(context, _playIdService);
|
|
|
|
Assert.Equal(maxLengthPlayId, _playIdService.PlayId);
|
|
await _next.Received(1).Invoke(context);
|
|
}
|
|
|
|
[Fact]
|
|
public async Task Invoke_WithSpecialCharactersInPlayId_SetsPlayIdAndCallsNext()
|
|
{
|
|
var context = new DefaultHttpContext();
|
|
context.Request.Headers["x-play-id"] = "test-play_id.123";
|
|
|
|
await _middleware.Invoke(context, _playIdService);
|
|
|
|
Assert.Equal("test-play_id.123", _playIdService.PlayId);
|
|
await _next.Received(1).Invoke(context);
|
|
}
|
|
}
|