Add Jacoco code-coverage reports generation and aggregation (temporalio#1171)

Author: Spikhalskiy

.github/workflows/coverage.yml

@@ -0,0 +1,35 @@
+name: Code Coverage
+on:
+  push:
+    branches:
+      - master
+
+jobs:
+  code-coverage:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+
+      - name: Set up Java
+        uses: actions/setup-java@v3
+        with:
+          java-version: '11'
+          distribution: 'temurin'
+
+      - name: Set up Gradle
+        uses: gradle/gradle-build-action@v2
+
+      - name: Run Tests
+        run: ./gradlew test -x checkLicenseMain -x checkLicenses -x spotlessCheck -x spotlessApply -Pjacoco
+        continue-on-error: true
+
+      - name: Run Test Coverage
+        run: ./gradlew testCodeCoverageReport -Pjacoco
+
+      - name: Publish Coverage
+        env:
+          COVERALLS_REPO_TOKEN: ${{ secrets.COVERALLS_REPO_TOKEN }}
+        run: ./gradlew coverallsJacoco -Pjacoco

README.md

@@ -1,4 +1,4 @@
-# Temporal Java SDK  [![Build status](https://badge.buildkite.com/663f6d1be81be6700c28c242b35905f20b68c4fda7b2c7c4e3.svg?branch=master)](https://buildkite.com/temporal/java-sdk-public)
+# Temporal Java SDK  [![Build status](https://badge.buildkite.com/663f6d1be81be6700c28c242b35905f20b68c4fda7b2c7c4e3.svg?branch=master)](https://buildkite.com/temporal/java-sdk-public) [![Coverage Status](https://coveralls.io/repos/github/temporalio/sdk-java/badge.svg?branch=master)](https://coveralls.io/github/temporalio/sdk-java?branch=master)
 
 [Temporal](https://github.com/temporalio/temporal) is a Workflow-as-Code platform for building and operating
 resilient applications using developer-friendly primitives, instead of constantly fighting your infrastructure.

build.gradle

@@ -1,6 +1,7 @@
 buildscript {
     ext {
         palantirGitVersionVersion = "${JavaVersion.current().isCompatibleWith(JavaVersion.VERSION_11) ? '0.15.0' : '0.13.0'}"
+        kotlinVersion = "${JavaVersion.current().isCompatibleWith(JavaVersion.VERSION_16) ? '1.5.32' : '1.4.32'}"
     }
 }
 
@@ -10,6 +11,12 @@ plugins {
     id 'com.palantir.git-version' version "${palantirGitVersionVersion}" apply false
     id 'io.github.gradle-nexus.publish-plugin' version '1.1.0'
     id 'com.diffplug.spotless' version '6.9.0' apply false
+    id 'com.github.nbaztec.coveralls-jacoco' version "1.2.14" apply false
+
+    //    id 'org.jetbrains.kotlin.jvm' version '1.4.32'
+    //    id 'org.jetbrains.kotlin.jvm' version '1.5.32'
+    //    id 'org.jetbrains.kotlin.jvm' version '1.6.20'
+    id 'org.jetbrains.kotlin.jvm' version "${kotlinVersion}" apply false
     id 'base'
 }
 
@@ -50,6 +57,6 @@ apply from: "$rootDir/gradle/errorprone.gradle"
 apply from: "$rootDir/gradle/licensing.gradle"
 apply from: "$rootDir/gradle/publishing.gradle"
 apply from: "$rootDir/gradle/dependencyManagement.gradle"
-if (project.project.hasProperty("jacoco")) {
+if (project.hasProperty("jacoco")) {
     apply from: "$rootDir/gradle/jacoco.gradle"
 }

gradle/jacoco.gradle

@@ -1,4 +1,48 @@
-//./gradlew jacocoTestReport -Pjacoco
+//./gradlew testCodeCoverageReport -Pjacoco
+
+apply plugin: 'jacoco-report-aggregation'
+apply plugin: 'com.github.nbaztec.coveralls-jacoco'
+
+dependencies {
+    jacocoAggregation project(':temporal-kotlin')
+    jacocoAggregation project(':temporal-opentracing')
+    jacocoAggregation project(':temporal-remote-data-encoder')
+    jacocoAggregation project(':temporal-sdk')
+    jacocoAggregation project(':temporal-serviceclient')
+    jacocoAggregation project(':temporal-test-server')
+    jacocoAggregation project(':temporal-testing')
+}
+
+def jacocoExclusions = [
+        '**/io/temporal/api/**',
+        '**/gogoproto/**'
+]
+
+reporting {
+    reports {
+        testCodeCoverageReport(JacocoCoverageReport) {
+            testType = TestSuiteType.UNIT_TEST
+        }
+    }
+}
+
+testCodeCoverageReport {
+    reports {
+        csv.required = true
+        xml.required = true
+    }
+
+    getClassDirectories().setFrom(files(
+            subprojects.collect {it.fileTree(dir: "${it.buildDir}/classes", exclude: jacocoExclusions)}
+    ))
+}
+
+coverallsJacoco {
+    reportPath = "build/reports/jacoco/testCodeCoverageReport/testCodeCoverageReport.xml"
+    reportSourceSets = subprojects.sourceSets.main.allSource.srcDirs.flatten()
+}
+
+tasks.coverallsJacoco.dependsOn(testCodeCoverageReport)
 
 subprojects {
     apply plugin: 'jacoco'
@@ -9,20 +53,22 @@ subprojects {
 
     jacocoTestReport {
         reports {
-            xml.enabled false
+            xml.enabled true
             csv.enabled true
         }
 
         afterEvaluate {
             classDirectories.setFrom(files(classDirectories.files.collect {
-                fileTree(dir: it, exclude: ["**/generated/**"])
+                fileTree(dir: it, exclude: jacocoExclusions)
             }))
         }
     }
 
     test {
         // Some tests don't work with Jacoco.
-        // It's not a bug, they are just written assuming that they are working not with a proxy, but a pure instance
+        // It's not a bug, they are just written assuming that they are working not with a proxy, but a pure instance.
         exclude 'io/temporal/workflow/KotlinAsyncChildWorkflowTest.class'
     }
+
+    testCodeCoverageReport.dependsOn jacocoTestReport
 }

gradle/java.gradle

@@ -53,7 +53,10 @@ subprojects {
             showStandardStreams true
         }
         forkEvery = 1
-        maxParallelForks = Runtime.runtime.availableProcessors().intdiv(2) ?: 1
+
+        var coresDivider = project.hasProperty("jacoco") ? 4 : 2 // penalize jacoco build to reduce load and random timeouts
+        maxParallelForks = Math.max(Runtime.runtime.availableProcessors().intdiv(coresDivider), 1) ?: 1
+
         // Captures the list of failed tests to log after build is done.
         afterTest { TestDescriptor descriptor, TestResult result ->
             if (result.resultType == org.gradle.api.tasks.testing.TestResult.ResultType.FAILURE) {

temporal-kotlin/build.gradle

@@ -1,14 +1,4 @@
-buildscript {
-    ext {
-        kotlinVersion = "${JavaVersion.current().isCompatibleWith(JavaVersion.VERSION_16) ? '1.5.32' : '1.4.32'}"
-    }
-}
-
 plugins {
-//    id 'org.jetbrains.kotlin.jvm' version '1.4.32'
-//    id 'org.jetbrains.kotlin.jvm' version '1.5.32'
-//    id 'org.jetbrains.kotlin.jvm' version '1.6.20'
-    id 'org.jetbrains.kotlin.jvm' version "${kotlinVersion}"
     id 'org.jlleitschuh.gradle.ktlint' version '10.3.0'
 }
 

temporal-sdk/src/main/java/io/temporal/internal/Config.java

@@ -20,7 +20,9 @@
 
 package io.temporal.internal;
 
-public class Config {
+public abstract class Config {
+  private Config() {}
+
   /** Force new workflow task after workflow task timeout multiplied by this coefficient. */
   public static final double WORKFLOW_TAK_HEARTBEAT_COEFFICIENT = 4d / 5d;
 }

temporal-sdk/src/main/java/io/temporal/internal/sync/WorkflowTimers.java

@@ -20,7 +20,9 @@
 
 package io.temporal.worker;
 
-import static org.junit.Assert.assertTrue;
+import static org.hamcrest.CoreMatchers.instanceOf;
+import static org.hamcrest.MatcherAssert.assertThat;
+import static org.junit.Assert.assertThrows;
 
 import io.temporal.activity.ActivityOptions;
 import io.temporal.activity.LocalActivityOptions;
@@ -56,11 +58,9 @@ public void verifyThatLocalActivitiesAreExecuted() {
   @Test
   public void verifyThatNormalActivitiesAreTimedOut() {
     NoArgsWorkflow activityWorkflow = testWorkflowRule.newWorkflowStub(NoArgsWorkflow.class);
-    try {
-      activityWorkflow.execute();
-    } catch (WorkflowFailedException e) {
-      assertTrue(e.getCause().getCause() instanceof TimeoutFailure);
-    }
+    WorkflowFailedException workflowFailedException =
+        assertThrows(WorkflowFailedException.class, activityWorkflow::execute);
+    assertThat(workflowFailedException.getCause().getCause(), instanceOf(TimeoutFailure.class));
   }
 
   @WorkflowInterface

temporal-sdk/src/test/java/io/temporal/worker/LocalActivityWorkerOnlyTest.java

@@ -56,7 +56,7 @@ public class WorkflowTaskFailureBackoffTest {
                   .reportEvery(com.uber.m3.util.Duration.ofMillis(10)))
           .build();
 
-  @Test
+  @Test(timeout = 15_000)
   public void testWorkflowTaskFailureBackoff() {
     testWorkflowTaskFailureBackoffReplayCount = 0;
     WorkflowOptions options =