Building with Maven

The Maven build action leverages unit tests to ensure that your code's core functions operate as expected. Within a Maven project, testing frameworks like JUnit are used to write and execute these tests.

1. Before configuring a unit test, you need to write unit test code in the project and ensure that the following conditions are met:
   • The storage location of unit test code must comply with the default unit test case directory specifications and naming specifications of Maven. You can specify the case location in the configuration.

     For example, if the unit test cases are stored in src/test/java/{{package}}/, the unit test is automatically executed during a Maven build.

   • The project cannot contain the configuration code for ignoring unit test cases. Specifically, ensure that the pom.xml file of the project does not contain the following code:

     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>

   • The JUnit dependency needs to be added to the pom.xml file. The following is the sample code that needs to be added:

     1 2 3 4 5

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

2. Create a unit test class in the code repository, as shown in Figure 2.
   Figure 2 Unit test file directory
   

   The following sample code is from the Demo.java file:

   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"; } } }

   The following sample code is from the DemoTest.java file:

   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. Configure a unit test in the build action.
   • Build on GUI
     1. In the command window displayed in action Build with Maven, use the number sign (#) to comment out the mvn package -Dmaven.test.skip=true -U -e -X -B command.

        

     2. Delete the number sign (#) before the #mvn package -Dmaven.test.failure.ignore=true -U -e -X -B command.

        

     3. Expand Unit Test and set the following parameters Table 5.

        Table 5 Parameters for unit test configuration

        Parameter	Description
        Print Test Results	Specify whether to process unit test results. Yes: Process unit test results. No: Do not process unit test results.
        Ignore Test Failure	If you choose to process the unit test result, you need to configure whether to ignore the case failure. Yes: If the case fails, the build task will continue. No: If the case fails, the build task will also fail.
        Test Report	The unit test results are aggregated into a visual test report. To retrieve these results, you need to specify the path of the unit test result files. In most cases, retain the default path **/TEST*.xml. To improve the accuracy of the result, specify a precise report path, for example, target/surefire-reports/TEST*.xml.
        Print Unit Test Results	Specify whether to process unit test coverage results. If you select Yes, a coverage test report is generated. For details about the configuration, see Generating a Unit Test Coverage Report Using JaCoCo.
        Report Location	If you choose to process the unit test coverage results, enter the relative path to the project root directory, for example, target/site/jacoco. Once you have done this, all files in that directory will be packaged and uploaded.

   • Build with Code

     Modify the code in the BUILD block in Creating a YAML File for Your Code-based Build by referring to the following sample code:

     1 2 3 4 5 6 7 8 9 10 11

     version: 2.0 # The value must be 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

     Table 6 Unit test parameters

     Parameter	Type	Description
     enable	Bool	Optional. Specify whether to process unit test results. true: Process unit test results. To set this parameter to true, add the -Dmaven.test.failure.ignore=true parameter to the end of the mvn command. false: Do not process unit test results. The default value is true.
     ignore_errors	Bool	Optional. Specify whether to ignore test failure. true: Ignore test failure. If the case fails, the build task will continue. false: Do not ignore test failure. If the case fails, the build task will also fail. The default value is true.
     report_path	String	Enter the path for storing unit test data. Specify an accurate report path, for example, target/surefire-reports/TEST*.xml.
     coverage	Bool	Optional. Specify whether to process coverage data. If you want to set this parameter to true, see Generating a Unit Test Coverage Report Using JaCoCo. true: Process coverage data. false: Do not process coverage data. The default value is false.
     coverage_report_path	String	Optional. If you choose to process the unit test coverage results, enter the relative path to the project root directory, for example, target/site/jacoco. Once you have done this, all files in that directory will be packaged and uploaded.

4. Once the task is successfully completed, you can access the test report on the testing tab of the task execution details page. When you opt to print the unit test coverage report, a report is generated. You can download it by clicking the button for downloading the test coverage report.

The unit test coverage report distinguishes between the code that has been exercised through unit tests and those that have not been covered. It helps you understand whether your tests have checked all code paths and logic.

If you set Print Unit Test Results to Yes, complete configurations as follows:

• Configuration method for a single-module project

  To generate the unit coverage report, add jacoco-maven-plugin to the project by including the following configuration to the pom.xml file.

  By default, the JaCoCo report goal is bound to the verify phase. You need to change the report goal to the test phase.

  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> #It defines the target phase of the report. <goals> <goal>report</goal> </goals> </execution> </executions> </plugin>

• Configuration method for a multi-module project

  Assume that the code structure of a multi-module project looks like the following example. You will walk through how to configure and generate a unit test report.

  1 2 3 4 5 6 7

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

  1. Add an aggregation module named report to the project. Your code directory structure then looks like this:

     1 2 3 4 5 6 7 8 9

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

  2. Add jacoco-maven-plugin to the pom.xml file in the root directory of the project. The following is a code sample:

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

     <!-- Configure unit test coverage--> <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. Configure the pom.xml file of the aggregation module.

     Use dependency elements to introduce all dependency modules and use report-aggregate to define the JaCoCo aggregation goal.

     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. Once the configuration is completed, run mvn test in the root directory of the project. After the command is successfully executed, the coverage report of each module is generated in the report/target/site/jacoco-aggregate directory. You can also customize an output path for the reports by configuring 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>