如何使用Jersey 2测试框架为此类编写单元测试

Question

我正在尝试为Rest api调用编写单元测试，该调用具有POST方法，用于使用Jersey2将视频文件添加到基于Web的应用程序。 这是我想要编写单元测试的类（ TemplateController.java ）方法的签名：

@POST
@Path("/video/add")
@Consumes(MediaType.APPLICATION_JSON)
@Produces(MediaType.APPLICATION_JSON)
public Response addVideoData(
    @Context HttpServletRequest request, 
    AttachmentDTO attachmentDTO) {
        ...
}

这是我测试类的测试方法（ TemplateControllerUnitTestCase.java ）：

@Test
public void videoAdd_requestObjectIsNull_ResponseStatusIsOK() throws Exception {
    // arrange
    Builder builder = target("/target/video/add").request();
    // action
    final Response response = builder.post(Entity.entity(attachemntDTO, MediaType.APPLICATION_JSON));
    // assertion
    ...
}

我能够在传递AttachmentDAO对象到TemplateController从测试类类，但无法通过这是越来越无效的请求对象method(addVideoData())的的TemplateController.java class 。

我正在使用RequestHelper类，它是HttpServletRequest的辅助类，所以我想使用Jersey2测试框架将此类的对象传递给method(addVideoData()) 。

Answer 1

您可以使用Jersey 2的HK2功能，这有助于依赖注入 。 这样做，您可以为HttpServletRequest创建一个Factory ，并从RequestHelper返回模拟。 例如

public class HttpServletRequestFactory implements Factory<HttpServlet> {

    @Override
    public HttpServletRequest provide() {
       return RequestHelper.getMockServletRequest();
    }

    @Override
    public void dispose(HttpSession t) {
    }
}

然后在JerseyTest子类中，只需使用ResourceConfig注册一个AbstractBinder 。 例如

@Override
public Application configure() {
    ResourceConfig config = new ResourceConfig(...);
    config.register(new AbstractBinder(){
        @Override
        public void configure() {
            bindFactory(HttpServletRequestFactory.class).to(HttpServletRequest.class);
        }
    });
} 

另外一个选项

...根本不是模拟HttpServletRequest ，而是使用实际的HttpServletRequest 。 为此，我们需要在覆盖getDeploymentContext()配置DeploymentContext ，并返回ServletDeploymentContext 。 你可以在这里和这里看到一个例子。 第一个还有一个使用Factory的示例，而第二个示例显示了如何基于web.xml设置进行配置。 如果您选择getTestContainerFactory HttpServletRequest的情况，那么您将不需要覆盖getTestContainerFactory和configureDeployment如示例中所示。 只要使用Application configure()覆盖就足够了，只要其他任何东西都不依赖于servlet功能。

链接中的示例使用

<dependency>
    <groupId>org.glassfish.jersey.test-framework.providers</groupId>
    <artifactId>jersey-test-framework-provider-grizzly2</artifactId>
    <version>${jersey.version}</version>
</dependency>

额外

我链接的示例都试图利用Sevlet功能。 所以我将给出一个使用请求模拟的完整示例。

import javax.servlet.http.HttpServletRequest;
import javax.ws.rs.GET;
import javax.ws.rs.Path;
import javax.ws.rs.core.Application;
import javax.ws.rs.core.Context;
import javax.ws.rs.core.Response;
import org.glassfish.hk2.api.Factory;
import org.glassfish.hk2.utilities.binding.AbstractBinder;
import org.glassfish.jersey.server.ResourceConfig;
import org.glassfish.jersey.test.JerseyTest;
import org.junit.Assert;
import org.junit.Test;

public class MockHttpSevletRequestTest extends JerseyTest {

    @Path("http")
    public static class HttpResource {
        @GET
        public Response getResponse(@Context HttpServletRequest request) {
            return Response.ok(request.getMethod()).build();
        }
    }

    @Override
    public Application configure() {
        ResourceConfig config = new ResourceConfig(HttpResource.class);
        config.register(new AbstractBinder() {
            @Override
            public void configure() {
                bindFactory(HttpServletRequestFactory.class)
                        .to(HttpServletRequest.class);
            }
        });
        return config;
    }

    public static class HttpServletRequestFactory implements Factory<HttpServletRequest> {

        @Override
        public HttpServletRequest provide() {
            return new MockHttpServletRequest();
        }

        @Override
        public void dispose(HttpServletRequest t) {
        }
    }

    @Test
    public void test() {
        String response = target("http").request().get(String.class);
        System.out.println(response);
        Assert.assertEquals("POST", response);
    }
}

MockHttpServletRequest很简单，是一个HttpServletRequest的虚拟实现，我只重写一个方法getMethod()并始终返回POST 。 你可以从结果中看到，即使它是一个get请求，它仍然会返回POST

public class MockHttpServletRequest implements HttpServletRequest {

    @Override
    public String getMethod() {
        return "POST";
    }
    ...
}