From 4abb1414467880fda9ff832e181d31b36b963020 Mon Sep 17 00:00:00 2001
From: softgitron <18495705+softgitron@users.noreply.github.com>
Date: Sun, 14 Feb 2021 12:26:59 +0200
Subject: [PATCH] RATIS-1314. Add JaCoCo coverity tests to Github actions

Restrict only to master and alway return 0

Revert delete temporary artifacts move

Change exit 0 to Actions specific option
---
 .github/workflows/post-commit.yml             |  51 +++++-
 dev-support/checks/sonar.sh                   |   5 +-
 pom.xml                                       |  17 +-
 .../java/org/apache/ratis/conf/ConfUtils.java |   4 +
 ratis-coverage/pom.xml                        | 171 ++++++++++++++++++
 5 files changed, 244 insertions(+), 4 deletions(-)
 create mode 100644 ratis-coverage/pom.xml

diff --git a/.github/workflows/post-commit.yml b/.github/workflows/post-commit.yml
index 7aee48a1d1..55785624b1 100644
--- a/.github/workflows/post-commit.yml
+++ b/.github/workflows/post-commit.yml
@@ -114,6 +114,47 @@ jobs:
         - name: Delete temporary build artifacts
           run: rm -rf ~/.m2/repository/org/apache/ratis
           if: always()
+  coverity:
+    name: coverity
+    runs-on: ubuntu-18.04
+    if: (github.repository == 'apache/ratis' || github.repository == 'apache/incubator-ratis') && github.event_name != 'pull_request'
+    strategy:
+      matrix:
+        profile:
+          - grpc
+          - server
+          - misc
+    steps:
+      - uses: actions/checkout@master
+      - name: Cache for maven dependencies
+        uses: actions/cache@v2
+        with:
+          path: ~/.m2/repository
+          key: maven-repo-${{ hashFiles('**/pom.xml') }}-${{ github.job }}
+          restore-keys: |
+            maven-repo-${{ hashFiles('**/pom.xml') }}
+            maven-repo-
+      - run: >-
+          ./dev-support/checks/unit.sh -P${{ matrix.profile }}-tests
+          -Dmaven.test.failure.ignore=true
+          -Djacoco.skip=false
+          -Dsurefire.rerunFailingTestsCount=3
+        continue-on-error: true
+      - name: Merge JaCoCo results
+        run: mvn -DskipTests -Djacoco.skip=false verify
+      - name: Copy JaCoCo XML report to artifacts
+        run: cp ./ratis-coverage/target/site/jacoco-aggregate/jacoco.xml ./target/unit
+      - name: Summary of failures
+        run: cat target/unit/summary.txt
+        if: ${{ !cancelled() }}
+      - uses: actions/upload-artifact@master
+        if: ${{ !cancelled() }}
+        with:
+          name: coverity-${{ matrix.profile }}
+          path: target/unit
+      - name: Delete temporary build artifacts
+        run: rm -rf ~/.m2/repository/org/apache/ratis
+        if: always()
   checkstyle:
     name: checkstyle
     runs-on: ubuntu-18.04
@@ -161,9 +202,12 @@ jobs:
   sonar:
     name: sonar
     runs-on: ubuntu-18.04
+    needs: [coverity]
     if: (github.repository == 'apache/ratis' || github.repository == 'apache/incubator-ratis') && github.event_name != 'pull_request'
     steps:
-        - uses: actions/checkout@master
+        - uses: actions/checkout@v2
+          with:
+            fetch-depth: 0
         - name: Cache for maven dependencies
           uses: actions/cache@v2
           with:
@@ -172,6 +216,9 @@ jobs:
             restore-keys: |
               maven-repo-${{ hashFiles('**/pom.xml') }}
               maven-repo-
+        - name: Download test artifacts for coverity analysis
+          uses: actions/download-artifact@v2
+          if: always()
         - name: Setup java 11
           uses: actions/setup-java@v1
           with:
@@ -182,4 +229,4 @@ jobs:
             GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
         - name: Delete temporary build artifacts
           run: rm -rf ~/.m2/repository/org/apache/ratis
-          if: always()
+          if: always()
\ No newline at end of file
diff --git a/dev-support/checks/sonar.sh b/dev-support/checks/sonar.sh
index a1f9dbe601..1a6e2cc0c0 100755
--- a/dev-support/checks/sonar.sh
+++ b/dev-support/checks/sonar.sh
@@ -20,4 +20,7 @@ if [ ! "$SONAR_TOKEN" ]; then
   echo "SONAR_TOKEN environment variable should be set"
   exit 1
 fi
