Hornbill
Easy http stubs for integration testing
Create a fake service
var fakeService = new FakeService() // Randomly allocates a port
var fakeService = new FakeService(port) // Or supply a specific port
Add some responses
fakeService.AddResponse requires a path, a method, and a Response
N.B. The path is a regex, so if you want to match /test?foo=bar then your path should be /test?foo=bar
Status Code
fakeService.AddResponse("/foo", Method.GET, Response.WithStatusCode(200))
Body
fakeService.AddResponse("/foo", Method.GET, Response.WithBody(200, "body"))
Headers
fakeService.AddResponse("/foo", Method.GET, Response.WithHeaders(200, new Dictionary<string, string> {["foo"] = "bar" }))
fakeService.AddResponse("/foo", Method.GET, Response.WithHeaders(200, "foo:bar", "bing:bong")
Body and Headers
fakeService.AddResponse("/foo", Method.GET, Response.WithBodyAndHeaders(200, "body", new Dictionary<string, string> {["foo"] = "bar" }))
fakeService.AddResponse("/foo", Method.GET, Response.WithBodyAndHeaders(200, "body", "foo:bar", "bing:bong"))
Queue of responses
fakeService.AddResponse("/foo", Method.GET, Response.WithResponses(new [] { Response.WithStatusCode(200), Response.WithStatusCode(500)}))
Delegate
fakeService.AddResponse("/foo", Method.GET, Response.WithDelegate(x => x.Query["foo"].Contains("bar") ? Response.WithStatusCode(200) : Response.WithStatusCode(404)))
Add responses from text
Requires a string in this format
GET path
200
foo: bar
Body
POST path
200
fakeService.AddResponsesFromText(text)
- Headers and body are optional
- Separate the body with a single line break
- Separate each response with a double line break
Add responses from file
The same as above, but takes a file name instead of a string
fakeService.AddResponsesFromFile(fileName)
Starting the service
Call fakeService.Start() to host on a random available port. The address is returned as a string.
Call fakeService.StartTestHost() to host using Microsoft.AspNetCore.TestHost. The HttpClient is returned.
Call fakeService.StartApp(app) to override the middleware entirely with your own.
Requests
You can examine the requests sent to your service via fakeService.Requests
You can execute an Action<Request> when a request is received by using fakeService.OnRequestReceived(request => ...)
Address
The address is returned from fakeService.Start() and is also available as a string fakeService.Url or Uri fakeService.Uri
Stopping the service
FakeService implements IDisposable but you can also call fakeService.Stop()
