ASP.NET Web API HttpClientをスタブまたはモック

Question

プロジェクトで新しいWeb APIビットを使用していて、要求にクライアント証明書を追加する必要があるため、通常のHttpMessageRequestを使用できないことがわかりました。その結果、HttpClientを使用しています（WebRequestHandlerを使用することができます）。これはすべてうまくいきますが、少なくともRhino Mockの場合はスタブ/モックフレンドリーではありません。

私は通常、代わりに使用するHttpClientの周りにラッパーサービスを作成しますが、可能ならばこれを避けたいと思います。ラップする必要があるメソッドがたくさんあるためです。私は何かが欠けていることを望んでいます—スタブの方法に関する提案HttpClient？

Answer 1

私はMoqを使用し、私はHttpClientをスタブアウトすることができます。私はこれをRhino Mock（私は自分で試したことはありません）と同じだと思います。 あなただけのHttpClientをスタブにしたい場合は、以下のコードは動作するはずです：

var stubHttpClient = new Mock<HttpClient>(); 
ValuesController controller = new ValuesController(stubHttpClient.Object); 

私が間違っているなら、私を修正してください。私はここであなたがHttpClient内のメンバーをスタブすることを言及していると思います。

一番人気の分離/モックオブジェクトのフレームワークを使用すると、以下のコードは

stubHttpClient.Setup(x => x.BaseAddress).Returns(new Uri("some_uri"); 

はまた、あなたは避けたいと述べた例外をスロー例えば非仮想メンバー 上/設定をスタブすることはできません多くのHttpClientメンバーをラップするため、ラッパーを作成します。なぜたくさんのメソッドをラップする必要があるのか​​はっきりしませんが、必要なメソッドだけを簡単にラップすることができます。例えば

：私は（私はコードを書くませんので、そこにたくさんの例を）あなたのための恩恵を受けるかもしれないと思う

public interface IHttpClientWrapper { Uri BaseAddress { get; }  } 

public class HttpClientWrapper : IHttpClientWrapper 
{ 
    readonly HttpClient client; 

    public HttpClientWrapper() { 
     client = new HttpClient(); 
    } 

    public Uri BaseAddress { 
     get 
     { 
      return client.BaseAddress; 
     } 
    } 
} 

は、他のオプション マイクロソフトモグラフレームワーク http://research.microsoft.com/en-us/projects/moles/ マイクロソフトの偽物：（あなたはVS2012 Ultimateを使用している場合） http://msdn.microsoft.com/en-us/library/hh549175.aspx

Answer 2

すでに@Rajによって提示された優れたアイデアに代わるものとして、下のステップに行くために、および/偽を模擬することが可能です代わりに。

HttpClientを必要とするクラスをコンストラクタ内の依存性注入パラメータとして受け入れる場合は、ユニットテスト時に自分でHttpMessageHandlerを注入したHttpClientを渡すことができます。以下のように、この単純なクラスでは、あなたが実装する必要がある唯一の1つの抽象メソッドを持っています

public class FakeHttpMessageHandler : HttpMessageHandler 
    { 
    public HttpRequestMessage RequestMessage { get; private set; } 

    protected override Task<HttpResponseMessage> SendAsync(HttpRequestMessage request, CancellationToken cancellationToken) 
     { 
     RequestMessage = request; 
     return Task.FromResult(new HttpResponseMessage(HttpStatusCode.OK)); 
     } 
    } 

私の簡単な例だけでは、後で検査のために公共の財産でHttpRequestMessageを保存し、HTTP 200（OK）を返しますが、返される結果を設定するコンストラクタを追加することでこれを補うことができます。あなたはこのように、このクラスを使用すると思い

：このアプローチには限界が

public void foo() 
    { 
    //Arrange 
    var fakeHandler = new FakeHttpMessageHandler(); 
    var client = new HttpClient(fakeHandler); 
    var SUT = new ClassUnderTest(client); 

    //Act 
    SUT.DomSomething(); 

    //Assert 
    fakeHandler.RequestMessage.Method.ShouldEqual(HttpMethod.Get); // etc... 
    } 

あり、複数の要求を行うか、複数のHttpClient Sを作成する必要がある方法で、たとえば、その後、偽のハンドラが開始される可能性がありますあまりにも複雑になる。しかし、単純な場合には考慮する価値があるかもしれません。

Answer 3

私は便利かもしれないMockHttpと呼ばれる数ヶ月前にライブラリをリリースしました。それは流暢な（そして拡張可能な）APIを持つカスタムHttpMessageHandlerを使用します。擬似ハンドラ（またはHttpClient）をサービスクラスに挿入すると、設定されたときに応答します。

以下に、基本的な使用法を示します。 WhenとRespondのメソッドには、カスタムロジックを実行することを含め、多数のオーバーロードがあります。 documentation on the GitHub pageはさらに詳細になります。

var mockHttp = new MockHttpMessageHandler(); 

// Setup a respond for the user api (including a wildcard in the URL) 
mockHttp.When("http://localhost/api/user/*") 
     .Respond("application/json", "{'name' : 'Test McGee'}"); // Respond with JSON 

// Inject the handler or client into your application code 
var client = new HttpClient(mockHttp); 

var response = async client.GetAsync("http://localhost/api/user/1234"); 
// or without async: var response = client.GetAsync(...).Result; 

var json = await response.Content.ReadAsStringAsync(); 

// No network connection required 
Console.Write(json); // {'name' : 'Test McGee'}