如何测试 Apache HttpClient RequestConfig 值是否设置正确？没有 public 吸气剂存在

Question

我有这个 class 来配置一个 HttpClient 实例：

package com.company.fraud.preauth.service.feignaccertifyclient;

    import com.company.fraud.preauth.config.ProviderClientConfig;
    import lombok.RequiredArgsConstructor;
    import lombok.extern.slf4j.Slf4j;
    import org.apache.http.client.HttpClient;
    import org.apache.http.client.config.RequestConfig;
    import org.apache.http.conn.ssl.TrustSelfSignedStrategy;
    import org.apache.http.impl.client.HttpClientBuilder;
    import org.apache.http.ssl.SSLContextBuilder;
    import org.springframework.context.annotation.Bean;
    import org.springframework.context.annotation.Configuration;

    import java.security.KeyManagementException;
    import java.security.KeyStoreException;
    import java.security.NoSuchAlgorithmException;


    @Slf4j
    @Configuration
    @RequiredArgsConstructor
    public class FeignClientConfig {

        private final ProviderClientConfig providerClientConfig;

        public HttpClient buildHttpClient() throws NoSuchAlgorithmException, KeyStoreException, KeyManagementException {
            RequestConfig.Builder requestBuilder = RequestConfig.custom();
            requestBuilder.setConnectTimeout(providerClientConfig.getConnectionTimeout());
            requestBuilder.setConnectionRequestTimeout(providerClientConfig.getConnectionRequestTimeout());
            requestBuilder.setSocketTimeout(providerClientConfig.getSocketTimeout());
            SSLContextBuilder builder = new SSLContextBuilder();
            builder.loadTrustMaterial(null, new TrustSelfSignedStrategy());

            return HttpClientBuilder.create()
                    .setMaxConnPerRoute(providerClientConfig.getMaxConnectionNumber())
                    .setDefaultRequestConfig(requestBuilder.build())
                    .setSSLContext(builder.loadTrustMaterial(null, new TrustSelfSignedStrategy()).build())
                    .build();
        }
    }

如何对此 class 进行单元测试，以查看结果 HttpClient 这些值是否设置正确？

从 httpClient 我无法访问其 RequestConfig。

我知道这两个帖子：

How do I test a private function or a class that has private methods, fields or inner classes? （这个问题的投票数表明它是测试中一个并发且有争议的话题，我的情况可能会提供一个例子，说明为什么我们应该在测试中查看实例的内部状态，尽管它是私有的）

（它显示了一种在代码中添加拦截器以检查配置值的方法，但我不喜欢它，因为我想将测试与功能代码分开）

有什么办法吗？我明白这个 class 应该测试一下，对吧？您不能盲目地相信它会起作用；并检查它 "notNull" 对我来说似乎很脆弱。

这个link可能会给我指明正确的方向：

https://dzone.com/articles/testing-objects-internal-state

它使用 PowerMock.Whitebox 检查实例的内部状态。

Answer 1

所以我检查了 PowerMock.Whitebox 源代码，结果发现内部使用了反射。而且，由于据说 PowerMock 与 JUnit 5 不兼容（直到现在），而且我不想添加另一个仅用于测试的依赖项，所以我将使用反射进行测试。

package com.company.fraud.preauth.service.feignaccertifyclient;

import com.company.fraud.preauth.config.PreAuthConfiguration;
import com.company.fraud.preauth.config.ProviderClientConfig;
import com.company.fraud.preauth.config.StopConfiguration;
import org.apache.http.client.HttpClient;
import org.apache.http.client.config.RequestConfig;
import org.junit.jupiter.api.DisplayName;
import org.junit.jupiter.api.Test;
import org.junit.jupiter.api.extension.ExtendWith;
import org.mockito.Mock;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.test.context.junit.jupiter.SpringExtension;

import java.lang.reflect.Field;

import static org.hamcrest.CoreMatchers.equalTo;
import static org.junit.Assert.assertThat;
import static org.mockito.Mockito.when;

@ExtendWith(SpringExtension.class)
@SpringBootTest(classes = {
        PreAuthConfiguration.class,
        StopConfiguration.class,
})
public class FeignClientConfigTest {

    @Mock
    private ProviderClientConfig providerClientConfig;

    @Test
    @DisplayName("should return HttpClient with defaultConfig field filled with values in providerClientConfig")
    public void shouldReturnHttpClientWithConfiguredValues() throws Exception {
        // given
        when(providerClientConfig.getConnectionRequestTimeout()).thenReturn(30000);
        when(providerClientConfig.getConnectionTimeout()).thenReturn(30);
        when(providerClientConfig.getMaxConnNumPerRoute()).thenReturn(20);
        when(providerClientConfig.getSocketTimeout()).thenReturn(10);
        FeignClientConfig feignClientConfig = new FeignClientConfig(providerClientConfig);

        // when
        HttpClient httpClient = feignClientConfig.buildHttpClient();

        // then
        // I want to test internal state of built HttpClient and this should be checked
        // I tried to use PowerMock.Whitebox, but then I found it uses reflection internally
        // I don't want to introduce another dependency, and PowerMock is said not to be compatible with JUnit 5, so..
        Field requestConfigField = httpClient.getClass().getDeclaredField("defaultConfig");
        requestConfigField.setAccessible(true);
        RequestConfig requestConfig = (RequestConfig)requestConfigField.get(httpClient);
        assertThat(requestConfig.getConnectionRequestTimeout(), equalTo(30000));
        assertThat(requestConfig.getConnectTimeout(), equalTo(30));
        assertThat(requestConfig.getSocketTimeout(), equalTo(10));
    }

}

此外，我回答了 OP 中关于何时在 class here

中测试私有成员的第一个问题

Answer 2

Whitebox 为我工作。由于此处未记录，我正在添加我的版本：

在我的例子中，我想测试超时是否不同于 0 以避免死锁

    HttpClient httpClient = factory.getHttpClient();

    RequestConfig sut = Whitebox.getInternalState(httpClient, "defaultConfig");

    assertNotEquals(0, sut.getConnectionRequestTimeout());
    assertNotEquals(0, sut.getConnectTimeout());
    assertNotEquals(0, sut.getSocketTimeout());

如何测试 Apache HttpClient RequestConfig 值是否设置正确？没有 public 吸气剂存在

How to test Apache HttpClient RequestConfig values are set correctly? No public getters present

testing

private-members

apache-commons-httpclient