我们如何使用 3rd 方 API 为 Web Api 创建单元测试

Question

我正在使用 Nunit 创建单元测试。我有 webapi 项目并使用一些第三方 api 下面是我正在使用的代码块之一。

在下面的函数中，您可以看到我正在返回 facebook graph api 以字符串格式返回的 json 数据。至于单元测试断言 IsEqual 检查我的两个比较对象将使用来自同一个 api 的数据然后我需要匹配它们还是需要对此类项目进行测试。

public  string getfriends(string accesstoken)
        {
            string retVal = "";
            string url = API_BaseUrl + "/me/invitable_friends?&access_token=" + accesstoken;
            System.Net.HttpWebRequest request = System.Net.WebRequest.Create(url) as System.Net.HttpWebRequest;
            System.Net.HttpWebResponse response = null;
            try
            {
                using (response = request.GetResponse() as System.Net.HttpWebResponse)
                {
                    System.IO.StreamReader reader = new System.IO.StreamReader(response.GetResponseStream());
                    retVal = reader.ReadToEnd();
                }
            }
            catch (Exception ex)
            {

            }
            return retVal;
        }

Answer 1

研究抽象您的依赖项（在本例中为 3rd 方 API）并将它们注入到它们的依赖类中。这将允许更好地模拟您的单元测试和整体上更灵活/可维护的架构。

以您当前的函数为例，抽象看起来像这样。

public interface IFacebookService {
    public string GetFriends();
}

public interface ITokenProvider {
    public string GetAccessToken();
}

这里接口的实现要有实际代码连接到第3方服务。

public class FacebookService : IFacebookService
    private string accesstoken;
    private string API_BaseUrl;

    public FacebookService(ITokenProvider tokens, IUrlProvider urls) {
        accessToken = tokens.GetAccessToken();
        API_BaseUrl = url.GetBaseUrl();
    }

    public  string Getfriends() {
        string retVal = "";
        string url = API_BaseUrl + "/me/invitable_friends?&access_token=" + accesstoken;
        System.Net.HttpWebRequest request = System.Net.WebRequest.Create(url) as System.Net.HttpWebRequest;
        System.Net.HttpWebResponse response = null;
        try {
            using (response = request.GetResponse() as System.Net.HttpWebResponse) {
                System.IO.StreamReader reader = new System.IO.StreamReader(response.GetResponseStream());
                retVal = reader.ReadToEnd();
            }
        }
        catch (Exception ex)
        {

        }
        return retVal;
    }
}

例如，如果您有一个依赖于该服务的 API 控制器。

public class FriendsController : ApiController {
    IFacebookService facebook;

    public FriendsController(IFacebookService facebook) {
        this.facebook = facebook;
    }

    [HttpGet]
    public IHttpActionResult GetFacebookFriends() {
        var friends = facebook.GetFriends();
        if(!string.IsNullOrWhiteSpace(friends)) {
            return Ok(friends);
        }
        return NotFound("You have no friends. :(");
    }
}

对于独立的单元测试，您现在可以模拟已抽象的第 3 方 API。我正在使用 Moq 来模拟第 3 方抽象。

[TestClass]
public class FriendsControllerTests {
    [TestMethod]
    public void GetFacebookFriendsTest() {
        //Arrange
        var facebook = Mock.Of<IFacebookService>();
        var facebookMock = Mock.Get(facebook);
        facebookMock.Setup(m => m.GetFriends()).Returns("{json of friends}");

        var sut = new FriendsController(facebook);

        //Act
        var actionResult = sut.GetFacebookFriends();

        //Assert
        //...do your assertions here 
    }
}

上述测试现在允许您单独测试控制器，而无需直接调用实际的第 3 方 API。

Answer 2

我会抽象出您的消息发送/检索，然后单独对其进行单元测试，并且无论哪个类也包含您的 GetFriends 隔离，模拟消息发送/检索。

您应该对所有项目进行单元测试，但代码需要以可行的方式设计。目前这段代码很难测试，因为它正在启动 HttpWebRequests，需要在某种接口后面隔离，称为 IRequestSender。我推荐 Moq 来模拟接口，不模拟你会发现测试就像用头撞墙。