Java单元和集成测试配置

基于Spring Boot搭建一个Java工程，通过Gradle进行构建，使用IntelliJ IDE开发，对于在build.gradle中配置Integration Test和Unit Test有多种方式。接下来分别介绍两种方式:

假设在IntelliJ中创建好如下Tree结构:

方法一: use another source set

Add into the source sets

sourceSets {
    main {
        java.srcDirs = ['src/main/java']
        resources.srcDirs = ['src/main/resources']
    }
    test {
        java.srcDirs = ['src/test/unit/java']
        resources.srcDirs = ['src/test/unit/resources', 'src/test/intg/resources']
    }
    integrationTest {
        java.srcDirs = ['src/test/intg/java']
    }
}

Add into the idea intelliJ

idea {
    module {
        testSourceDirs += sourceSets.integrationTest.java.srcDirs
    }
}

Apply the dependencies for integration test

dependencies {
    compile("org.springframework.boot:spring-boot-starter-web")
    compile("org.springframework.boot:spring-boot-starter-data-jpa")
    testCompile("com.jayway.jsonpath:json-path")
    testCompile("org.springframework.boot:spring-boot-starter-test")
    integrationTestCompile sourceSets.main.output
    integrationTestCompile sourceSets.test.output
    integrationTestCompile configurations.testCompile
    integrationTestRuntime configurations.testRuntime
}

Create the unit and integrationTest tasks

task unitTest(dependsOn: test)

task integrationTest(type: Test) {
    testClassesDir = sourceSets.integrationTest.output.classesDir
    classpath = sourceSets.integrationTest.runtimeClasspath
}

build.dependsOn integrationTest

方法二: use the same source set as test

Add into the source sets

sourceSets {
    main {
        java.srcDirs = ['src/main/java']
        resources.srcDirs = ['src/main/resources']
    }
    test {
        java.srcDirs = ['src/test/unit/java', 'src/test/intg/java']
        resources.srcDirs = ['src/test/unit/resources', 'src/test/intg/resources']
    }
}

Exclude the test classes *IntegrationTest.class

test {
    exclude '**/*IntegrationTest.class'
}

Add the dependencies for test

dependencies {
    compile("org.springframework.boot:spring-boot-starter-web")
    compile("org.springframework.boot:spring-boot-starter-data-jpa")
    testCompile("com.jayway.jsonpath:json-path")
    testCompile("org.springframework.boot:spring-boot-starter-test")
}

Create the unit and integrationTest tasks

task unitTest(dependsOn: test)

task integrationTest(type: Test) {
    include '**/*IntegrationTest.class'
}

build.dependsOn integrationTest

集成测试实现DEMO

如果对于1.4.0.RELEASE以下的Spring Boot版本，可以采用以下方式：

ApplicationIntegrationTest.java

@RunWith(SpringJUnit4ClassRunner.class)
@SpringApplicationConfiguration(classes = Application.class)
@WebAppConfiguration
@Transactional
public abstract class ApplicationIntegrationTest {
    protected MockMvc mockMvc;
}

若是针对1.4.0.RELEASE及以上的Spring Boot版本，部分用法可能已经过期了，可以升级为以下方式：

BaseIntegrationTest.java

import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.test.context.ActiveProfiles;
import org.springframework.test.context.ContextConfiguration;
import org.springframework.test.context.junit4.SpringJUnit4ClassRunner;
import org.springframework.test.web.servlet.MockMvc;

@RunWith(SpringJUnit4ClassRunner.class)
@ContextConfiguration(classes = {IntegrationTestConfiguration.class})
@SpringBootTest(webEnvironment = DEFINED_PORT)
@ActiveProfiles("local")
public abstract class BaseIntegrationTest {
    protected MockMvc mockMvc;
}

IntegrationTestConfiguration.java

@Configuration
@ComponentScan(basePackages = {"xx.xxx.xx"})
@PropertySources(value = {
        @PropertySource("classpath:application.yml"),
        @PropertySource("classpath:test-application.yml")
})
@EnableAutoConfiguration
public class IntegrationTestConfiguration {
}

然后Controller的集成测试可以类似如下的写法：

XXXControllerIntegrationTest.java

import org.springframework.test.web.servlet.MockMvc;
import static org.hamcrest.Matchers.hasSize;
import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.get;
import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.jsonPath;
import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.status;
import static org.springframework.test.web.servlet.setup.MockMvcBuilders.standaloneSetup;

public class XXXControllerIntegrationTest extends ApplicationIntegrationTest {
    @Autowired
    private XXXController xxxController;

    @Autowired
    private XXXRepository xxxRepository;

    @Before
    public void setUp() {
        mockMvc = MockMvcBuilders.standaloneSetup(xxxController).build();
    }

    @Test
    public void should_get_xxxs_by_book_xxx() throws Exception {
        xxxRepository.save(new XXX("123456", "This is a integ test"));

        mockMvc.perform(get(format("/xxx/%s/yyys", vvv)))
                .andExpect(status().isOk())
                .andExpect(jsonPath("$", hasSize(1)))
                .andExpect(jsonPath("$[0].uuid").value("123456"))
                .andExpect(jsonPath("$[0].content").value("This is a integ test"));
    }
}

单元测试实现DEMO

单元测试采用JUnit和Mockito测试框架实现.

DefaultXxxServiceTest.java

public class DefaultXxxServiceTest {
    @InjectMocks
    private DefaultXxxService xxxService;

    @Mock
    private XxxRepository xxxRepository;

    @Before
    public void setUp() {
        MockitoAnnotations.initMocks(this);
    }

    @Test
    public void should_retrieve_xxxs_by_yyy_uuid() {
        String yyyUuid = "book123456";
        List<Xxx> expectedXxxs = asList(new Xxx(), new Xxx());
        when(xxxRepository.findByYyy(yyyUuid)).thenReturn(expectedXxxs);

        Iterable<Xxx> xxxs = xxxService.retrieveXxxs(yyyUuid);

        assertThat(xxxs, is(expectedXxxs));
    }
}

Run unit test

./gradlew test, it depends on build task.

Run integration test

./gradlew integrationTest or ./gradlew iT, it depends on build task.

Run build exclude integration test

./gradlew build -x integrationTest or ./gradlew build -x iT