Generate and upload code coverage report on PRs (#261)

* Adding jacoco plugin for aggregate report generation

* running codecov on pr build

* Explicitly uploading the coverage report

* Adding codecov upload to master build

Author: srprash

.github/workflows/master-build.yml

@@ -17,28 +17,48 @@ jobs:
         java:
           - 8
           - 11
+        include:
+          - os: ubuntu-latest
+            java: 11
+            coverage: true
     steps:
       - name: Checkout Repository
         uses: actions/checkout@v1
+
       - name: Setup java
         uses: actions/setup-java@v1
         with:
           java-version: ${{ matrix.java }}
+
       - name: Cache Gradle Modules
         uses: actions/cache@v1
         with:
           path: ~/.gradle/caches
           key: gradle-caches-${{ hashFiles('**/*.gradle.kts') }}
+
       - name: Cache Gradle Wrapper
         uses: actions/cache@v1
         with:
           path: ~/.gradle/wrapper
           key: gradle-wrapper-${{ hashFiles('gradle/wrapper/gradle-wrapper.properties') }}
+
       - name: Execute Gradle build
-        run: ./gradlew build --stacktrace
+        run: ./gradlew build ${{ matrix.coverage && 'codeCoverageReport' || '' }} --stacktrace
         shell: bash
         env:
           CI: true
+
+      - uses: codecov/codecov-action@v1
+        if: ${{ matrix.coverage }}
+        with:
+          files: ./jacoco/build/reports/jacoco/codeCoverageReport/codeCoverageReport.xml
+
+      - uses: actions/upload-artifact@v2
+        if: ${{ matrix.coverage }}
+        with:
+          name: coverage-report
+          path: jacoco/build/reports/jacoco/codeCoverageReport/html
+
   publish:
     name: Publish snapshots
     runs-on: ubuntu-latest

.github/workflows/pr-build.yml

@@ -17,25 +17,44 @@ jobs:
         java:
           - 8
           - 11
+        include:
+          - os: ubuntu-latest
+            java: 11
+            coverage: true
     steps:
       - name: Checkout Repository
         uses: actions/checkout@v1
+
       - name: Setup java
         uses: actions/setup-java@v1
         with:
           java-version: ${{ matrix.java }}
+
       - name: Cache Gradle Modules
         uses: actions/cache@v1
         with:
           path: ~/.gradle/caches
           key: gradle-caches-${{ hashFiles('**/*.gradle.kts') }}
+
       - name: Cache Gradle Wrapper
         uses: actions/cache@v1
         with:
           path: ~/.gradle/wrapper
           key: gradle-wrapper-${{ hashFiles('gradle/wrapper/gradle-wrapper.properties') }}
+
       - name: Execute Gradle build
-        run: ./gradlew build --stacktrace
+        run: ./gradlew build ${{ matrix.coverage && 'codeCoverageReport' || '' }} --stacktrace
         shell: bash
         env:
           CI: true
+
+      - uses: codecov/codecov-action@v1
+        if: ${{ matrix.coverage }}
+        with:
+          files: ./jacoco/build/reports/jacoco/codeCoverageReport/codeCoverageReport.xml
+
+      - uses: actions/upload-artifact@v2
+        if: ${{ matrix.coverage }}
+        with:
+          name: coverage-report
+          path: jacoco/build/reports/jacoco/codeCoverageReport/html

build.gradle.kts

@@ -302,3 +302,63 @@ allprojects {
         }
     }
 }
