Add test coverage report (#599)

Author: yux0

.buildkite/pipeline.yml

@@ -8,7 +8,9 @@ steps:
     agents:
       queue: "workers"
       docker: "*"
-    command: "./gradlew --no-daemon test"
+    command: "./gradlew --no-daemon test jacocoTestReport"
+    artifact_paths:
+      - "build/reports/jacoco/test/*.xml"
     timeout_in_minutes: 15
     retry:
       automatic:
@@ -49,3 +51,17 @@ steps:
           run: unit-test-docker-sticky-off
           config: docker/buildkite/docker-compose.yaml
   - wait
+
+  - label: ":java: Report test coverage"
+    agents:
+      queue: "workers"
+      docker: "*"
+    command: ".buildkite/scripts/coverage.sh"
+    retry:
+      automatic:
+        - exit_status: "*"
+          limit: 3
+    plugins:
+      - docker-compose#v3.0.0:
+          run: test-coverage-report
+          config: docker/buildkite/docker-compose.yaml

.buildkite/scripts/coverage.sh

@@ -0,0 +1,15 @@
+#!/bin/sh
+
+set -ex
+
+# download cover files from all the tests
+mkdir -p build/reports/jacoco/test
+buildkite-agent artifact download "build/reports/jacoco/test/jacocoTestReport.xml" . --step ":java: Unit test with test services" --build "$BUILDKITE_BUILD_ID"
+
+echo "download complete"
+
+# report coverage
+./gradlew coverallsJacoco
+
+# cleanup
+rm -rf ./build

README.md

@@ -1,4 +1,4 @@
-# Java framework for Cadence [![Build Status](https://badge.buildkite.com/0c96b8b74c0921208e898c10a602e2fe9ecb7641c2befee0e7.svg?theme=github&branch=master)](https://buildkite.com/uberopensource/cadence-java-client) [![Javadocs](https://www.javadoc.io/badge/com.uber.cadence/cadence-client.svg)](https://www.javadoc.io/doc/com.uber.cadence/cadence-client)
+# Java framework for Cadence [![Build Status](https://badge.buildkite.com/0c96b8b74c0921208e898c10a602e2fe9ecb7641c2befee0e7.svg?theme=github&branch=master)](https://buildkite.com/uberopensource/cadence-java-client) [![Javadocs](https://www.javadoc.io/badge/com.uber.cadence/cadence-client.svg)](https://www.javadoc.io/doc/com.uber.cadence/cadence-client) [![Coverage Status](https://coveralls.io/repos/github/uber/cadence-java-client/badge.svg)](https://coveralls.io/github/uber/cadence-java-client)
 
 
 [Cadence](https://github.com/uber/cadence) is a distributed, scalable, durable, and highly available orchestration engine we developed at Uber Engineering to execute asynchronous long-running business logic in a scalable and resilient way.

build.gradle

@@ -6,16 +6,19 @@ buildscript {
 
 plugins {
     id "com.github.hierynomus.license" version"0.15.0"
+    id 'com.github.nbaztec.coveralls-jacoco' version '1.2.11'
     id 'com.github.sherter.google-java-format' version '0.8'
     id 'net.ltgt.errorprone' version  '1.1.1'
     id 'java-library'
+    id 'jacoco'
 }
 
 repositories {
     maven {
         url 'https://plugins.gradle.org/m2/'
     }
     mavenCentral()
+    jcenter()
 }
 
 apply plugin: 'maven'
@@ -272,4 +275,19 @@ uploadArchives {
     }
 }
 
-//logging.captureStandardOutput LogLevel.INFO
+jacoco {
+    toolVersion = "0.8.2"
+}
+
+jacocoTestReport {
+    reports {
+        xml.enabled = true // coveralls plugin depends on xml format report
+        html.enabled = true
+    }
+
+    afterEvaluate {
+        classDirectories.setFrom(files(classDirectories.files.collect {
+            fileTree(dir: it, excludes: ['com/uber/cadence/shadower/*.class', 'com/uber/cadence/*.class'])
+        }))
+    }
+}

docker/buildkite/docker-compose.yaml

@@ -92,4 +92,34 @@ services:
       - "USER=unittest"
       - "USE_DOCKER_SERVICE=false"
     volumes:
-      - "../../:/cadence-java-client"
+      - "../../:/cadence-java-client"
+
+  test-coverage-report:
+    build:
+      context: ../../
+      dockerfile: ./docker/buildkite/Dockerfile
+    command: "./gradlew --no-daemon test"
+    environment:
+      - "USER=unittest"
+      - "USE_DOCKER_SERVICE=false"
+      - CI
+      - BUILDKITE
+      - BUILDKITE_AGENT_ACCESS_TOKEN
+      - BUILDKITE_JOB_ID
+      - BUILDKITE_BUILD_ID
+      - BUILDKITE_BUILD_NUMBER
+      - BUILDKITE_BRANCH
+      - BUILDKITE_BUILD_URL
+      - BUILDKITE_PROJECT_SLUG
+      - BUILDKITE_COMMIT
+      - BUILDKITE_PULL_REQUEST
+      - BUILDKITE_TAG
+      - BUILDKITE_REPO
+      - BUILDKITE_BUILD_CREATOR
+      - BUILDKITE_BUILD_CREATOR_EMAIL
+      - BUILDKITE_BUILD_CREATOR_TEAMS
+      - BUILDKITE_PULL_REQUEST_REPO
+      - COVERALLS_REPO_TOKEN
+    volumes:
+      - "../../:/cadence-java-client"
+      - /usr/bin/buildkite-agent:/usr/bin/buildkite-agent