Moq:如何使用Nunit和内部HttpClient测试一个类?

时间:2013-09-10 15:41:48

标签: c# mocking nunit moq

我在nUnit中运行我的测试,通常我可以模拟出依赖项,然后返回某些值或抛出错误。

我有一个类作为内部HttpClient,我想测试该类,我有什么选择。

这是我的代码,它不完整,以免泛滥消息。正如您所看到的,我在内部使用HttpClient而不是作为依赖项注入。该类抛出了许多自定义异常,我想要Moq,否则我需要传递真实的用户名和密码,这些密码会给我提供抛出异常所需的状态代码。

有人有想法吗?如果我不能模拟httpclient那么我就永远不能测试我的课它会引发异常。

我真的必须将HttpClient更改为对构造函数的依赖吗?

public bool ItemsExist(string itemValue)
{

    var relativeUri = string.Format(UrlFormatString, itemValue.ToUpper());

    var uri = new Uri(new Uri(this.baseUrl), relativeUri);

    using (var client = new HttpClient())
    {
        client.DefaultRequestHeaders.Authorization = new AuthenticationHeaderValue("Basic", this.encodedCredentials);
        client.DefaultRequestHeaders.Accept.Add(
            new MediaTypeWithQualityHeaderValue("application/json"));

        var response = client.GetAsync(uri).Result;

        switch (response.StatusCode)
        {
            case HttpStatusCode.Unauthorized:
                // DO something here
                throw new CustomAuthorizationException();

            case HttpStatusCode.Forbidden:
                throw new CustomAuthenticationException();

        }

        return true;

3 个答案:

答案 0 :(得分:22)

让我建议一个更简单的解决方案,而不需要抽象/包装httpclient,我认为它与模拟框架完美配合。

您需要为假HttpMessageHandler创建一个类,如下所示:

public class FakeHttpMessageHandler : HttpMessageHandler
{
    public virtual HttpResponseMessage Send(HttpRequestMessage request)
    {
        throw new NotImplementedException("Rember to setup this method with your mocking framework");
    }

    protected override Task<HttpResponseMessage> SendAsync(HttpRequestMessage request, System.Threading.CancellationToken cancellationToken)
    {
        return Task.FromResult(Send(request));
    }
}

在实例化HttpClient时可以使用这样创建的HttpMessageHandler:

var msgHandler = new Mock<FakeHttpMessageHandler>() { CallBase = true };
var fakeclient = new HttpClient(msgHandler.Object);

你可以设置方法(这里使用Moq):

msgHandler.Setup(t => t.Send(It.Is<HttpRequestMessage>(
            msg =>
                    msg.Method == HttpMethod.Post &&
                    msg.RequestUri.ToString() == "http://test.te/item/123")))
                    .Returns(new HttpResponseMessage(System.Net.HttpStatusCode.NotFound));

现在,您可以在必要时使用fakeclient。

答案 1 :(得分:11)

你无法对它进行单元测试。就像你提到的那样:HttpClient是一个依赖项,因此它应该被注入。

就个人而言,我会创建自己的IHttpClient接口,由HttpClientWrapper实现,包围System.Net.HttpClient。然后,IHttpClient将作为依赖项传递给对象的构造函数。

如下所示,HttpClientWrapper无法进行单元测试。但是,我会编写几个集成测试来确保包装器写得很好。

修改

IHttpClient不一定是HttpClient的“有效”界面。它只需要一个适合您需求的界面。它可以包含任意数量的方法。

想象一下:HttpClient允许你做很多事情。但是在你的项目中,你只是调用GetAsync(uri).Result方法,而不是其他任何方法。

鉴于这种情况,您将编写以下接口和实现:

interface IHttpClient
{
    HttpResponseMessage Get(string uri);
}

class HttpClientWrapper : IHttpClient
{
    private readonly HttpClient _client;

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


    public HttpResponseMessage Get(string uri)
    {
        return _client.GetAsync(new Uri(uri)).Result;
    }
}

因此,正如我之前所说,界面只需满足您的需求。您不必环绕 WHOLE HttpClient类。

显然,你会像这样moq你的对象:

var clientMock = new Mock<IHttpClient>();
//setup mock
var myobj = new MyClass(clientMock.object);

创建一个实际的对象:

var client = new HttpClientWrapper(new HttpClient());
var myobj = new MyClass(client );

<强> EDIT2

OH!不要忘记IHttpClient也应该扩展IDisposable界面,非常重要!

答案 2 :(得分:3)

另一种选择是使用Flurl [披露:我是作者],一个用于构建和调用网址的库。它包括testing helpers,使伪造所有HTTP非常容易。不需要包装器接口。

对于初学者,您的HTTP代码本身看起来像这样:

using Flurl;
using Flurl.Http;

...

try {
    var response = this.baseUrl
        .AppendPathSegment(relativeUri)
        .WithBasicAuth(username, password)
        .WithHeader("Accept", "application/json")
        .GetAsync().Result;

    return true;
}
catch (FlurlHttpException ex) {
    // Flurl throws on unsuccessful responses. Null-check ex.Response,
    // then do your switch on ex.Response.StatusCode.
}

现在为了测试乐趣:

using Flurl.Http.Testing;

...

[Test]
public void ItemsExists_SuccessResponse() {
    // kick Flurl into test mode - all HTTP calls will be faked and recorded
    using (var httpTest = new HttpTest()) {
        // arrange
        test.RespondWith(200, "{status:'ok'}");
        // act
        sut.ItemExists("blah");
        // assert
        test.ShouldHaveCalled("http://your-url/*");
    }
}

在NuGet上获取它:

PM> Install-Package Flurl.Http