+
+subprojects {
+    group = "com.amazonaws"
+
+    plugins.withId("java-library") {
+        plugins.apply("jacoco")
+
+        configure<JacocoPluginExtension> {
+            toolVersion = "0.8.6"
+        }
+
+        // Do not generate reports for individual projects
+        tasks.named("jacocoTestReport") {
+            enabled = false
+        }
+
+        configurations {
+            val implementation by getting
+
+            create("transitiveSourceElements") {
+                isVisible = false
+                isCanBeResolved = false
+                isCanBeConsumed = true
+                extendsFrom(implementation)
+                attributes {
+                    attribute(Usage.USAGE_ATTRIBUTE, objects.named(Usage.JAVA_RUNTIME))
+                    attribute(Category.CATEGORY_ATTRIBUTE, objects.named(Category.DOCUMENTATION))
+                    attribute(DocsType.DOCS_TYPE_ATTRIBUTE, objects.named("source-folders"))
+                }
+                val mainSources = the<JavaPluginConvention>().sourceSets.getByName(SourceSet.MAIN_SOURCE_SET_NAME)
+                mainSources.java.srcDirs.forEach {
+                    outgoing.artifact(it)
+                }
+            }
+
+            create("coverageDataElements") {
+                isVisible = false
+                isCanBeResolved = false
+                isCanBeConsumed = true
+                extendsFrom(implementation)
+                attributes {
+                    attribute(Usage.USAGE_ATTRIBUTE, objects.named(Usage.JAVA_RUNTIME))
+                    attribute(Category.CATEGORY_ATTRIBUTE, objects.named(Category.DOCUMENTATION))
+                    attribute(DocsType.DOCS_TYPE_ATTRIBUTE, objects.named("jacoco-coverage-data"))
+                }
+                // This will cause the test task to run if the coverage data is requested by the aggregation task
+                tasks.withType(Test::class) {
+                    outgoing.artifact(extensions.getByType<JacocoTaskExtension>().destinationFile!!)
+                }
+            }
+
+            configureEach {
+                resolutionStrategy {
+                    failOnVersionConflict()
+                    preferProjectModules()
+                }
+            }
+        }
+    }
+}

jacoco/build.gradle.kts

@@ -0,0 +1,60 @@
+plugins {
+    `java-library`
+}
+
+description = "AWS X-Ray SDK Code Coverage"
+
+dependencies {
+    rootProject.subprojects.forEach { subproject ->
+        // Generate aggregate coverage report for published modules that enable jacoco.
+        subproject.plugins.withId("jacoco") {
+            subproject.plugins.withId("maven-publish") {
+                implementation(project(subproject.path)) {
+                    isTransitive = false
+                }
+            }
+        }
+    }
+}
+
+val sourcesPath by configurations.creating {
+    isVisible = false
+    isCanBeResolved = true
+    isCanBeConsumed = false
+    extendsFrom(configurations.implementation.get())
+    attributes {
+        attribute(Usage.USAGE_ATTRIBUTE, objects.named(Usage.JAVA_RUNTIME))
+        attribute(Category.CATEGORY_ATTRIBUTE, objects.named(Category.DOCUMENTATION))
+        attribute(DocsType.DOCS_TYPE_ATTRIBUTE, objects.named("source-folders"))
+    }
+}
+
+val coverageDataPath by configurations.creating {
+    isVisible = false
+    isCanBeResolved = true
+    isCanBeConsumed = false
+    extendsFrom(configurations.implementation.get())
+    attributes {
+        attribute(Usage.USAGE_ATTRIBUTE, objects.named(Usage.JAVA_RUNTIME))
+        attribute(Category.CATEGORY_ATTRIBUTE, objects.named(Category.DOCUMENTATION))
+        attribute(DocsType.DOCS_TYPE_ATTRIBUTE, objects.named("jacoco-coverage-data"))
+    }
+}
+
+// Task to gather code coverage from multiple subprojects
+val codeCoverageReport by tasks.registering(JacocoReport::class) {
+    additionalClassDirs(configurations.runtimeClasspath.get())
+    additionalSourceDirs(sourcesPath.incoming.artifactView { lenient(true) }.files)
+    executionData(coverageDataPath.incoming.artifactView { lenient(true) }.files.filter { it.exists() })
+
+    reports {
+        // xml is usually used to integrate code coverage with
+        // other tools like SonarQube, Coveralls or Codecov
+        xml.isEnabled = true
+
+        // HTML reports can be used to see code coverage
+        // without any external tools
+        html.isEnabled = true
+    }
+}
+

settings.gradle.kts

@@ -28,3 +28,5 @@ include(":aws-xray-recorder-sdk-metrics")
 
 // Internal project for applying dependency management.
 include(":dependencyManagement")
+// Project for generating aggregated Jacoco code coverage report.
+include(":jacoco")