Scott Hanselman

Experiments in Open Source: Exploring vcr-sharp for Http record and playback

September 10, '17 Comments [19] Posted in DotNetCore | Open Source
Sponsored By

I've always said that reading source code is as important as write it - especially as part of the learning process. You learn a ton about how other coders think and solve problems, plus you learn about lots of new libraries and methods you may not be familiar with.

Last week I noticed this tweet from Brendan Forster about an experiment he's working on. He is interesting in your feedback on his experiment and if you would use it.

He's created a new library for .NET called vcr-sharp that is inspired by the vcr Ruby gem and the scotch .NET library.

Again, he's made it clear he's just experimenting but I think this has some interesting potential.

Vcr-sharp lets you record and playback HTTP requests! In this example, WithCassette is an extension method on HttpClientFactory. That extension method sets up a DelgatingHandler to a ReplayingHandler. That ReplayingHandler "loads the cassette" and returns it as a cached response.

using (var httpClient = HttpClientFactory.WithCassette("my-test-scenario"))
{
var request = new HttpRequestMessage(HttpMethod.Get, "http://www.iana.org/domains/reserved");
var response = await httpClient.SendAsync(request);
var body = await response.Content.ReadAsStringAsync();
body.ShouldContain("Example domains");
}

Also worth noting is that within the VCR-Sharp library Brendan uses an assertion library for .NET called "Shouldly." Shouldly has some interesting extension methods that let you express how you Assert within your Tests.

They say - this is the old Assert way:

Assert.That(contestant.Points, Is.EqualTo(1337));

For your troubles, you get this message, when it fails:

Expected 1337 but was 0

They say - this is how it Should be:

contestant.Points.ShouldBe(1337);

Which is just syntax, so far, but check out the message when it fails:

contestant.Points should be 1337 but was 0

Another example:

Assert.That(map.IndexOfValue("boo"), Is.EqualTo(2));    // -> Expected 2 but was 1
map.IndexOfValue("boo").ShouldBe(2);                    // -> map.IndexOfValue("boo") should be 2 but was 1

It makes tests very easy to read. A nice bit of syntactic sugar:

[Fact]
public async Task AppendsNewRequestToCache()
{
Environment.SetEnvironmentVariable("VCR_MODE", "Cache");
var session = "append-second-request";

using (var httpClient = HttpClientFactory.WithCassette(session))
{
var request = new HttpRequestMessage(HttpMethod.Get, "https://www.iana.org/performance/ietf-statistics");
var response = await httpClient.SendAsync(request);
}

var cassette = await ReadCassetteFile(session);
cassette.http_interactions.Length.ShouldBe(2);
}

It also uses BenchmarkDotNet, which you may be familiar with. It allows you to mark methods as [Benchmark] methods and you'll get smart warming up, running, teardowns and statistics like this;

[Benchmark]
public async Task ReadFromCache()
{

using (var httpClient = HttpClientFactory.WithCassette("example-test"))
{
var request = new HttpRequestMessage(HttpMethod.Get, "http://www.iana.org/domains/reserved");
var response = await httpClient.SendAsync(request);
}
} Output:
        Method |     Mean |    Error |   StdDev |
-------------- |---------:|---------:|---------:|
ReadFromCache | 684.1 us | 3.154 us | 2.796 us |

I'd encourage you to check vcr-sharp out over at https://github.com/shiftkey/vcr-sharp, read the source code, and think about how you'd use it. I am sure Brendan would appreciate your thoughts and feedback in the GitHub Issues! Also check out how he uses Tests, Shouldly, and BenchmarkDotNet in his project and consider how you'd use them in yours!


Sponsor: Raygun provides real time .NET error monitoring and supports all other major programming languages and frameworks too! Forget logs and support tickets. Reproduce software bugs in minutes with Raygun's error tracking software!

About Scott

Scott Hanselman is a former professor, former Chief Architect in finance, now speaker, consultant, father, diabetic, and Microsoft employee. He is a failed stand-up comic, a cornrower, and a book author.

facebook twitter subscribe
About   Newsletter
Sponsored By
Hosting By
Dedicated Windows Server Hosting by SherWeb
Sunday, 10 September 2017 07:17:03 UTC
I really like the name: vcr-sharp. It captures the tape-like nature of the caching provided.

This is certainly a good concept too. I've done this myself to speed up HTTP tests, so they don't have to make high latency requests over and over again.
Sunday, 10 September 2017 07:31:05 UTC
Another play and record tool is https://github.com/WireMock-Net/WireMock.Net which can return stubbed/mocked responses based on pattern matching on url, headers and body.

It can also be used in unit testing.

I'm also working on a standalone Docker image which can run in a Docker Linux container.
Stef Heyenrath
Sunday, 10 September 2017 09:39:13 UTC
Please tell me how can we add text along with video and audio stream using vcr-sharp, as this is possible but I couldn't find a way to do so.
Sunday, 10 September 2017 11:15:31 UTC
This article is very good and informative, I learned from here. I would love to read more articles from here. Also, you can learn real information from this link.

What side is your appendix on
Sunday, 10 September 2017 18:43:56 UTC
Cool library. I thought it would fun to see if this would play nicely with Flurl. If anyone's interested, here's an approach that would work well: https://gist.github.com/tmenier/0d2221b01f902e26312bca8eca204c7d
Todd Menier
Monday, 11 September 2017 05:27:56 UTC
On a side note - I'm getting certificate warnings when reading your blog posts via RSS - a certificate name mismatch
Damien
Monday, 11 September 2017 11:12:59 UTC
Shouldly looks very similar to Fluent Assertions (https://github.com/fluentassertions/fluentassertions), which I've enjoyed using and seems more established.
Monday, 11 September 2017 11:17:14 UTC
Can you please explain why WithCassette is an extension method?
Sir Rufo
Monday, 11 September 2017 12:45:51 UTC
thank you so much
Tuesday, 12 September 2017 00:42:37 UTC
Great find with Shouldly. I've been doing assertions like this with JavaScript and the Chai assertion library and been missing it on the .NET side of things. Thanks Scott.
Tuesday, 12 September 2017 13:43:36 UTC
Thanks for the tip!



Small typo in the fifth paragraph:

That extension method sets up a DelgatingHandler to a ReplayingHandler.


Tuesday, 12 September 2017 14:45:13 UTC
Good job and bunch of thanks for this valuable post.
Wednesday, 13 September 2017 14:25:32 UTC
Thank, I enjoyed to read it.
Very informative post, it will help me with my work
router login
Max
Wednesday, 13 September 2017 14:46:18 UTC
More interesting than this article is the comment section, I do not have in mind how I could use this idea, but the responses from the others are really interesting.

Great concept too.
Wednesday, 13 September 2017 19:44:52 UTC
first day collection koimoi
koimoi, 1st day box office collection
Monday, 18 September 2017 12:02:18 UTC
good blog i like this blog
Wednesday, 20 September 2017 11:11:09 UTC
Awesome write-up. I’m a normal visitor of your web site and appreciate you taking the time to maintain the nice site. I will be a regular visitor for a really long time.
Friday, 22 September 2017 06:44:59 UTC
I visit this while searching on google. Codings attract me. It's really informative.
Saturday, 23 September 2017 10:13:32 UTC
Thanks for the nice review you have shared.
بازی دست دوم
Comments are closed.

Disclaimer: The opinions expressed herein are my own personal opinions and do not represent my employer's view in any way.