hbase/dev-support/code-coverage
Horváth Dóra 37a8e5b1c2 HBASE-27685 Enable code coverage reporting to SonarQube in HBase (#5076)
(cherry picked from commit 72d5a46899)
2023-03-10 20:29:02 +01:00
..
README.md HBASE-27685 Enable code coverage reporting to SonarQube in HBase (#5076) 2023-03-10 20:29:02 +01:00
run-coverage.sh HBASE-27685 Enable code coverage reporting to SonarQube in HBase (#5076) 2023-03-10 20:29:02 +01:00

README.md

Code analysis

The run-coverage.sh script runs maven with the jacoco profile which generates the test coverage data for the java classes. If the required parameters are given it also runs the sonar code analysis and uploads the results to the given SonarQube Server.

Running code analysis

After running the script the reports generated by the JaCoCo code coverage library can be found under the /target/site/jacoco/ folder of the related modules.

Here is how you can generate the code coverage report:

sh dev/code-coverage/run-coverage.sh

Publishing coverage results to SonarQube

The required parameters for publishing the results to SonarQube are:

  • host URL,
  • login credentials,
  • project key

The project name is an optional parameter.

Here is an example command for running and publishing the coverage data:

./dev/code-coverage/run-coverage.sh -l ProjectCredentials -u https://exampleserver.com -k Project_Key -n Project_Name