https://github.com/aarnott/httpclientecho

Enables automated tests with HTTP calls to avoid incurring the cost and instability of network traffic by recording a "live" test run and replaying it for subsequent test runs.
https://github.com/aarnott/httpclientecho

Last synced: 19 days ago
JSON representation

Enables automated tests with HTTP calls to avoid incurring the cost and instability of network traffic by recording a "live" test run and replaying it for subsequent test runs.

• Host: GitHub
• URL: https://github.com/aarnott/httpclientecho
• Owner: AArnott
• License: ms-pl
• Created: 2018-05-20T04:28:13.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2018-05-26T18:48:29.000Z (over 6 years ago)
• Last Synced: 2024-12-01T00:03:57.227Z (about 1 month ago)
• Language: C#
• Homepage:
• Size: 230 KB
• Stars: 3
• Watchers: 2
• Forks: 0
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# HttpClientEcho

[![NuGet](https://img.shields.io/nuget/v/HttpClientEcho.svg)](https://nuget.org/packages/HttpClientEcho)

[![Build status](https://ci.appveyor.com/api/projects/status/g2b03pfq01mluh6w/branch/master?svg=true)](https://ci.appveyor.com/project/AArnott/httpclientecho/branch/master)

[![Build Status](https://travis-ci.org/AArnott/HttpClientEcho.svg?branch=master)](https://travis-ci.org/AArnott/HttpClientEcho)

[![codecov](https://codecov.io/gh/AArnott/HttpClientEcho/branch/master/graph/badge.svg)](https://codecov.io/gh/AArnott/HttpClientEcho)

Enables automated testing to test all local code without actually incurring

the cost and instability of network traffic, by recording a "live" test run

and replaying it for subsequent test runs.

## Usage

Consider the simplest use case of an HTTP call in a test:

```csharp

[Fact]

public async Task Simple()

{

    var httpClient = new HttpClient();

    var response = await httpClient.GetAsync("https://www.bing.com/");

    response.EnsureSuccessStatusCode();

}

```

The above test fails if the network fails or if the server throttles your tests requests.

By leveraging `HttpClientEcho` we can isolate this test from the network while still

emulating the server's full response.

First, install the [`HttpClientEcho` NuGet package][NuGet].

Thene simply pass in a `new EchoMessageHandler()` to the `HttpClient` constructor:

```csharp

[Fact]

public async Task Simple()

{

    var httpClient = new HttpClient(new EchoMessageHandler());

    var response = await httpClient.GetAsync("https://www.bing.com/");

    response.EnsureSuccessStatusCode();

}

```

The first time you run the test, it will contact the server and cache the result

with your test project (and tracked in source control where applicable).

Subsequent runs of your test will reuse the cached response and avoid the network call.

## How it works

The first time you run your tests, your test project transitions from this cache-less version:

![Project with no cache](doc/images/SolutionExplorer_no_cache.png)

After your test run, a cache file is added to your project:

![Project with HTTP cache](doc/images/SolutionExplorer_with_cache.png)

The cache file itself is an easy-to-read representation of the network traffic that took place.

It is your HTTP traffic serialized in a near-HTTP protocol like fashion. For example,

with one cached request+response, the file would look something like this:

```

GET https://www.bing.com/

200 OK

Content-Length: 9

Content-Type: text/html; charset=utf-8

some data

```

[NuGet]: https://nuget.org/packages/HttpClientEcho