Hypothesist.AspNet 3.0.88

dotnet add package Hypothesist.AspNet --version 3.0.88
NuGet\Install-Package Hypothesist.AspNet -Version 3.0.88
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="Hypothesist.AspNet" Version="3.0.88" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add Hypothesist.AspNet --version 3.0.88
#r "nuget: Hypothesist.AspNet, 3.0.88"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
// Install Hypothesist.AspNet as a Cake Addin
#addin nuget:?package=Hypothesist.AspNet&version=3.0.88

// Install Hypothesist.AspNet as a Cake Tool
#tool nuget:?package=Hypothesist.AspNet&version=3.0.88

nuget

Hypothesist.AspNet

Use Hypothesist to validate received requests (from an external invocation) via ASP.NET middleware.

Arrange

Define the hypothesis:

var observer = Observer.For<string>();

Insert the middleware to test from incoming requests:

var builder = WebApplication.CreateBuilder(args);

await using var app = builder.Build();
app.MapGet("/hello", (string data) => Results.Ok());
app.Use(observer
    .FromRequest()
    .With(request => request.Query["data"]!));

or read from the body:

app.Use(observer
    .FromRequest()
    .Body(body => JsonSerializer.DeserializeAsync<Guid>(body)));

Remark: the order of middleware is very important! If you plugin the hypothesis after the body is read by other middleware, you will receive an empty stream and thus no content.

Only test for a specific route:

app.UseWhen(context => context.Request.Path == "/hello", then => then
    .Use(observer
        .FromRequest()
        .With(request => request.Query["data"]!)));

or directly test from an endpoint filter:

app.MapPost("/hello", ([FromBody]Guid body) => Results.Ok(body))
    .AddEndpointFilter(observer
        .FromEndpoint()
        .With(context => context.GetArgument<Guid>(0)));

Act

Invocation on the endpoint from some external program, like:

curl 'http://localhost:1234/hello?data=some-input'

Assert

await Hypothesis
    .On(observer)
    .Timebox(2.Seconds());
    .Any()
    .Match("some-data")
    .Validate();
Product Compatible and additional computed target framework versions.
.NET net6.0 is compatible.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 is compatible.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 was computed.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed. 
Compatible target framework(s)
Additional computed target framework(s)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
3.0.88 129 1/11/2024
2.2.72 174 11/23/2023
2.2.71 88 11/23/2023
2.2.66 81 11/6/2023
2.2.64 84 11/6/2023
2.2.63 95 11/2/2023
2.1.62 72 11/2/2023
2.1.61 72 11/2/2023
2.1.60 76 11/1/2023