使用 Mockito 模拟在 Grizzly 上运行的 Jersey REST Api

Question

我正在测试我使用 Jersey 设置的 RESTful api。我想使用 JUnit 测试它，同时使用 Grizzly 运行它以提供 Http 容器。

使用服务器的一般测试工作正常，即发送请求和接收响应等。

该 api 称为 CMSApi，它有一个名为 skyService 的依赖项，我想对其进行模拟，所以我只测试 api。 所以问题是如何将 CMSApi 注入使用 Mockito 创建的 mockSkyService 对象？相关代码如下：

Grizzly 服务器启动：

public static HttpServer startServer() {
    final ResourceConfig rc = new ResourceConfig().packages("com.sky");
    rc.property(ServerProperties.BV_SEND_ERROR_IN_RESPONSE, true);
    return GrizzlyHttpServerFactory.createHttpServer(URI.create(BASE_URI), rc);

}

我的 JUnit 调用了上面的 start 方法：

@Before
public void setUpServer() throws Exception {

    // start the server and create the client
    server = Main.startServer();

    Client client = ClientBuilder.newClient();
    target = client.target(Main.BASE_URI);
}

我使用@RunWith(MockitoJUnitRunner.class) 运行测试。

以下是测试中的相关对象：

//System Under Test
private CMSApi cmsApi;

//Mock
@Mock private static SkyService mockSkyService;

这里是调用的测试方法：

  @Test
public void testSaveTile() {

    //given
    final Invocation.Builder invocationBuilder = target.path(PATH_TILE).request(MediaType.APPLICATION_JSON).accept(MediaType.APPLICATION_JSON);

    Tile tile = new Tile(8, "LABEL", clientId, new Date(), null);

    //when      
    Response response = invocationBuilder.post(Entity.entity(tile, MediaType.APPLICATION_JSON_TYPE));

    //then
    assertEquals(Status.OK.getStatusCode(), response.getStatus());

}

Maven 依赖项

<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
     xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">

<modelVersion>4.0.0</modelVersion>

<groupId>com.sky</groupId>
<artifactId>sky-service</artifactId>
<packaging>jar</packaging>
<version>1.0-SNAPSHOT</version>
<name>sky-service</name>

<dependencyManagement>
    <dependencies>
        <dependency>
            <groupId>org.glassfish.jersey</groupId>
            <artifactId>jersey-bom</artifactId>
            <version>${jersey.version}</version>
            <type>pom</type>
            <scope>import</scope>
        </dependency>
    </dependencies>
</dependencyManagement>

 <dependencies>
     <dependency> 
        <groupId>org.glassfish.jersey.media</groupId>
        <artifactId>jersey-media-json-jackson</artifactId>
        </dependency>        
    <dependency>
        <groupId>org.glassfish.jersey.test-framework.providers</groupId>
        <artifactId>jersey-test-framework-provider-bundle</artifactId>
        <type>pom</type>
        <scope>test</scope>

    <dependency>
        <groupId>org.glassfish.jersey.ext</groupId>
        <artifactId>jersey-bean-validation</artifactId>
        </dependency>
    <dependency>
        <groupId>org.glassfish.jersey.test-framework.providers</groupId>
        <artifactId>jersey-test-framework-provider-grizzly2</artifactId>
    </dependency>
    <dependency>
        <groupId>com.sun.jersey</groupId>
        <artifactId>jersey-json</artifactId>
        <version>1.16</version>
    </dependency>

    <dependency>
        <groupId>junit</groupId>
        <artifactId>junit</artifactId>
        <version>4.10</version>
        <scope>test</scope>
    </dependency>
    <!-- Dependency for Mockito -->
    <dependency>
        <groupId>org.mockito</groupId>
        <artifactId>mockito-all</artifactId>
        <version>1.9.5</version>
        <scope>test</scope>
    </dependency>
</dependencies>

<build>
    <plugins>
        <plugin>
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-compiler-plugin</artifactId>
            <version>2.5.1</version>
            <inherited>true</inherited>
            <configuration>
                <source>1.7</source>
                <target>1.7</target>
            </configuration>
        </plugin>
        <plugin>
            <groupId>org.codehaus.mojo</groupId>
            <artifactId>exec-maven-plugin</artifactId>
            <version>1.2.1</version>
            <executions>
                <execution>
                    <goals>
                        <goal>java</goal>
                    </goals>
                </execution>
            </executions>
            <configuration>
                <mainClass>com.sky.Main</mainClass>
            </configuration>
        </plugin>
    </plugins>
</build>

<properties>
    <jersey.version>2.15</jersey.version>
    <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
</properties>

Answer 1

您将需要使用ResourceConfig，因为您需要显式注册CMSApi，以便在注册之前将其注入模拟的SkyService。它基本上看起来像

// Sample interface
public interface SkyService {
    public String getMessage();
}

@Path("...")
public class CMSApi {
    private SkyService service;
    public void setSkyService( SkyService service ) { this.service = service; }
}

// Somewhere in test code
CMSApi api = new CMSApi();
SkyServicer service = Mockito.mock(SkyService.class);
Mockito.when(server.getMessage()).thenReturn("Hello World");
api.setSkyService(service);
resourceConfig.register(api);

关键是要设置资源类以注入其依赖项。更容易测试是依赖注入的好处之一。您可以通过构造函数注入，也可以像我所做的那样通过 setter 注入，或者通过带有 @Inject 注释的注入框架注入。

你可以看到一个更完整的例子here，它使用了Jersey DI 框架HK2。您还可以查看更多关于 Jersey 和 HK2 here 的信息。然后示例还使用了Jersey Test Framework，我认为您已经将其作为依赖项，因此您可能希望利用它。这里是another example，它使用的是 Jersey 1，但是概念是一样的，你也许可以从中得到一些想法。

顺便说一句，您似乎使用的是我熟悉的 Jersey 原型。因此，您显示的配置代码位于不同的类中。您可能不想弄乱当前的应用程序配置，因此您最好的选择是使用测试框架并创建一个新配置，如我链接到的示例中所示。否则，您将需要其他方式从测试类访问资源配置。或者您可以在测试类中设置一个新服务器，而不是在Main 类中启动服务器。