From 58157ff310eb1c0968edf9a5c45db56a598f750b Mon Sep 17 00:00:00 2001
From: Darin Kelkhoff <darin.kelkhoff@gmail.com>
Date: Thu, 7 Jul 2022 08:23:54 -0500
Subject: [PATCH] Adding jacoco coverage reporting

---
 pom.xml | 65 ++++++++++++++++++++++++++++++++++++++++++++++++++-------
 1 file changed, 58 insertions(+), 7 deletions(-)

diff --git a/pom.xml b/pom.xml
index d2adfb84..aa639590 100644
--- a/pom.xml
+++ b/pom.xml
@@ -44,6 +44,8 @@
       <maven.compiler.target>17</maven.compiler.target>
       <maven.compiler.showDeprecation>true</maven.compiler.showDeprecation>
       <maven.compiler.showWarnings>true</maven.compiler.showWarnings>
+      <coverage.haltOnFailure>true</coverage.haltOnFailure>
+      <coverage.instructionCoveredRatioMinimum>0.80</coverage.instructionCoveredRatioMinimum>
    </properties>
 
    <dependencies>
@@ -121,6 +123,10 @@
             <groupId>org.apache.maven.plugins</groupId>
             <artifactId>maven-surefire-plugin</artifactId>
             <version>3.0.0-M5</version>
+            <configuration>
+               <!-- Sets the VM argument line used when integration tests are run. -->
+               <argLine>@{jaCoCoArgLine}</argLine>
+            </configuration>
          </plugin>
          <plugin>
             <groupId>org.apache.maven.plugins</groupId>
@@ -174,23 +180,38 @@
             <groupId>org.jacoco</groupId>
             <artifactId>jacoco-maven-plugin</artifactId>
             <version>0.8.8</version>
+            <configuration>
+               <excludes>
+                  <exclude>com/kingsrook/qqq/backend/core/model/**/*.class</exclude>
+                  <exclude>com/kingsrook/qqq/backend/core/exceptions/**/*.class</exclude>
+               </excludes>
+            </configuration>
             <executions>
                <execution>
-                  <id>jacoco-check</id>
+                  <id>pre-unit-test</id>
+                  <goals>
+                     <goal>prepare-agent</goal>
+                  </goals>
+                  <configuration>
+                     <propertyName>jaCoCoArgLine</propertyName>
+                  </configuration>
+               </execution>
+               <execution>
+                  <id>unit-test-check</id>
                   <goals>
                      <goal>check</goal>
                   </goals>
                   <configuration>
+                     <!-- Gives us the ability to pass a parameter to not fail due to coverage E.g. -Dcoverage.haltOnFailure=false -->
+                     <haltOnFailure>${coverage.haltOnFailure}</haltOnFailure>
                      <rules>
                         <rule>
-                           <!-- <element>PACKAGE</element> -->
                            <element>BUNDLE</element>
                            <limits>
                               <limit>
-                                 <!-- <counter>LINE</counter> -->
                                  <counter>INSTRUCTION</counter>
                                  <value>COVEREDRATIO</value>
-                                 <minimum>0.80</minimum>
+                                 <minimum>${coverage.instructionCoveredRatioMinimum}</minimum>
                               </limit>
                            </limits>
                         </rule>
@@ -198,13 +219,43 @@
                   </configuration>
                </execution>
                <execution>
-                  <id>report</id>
-                  <phase>prepare-package</phase>
+                  <id>post-unit-test</id>
+                  <phase>verify</phase>
                   <goals>
                      <goal>report</goal>
                   </goals>
+               </execution>
+            </executions>
+         </plugin>
+         <plugin>
+            <artifactId>exec-maven-plugin</artifactId>
+            <groupId>org.codehaus.mojo</groupId>
+            <version>3.0.0</version>
+            <executions>
+               <execution>
+                  <id>test-coverage-summary</id>
+                  <phase>verify</phase>
+                  <goals>
+                     <goal>exec</goal>
+                  </goals>
                   <configuration>
-                     <outputDirectory>${project.build.directory}/jacoco</outputDirectory>
+                     <executable>sh</executable>
+                     <arguments>
+                        <argument>-c</argument>
+                        <argument>
+                           <![CDATA[
+echo "Element\nInstructions Missed\nInstruction Coverage\nBranches Missed\nBranch Coverage\nComplexity Missed\nComplexity Hit\nLines Missed\nLines Hit\nMethods Missed\nMethods Hit\nClasses Missed\nClasses Hit\n" > /tmp/$$.headers
+xpath -q -e '/html/body/table/tfoot/tr[1]/td/text()' target/site/jacoco/index.html > /tmp/$$.values
+echo
+echo "Jacoco coverage summary report:"
+echo "   See also target/site/jacoco/index.html"
+echo "   and https://www.jacoco.org/jacoco/trunk/doc/counters.html"
+echo "------------------------------------------------------------"
+paste /tmp/$$.headers /tmp/$$.values | tail +2 | awk -v FS='\t' '{printf("%-20s %s\n",$1,$2)}'
+rm /tmp/$$.headers /tmp/$$.values
+                           ]]>
+                        </argument>
+                     </arguments>
                   </configuration>
                </execution>
             </executions>