使用Maven构建

1. 配置单元测试前，需要在项目中编写单元测试代码，且需满足如下条件：
   • 单元测试用例代码存放位置需满足Maven默认单元测试用例目录规范及命名规范，或自行在配置中指定用例位置。

     如：单元测试用例统一存放在路径为“src/test/java/{{package}}/”，单元测试将在Maven构建过程自动执行。

   • 项目中不可存在忽略单元测试用例的配置代码，即确保以下代码未存在于项目的“pom.xml”文件中。

     1 2 3 4 5 6 7 8

     <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-surefire-plugin</artifactId> <version>2.18.1</version> <configuration> <skipTests>true</skipTests> </configuration> </plugin>

   • “pom.xml”文件中需引入junit依赖，添加的代码示例如下。

     1 2 3 4 5

     <dependency> <groupId>junit</groupId> <artifactId>junit</artifactId> <version>4.13.1</version> </dependency>

     

     junit版本需在4.13.1及以上。

2. 在代码仓中创建单元测试类，如图2所示。
   图2 单元测试文件目录
   

   “Demo.java”文件代码示例如下：

   1 2 3 4 5 6 7 8 9 10 11 12 13 14

   package test; public class Demo { public String test(Integer i) { switch (i) { case 1: return "1"; case 2: return "2"; default: return "0"; } } }

   “DemoTest.java”文件代码示例如下：

   1 2 3 4 5 6 7 8 9 10 11 12 13

   package test; import org.junit.Test; public class DemoTest { private Demo demo=new Demo(); @Test public void test(){ assert demo.test(1).equals("1"); assert demo.test(2).equals("2"); assert demo.test(3).equals("0"); } }

3. 配置构建步骤中的单元测试。
   • 图形化构建
     1. 在“Maven构建”步骤的命令窗口，使用“#”注释命令mvn package -Dmaven.test.skip=true -U -e -X -B。

        

     2. 删除#mvn package -Dmaven.test.failure.ignore=true -U -e -X -B命令前的“#”。

        

     3. 展开“单元测试”，根据实际需求参考表5配置参数。

        表5 单元测试配置参数说明

        参数	说明
        是否处理单元测试结果	配置是否处理单元测试结果。 是：处理。 否：不处理。
        是否忽略用例失败	当选择处理单元测试结果时，需要配置是否忽略用例失败。 是：用例失败时构建任务仍然继续。 否：用例失败时构建任务也失败。
        单元测试结果文件	测试报告需要采集单元测试结果用以生成可视化报告，需在此处填写单元测试结果文件存放路径。 多数情况下，保留默认路径“**/TEST*.xml”即可满足任务需求。为增加结果准确性，可根据实际情况制定精确的报告路径，如：“target/surefire-reports/TEST*.xml”。
        是否处理单元测试覆盖率结果	根据实际需要配置“是否处理单元测试覆盖率结果”，若选“是”，会生成覆盖率测试报告。配置方法请参见使用JaCoCo生成单元测试覆盖率报告。
        单元测试覆盖率报告路径	当选择处理单元测试覆盖率结果时，需填写相对于项目根目录的相对路径，如：target/site/jacoco，选择处理单元测试覆盖率结果后，会将此目录下的所有文件进行打包上传。

   • 代码化构建

     参考以下代码示例，修改在创建代码化构建使用的YAML文件中的BUILD部分代码信息。

     1 2 3 4 5 6 7 8 9 10 11

     version: 2.0 # 必须是2.0 steps: BUILD: - maven: unit_test: coverage: true ignore_errors: false report_path: "**/TEST*.xml" enable: true coverage_report_path: "**/site/jacoco" command: mvn package -Dmaven.test.failure.ignore=true -U -e -X -B

     表6 单元测试参数说明

     参数	类型	说明
     enable	bool	可选参数。 配置是否处理单元测试结果。 true：处理。配置“true”，需要mvn命令末尾增加-Dmaven.test.failure.ignore=true参数。 false：不处理。 默认值：true。
     ignore_errors	bool	可选参数。 配置是否忽略用例失败。 true：忽略，用例失败时构建任务仍然继续。 false：不忽略，用例失败时构建任务也失败 默认值：true。
     report_path	String	填写单元测试数据存储路径。可根据实际情况制定精确的报告路径，如：“target/surefire-reports/TEST*.xml”。
     coverage	bool	可选参数。 配置是否处理覆盖率数据。若配置“true”，配置方法请参见使用JaCoCo生成单元测试覆盖率报告。 true：处理。 false：不处理。 默认值：false。
     coverage_report_path	string	可选参数。 当选择处理单元测试覆盖率结果时，需填写相对于项目根目录的相对路径，如：target/site/jacoco，选择处理单元测试覆盖率结果后，会将此目录下的所有文件进行打包上传。

