ASP.NET 核心 - 进行外部 API 调用的单元测试服务方法

Question

我最近开始学习自动化测试，我对 controller 级别的集成测试非常满意。 我有一个 ASP.NET 核心 Web API 进行验证检查，并在服务中调用以下方法。 当他们调用外部 API 时，我正在努力弄清楚如何对它们进行单元测试。

我如何对这些进行单元测试？ 是否应该涉及 mocking 或……？ 如果可能的话，我将不胜感激任何有用的输入和实际示例（如我将如何安排、执行和断言）。

public VerificationResponse VerifyDetails(VerificationRequest verificationRequest)
{
    try
    {
        var token = GetVerificationAuthenticationToken();

        if (!String.IsNullOrWhiteSpace(token))
        {
            var verificationUrl = _Configuration.GetSection("Verification:VerificationSettings:Url").Value;
            var timeout = int.Parse(_Configuration.GetSection("RestAPIClientTimeout").Value);

            var client = new RestClient(verificationUrl);
            client.Timeout = timeout;
            var request = new RestRequest(Method.POST);
            var body = JsonSerializer.Serialize<VerificationRequest>(verificationRequest);

            request.AddHeader("Authorization", $"Bearer {token}");
            request.AddHeader("Content-Type", "application/json");
            request.AddParameter("application/json", body, ParameterType.RequestBody);
            var verificationResponse = client.Execute<VerificationResponse>(request);

            if (!verificationResponse .IsSuccessful)
            {
                throw new ResponseException(verificationResponse.Content);
            }

            return verificationResponse.Data;
        }
        else
        {
            throw new ResponseException("The verification access token is empty");
        }
    }
    catch (Exception ex)
    {
        _Logger.LogError(ex, ex.Message);
        throw;
    }
}

public string GetVerificationAuthenticationToken()
{
    try
    {
        var clientID = _Configuration.GetSection("Verification:TokenSettings:ClientID").Value;
        var username = _Configuration.GetSection("Verification:TokenSettings:Username").Value;
        var tokenUrl = _Configuration.GetSection("Verification:TokenSettings:Url").Value;
        var scope = _Configuration.GetSection("Verification:TokenSettings:Scope").Value;
        var password = _Configuration.GetSection("Verification:TokenSettings:Password").Value;
        var grantType = _Configuration.GetSection("Verification:TokenSettings:GrantType").Value;
        var timeout = int.Parse(_Configuration.GetSection("RestAPIClientTimeout").Value);

        var client = new RestClient(tokenUrl);
        client.Timeout = timeout;
        var request = new RestRequest(Method.POST);
        request.AddHeader("Content-Type", "application/x-www-form-urlencoded");
        request.AddParameter("client_id", clientID);
        request.AddParameter("username", username);
        request.AddParameter("password", password);
        request.AddParameter("grant_type", grantType);
        request.AddParameter("scope", scope);
        var response = client.Execute<VerificationTokenResponse>(request);

        if (!response.IsSuccessful)
        {
            throw new ResponseException(response.Content);
        }

        return response.Data.AccessToken;
    }
    catch (Exception ex)
    {
        _Logger.LogError(ex, ex.Message);
        throw;
    }
}

Answer 1

任何调用外部 web API 的东西都应该移到它自己的 class 中。 新的 class 应该实现一个接口。 controller 将接收一个 object 作为构造函数或方法参数实现此接口。

在这种情况下，您希望您的控制器非常简单，并将大部分逻辑移到另一个 class 中。

这是一项相当大的重构工作。 获取验证令牌的代码，以及调用 web API 以获取验证响应的代码都应移至另一个 class。 基本上所有 controller 都减少到：

public class YourController : Controller
{
    private IWebApiClient api;

    public YourController(IWebApiClient api)
    {
        this.api = api;
    }

    // other controller methods...

    public VerificationResponse VerifyDetails(VerificationRequest verificationRequest)
    {
        try
        {
            var verificationResponse = api.Verify(verificationRequest);

            if (!verificationResponse.IsSuccessful)
            {
                throw new ResponseException(verificationResponse.Content);
            }

            return verificationResponse.Data;
        }
        catch (Exception ex)
        {
            _Logger.LogError(ex, ex.Message);
            throw;
        }
    }
}

您需要一个接口和一个实现 class：

public interface IWebApiClient
{
    VerificationResponse Verify(VerificationRequest verificationRequest);
}

public class WebApiClient : IWebApiClient
{
    public VerificationResponse Verify(VerificationRequest verificationRequest)
    {
        // get token, make call, etc.
    }
}

在 Services.cs 中，注册一个 WebApiClient 实例以满足对 IWebApiClient 接口的需求。

现在您的单元测试可以模拟 IWebApiClient 的响应对象。 如果需要，您可以编写自己的实现，或者使用像 Moq 这样的 mocking 库。