-mvn -B verify -DskipShade -DskipTests org.sonarsource.scanner.maven:sonar-maven-plugin:3.6.0.1398:sonar -Dsonar.host.url=https://sonarcloud.io -Dsonar.organization=apache -Dsonar.projectKey=apache-ratis
+mvn -B verify -DskipShade -DskipTests org.sonarsource.scanner.maven:sonar-maven-plugin:3.6.0.1398:sonar \
+-Dsonar.host.url=https://sonarcloud.io \
+-Dsonar.coverage.jacoco.xmlReportPaths=$(find "$(pwd)" -path '*jacoco.xml' | tr '\n' ',') \
+-Dsonar.organization=apache -Dsonar.projectKey=apache-ratis
diff --git a/pom.xml b/pom.xml
index bd9b95fcac..72f8be5db0 100644
--- a/pom.xml
+++ b/pom.xml
@@ -78,6 +78,7 @@
     <module>ratis-resource-bundle</module>
     <module>ratis-grpc</module>
     <module>ratis-netty</module>
+    <module>ratis-coverage</module>
     <module>ratis-hadoop</module>
 
     <module>ratis-test</module>
@@ -249,6 +250,8 @@
     <!-- LOG4J version -->
     <log4j.version>1.2.17</log4j.version>
 
+    <!-- Skip JaCoCo coverity reports by default -->
+    <jacoco.skip>true</jacoco.skip>
   </properties>
 
   <dependencyManagement>
@@ -703,7 +706,7 @@
             <reuseForks>false</reuseForks>
             <trimStackTrace>false</trimStackTrace>
             <forkedProcessTimeoutInSeconds>600</forkedProcessTimeoutInSeconds>
-            <argLine>-Xmx2048m -XX:+HeapDumpOnOutOfMemoryError</argLine>
+            <argLine>@{argLine} -Xmx2048m -XX:+HeapDumpOnOutOfMemoryError</argLine>
             <systemPropertyVariables>
               <ratis.log.dir>${project.build.directory}/log</ratis.log.dir>
               <ratis.tmp.dir>${project.build.directory}/tmp</ratis.tmp.dir>
@@ -907,6 +910,18 @@
           </execution>
         </executions>
       </plugin>
+      <plugin>
+        <groupId>org.jacoco</groupId>
+        <artifactId>jacoco-maven-plugin</artifactId>
+        <version>0.8.6</version>
+        <executions>
+          <execution>
+            <goals>
+              <goal>prepare-agent</goal>
+            </goals>
+          </execution>
+        </executions>
+      </plugin>
     </plugins>
   </build>
 
