How to debug sonar codeCoverage not coming through in multimodule java gradle project

lievenvaneeckhaute · May 19, 2024, 2:18pm

When I run sonar it’s reporting 0 coverage despite in the logs it claims to find the report.

I see this in a simple multimodule gradle project.

Runs in gitlab.

Scanner command used when applicable (private details masked)
gradle test jacocoTestReport sonar
Languages of the repository
Java
Only if the SonarCloud project is public, the URL
private
Error observed (wrap logs/code around with triple quotes ``` for proper formatting)
No coverage
Steps to reproduce
Root project gradle file:

plugins {
	java
	jacoco
	id("org.sonarqube") version "5.0.0.4638"
...
}
...
sonar {
	properties {
		property("sonar.projectKey", "COMPANY_project")
		property("sonar.organization", "COMPANY")
		property("sonar.binaries", "main/build/classes")
		property("sonar.tests", "junit")
		property("sonar.junit.reportsPath", "main/build/test-results")
		property("sonar.java.coveragePlugin", "jacoco")
		property("sonar.gradle.skipCompile", "true")
		property("sonar.coverage.jacoco.xmlReportPaths", "main/build/reports/jacoco/test/jacocoTestReport.xml")
	}
tasks.test {
	finalizedBy(tasks.jacocoTestReport) // report is always generated after tests run
}
tasks.jacocoTestReport {
	dependsOn(tasks.test) // tests are required to run before generating the report
}

tasks.sonar.configure {
	dependsOn(tasks.jacocoTestReport)
}

tasks.jacocoTestReport {
	reports {
		xml.required = true
	}
}

}

Child module:

plugins {
	java
	jacoco
...
}
...
tasks.jacocoTestReport {
	reports {
		xml.required = true
	}
}

In the logs it shows it’s actually picking up the report:

2024-05-19T15:58:59.108+0200 [INFO] [org.sonarqube.gradle.SonarTask] Sensor JaCoCo XML Report Importer [jacoco]
2024-05-19T15:58:59.109+0200 [INFO] [org.sonarqube.gradle.SonarTask] Importing 1 report(s). Turn your logs in debug mode in order to see the exhaustive list.
2024-05-19T15:58:59.109+0200 [DEBUG] [org.sonarqube.gradle.SonarTask] Reading report '.../main/build/reports/jacoco/test/jacocoTestReport.xml'
2024-05-19T15:58:59.118+0200 [INFO] [org.sonarqube.gradle.SonarTask] Sensor JaCoCo XML Report Importer [jacoco] (done) | time=10ms

Yet still it always reports No coverage.
Any ideas? I’ve tried all guides I could find so far.
Works properly in a project with no submodules.
Do not share screenshots of logs – share the text itself (bonus points for being well-formatted)!

ganncamp · May 20, 2024, 3:04pm

Hi,

Welcome to the community!

I suspect this is about paths. Specifically, the paths in the coverage report likely don’t match the paths the analysis is seeing. Unfortunately, you’ll have to generate a --debug log to see whether or not this is the case. Yes, I know, debug logs are hideous in Gradle. Unfortunately, that’s the next step here.

Ann

lievenvaneeckhaute · May 21, 2024, 11:50am

Hi Ann, I’ve enabled debugging.
Can you share what exactly I’m looking for in the logs? I’d rather not share a debug log with the world. I can send it privately if that’s useful. Meanwhile I’m looking if I can setup a minimal gitlab project that has nothing sensitive in it. Or perhaps you have an example multimodule gradle project that works perfectly? That way I can work my way back to a multimodule gradle project that reports coverage properly. Thanks in advance!

ganncamp · May 21, 2024, 1:01pm

Hi,

Do a text search in the log for ‘coverage’. You’ll come to the part (eventually ) where the coverage report is being imported, and from there it should tell you if any of the paths are off. (Although, actually I’d have expected that to show up at INFO level.)

Ann

lievenvaneeckhaute · May 23, 2024, 8:05am

Hi, I’ve grepped on coverage. Here are the logs:

grep -i "coverage" sonar.out
2024-05-21T08:06:26.641+0000 [DEBUG] [org.gradle.internal.operations.DefaultBuildOperationRunner] Build operation 'Register task :jacocoTestCoverageVerification' started
2024-05-21T08:06:26.641+0000 [DEBUG] [org.gradle.internal.operations.DefaultBuildOperationRunner] Completing Build operation 'Register task :jacocoTestCoverageVerification'
2024-05-21T08:06:26.641+0000 [DEBUG] [org.gradle.internal.operations.DefaultBuildOperationRunner] Build operation 'Register task :jacocoTestCoverageVerification' completed
2024-05-21T08:06:26.827+0000 [DEBUG] [org.gradle.internal.operations.DefaultBuildOperationRunner] Build operation 'Register task :main:jacocoTestCoverageVerification' started
2024-05-21T08:06:26.827+0000 [DEBUG] [org.gradle.internal.operations.DefaultBuildOperationRunner] Completing Build operation 'Register task :main:jacocoTestCoverageVerification'
2024-05-21T08:06:26.827+0000 [DEBUG] [org.gradle.internal.operations.DefaultBuildOperationRunner] Build operation 'Register task :main:jacocoTestCoverageVerification' completed
2024-05-21T08:06:26.837+0000 [INFO] [io.spring.gradle.dependencymanagement.internal.DependencyManagementApplier] Applying dependency management to configuration 'coverageDataElementsForTest' in project 'main'
2024-05-21T08:06:27.033+0000 [INFO] [org.gradle.api.internal.artifacts.configurations.DefaultConfiguration] The configuration :coverageDataElementsForTest is both consumable and declarable. This combination is incorrect, only one of these flags should be set.
2024-05-21T08:06:28.126+0000 [INFO] [org.gradle.api.internal.artifacts.configurations.DefaultConfiguration] The configuration :main:coverageDataElementsForTest is both consumable and declarable. This combination is incorrect, only one of these flags should be set.
2024-05-21T08:06:28.477+0000 [DEBUG] [org.gradle.internal.component.model.LoggingAttributeMatchingExplanationBuilder] Candidate project :main configuration coverageDataElementsForTest attribute org.gradle.category value {org.gradle.category=verification} doesn't requested value library
2024-05-21T08:06:28.477+0000 [DEBUG] [org.gradle.internal.component.model.DefaultAttributeMatcher] Selected matches [0] from candidates [project :main configuration apiElements, project :main configuration coverageDataElementsForTest, project :main configuration mainSourceElements, project :main configuration runtimeElements, project :main configuration testResultsElementsForTest] for {org.gradle.category=library, org.gradle.dependency.bundling=external, org.gradle.jvm.environment=standard-jvm, org.gradle.jvm.version=17, org.gradle.libraryelements=classes, org.gradle.usage=java-api}
2024-05-21T08:06:43.743+0000 [INFO] [org.sonarqube.gradle.SonarTask] Pull request 41 for merge into main from sonar_coverage
2024-05-21T08:06:47.818+0000 [DEBUG] [org.sonarqube.gradle.SonarTask] 'Cobertura Sensor for Python coverage' skipped because there is no related file in current project
2024-05-21T08:06:48.869+0000 [DEBUG] [org.sonarqube.gradle.SonarTask] 'Cobertura Sensor for Python coverage' skipped because there is no related file in current project
2024-05-21T08:06:48.872+0000 [DEBUG] [org.sonarqube.gradle.SonarTask] 'Generic Coverage Report' skipped because one of the required properties is missing
2024-05-21T08:06:50.557+0000 [DEBUG] [org.sonarqube.gradle.SonarTask] Sensors : Zero Coverage Sensor -> Java CPD Block Indexer
2024-05-21T08:06:50.557+0000 [INFO] [org.sonarqube.gradle.SonarTask] Sensor Zero Coverage Sensor
2024-05-21T08:06:50.557+0000 [INFO] [org.sonarqube.gradle.SonarTask] Sensor Zero Coverage Sensor (done) | time=0ms

Note that it does seem to find the jacoco xml report according to this:

2024-05-21T08:06:48.648+0000 [INFO] [org.sonarqube.gradle.SonarTask] Sensor JaCoCo XML Report Importer [jacoco]
2024-05-21T08:06:48.652+0000 [DEBUG] [org.sonarqube.gradle.SonarTask] Reading report '[redacted]/main/build/reports/jacoco/test/jacocoTestReport.xml'
2024-05-21T08:06:48.672+0000 [INFO] [org.sonarqube.gradle.SonarTask] Sensor JaCoCo XML Report Importer [jacoco] (done) | time=23ms

ganncamp · May 23, 2024, 12:10pm

Hi,

Thanks for the log excerpt. Nothing jumps out at me. It was a bit of a straw-clutch anyway. I’m going to signal for help.

Ann

angelo.buono · May 27, 2024, 3:58pm

Hello @lievenvaneeckhaute, welcome to the Sonar Community!

Are you sure that the submodules are generating the Jacoco XML report? To make sure that this is the case add the following task for all the child modules:

tasks.test {
    finalizedBy(tasks.jacocoTestReport) 
}

Could you also to keep the property sonar.coverage.jacoco.xmlReportPaths to its default?

Cheers,
Angelo

lievenvaneeckhaute · May 28, 2024, 9:57am

Hello @angelo.buono . I’ve added the task to the child module.
Note that I can confirm that the file is generated and contains proper data.
Leaving the xmlReport path empty and adding the above task still yields No data about Coverage.

2024-05-28T09:47:40.199+0000 [INFO] [org.sonarqube.gradle.SonarTask] Importing 1 report(s). Turn your logs in debug mode in order to see the exhaustive list.
2024-05-28T09:47:40.199+0000 [DEBUG] [org.sonarqube.gradle.SonarTask] Reading report '[redacted]/main/build/reports/jacoco/test/jacocoTestReport.xml'
2024-05-28T09:47:40.214+0000 [INFO] [org.sonarqube.gradle.SonarTask] Sensor JaCoCo XML Report Importer [jacoco] (done) | time=17ms

angelo.buono · May 28, 2024, 12:29pm

Hi @lievenvaneeckhaute, the reproducer I’m using works as expected: the sensor reads the report generated in each of the configured modules.

Here is my reproducer: MultiModuleGradleProject.zip (120.8 KB). Can you verify that it works for you?

Run the command below by specifying the appropriate sonar.host.url and sonar.token:

 ./gradlew --debug  clean build sonar -Dsonar.host.url=<URL> -Dsonar.token=<TOKEN> | grep "Reading report"

The expected output should look like the following:

[DEBUG] [org.sonarqube.gradle.SonarTask] Reading report '<PATH_TO>/MultiModuleGradleProject/module1/build/reports/jacoco/test/jacocoTestReport.xml'
[DEBUG] [org.sonarqube.gradle.SonarTask] Reading report '<PATH_TO>/MultiModuleGradleProject/module2/build/reports/jacoco/test/jacocoTestReport.xml'
[DEBUG] [org.sonarqube.gradle.SonarTask] Reading report '<PATH_TO>/MultiModuleGradleProject/build/reports/jacoco/test/jacocoTestReport.xml'

If the output matches, please check for differences in the configuration. I hope this helps you!

Cheers,
Angelo

lievenvaneeckhaute · May 29, 2024, 11:38am

Thanks everyone for helping out. The example multi module project helped me debug our local project. It turns out code coverage can’t handle a submodule ‘main’. Renaming the submodule to ‘application’ resolved the issue.

system · June 10, 2024, 2:42pm

This topic was automatically closed 7 days after the last reply. New replies are no longer allowed.

Topic		Replies	Views
Unable to view complete code coverage on Sonar Cloud server when used multi module Gradle project SonarQube Cloud java , coverage	18	1058	June 5, 2023
GitLab+Gradle+sonarQube showing code coverage 0% for java SonarQube Server / Community Build java , sonarqube , coverage	1	552	September 25, 2023
Code Coverage not being reported in SonarQube SonarQube Server / Community Build sonarqube , gradle , coverage	2	555	October 5, 2022
Sonarqube code coverage is 0 SonarQube Server / Community Build java , gradle , scanner , coverage , tests	4	6591	February 25, 2021
Jacoco Coverage Report for multi module gradle project not visible for Sonar SonarQube Cloud gradle , coverage , jacoco , multi-module , sonarqube-cloud	1	1062	December 28, 2023

How to debug sonar codeCoverage not coming through in multimodule java gradle project

Related topics