4. 配置完成后，如果构建任务执行成功，即可在任务执行详情页面的“测试”页签查看测试报告。如果选择了处理单元测试覆盖率报告，会生成覆盖率测试报告，单击“覆盖率报告下载”即可下载。

配置单元测试时，如果选择处理单元测试覆盖率结果，则需要按照如下指导进行配置。

• 单模块项目配置方法

  在项目中已添加jacoco-maven-plugin插件用于生成单元覆盖率报告，即在“pom.xml”文件中添加如下配置：

  JaCoCo的report目标默认是在verify阶段，这里需要将report目标定义为test阶段。

  1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19

  <plugin> <groupId>org.jacoco</groupId> <artifactId>jacoco-maven-plugin</artifactId> <version>0.8.5</version> <executions> <execution> <goals> <goal>prepare-agent</goal> </goals> </execution> <execution> <id>report</id> <phase>test</phase> #定义report目标的阶段 <goals> <goal>report</goal> </goals> </execution> </executions> </plugin>

• 多模块项目配置方法

  假设多模块项目代码结构如下，以此为例为您介绍如何配置生成单元测试覆盖率报告。

  1 2 3 4 5 6 7

  ├── module1 │ └── pom.xml ├── module2 │ └── pom.xml ├── module3 │ └── pom.xml ├── pom.xml

  1. 在项目下添加一个用来聚合的模块，自定义名称如：report，添加聚合模块后的代码结构如下：

     1 2 3 4 5 6 7 8 9

     ├── module1 │ └── pom.xml ├── module2 │ └── pom.xml ├── module3 │ └── pom.xml ├── report │ └── pom.xml ├── pom.xml

  2. 在项目根目录的“pom.xml”文件添加jacoco-maven-plugin插件，代码示例如下。

     1 2 3 4 5 6 7 8 9 10 11 12 13

     <!-- 配置单元测试覆盖率--> <plugin> <groupId>org.jacoco</groupId> <artifactId>jacoco-maven-plugin</artifactId> <version>0.8.3</version> <executions> <execution> <goals> <goal>prepare-agent</goal> </goals> </execution> </executions> </plugin>

  3. 配置聚合模块的“pom.xml”文件。

     以dependency形式引入所有依赖模块，并使用report-aggregate定义JaCoCo聚合目标。

     1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36

     <dependencies> <dependency> <groupId>${project.groupId}</groupId> <artifactId>module1</artifactId> <version>${project.version}</version> </dependency> <dependency> <groupId>${project.groupId}</groupId> <artifactId>module2</artifactId> <version>${project.version}</version> </dependency> <dependency> <groupId>${project.groupId}</groupId> <artifactId>module3</artifactId> <version>${project.version}</version> </dependency> </dependencies> <build> <plugins> <plugin> <groupId>org.jacoco</groupId> <artifactId>jacoco-maven-plugin</artifactId> <version>0.8.3</version> <executions> <execution> <id>report-aggregate</id> <phase>test</phase> <goals> <goal>report-aggregate</goal> </goals> </execution> </executions> </plugin> </plugins> </build>

  4. 配置完成后，在项目根目录下执行mvn test，执行成功后会在“report/target/site/jacoco-aggregate”目录下生成各个模块的覆盖率报告。也可以在outputDirectory中自定义报告的输出路径：

     1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17

     <plugin> <groupId>org.jacoco</groupId> <artifactId>jacoco-maven-plugin</artifactId> <version>0.8.3</version> <executions> <execution> <id>report-aggregate</id> <phase>test</phase> <goals> <goal>report-aggregate</goal> </goals> <configuration> <outputDirectory>target/site/jacoco</outputDirectory> </configuration> </execution> </executions> </plugin>

关于使用Maven构建时的常见问题，可参考使用Maven构建时常见问题。