diff --git a/ratis-common/src/main/java/org/apache/ratis/conf/ConfUtils.java b/ratis-common/src/main/java/org/apache/ratis/conf/ConfUtils.java
index b662dffdd0..9546109dd3 100644
--- a/ratis-common/src/main/java/org/apache/ratis/conf/ConfUtils.java
+++ b/ratis-common/src/main/java/org/apache/ratis/conf/ConfUtils.java
@@ -266,6 +266,10 @@ static void printAll(Class<?> confClass, Consumer<Object> out) {
 
   static void printField(Class<?> confClass, Consumer<Object> out, Field f) {
     final int modifiers = f.getModifiers();
+    // Ignore synthetic fields. Required by JaCoCo coverity reports
+    if (f.isSynthetic()) {
+      return;
+    }
     if (!Modifier.isStatic(modifiers)) {
       throw new IllegalStateException("Found non-static field " + f);
     }
diff --git a/ratis-coverage/pom.xml b/ratis-coverage/pom.xml
new file mode 100644
index 0000000000..588c49e11a
--- /dev/null
+++ b/ratis-coverage/pom.xml
@@ -0,0 +1,171 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+  Licensed under the Apache License, Version 2.0 (the "License");
+  you may not use this file except in compliance with the License.
+  You may obtain a copy of the License at
+    http://www.apache.org/licenses/LICENSE-2.0
+  Unless required by applicable law or agreed to in writing, software
+  distributed under the License is distributed on an "AS IS" BASIS,
+  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+  See the License for the specific language governing permissions and
+  limitations under the License. See accompanying LICENSE file.
+-->
+<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+    <modelVersion>4.0.0</modelVersion>
+    <parent>
+        <artifactId>ratis</artifactId>
+        <groupId>org.apache.ratis</groupId>
+        <version>2.1.0-SNAPSHOT</version>
+    </parent>
+
+    <artifactId>report</artifactId>
+    <name>Apache Ratis Coverity Report</name>
+
+
+    <dependencies>
+        <!-- Intra-project dependencies -->
+        <dependency>
+            <groupId>org.apache.ratis</groupId>
+            <artifactId>ratis-thirdparty-misc</artifactId>
+        </dependency>
+        <dependency>
+            <groupId>org.apache.ratis</groupId>
+            <artifactId>ratis-resource-bundle</artifactId>
+            <version>${project.version}</version>
+            <optional>true</optional>
+        </dependency>
+        <dependency>
+            <artifactId>ratis-docs</artifactId>
+            <groupId>org.apache.ratis</groupId>
+        </dependency>
+        <dependency>
+            <artifactId>ratis-proto</artifactId>
+            <groupId>org.apache.ratis</groupId>
+        </dependency>
+        <dependency>
+            <artifactId>ratis-common</artifactId>
+            <groupId>org.apache.ratis</groupId>
+        </dependency>
+        <dependency>
+            <artifactId>ratis-common</artifactId>
+            <groupId>org.apache.ratis</groupId>
+            <type>test-jar</type>
+        </dependency>
+
+        <dependency>
+            <artifactId>ratis-client</artifactId>
+            <groupId>org.apache.ratis</groupId>
+        </dependency>
+        <dependency>
+            <artifactId>ratis-client</artifactId>
+            <groupId>org.apache.ratis</groupId>
+            <type>test-jar</type>
+        </dependency>
+        <dependency>
+            <artifactId>ratis-server</artifactId>
+            <groupId>org.apache.ratis</groupId>
+        </dependency>
+        <dependency>
+            <artifactId>ratis-server</artifactId>
+            <groupId>org.apache.ratis</groupId>
+            <type>test-jar</type>
+        </dependency>
+
+        <dependency>
+            <artifactId>ratis-grpc</artifactId>
+            <groupId>org.apache.ratis</groupId>
+        </dependency>
+        <dependency>
+            <artifactId>ratis-grpc</artifactId>
+            <groupId>org.apache.ratis</groupId>
+            <type>test-jar</type>
+        </dependency>
+
+        <dependency>
+            <artifactId>ratis-netty</artifactId>
+            <groupId>org.apache.ratis</groupId>
+        </dependency>
+        <dependency>
+            <artifactId>ratis-netty</artifactId>
+            <groupId>org.apache.ratis</groupId>
+            <type>test-jar</type>
+        </dependency>
+
+        <dependency>
+            <artifactId>ratis-hadoop</artifactId>
+            <groupId>org.apache.ratis</groupId>
+        </dependency>
+        <dependency>
+            <artifactId>ratis-hadoop</artifactId>
+            <groupId>org.apache.ratis</groupId>
+            <type>test-jar</type>
+        </dependency>
+
+        <dependency>
+            <artifactId>ratis-test</artifactId>
+            <groupId>org.apache.ratis</groupId>
+        </dependency>
+        <dependency>
+            <artifactId>ratis-test</artifactId>
+            <groupId>org.apache.ratis</groupId>
+            <type>test-jar</type>
+        </dependency>
+
+        <dependency>
+            <artifactId>ratis-examples</artifactId>
+            <groupId>org.apache.ratis</groupId>
+        </dependency>
+        <dependency>
+            <artifactId>ratis-examples</artifactId>
+            <groupId>org.apache.ratis</groupId>
+            <type>test-jar</type>
+        </dependency>
+
+        <dependency>
+            <artifactId>ratis-replicated-map</artifactId>
+            <groupId>org.apache.ratis</groupId>
+        </dependency>
+        <dependency>
+            <artifactId>ratis-replicated-map</artifactId>
+            <groupId>org.apache.ratis</groupId>
+            <type>test-jar</type>
+        </dependency>
+
+        <dependency>
+            <artifactId>ratis-logservice</artifactId>
+            <groupId>org.apache.ratis</groupId>
+        </dependency>
+        <dependency>
+            <artifactId>ratis-logservice</artifactId>
+            <groupId>org.apache.ratis</groupId>
+            <type>test-jar</type>
+        </dependency>
+        <dependency>
+            <groupId>org.apache.ratis</groupId>
+            <artifactId>ratis-metrics</artifactId>
+        </dependency>
+        <dependency>
+            <groupId>org.apache.ratis</groupId>
+            <artifactId>ratis-tools</artifactId>
+        </dependency>
+    </dependencies>
+
+    <build>
+        <plugins>
+            <plugin>
+                <groupId>org.jacoco</groupId>
+                <artifactId>jacoco-maven-plugin</artifactId>
+                <executions>
+                    <execution>
+                        <id>report</id>
+                        <phase>verify</phase>
+                        <goals>
+                            <goal>report-aggregate</goal>
+                        </goals>
+                    </execution>
+                </executions>
+            </plugin>
+        </plugins>
+    </build>
+
+</project>
\ No newline at end of file