BunsenBurner.Http 6.2.4

dotnet add package BunsenBurner.Http --version 6.2.4                
NuGet\Install-Package BunsenBurner.Http -Version 6.2.4                
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="BunsenBurner.Http" Version="6.2.4" />                
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add BunsenBurner.Http --version 6.2.4                
#r "nuget: BunsenBurner.Http, 6.2.4"                
#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 BunsenBurner.Http as a Cake Addin
#addin nuget:?package=BunsenBurner.Http&version=6.2.4

// Install BunsenBurner.Http as a Cake Tool
#tool nuget:?package=BunsenBurner.Http&version=6.2.4                

Bunsen Burner Bunsen Burner Http

Nuget

Getting Started

To use this library, simply include BunsenBurner.Http.dll in your project or grab it from NuGet, and add this to the top of each test .cs file that needs it:

using BunsenBurner.Http;
// allows for fluent building of requests and responses
using HttpBuildR;
using Req = System.Net.Http.HttpMethod;
using Resp = System.Net.HttpStatusCode;

What?

This provides a set of extensions and types to make testing HTTP based services easy!

Compose a request like so,

using HttpBuildR;
using Req = System.Net.Http.HttpMethod;
...
var req = 
    // start with a HTTP method
    Req.Get
    // flurl can be used for the URL composition
    .To("/hello-world".SetQueryParam("a", 1)) // all http verbs as covered
    // the non-url based parts are covered by methods
    // including JWT based auth token construction
    .WithHeader("b", 123, x => x.ToString())

Then convert the request to a scenario that can be run against a test or real server.

The test server builder provides an opinionated way to build test servers.

req.ArrangeRequest() // convert to a scenario
    // run the request against the test server defined by the Startup class
   .ActAndCall(TestServerBuilderOptions.New<Startup>().Build())
    // a response context contains the http response and all log messages produced
    // while handling the request
   .Assert(ctx => ctx.Response.StatusCode == HttpStatusCode.OK);

And HttpClient can be mocked out via a HttpMessageStore

using HttpBuildR;
using static BunsenBurner.Http.HttpMessageMatchers;
using Req = System.Net.Http.HttpMethod;
using Resp = System.Net.HttpStatusCode;

var store = HttpMessageStore.New();
store.Setup(
    // for a given named client
    "PersonService",
    // matchers can be used and composed to match incomming requests
    HasMethod(HttpMethod.Put).And(HasJsonContent((Person p) => p.Age > 19))),
    // response builder can be provided
    req => Resp.OK.Result(request: req)
                  .WithJsonContent(new { LastUpdatedDate = DateTime.Now })
...
// now a store can be converted to a client, or passed to a DummyFactory
var client = store.CreateClient("PersonService");
// now call the client
var result = await client.SendAsync(Req.Put.To("some-endpoint")
                                           .WithBearerToken(...)
                                           .WithJsonContent(new Person(25)));
// the store records all requests and responses made against it
Assert.True(store.Any(m => m.ClientName == "PersonService"
                        && m.Request.Method == HttpMethod.Put
                        && m.Response.StatusCode == Resp.OK))

That's it! Just compose requests and assert against responses.

For more examples check out the test project, create an issue or start a discussion.

Product Compatible and additional computed target framework versions.
.NET net5.0 was computed.  net5.0-windows was computed.  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. 
.NET Core netcoreapp2.0 was computed.  netcoreapp2.1 was computed.  netcoreapp2.2 was computed.  netcoreapp3.0 was computed.  netcoreapp3.1 is compatible. 
.NET Standard netstandard2.0 is compatible.  netstandard2.1 was computed. 
.NET Framework net461 was computed.  net462 was computed.  net463 was computed.  net47 was computed.  net471 was computed.  net472 was computed.  net48 was computed.  net481 was computed. 
MonoAndroid monoandroid was computed. 
MonoMac monomac was computed. 
MonoTouch monotouch was computed. 
Tizen tizen40 was computed.  tizen60 was computed. 
Xamarin.iOS xamarinios was computed. 
Xamarin.Mac xamarinmac was computed. 
Xamarin.TVOS xamarintvos was computed. 
Xamarin.WatchOS xamarinwatchos was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
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
6.2.4 11,973 6/20/2023
6.2.3 165 6/5/2023
6.2.2 213 4/25/2023
6.2.1 262 3/11/2023
6.2.0 310 1/29/2023
6.1.1 759 1/19/2023
6.1.0 2,319 1/12/2023
6.0.0 321 1/11/2023
5.3.1 520 1/7/2023
5.3.0 534 1/6/2023
5.2.0 566 12/17/2022
5.1.0 819 12/12/2022
5.0.0 536 12/11/2022
4.0.1 556 12/11/2022
4.0.0 577 12/11/2022
3.0.0 555 12/10/2022
2.2.0 515 12/9/2022
2.1.0 545 12/9/2022
2.0.0 620 12/9/2022
1.6.2 648 12/2/2022
1.6.1 603 12/1/2022
1.6.0 567 11/30/2022
1.5.1 628 11/26/2022
1.5.0 615 11/21/2022
1.4.1 615 11/19/2022
1.4.0 603 11/19/2022
1.3.0 615 11/19/2022
1.2.1 630 11/17/2022
1.2.0 607 11/16/2022
1.1.1 640 11/15/2022
1.1.0 612 11/15/2022
1.0.4 489 11/8/2022
1.0.3 523 11/6/2022
1.0.2 526 11/6/2022
1.0.1 517 11/6/2022
1.0.0 530 11/6/2022