Add JaCoCo for Code Coverage Reports in Pass Core

[tsande16]

This PR will add JaCoCo (Java Code Coverage) to the pass-core project. It is mostly the default configuration for JaCoCo. The reports are aggregated into the jacoco-aggregate-report module. In my research this is the approach to take when setting up an aggregate report to be consumed by a report service like SonarQube.

• Report can be found in target/site/jacoco/index.html in the jacoco-aggregate-report module
  • Reports on individual classes are found in subfolders such as target/site/jacoco/org.eclipse.pass.support.client etc. These can be navigated to by using the index.html
• I removed the coverage ratio so it wouldn't fail the build as we determined in our last status meeting, the first iteration will be just to view the reports and then determine what type of metrics to fail a build.
• There was some minor javadoc added to the FileService.

To generate the reports:

• run mvn verify

[sonarqubecloud]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

[tsande16]

@markpatton @rpoet-jh Where should we put the documentation for this? Perhaps it should have it's own section in the Developer Documentation section, since it's a topic that spans pass-core and pass-support.

[rpoet-jh]

Good job, Tim. Just a couple comments.

[rpoet-jh]

Since pass-core-main depends on all other modules already, did you try putting this jacoco pom config (report-aggregate) into the pass-core-main module pom? I wonder if that may be better if it works so that we don't add another module to pass-core? I know there has been talk about wanting to consolidate the modules into one for pass-core.

[markpatton]

Yes. I'd like to eventually consolidate all the pass-core modules. I don't think the separation has much point. I agree about using pass-core main if possible. In fact I was wondering if it would work in the pass root module to just cover everything.

[tsande16]

@rpoet-jh I will give this a shot and see what happens. I followed this setup from JaCoCo

From my understanding the report aggregation needs to be it's own separate module. When I originally tried doing this I tried setting the project POM to be the aggregator, but that didn't work. From my reading of the docs, if it was setup in pass-core-main it wouldn't generate a report for pass-core-main, but would only collect from the other submodules and place the aggregated report in pass-core-main.

[tsande16]

@markpatton @rpoet-jh This is what happens when I move the aggregation to pass-core-main. It won't create a report for pass-core-main. I've tried playing around with different phases, scopes, with/without the agent in pass-core-main.

[rpoet-jh]

Ok, thanks for trying. When we consolidate the modules in pass-core, we can revisit. I'm fine leaving it like this for now, @markpatton any objection?

[markpatton]

@rpoet-jh @tsande16 No. Let's go for it.

[rpoet-jh]

pass-core uses java 17 atm.

[tsande16]

Good catch. It's interesting that IntelliJ generated that even though my project is set to 17.

[tsande16]

@rpoet-jh I'm reviewing this and it seems like some modules have this property set and other do not. It looks like the majority do not have it set. Should I remove this property altogether?

[tsande16]

Actually the only other POM that has it is in the pass-core-policy submodule. And I'm assuming all this will be inherited from pass-main POM:

<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-compiler-plugin</artifactId>
<version>${maven-compiler-plugin.version}</version>
<configuration>
  <release>17</release>
</configuration>

[rpoet-jh]

@rpoet-jh I'm reviewing this and it seems like some modules have this property set and other do not. It looks like the majority do not have it set. Should I remove this property altogether?

Yeah, I think maven.compiler.source and maven.compiler.target should be removed. Like you said, release will be inherited from the main pom plugin config.

[markpatton]

Agreed.

[sonarqubecloud]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

[tsande16]

@rpoet-jh Following up from our zoom convo from earlier. I tested the question you brought up to see if report aggregation works with tests that exist in another module.

Setup: The FileService tests exist in pass-core-main module. I picked this method which was missing coverage for this one branch:

I added a test for the getFileById() exception logic with a missing ID or file name:

@Test
void testGetFileByIdMissingFileId() {
    ResponseEntity<?> response = passFileServiceController.getFileById("", "file.txt");

    assertEquals(400, response.getStatusCodeValue());
    assertEquals("File ID not provided to get a file.", response.getBody());
}

And it now shows it as covered in the JaCoCo Report: