使用 jUnit 和 Mockito 进行外部 REST API 调用的单元测试

Question

我正在 Spring Boot Java 应用程序中为服务类构建单元测试。

服务类对返回 JSON 响应的 REST API 服务进行外部调用。我正在使用 Mockito 模拟这个电话。我在 mockserver 响应中对 JSON 进行硬编码。

在单元测试中硬编码 JSON 是一种不好的做法吗？如果 JSON 结构发生变化，那么测试应该失败是我的推理。是否有更好的最佳实践来执行此操作？

以下示例代码段：

实际的代码是功能性的，我只是编辑了这个 sn-p 它为简洁起见，所以如果您发现任何错误，请发表评论：

    public class UserServiceTest extends TestCase {

    private static final String MOCK_URL = "baseUrl";
    private static final String DEFAULT_USER_ID = "353";

    UserService classUnderTest;
    ResponseEntity<Customer> mockResponseEntity;
    MockRestServiceServer mockServer;
    @Mock
    RestTemplate mockRestTemplate;

    public void setUp() throws Exception {
        super.setUp();

        classUnderTest = new UserRestService();
        mockRestTemplate = new RestTemplate();
        mockServer = MockRestServiceServer.createServer(mockRestTemplate);

        ReflectionTestUtils.setField(classUnderTest, "restTemplate",
                mockRestTemplate);
        ReflectionTestUtils.setField(classUnderTest, "userSvcUrl",
                MOCK_URL);
    }

    public void testGetUserById() throws Exception {

        mockServer.expect(requestTo(MOCK_URL + "/Users/" + DEFAULT_USER_ID)).andExpect(method(HttpMethod.GET))
                .andRespond(withSuccess(
                        "{\n" +
                                "    \"UserCredentials\": {\n" +
                                "        \"Password\": \"\",\n" +
                                "        \"PasswordNeedsUpdate\": false,\n" +
                                "        \"Security\": [\n" +
                                "            {\n" +
                                "                \"Answer\": \"\",\n" +
                                "                \"Question\": \"Why did the bicycle fall over?\"\n" +
                                "            }\n" +
                                "        ]\n" +
                                "}"
                        , MediaType.APPLICATION_JSON));


        Customer customer = classUnderTest.getUserById(DEFAULT_USER_ID);

        mockServer.verify();
        assertNotNull(customer);
        assertEquals(DEFAULT_USER_ID, customer.getId());
    }
}

Answer 1

我目前和你在同一条船上，我的推理如下： 创建一个虚拟的 JSON 响应就像模拟一个对象并使用 Mockito.when 控制它。当您更改某些内部解析或期望不同的结果时，您需要更改 when().thenReturn() 调用中的任何内容。这与更改调用和更改对象表示的 JSON 响应相同。

因此，我的猜测是这很好。阅读有关测试 REST API 的各种文章后，普遍认为创建虚拟 JSON 响应是一种很好的做法。最佳做法是（不时）下载真正的 JSON 响应并将其作为模拟响应插入。通过这种方式，您可以让您的测试与外部方保持同步，而无需互联网请求即可运行测试。

按要求编辑：

• Ruby - Stubbing external services,

• Python - Testing a successful call

• JavaScript - An example of AJAX testing

• Python - Lastly a Google tutorial about mocking

Answer 2

我想说明另一种考虑的方法，即创建 JSON 表示的对象的 POJO（例如数据模型，JavBean），然后使用 JSON 序列化程序（例如 Google 的 Gson）进行转换到 JSON 字符串。

UserCredentials uc = new UserCredentials ();
//set the values
Gson gson = new GsonBuilder().setPrettyPrinting().create();
String json = gson.toJson(uc);