• 单元测试教程
    • 示例项目
    • 技术
    • pom依赖和插件
    • 目录结构
    • 编写测试groovy脚本
    • 其他
    • spock其他用法
    • 参考

    单元测试教程

    示例项目

    asgard-service

    技术

    框架：spock

    语言：groovy

    pom依赖和插件

    1. <!-- Test Dependencies -->
    2.  <dependencies>
    3.         <dependency>
    4.             <groupId>org.springframework.boot</groupId>
    5.             <artifactId>spring-boot-starter-test</artifactId>
    6.             <scope>test</scope>
    7.         </dependency>
    8.         <dependency>
    9.             <groupId>io.choerodon</groupId>
    10.             <artifactId>choerodon-liquibase</artifactId>
    11.             <version>${choerodon.starters.version}</version>
    12.             <scope>test</scope>
    13.         </dependency>
    14.         <dependency>
    15.             <groupId>com.h2database</groupId>
    16.             <artifactId>h2</artifactId>
    17.             <version>1.4.197</version>
    18.             <scope>test</scope>
    19.         </dependency>
    20.         <dependency>
    21.             <groupId>org.spockframework</groupId>
    22.             <artifactId>spock-core</artifactId>
    23.             <version>1.1-groovy-2.4-rc-2</version>
    24.             <scope>test</scope>
    25.         </dependency>
    26.         <dependency>
    27.             <groupId>org.spockframework</groupId>
    28.             <artifactId>spock-spring</artifactId>
    29.             <version>1.1-groovy-2.4-rc-3</version>
    30.             <scope>test</scope>
    31.         </dependency>
    32.         <!-- https://mvnrepository.com/artifact/cglib/cglib-nodep -->
    33.         <dependency>
    34.             <groupId>cglib</groupId>
    35.             <artifactId>cglib-nodep</artifactId>
    36.             <version>2.2</version>
    37.             <scope>test</scope>
    38.         </dependency>
    39.    </dependencies>
    41.    <build>
    42.            <finalName>app</finalName>
    43.            <plugins>
    44.                <plugin>
    45.                    <groupId>org.codehaus.gmavenplus</groupId>
    46.                    <artifactId>gmavenplus-plugin</artifactId>
    47.                    <version>1.5</version>
    48.                    <executions>
    49.                        <execution>
    50.                            <goals>
    51.                                <goal>addTestSources</goal>
    52.                                <goal>testCompile</goal>
    53.                            </goals>
    54.                        </execution>
    55.                    </executions>
    56.                </plugin>
    57.                <plugin>
    58.                    <groupId>org.apache.maven.plugins</groupId>
    59.                    <artifactId>maven-compiler-plugin</artifactId>
    60.                    <version>3.3</version>
    61.                    <configuration>
    62.                        <source>1.8</source>
    63.                        <target>1.8</target>
    64.                    </configuration>
    65.                </plugin>
    66.                <plugin>
    67.                    <groupId>org.apache.maven.plugins</groupId>
    68.                    <artifactId>maven-surefire-plugin</artifactId>
    69.                    <version>2.18.1</version>
    70.                    <configuration>
    71.                        <includes>
    72.                            <include>**/*Test.java</include>
    73.                            <include>**/*Spec.java</include>
    74.                        </includes>
    75.                    </configuration>
    76.                </plugin>
    77.            </plugins>
    78.        </build>

    目录结构

    单元测试教程 - 图1

    IntegrationTestConfiguration.groovy

    1. @TestConfiguration
    2. @Import(LiquibaseConfig)
    3. class IntegrationTestConfiguration {
    5.     private final detachedMockFactory = new DetachedMockFactory()
    7.     @Value('${choerodon.oauth.jwt.key:choerodon}')
    8.     String key
    10.     @Autowired
    11.     TestRestTemplate testRestTemplate
    13.     @Autowired
    14.     LiquibaseExecutor liquibaseExecutor
    16.     final ObjectMapper objectMapper = new ObjectMapper()
    18.     //Mock KafkaTemplate, 以防spring-for-kafka影响报错
    19.     @Bean
    20.     KafkaTemplate kafkaTemplate() {
    21.         detachedMockFactory.Mock(KafkaTemplate)
    22.     }
    24.     @PostConstruct
    25.     void init() {
    26.         //通过liquibase初始化h2数据库
    27.         liquibaseExecutor.execute()
    28.         //给TestRestTemplate的请求头部添加JWT
    29.         setTestRestTemplateJWT()
    30.     }
    32.     private void setTestRestTemplateJWT() {
    33.         testRestTemplate.getRestTemplate().setRequestFactory(new HttpComponentsClientHttpRequestFactory())
    34.         testRestTemplate.getRestTemplate().setInterceptors([new ClientHttpRequestInterceptor() {
    35.             @Override
    36.             ClientHttpResponse intercept(HttpRequest httpRequest, byte[] bytes, ClientHttpRequestExecution clientHttpRequestExecution) throws IOException {
    37.                 httpRequest.getHeaders()
    38.                         .add('JWT_Token', createJWT(key, objectMapper))
    39.                 return clientHttpRequestExecution.execute(httpRequest, bytes)
    40.             }
    41.         }])
    42.     }
    44.     static String createJWT(final String key, final ObjectMapper objectMapper) {
    45.         Signer signer = new MacSigner(key)
    46.         CustomUserDetails defaultUserDetails = new CustomUserDetails('default', 'unknown', Collections.emptyList())
    47.         defaultUserDetails.setUserId(0L)
    48.         defaultUserDetails.setOrganizationId(0L)
    49.         defaultUserDetails.setLanguage('zh_CN')
    50.         defaultUserDetails.setTimeZone('CCT')
    51.         String jwtToken = null
    52.         try {
    53.             jwtToken = 'Bearer ' + JwtHelper.encode(objectMapper.writeValueAsString(defaultUserDetails), signer).getEncoded()
    54.         } catch (IOException e) {
    55.             e.printStackTrace()
    56.         }
    57.         return jwtToken
    58.     }
    60. }

    application-test.yml

    1. spring:
    2.   cloud:
    3.     bus:
    4.       enabled: false # 关闭bus,否则kafka报错
    5.   sleuth:
    6.     stream:
    7.       enabled: false # 关闭zipkin，否则kafka报错
    8.   datasource:  # 使用内存数据库h2
    9.     password: sa
    10.     url: jdbc:h2:mem:testdb;DB_CLOSE_DELAY=-1;MODE=Mysql;TRACE_LEVEL_SYSTEM_OUT=2;
    11.     username: sa
    12.   autoconfigure: # 关闭LiquibaseAutoConfiguration和KafkaAutoConfiguration的自动化配置
    13.     exclude: org.springframework.boot.autoconfigure.liquibase.LiquibaseAutoConfiguration,org.springframework.boot.autoconfigure.kafka.KafkaAutoConfiguration
    14. hystrix:
    15.   stream:
    16.     queue:
    17.       enabled: false # 关闭hystrix stream，否则kafka报错
    18. data:
    19.   dir: src/main/resources
    20. eureka:
    21.   client:
    22.     enabled: false # 关闭eureka

    编写测试groovy脚本

    添加注解@SpringBootTest(webEnvironment = RANDOM_PORT)和@Import(IntegrationTestConfiguration)。继承Specification且类名为Spec后缀。注入所需要测试的类对象通过given(前提条件),when(触发条件),then(期望结果)。

    1. @SpringBootTest(webEnvironment = RANDOM_PORT)
    2. @Import(IntegrationTestConfiguration)
    3. class SagaTaskMapperSpec extends Specification {
    5.     @Autowired
    6.     SagaTaskMapper sagaTaskMapper
    8.     def 'insert'() {
    9.         given: '创建一个bean'
    10.          SagaTask sagaTask = new SagaTask()
    11.         def testCode = 'test_code'
    12.         def testSagaCode = 'test_saga_code'
    13.         sagaTask.setCode(testCode)
    14.         sagaTask.setSagaCode(testSagaCode)
    15.         sagaTask.setSeq(1)
    16.         sagaTask.setIsEnabled(true)
    17.         sagaTask.setMaxRetryCount(1)
    19.         when: '插入数据库'
    20.         sagaTaskMapper.insert(sagaTask)
    22.         then: '返回ID'
    23.         sagaTask.getId() != null
    25.         when: '根据ID在数据库查询'
    26.         def data = sagaTaskMapper.selectByPrimaryKey(sagaTask.getId())
    28.         then: '对比数据'
    29.         data.getCode() == testCode
    30.         data.getSagaCode() == testSagaCode
    31.         data.getSeq() == 1
    32.         data.getIsEnabled()
    33.         data.getMaxRetryCount() == 1
    34.     }
    35. }

    其他

    如果在idea不能直接编译运行测试groovy文件，可能是因idea没有识别test/groovy目录。

    单元测试教程 - 图2

    spock其他用法

    • @Shared：多个测试方法中共享数据

    • @Stepwise: 当测试方法间存在依赖关系时，标明测试方法将严格按照其在源代码中声明的顺序执行

    • setupSpec(): 设置每个测试类的环境

    • setup(): 设置每个测试方法的环境，每个测试方法执行一次

    • cleanup(): 清理每个测试方法的环境，每个测试方法执行一次

    • cleanupSepc(): 清理每个测试类的环境

    • @Ignore: 忽略测试方法

    • @IgnoreRest：只测试这个方法，而忽略所有其他方法

    • @Timeout： 设置测试方法的超时时间，默认单位为秒

    参考

    https://blog.csdn.net/u012129558/article/details/78675421

    http://blog.codepipes.com/testing/spock-vs-junit.html