如何使用标头模拟 HttpServletRequest？

Question

我正在使用Mockito和JUnit来测试应用程序。 我需要在HttpServletRequest时向HttpServletRequest添加标头。 这是我第一次使用模拟概念来测试应用程序。 在使用这个模拟概念时，我们如何为请求对象设置标头？

应用代码

@Produces({ MediaType.APPLICATION_JSON })
@Path("/devices")
public class DvrRestService {
    private static final Logger logger = LoggerFactory.getLogger(DvrRestService.class);

    private DvrMiddleService dvrMiddleService;

    @Inject
    public DvrRestService(DvrMiddleService dvrMiddleService) {
        this.dvrMiddleService = dvrMiddleService;
    }

    @GET 
    @Path("/{deviceId}/metadata")
    public Response getDeviceMetadata(@Context HttpServletRequest request, @PathParam("deviceId") String deviceId,
        @RequiredSession final Session session) {

        try {
            public static String[] REQUEST_HEADERS = { "if-none-match" };
            List<String> requiredHeaders = Lists.newArrayList(REQUEST_HEADERS);
            Map<String, String> headers = new HashMap<String, String>();

            Enumeration<String> headerNames = request.getHeaderNames();
            while (headerNames.hasMoreElements()) { // here gettting NullPointerException

                String headerName = headerNames.nextElement();
                if (requiredHeaders.contains(headerName.toLowerCase())) {
                    String value = request.getHeader(headerName);
                    if (value != null) {
                        headers.put(headerName, value);
                        System.out.println("headerName: " + headerName + ", Value: " + value);
                    }
                }
            }
            DvrResponse response = dvrMiddleService.getDeviceMetadata(deviceId.toUpperCase(), getHeaders(request));
            return processResponse(response.statusCode, response.getResponse(), DeviceMetadataResponse.class,
                response.getHeaders());
        } catch (Exception e) {
            return processErrorResponse(e, new DeviceMetadataResponse(), logger);
        }

    }
}

测试

public class DvrRestServiceTest {

    static DvrMiddleService dms;
    static HttpServletRequest request;
    static Session session;
    static DvrRestService drs;
    public static final String DeviceId = "000004D42070";
    @BeforeClass
    public static void init(){
        dms = mock(DvrMiddleService.class);
        request = mock(HttpServletRequest.class);
        session = mock(Session.class);
        drs = new DvrRestService(dms);
    }
    @Test
    public void getDeviceMetadataTest(){
        Response rs = drs.getDeviceMetadata(request, DeviceId, session);
        assertEquals(Response.Status.OK, rs.getStatus());
    }
}

Answer 1

作为主体的起点和演示，您可以从以下代码段开始。

// define the headers you want to be returned
Map<String, String> headers = new HashMap<>();
headers.put(null, "HTTP/1.1 200 OK");
headers.put("Content-Type", "text/html");

// create an Enumeration over the header keys
Enumeration<String> headerNames = Collections.enumeration(headers.keySet());

// mock HttpServletRequest
HttpServletRequest request = mock(HttpServletRequest.class);
// mock the returned value of request.getHeaderNames()
when(request.getHeaderNames()).thenReturn(headerNames);

System.out.println("demonstrate output of request.getHeaderNames()");
while (headerNames.hasMoreElements()) {
    System.out.println("header name: " + headerNames.nextElement());
}
    
// mock the returned value of request.getHeader(String name)
doAnswer(new Answer<String>() {
    @Override
    public String answer(InvocationOnMock invocation) throws Throwable {
        Object[] args = invocation.getArguments();
        return headers.get((String) args[0]);
    }
}).when(request).getHeader("Content-Type");

System.out.println("demonstrate output of request.getHeader(String name)");
String headerName = "Content-Type";
System.out.printf("header name: [%s]   value: [%s]%n", 
        headerName, request.getHeader(headerName));
}

输出

demonstrate output of request.getHeaderNames()
header name: null
header name: Content-Type

demonstrate output of request.getHeader(String name)
header name: [Content-Type]   value: [text/html]

Answer 2

HttpServletRequest是一个复杂的接口，有 20 多个方法，它们之间有明确定义的相互作用。 与其仔细模拟您正在使用的那些，另一种方法是使用一个已经具有完整功能模拟类型的库。

这种方法的一个优点是它在面对使用类上的其他方法获取相同信息的未来重构时更具弹性。 在检索HttpServletRequest的“if-none-match”标头的情况下，我看到可以合法地用于检索标头的三种不同方法： getHeader(String name) 、 getHeaders(String name)和getHeaderNames() 。 此外， getHeader和getHeaders都不区分大小写（调用代码是否使用“if-none-match”、“If-None-Match”等并不重要），因此它们参数的任何可能的大小写都是正确。 很可能通过直接模拟来支持这一点，尽管它涉及额外的样板代码，使测试复杂化并使其不那么明显。

spring-test库有一个MockHttpServletRequest类来模拟这个接口，通过一个简单的 API 设置标头和其他值。 虽然该库是为测试Spring应用程序而设计的，但MockHttpServletRequest类本身应该完全可用，即使应用程序不使用 Spring。

@BeforeClass
public static void init(){
    // ...

    MockHttpServletRequest mockRequest = new MockHttpServletRequest();
    request.addHeader("Content-Type", "text/html");
    request.addHeader("if-none-match", "*");
    request.addHeader("customHeader", "customValue");

    this.request = mockRequest;
}

Answer 3

这在我的情况下有效

mockMvc.perform(post("<<url>>").content("<<jsonStrig>>").header("key", "value"));

也可用于获取请求。

Answer 4

我知道 OP 正在使用 Mockito。 这个答案适用于那些使用 spock 的人。 你可以很容易地做到这一点。

class MyTestSpec extends Specification {

    HttpServletRequest request = Mock()
    MyTestClass myTestClass = new MyTestClass()

    def 'my test'() {
        setup:
        String expectedHeader = "x-mycustom-header"

        when:
        String someResult = myTestClass.someTestMethod()

        then:
        // here is where you return your header from the mocked request
        1 * request.getHeader(_ as String) >> expectedHeader
    }
}