使用dropwizard(4)-加入测试-jacoco代码覆盖率

阳光穿透心脏的1/2处 2022-06-03 23:17 274阅读 0赞

![dropwizard-hat.png][]

# 前言 #

dropwizard提供了一个简单的测试框架。这里简单集成并加入jacoco测试。

作者：@Ryan-Miao  
本文为作者原创，转载请注明出处：[http://www.cnblogs.com/woshimrf/p/dropwizard-test-jacoco.html][http_www.cnblogs.com_woshimrf_p_dropwizard-test-jacoco.html]

# Demo source #

[https://github.com/Ryan-Miao/l4dropwizard][https_github.com_Ryan-Miao_l4dropwizard]

本文是基于[dropwizard入门][dropwizard]之上的演进。

确保依赖都是最新的，或者自行解决版本冲突，比如jackson不同版本之间的类有所不同。

# 加入dropwizard-testing #

在dependencies中增加依赖

<dependency>
        <groupId>io.dropwizard</groupId>
        <artifactId>dropwizard-testing</artifactId>
        <version>${dropwizard.version}</version>
        <scope>test</scope>
    </dependency>

# 新增Mockito #

<dependency>
        <groupId>junit</groupId>
        <artifactId>junit</artifactId>
        <version>4.12</version>
    </dependency>
    <dependency>
        <groupId>org.mockito</groupId>
        <artifactId>mockito-core</artifactId>
        <version>2.12.0</version>
        <scope>test</scope>
    </dependency>

# 新增jacoco #

在properties下新增

<jacoco.skip.instrument>true</jacoco.skip.instrument>
    <jacoco.percentage.instruction>0.01</jacoco.percentage.instruction>
    <jacoco.percentage.branch>0</jacoco.percentage.branch>

在plugin新增

<plugin>
        <groupId>org.jacoco</groupId>
        <artifactId>jacoco-maven-plugin</artifactId>
        <configuration>
            <excludes>
                <exclude>**/ioc/**/*</exclude>
                <exclude>**/exceptions/**/*</exclude>
                <exclude>**/connector/*</exclude>
                <exclude>**/valueobject/**/*</exclude>
                <exclude>**/exception/**/*</exclude>
                <exclude>**/entity/**/*</exclude>
                <exclude>**/constant/*</exclude>
                <exclude>**/*Test.*</exclude>
                <exclude>**/Dagger*</exclude>
                <exclude>**/*Factory.*</exclude>
                <exclude>**/*Module.*</exclude>
            </excludes>
        </configuration>
        <executions>
            <execution>
                <id>jacoco-initialize</id>
                <goals>
                    <goal>prepare-agent</goal>
                </goals>
            </execution>
            <execution>
                <id>jacoco-check</id>
                <phase>test</phase>
                <goals>
                    <goal>check</goal>
                </goals>
                <configuration>
                    <rules>
                        <rule implementation="org.jacoco.maven.RuleConfiguration">
                            <element>BUNDLE</element>
                            <limits>
                                <limit implementation="org.jacoco.report.check.Limit">
                                    <counter>INSTRUCTION</counter>
                                    <value>COVEREDRATIO</value>
                                    <minimum>${jacoco.percentage.instruction}</minimum>
                                </limit>
                                <limit implementation="org.jacoco.report.check.Limit">
                                    <counter>BRANCH</counter>
                                    <value>COVEREDRATIO</value>
                                    <minimum>${jacoco.percentage.branch}</minimum>
                                </limit>
                            </limits>
                        </rule>
                    </rules>
                </configuration>
            </execution>
            <execution>
                <id>jacoco-report</id>
                <phase>test</phase>
                <goals>
                    <goal>report</goal>
                </goals>
            </execution>
            <execution>
                <id>jacoco-instrument</id>
                <phase>test</phase>
                <goals>
                    <goal>instrument</goal>
                </goals>
                <configuration>
                    <skip>${jacoco.skip.instrument}</skip>
                </configuration>
            </execution>
        </executions>
    </plugin>

# 编写测试 #

首先，更新依赖，

mvn clean install

IDEA中刷新maven按钮。

然后，新建Resource测试类：

package com.test.domain.resource;
    
    import com.test.domain.entiry.GithubUser;
    import com.test.domain.service.IGithubService;
    import io.dropwizard.testing.junit.ResourceTestRule;
    import org.junit.After;
    import org.junit.Before;
    import org.junit.ClassRule;
    import org.junit.Test;
    
    import static org.junit.Assert.assertEquals;
    import static org.mockito.ArgumentMatchers.anyString;
    import static org.mockito.Mockito.mock;
    import static org.mockito.Mockito.reset;
    import static org.mockito.Mockito.verify;
    import static org.mockito.Mockito.when;
    
    /** * Created by Ryan Miao on 11/20/17. */
    public class GithubResourceTest { 
    
        private static final IGithubService service = mock(IGithubService.class);
    
        @ClassRule
        public static final ResourceTestRule resources = ResourceTestRule.builder()
                .addResource(new GithubResource(service))
                .build();
    
    
        @Before
        public void setup() {
    
        }
    
        @After
        public void tearDown(){
            // we have to reset the mock after each test because of the
            // @ClassRule, or use a @Rule as mentioned below.
            reset(service);
        }
    
        @Test
        public void testGetPerson() {
    
            GithubUser user = new GithubUser();
            String name = "Ryan";
            user.setName(name);
            when(service.getUserProfile(anyString())).thenReturn(user);
            GithubUser githubUser = resources.target("/github/users/ryan-miao").request().get(GithubUser.class);
            assertEquals(name, githubUser.getName());
            verify(service).getUserProfile("ryan-miao");
        }
    
    }

# 验收，查看覆盖率 #

mvn clean install

## 查看jacoco覆盖率 ##

report在`target/site/jacoco/index.html`

[dropwizard-hat.png]: /images/20220604/7f46c423ea814b6b95b005d1bc24f2f7.png
[http_www.cnblogs.com_woshimrf_p_dropwizard-test-jacoco.html]: http://www.cnblogs.com/woshimrf/p/dropwizard-test-jacoco.html
[https_github.com_Ryan-Miao_l4dropwizard]: https://github.com/Ryan-Miao/l4dropwizard
[dropwizard]: http://www.cnblogs.com/woshimrf/tag/dropwizard/