Merge pull request #363 from marklogic/feature/code-coverage

Giving up on multi-project Sonar code coverage for now

Author: rjrudin

Jenkinsfile

@@ -1,5 +1,7 @@
 @Library('shared-libraries') _
 
+// Using testCodeCoverageReport from the jacoco-report-aggregation plugin to produce an aggregated code coverage
+// report, even though Sonar doesn't seem to be able to make sense of it yet. 
 def runtests(String javaVersion){
   sh label:'test', script: '''#!/bin/bash
     export JAVA_HOME=$'''+javaVersion+'''
@@ -12,7 +14,7 @@ def runtests(String javaVersion){
    ./gradlew -i mlDeploy
    echo "Loading data a second time to try to avoid Optic bug with duplicate rows being returned."
    ./gradlew -i mlLoadData
-   ./gradlew test || true
+   ./gradlew testCodeCoverageReport || true
   '''
   junit '**/build/**/*.xml'
 }

build.gradle

@@ -1,22 +1,13 @@
 plugins {
   id "java-library"
-  id "jacoco-report-aggregation"
   id "org.sonarqube" version "5.1.0.4882"
 }
 
-// See https://docs.gradle.org/current/samples/sample_jvm_multi_project_with_code_coverage_standalone.html .
-// This isn't picking up jacoco coverage of all the subprojects. Will figure that out soon.
-dependencies {
-  jacocoAggregation project(':marklogic-langchain4j')
-  jacocoAggregation project(':marklogic-spark-api')
-  jacocoAggregation project(':marklogic-spark-langchain4j')
-  jacocoAggregation project(':marklogic-spark-connector')
-}
-
 sonar {
   properties {
     property "sonar.projectKey", "marklogic-spark"
     property "sonar.host.url", "http://localhost:9000"
+    property "sonar.coverage.jacoco.xmlReportPaths", "marklogic-spark-connector/build/reports/jacoco/testCodeCoverageReport/testCodeCoverageReport.xml"
   }
 }
 

marklogic-spark-connector/build.gradle

@@ -3,6 +3,12 @@ plugins {
   id 'com.gradleup.shadow' version '8.3.3'
   id "com.marklogic.ml-gradle" version "5.0.0"
   id 'maven-publish'
+
+  // This is working in terms of nicely aggregating jacoco code coverage data from each subproject. It produces a very
+  // nice HTML report under build/reports/jacoco/testCodeCoverageReport. Unfortunately, Sonar doesn't seem able to get
+  // all the coverage data from this directory; it only reports coverage from this project. Something to be figured out
+  // later.
+  id "jacoco-report-aggregation"
 }
 
 configurations {
@@ -26,6 +32,11 @@ configurations.all {
 }
 
 dependencies {
+  // Adding these forces code coverage data to be calculated for these subprojects.
+  jacocoAggregation project(':marklogic-langchain4j')
+  jacocoAggregation project(':marklogic-spark-api')
+  jacocoAggregation project(':marklogic-spark-langchain4j')
+
   // This is compileOnly as any environment this is used in will provide the Spark dependencies itself.
   compileOnly('org.apache.spark:spark-sql_2.12:' + sparkVersion) {
     // Excluded from our ETL tool for size reasons, so excluded here as well to ensure we don't need it.