[CALCITE-5427] Provide code quality/coverage metrics with SonarCloud and JaCoCo

• Type: Improvement
• Status: Closed
• Priority: Major
• Resolution: Fixed
• Fix Version/s: 1.33.0
• Component/s: build
• Labels: pull-request-available
• Assignee: Stamatis Zampetakis
• Reporter: Stamatis Zampetakis
• Created: 09/Dec/22 16:41
• Updated: 07/Feb/23 22:33
• Resolved: 09/Jan/23 17:01

Description

Provide code quality and coverage metrics for the master branch and every PR to facilitate code reviews, improve security, and protect against regressions by exploiting SonarCloud and JaCoCo.

SonarCloud is popular platform for providing code quality insights and widely used by ASF projects.

JaCoCo relies on instrumentation via a java agent to gather code coverage information while running tests.

The integration in the Calcite build can be done via Gradle plugins and the analysis will be triggered automatically via GitHub actions. Appropriate configuration properties will be added ensure that local builds will not be impacted.

Initially, the code quality metrics will have purely informational character and will be at the discretion of the reviewer to enforce or ignore them.

Later on, we can decide and agree on code quality gates which can be enforced automatically by SonarCloud and JaCoCo. It is possible to enforce things mostly at CI level but certain things can also be applied on local builds.

Issue Links

• is related to: CALCITE-5474 Disable Sonar quality gates to avoid checks appearing as failures
• links to: GitHub Pull Request #3018
• links to: GitHub Pull Request #3019