Add JaCoCo for Code Coverage Reports in Pass Support

[tsande16]

This PR will add JaCoCo (Java Code Coverage) to the pass-support 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
  • Reports on individual classes are found in subfolders such as target/site/jacoco/org.eclipse.pass.support.client etc. These can be nagivated 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.

Other important notes: I had to update the dockerfile: pass-journal-loader/pass-journal-loader-nih/Dockerfile. I couldn't get it to work any other way locally, however I'm not sure if this is the best approach.

To generate the reports:

• run mvn verify

[markpatton]

It would be better not to copy all of target into the image and instead just pick out what you need.

[markpatton]

Maybe that copy glob pattern doesn't work cross-platform? One solution would be to update the pom such that the executable jar which is produced has a set name.

[rpoet-jh]

Not sure why this change was made for this PR. Maybe a mistaken commit?

[rpoet-jh]

I see the comment in the description. I will work with Tim to troubleshoot. It must have been something strange in Tim's docker env. The other modules have the same pattern of copying. The * is used so we can leave the version in the exec jar file (there will only be one file that matches in target).

[tsande16]

I'm running the latest docker which was recently update on 1/9 prior to me making this change. I tested running mvn verify on the pass-journal-loader module and it passed with the original docker statements. I'm now testing mvn verify on pass-support altogether.

Side note: Docker for Windows apparently just has intermittent problems. On some versions I never experience issues and then it will update and I'm plagued with a whole variety of problems.

[tsande16]

@rpoet-jh @markpatton Reverted back to the previous version. I tested a couple times and it's now passing.

[rpoet-jh]

Because this repeats in all modules, did you try defining this in a pluginManagement element in pass-support/pom.xml and then defining the plugin in the child modules (exception would be jacoco-aggregate-report which would remain as is)?

[tsande16]

No I haven't, I can give this a try and see if it works!

[tsande16]

Very cool, this worked! Nice find!

[markpatton]

Tests pass for me locally. I agree with Russ about checking if the pom changes can be consolidated.

[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

[rpoet-jh]

Since this pom looks like it requires the plugin declaration in the plugins element too (line 109), you can remove the pluginManagement element and put the <version>${jacoco-maven-plugin.version}</version> below in the plugins section.

[tsande16]

I tried this 4 different ways, and here were the results:

With only the plugin without the agent in the root POM

<plugin>
  <groupId>org.jacoco</groupId>
  <artifactId>jacoco-maven-plugin</artifactId>
  <version>${jacoco-maven-plugin.version}</version>
</plugin>

---

With only the plugin in the pluginManagement tag in the root POM

<pluginManagement>
  <plugins>
    <plugin>
      <groupId>org.jacoco</groupId>
      <artifactId>jacoco-maven-plugin</artifactId>
      <version>${jacoco-maven-plugin.version}</version>
    </plugin>
  </plugins>
</pluginManagement>

---

Plugin with agent only in the root POM

Test now....

---

With pluginManagement and the agent in plugin tags in the root POM

<build>
  <pluginManagement>
    <plugins>
      <plugin>
        <groupId>org.jacoco</groupId>
        <artifactId>jacoco-maven-plugin</artifactId>
        <version>${jacoco-maven-plugin.version}</version>
      </plugin>
    </plugins>
  </pluginManagement>

  <plugins>
    <plugin>
      <groupId>org.jacoco</groupId>
      <artifactId>jacoco-maven-plugin</artifactId>
      <executions>
        <execution>
          <id>prepare-agent</id>
          <goals>
            <goal>prepare-agent</goal>
          </goals>
        </execution>
      </executions>
    </plugin>

[rpoet-jh]

I'd remove these line feeds in the children pom.xml file.

[tsande16]

Done.

[rpoet-jh]

You can remove the version element here.

[tsande16]

Done.