Building with Maven

If you need to configure a unit test on GUI, perform the following operations:

1. Before configuring a unit test, you need to compile 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 task.

   • The project cannot contain the configuration code of ignoring unit test cases.
     Click the name of the code repository. The Files page of CodeArts Repo is displayed. Verify that the following code does not exist in the pom.xml file of the project:

     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>

   • Click the code repository name. On the Files page of CodeArts Repo, import the JUnit dependency to the pom.xml file. The following shows the code example.

     1 2 3 4 5

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

2. and .
3. Create a unit test class in the src directory.

   The code sample of Demo is as follows:

   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 code sample of DemoTest is as follows:

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

4. In the command window, use # to comment out the mvn package -Dmaven.test.skip=true -U -e -X -B command.

5. Delete # before the #mvn deploy -Dmaven.test.skip=true -U -e -X -B command.

6. Expand Unit Test and set the following parameters:
   • Select Yes for Print Test Results.
   • Configure Ignore Test Failure as required.
     • If Yes is selected, the build task is successful when the test case fails.
     • If No is selected, the build task fails when the test case fails.
   • Configure the path of the unit test result file.

     The test report needs to collect the unit test result to generate a visual report. Therefore, specify the path of the unit test result file.

     • In most cases, retain the default path **/TEST*.xml.
     • To improve the accuracy of the result, you can specify a precise report path, for example, target/surefire-reports/TEST*.xml.
   • Specify whether to print unit test coverage results. For details about the configuration method, see Generating a Unit Test Coverage Report Using JaCoCo.
   • Configure the report location.

     A relative path in the project whose files will all be uploaded. Example: target/site/jacoco

   After the task is successfully executed, you can view the test report on the testing tab page 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.

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:

  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> <goals> <goal>report</goal> </goals> </execution> </executions> </plugin>

  By default, the JaCoCo report goal is bound to the verify phase. You need to change the report goal to the test phase, so that the unit test coverage report can be generated in the target/site/jacoco directory of the code when mvn test is executed.

• 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.

     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>

     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>