-
Notifications
You must be signed in to change notification settings - Fork 3.3k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
HBASE-27685 Enable code coverage reporting to SonarQube in HBase
- Loading branch information
Dora Horvath
committed
Mar 5, 2023
1 parent
d2b0074
commit 4245ab5
Showing
4 changed files
with
162 additions
and
9 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,49 @@ | ||
| <!-- | ||
| Licensed to the Apache Software Foundation (ASF) under one | ||
| or more contributor license agreements. See the NOTICE file | ||
| distributed with this work for additional information | ||
| regarding copyright ownership. The ASF licenses this file | ||
| to you under the Apache License, Version 2.0 (the | ||
| "License"); you may not use this file except in compliance | ||
| with the License. You may obtain a copy of the License at | ||
| http://www.apache.org/licenses/LICENSE-2.0 | ||
| Unless required by applicable law or agreed to in writing, software | ||
| distributed under the License is distributed on an "AS IS" BASIS, | ||
| WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| See the License for the specific language governing permissions and | ||
| limitations under the License. | ||
| --> | ||
|
|
||
| # 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` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,87 @@ | ||
| #!/usr/bin/env bash | ||
| # | ||
| # Licensed to the Apache Software Foundation (ASF) under one or more | ||
| # contributor license agreements. See the NOTICE file distributed with | ||
| # this work for additional information regarding copyright ownership. | ||
| # The ASF licenses this file to You under the Apache License, Version 2.0 | ||
| # (the "License"); you may not use this file except in compliance with | ||
| # the License. You may obtain a copy of the License at | ||
| # | ||
| # http://www.apache.org/licenses/LICENSE-2.0 | ||
| # | ||
| # Unless required by applicable law or agreed to in writing, software | ||
| # distributed under the License is distributed on an "AS IS" BASIS, | ||
| # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| # See the License for the specific language governing permissions and | ||
| # limitations under the License. | ||
| # | ||
|
|
||
| usage() { | ||
| echo | ||
| echo "Options:" | ||
| echo " -h Display help" | ||
| echo " -u SonarQube Host URL" | ||
| echo " -l SonarQube Login Credentials" | ||
| echo " -k SonarQube Project Key" | ||
| echo " -n SonarQube Project Name" | ||
| echo " -t Number of threads (example: 1 or 2C)." | ||
| echo | ||
| echo "Important:" | ||
| echo " The required parameters for publishing the coverage results to SonarQube are:" | ||
| echo " - Host URL" | ||
| echo " - Login Credentials" | ||
| echo " - Project Key" | ||
| echo | ||
| } | ||
|
|
||
| execute() { | ||
| SCRIPT_DIR="$(cd -- "$(dirname -- "${BASH_SOURCE[0]}")" &>/dev/null && pwd)" | ||
| MAIN_POM="${SCRIPT_DIR}/../../pom.xml" | ||
|
|
||
| # Check the syntax for the thread variable | ||
| if [[ "$THREAD_COUNT" =~ ^[0-9]+([.][0-9]+)?$ ]] || [[ "$THREAD_COUNT" =~ ^[0-9]+([.][0-9]+)+[C]?$ ]]; then | ||
| THREADS="${THREAD_COUNT}" | ||
| else | ||
| THREADS=1 | ||
| fi | ||
|
|
||
| echo "Running unit and integration tests with runAllTests profile" | ||
|
|
||
| mvn -B -e -f "${MAIN_POM}" clean test -PrunAllTests -Pjacoco -Pbuild-with-jdk11 -fn | ||
|
|
||
| echo "Starting verifying phase" | ||
|
|
||
| mvn -B -e -f "${MAIN_POM}" verify -DskipTests -DskipITs -Pjacoco -Pbuild-with-jdk11 -fn -T "$THREADS" | ||
|
|
||
| echo "Starting sonar scanner analysis" | ||
|
|
||
| # If the required parameters are given, the code coverage results are uploaded to the SonarQube Server | ||
| if [ -n "$SONAR_LOGIN" ] && [ -n "$SONAR_PROJECT_KEY" ] && [ -n "$SONAR_URL" ]; then | ||
| mvn -B -e -f "${MAIN_POM}" sonar:sonar -Dsonar.host.url="$SONAR_URL" \ | ||
| -Dsonar.login="$SONAR_LOGIN" -Dsonar.projectKey="$SONAR_PROJECT_KEY" \ | ||
| -Dsonar.projectName="$SONAR_PROJECT_NAME" -Pjacoco -T "$THREADS" | ||
| fi | ||
|
|
||
| echo "Build finished" | ||
| } | ||
|
|
||
| while getopts ":u:l:k:n:t:h" option; do | ||
| case $option in | ||
| u) SONAR_URL=${OPTARG:-} ;; | ||
| l) SONAR_LOGIN=${OPTARG:-} ;; | ||
| k) SONAR_PROJECT_KEY=${OPTARG:-} ;; | ||
| n) SONAR_PROJECT_NAME=${OPTARG:-} ;; | ||
| t) THREAD_COUNT=${OPTARG:-} ;; | ||
| h) # Display usage | ||
| usage | ||
| exit | ||
| ;; | ||
| \?) # Invalid option | ||
| echo "Error: Invalid option" | ||
| exit | ||
| ;; | ||
| esac | ||
| done | ||
|
|
||
| # Start code analysis | ||
| execute |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters