aweXpect.Web 4.0.0-pre.3

aweXpect.Web

aweXpect.Web contains expectations for HttpRequestMessage, HttpResponseMessage, Uri and IPAddress, e.g. to verify the responses of an HttpClient.

Installation

dotnet add package aweXpect.Web

The package brings Expect.That with it, but not the expectations for strings, numbers or collections, so reference aweXpect as well. The expectations live in the namespace aweXpect, so using aweXpect; is all you need; only the customization lives in aweXpect.Web.

At a glance

HttpResponseMessage response = await httpClient.GetAsync("https://music.example.com/tracks/1");

// verify the status code, either the exact value or its category
await Expect.That(response).HasStatusCode().Success();

// verify the media type and the headers of the response
await Expect.That(response).HasContentType("application/json");
await Expect.That(response).HasHeader("Cache-Control").WithValue("must-revalidate, max-age=0, private");

// verify the content of the response
await Expect.That(response).HasContent("*Let It Be*").AsWildcard();

A failing expectation on a request or response includes the formatted HTTP request and response. If the test server returned the track, HasStatusCode(HttpStatusCode.NotFound) would fail with:

Expected that response
has status code equal to 404 NotFound,
but it had status code 200 OK

HTTP-Request:
  GET http://localhost/tracks/1 HTTP/1.1

HTTP-Response:
  200 OK HTTP/1.1
    x-vendor: VENDOR
    Content-Type: application/json; charset=utf-8
    Content-Length: 51
  {
    "id": 1,
    "title": "Let It Be",
    "artist": "The Beatles"
  }

Overview

Expectations for HttpRequestMessage:

Expectations for HttpResponseMessage:

Expectations for Uri:

Expectations for IPAddress:

Customization

Set a value under Customize.aweXpect.Web() for the current async flow, or under Customize.aweXpect.Global.Web() for all tests.

Documentation

The full documentation is available at docs.testably.org:

• HTTP requests and responses: method, request URI, headers, content type and content of an HttpRequestMessage, and status code, headers, content type, content, problem details and the request message of an HttpResponseMessage
• URIs: kind, port, scheme, host, path, fragment, base URI and query parameters of a Uri
• IP addresses: IPv4, IPv6, loopback, subnet membership and equality of an IPAddress
• Customization: formatting the request and response content in failure messages