Sonar(Python)代码报告覆盖率不显示问题排查求助

Hey there, let’s dig into why your Python coverage isn’t showing up in Sonar—especially with that multi-module Maven setup where you already have a valid Cobertura report in the target directory. Inclusion/exclusion rules are absolutely a common culprit here, but there are a few other multi-module-specific gotchas to check too.

First: Verify Multi-Module Path Configuration #

In a parent-child Maven setup, the sonar.python.coverage.reportPath in your parent pom might not be resolving correctly for each submodule. Here’s what to check:

• Use Maven variables instead of hardcoded paths: Instead of a fixed relative path, configure the report path in the parent pom using ${project.build.directory}/site/cobertura/coverage.xml. This ensures each submodule points to its own generated report, not a parent-level file.
• Switch to the plural reportPaths if needed: If you have multiple coverage reports per submodule, use sonar.python.coverage.reportPaths (note the plural) and list all relevant paths (e.g., ${project.build.directory}/**/coverage.xml).
• Confirm submodules inherit the parent config: Make sure each child pom doesn’t override the sonar.python.coverage.reportPath setting with its own conflicting value.

Next: Check Inclusion/Exclusion Rule Mismatches #

This is the most likely culprit. Sonar will ignore coverage data if the file paths in your Cobertura report don’t align with the files Sonar is scanning (due to inclusion/exclusion rules). Here’s how to debug:

1. Validate sonar.sources for each submodule: Each child pom should set sonar.sources to its Python source root (e.g., src/main/python). If this is missing or incorrect, Sonar won’t map the Cobertura data to the right files.
2. Audit your inclusion/exclusion patterns:
   • If you’re using sonar.inclusions or sonar.python.inclusions, ensure the pattern matches your actual source file structure. For example, if your submodules have sources under [submodule-name]/src/main/python, a pattern like **/src/main/python/**/*.py will work, whereas src/main/python/**/*.py might only match the parent directory’s sources.
   • Avoid over-excluding! If you have sonar.exclusions=**/test/**, that’s fine for excluding test code from coverage calculation—but double-check that your Cobertura report isn’t trying to report coverage on test files (it shouldn’t be).
3. Match Cobertura paths to Sonar’s scanned paths: Open your generated Cobertura XML and look at the <class> or <source> nodes. For example, if Cobertura lists a file as src/main/python/my_module/foo.py, Sonar must be scanning that exact path relative to the submodule’s root. If Sonar sees it as my_module/src/main/python/foo.py (due to misconfigured sonar.sources), the coverage data won’t link up.

Quick Checks for Cobertura Report Validity #

Before blaming Sonar, confirm your Cobertura report is actually populated:

• Open the XML file and look for <line> elements with hits attributes (e.g., <line number="10" hits="5"/>). If all hits are 0 or the report has no line data, the issue is with how you’re generating coverage, not Sonar.
• Ensure the report uses relative paths (not absolute paths) for source files. Absolute paths can break when Sonar runs in a different environment or directory structure.

Debug with Sonar’s Verbose Logs #

Run your Sonar scan with debug logging enabled to get concrete clues:

mvn sonar:sonar -X

Look for lines like:

• Found coverage report: [path/to/coverage.xml] (confirms Sonar is picking up the report)
• Cannot find coverage report for file [path/to/file.py] (indicates a path mismatch between Cobertura and Sonar’s scanned files)
• Excluded sources: [list of excluded paths] (shows if your inclusion/exclusion rules are excluding files you want covered)

Final Checklist #

1. Use ${project.build.directory} in coverage report paths for submodule-specific resolution.
2. Align sonar.sources in each submodule with your Python source root.
3. Ensure inclusion/exclusion patterns match the actual file structure across all submodules.
4. Verify Cobertura report paths match Sonar’s scanned file paths exactly.
5. Check debug logs for path matching errors or report detection issues.

内容的提问来源于stack exchange，提问作者Carlos Miguel Colanta