https://github.com/dkackman/fakehttp

A library for faking RESTful http client communication
https://github.com/dkackman/fakehttp

c-sharp fakehttp http rest-client restful

Last synced: about 1 month ago
JSON representation

A library for faking RESTful http client communication

• Host: GitHub
• URL: https://github.com/dkackman/fakehttp
• Owner: dkackman
• License: apache-2.0
• Created: 2015-03-09T22:19:42.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2022-12-08T14:48:32.000Z (almost 2 years ago)
• Last Synced: 2024-08-09T03:02:27.198Z (3 months ago)
• Topics: c-sharp, fakehttp, http, rest-client, restful
• Language: C#
• Homepage: https://dkackman.github.io/FakeHttp/
• Size: 14.1 MB
• Stars: 18
• Watchers: 3
• Forks: 3
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# FakeHttp

[Nuget Package](https://www.nuget.org/packages/Dkackman.FakeHttp/)

[Project documentation and how to articles](https://dkackman.github.io/FakeHttp/).

A library for faking http Rest client communication using System.Net.Http.

Codeproject article with background: http://www.codeproject.com/Articles/1006722/MockHttp 

Allows for writing unit tests to handle http response scenarios from a RESTful service, without needing access to the network or service at test execution time. 

Responses are stored statically on the local file system, in a directory structure that can mapped onto a specific rest endpoint, set of query parameters and http verb.

This allows service layer access code to be unit tested without regard to the actual availability of the real service endpoint. This also ensures that response details and data returned to the test can be controlled, allowing specific test scenarios to be run at any time.

The quickest way to get started is to use an AutomaticHttpClientHandler anywhere you instantiate an System.Net.HttpClient. The automatic handler will first check the local file system for a saved response. If one is not found it will access the live http endpoint, and save the response. Future calls to the same endpoint with identical parameters will return the stored response and content.

    [TestMethod]

    public async Task CanAccessGoogleStorageBucket()

    {

        // this is the path where responses will be stored for future use

        var path = Path.Combine(Path.GetTempPath(), "FakeHttp_UnitTests");

        var handler = new AutomaticHttpClientHandler(new FileSystemResources(path));

        using (var client = new HttpClient(handler, true))

        {

            client.BaseAddress = new Uri("https://www.googleapis.com/");

            using (var response = await client.GetAsync("storage/v1/b/uspto-pair"))

            {

                response.EnsureSuccessStatusCode();

                dynamic metaData = await response.Content.Deserialize();

                // we got a response and it looks like the one we want

                Assert.IsNotNull(metaData);

                Assert.AreEqual("https://www.googleapis.com/storage/v1/b/uspto-pair", metaData.selfLink);

            }

        }

    }

If more fine grained control is needed over the handler, this workflow can be used without the need to change the service client layer or unit test code:

- Write unit tests that interacts with a live RESTful service that executes the specific client data access functionality under test

- Refine the live tests until they pass

- Execute the test in "capture" mode to record the response of the Rest service

- Execute future test runs in "fake" mode to decouple the tests from the live Rest service

Recorded Http Response messages and content can be edited to create test conditions that simulate Http failure modes or response header values.

    [AssemblyInitialize]

    public static void AssemblyInitialize(TestContext context)

    {

        // the mode controls which type of HttpMessageHandler to create: online, fake or capture

        MessageHandlerFactory.Mode = MessageHandlerMode.Fake;

    }

    [TestMethod]

    [TestCategory("fake")]

    [DeploymentItem(@"FakeResponses\")]

    public async Task CanGetSimpleJsonResult()

    {

        var handler = MessageHandlerFactory.CreateMessageHandler(new FileSystemResources(TestContext.DeploymentDirectory));

        using (var client = new HttpClient(handler, true))

        {

            client.BaseAddress = new Uri("https://www.googleapis.com/");

            var response = await client.GetAsync("storage/v1/b/uspto-pair");

            response.EnsureSuccessStatusCode();

            dynamic metaData = await response.Deserialize();

            // we got a response and it looks like the one we want

            Assert.IsNotNull(metaData);

            Assert.AreEqual("https://www.googleapis.com/storage/v1/b/uspto-pair", metaData.selfLink);

        }

    }