chore: introduce coverage report/check (#18)

This change uses jacoco to add coverage report/check. Our current line coverage sits at ~70%. I set the minimum line coverage to 70% to ensure future changes align with such requirement. When we have CI enabled, new code that doesn't meet 70% coverage will fail build. Signed-off-by: Keran Yang <[email protected]> Co-authored-by: Vigith Maurice <[email protected]>
numaproj · Feb 13, 2023 · cd508ad · cd508ad
1 parent e4e9ef2
commit cd508ad
Show file tree

Hide file tree

Showing 2 changed files with 54 additions and 0 deletions.
diff --git a/lombok.config b/lombok.config
@@ -0,0 +1,7 @@
+# This tells lombok this directory is the root,
+# no need to look somewhere else for java code.
+config.stopBubbling = true
+# This will add the @lombok.Generated annotation
+# to all the code generated by Lombok,
+# so it can be excluded from coverage by jacoco.
+lombok.addLombokGeneratedAnnotation = true
diff --git a/pom.xml b/pom.xml
@@ -118,6 +118,53 @@
                     </execution>
                 </executions>
             </plugin>
+            <plugin>
+                <groupId>org.jacoco</groupId>
+                <artifactId>jacoco-maven-plugin</artifactId>
+                <version>0.8.7</version>
+                <configuration>
+                    <excludes>
+                        <exclude>io/numaproj/numaflow/sink/v1/*</exclude>
+                        <exclude>io/numaproj/numaflow/function/v1/*</exclude>
+                        <exclude>io/numaproj/numaflow/function/metadata/*</exclude>
+                        <exclude>io/numaproj/numaflow/utils/*</exclude>
+                    </excludes>
+                </configuration>
+                <executions>
+                    <execution>
+                        <goals>
+                            <goal>prepare-agent</goal>
+                        </goals>
+                    </execution>
+                    <execution>
+                        <id>report</id>
+                        <phase>prepare-package</phase>
+                        <goals>
+                            <goal>report</goal>
+                        </goals>
+                    </execution>
+                    <execution>
+                        <id>jacoco-check</id>
+                        <goals>
+                            <goal>check</goal>
+                        </goals>
+                        <configuration>
+                            <rules>
+                                <rule>
+                                    <element>BUNDLE</element>
+                                    <limits>
+                                        <limit>
+                                            <counter>LINE</counter>
+                                            <value>COVEREDRATIO</value>
+                                            <minimum>0.70</minimum>
+                                        </limit>
+                                    </limits>
+                                </rule>
+                            </rules>
+                        </configuration>
+                    </execution>
+                </executions>
+            </plugin>
         </plugins>
 
         <extensions>