mirror of
https://github.com/SonarSource/sonarqube-quality-gate-action.git
synced 2026-09-23 13:38:32 +00:00
7a5fffe8e5
* feat(SQQGGHA-12): surface SonarQube error message on background task failure Report the analysis error message when the background task status is not SUCCESS, instead of only failing at the quality gate lookup step. * fix: surface CANCELED SonarQube task status with clear message Co-authored-by: Amaury Wyart <285676107+amaurywyart-sq@users.noreply.github.com> * fix: use octal ANSI escape codes for bash 3.2 compatibility \e is not interpreted by echo -e on bash 3.2 (e.g. macOS/self-hosted runners), which printed raw escape sequences instead of colored output. \033 works on both bash 3.2 and modern bash. --------- Co-authored-by: Gitar <noreply@gitar.ai> Co-authored-by: Amaury Wyart <285676107+amaurywyart-sq@users.noreply.github.com>
92 lines
3.3 KiB
Bash
Executable File
92 lines
3.3 KiB
Bash
Executable File
#!/usr/bin/env bash
|
|
|
|
source "$(dirname "$0")/common.sh"
|
|
|
|
if [[ -z "${SONAR_TOKEN}" ]]; then
|
|
echo "Set the SONAR_TOKEN env variable."
|
|
exit 1
|
|
fi
|
|
|
|
metadataFile="$1"
|
|
pollingTimeoutSec="$2"
|
|
|
|
|
|
if [[ ! -f "$metadataFile" ]]; then
|
|
echo "$metadataFile does not exist."
|
|
exit 1
|
|
fi
|
|
|
|
if [[ ! $pollingTimeoutSec =~ ^[0-9]+$ || $pollingTimeoutSec -le 0 ]]; then
|
|
echo "'$pollingTimeoutSec' is an invalid value for the polling timeout. Please use a positive, non-zero number."
|
|
exit 1
|
|
fi
|
|
|
|
if [[ ! -z "${SONAR_HOST_URL}" ]]; then
|
|
serverUrl="${SONAR_HOST_URL%/}"
|
|
ceTaskUrl="${SONAR_HOST_URL%/}/api$(sed -n 's/^ceTaskUrl=.*api//p' "${metadataFile}")"
|
|
else
|
|
serverUrl="$(sed -n 's/serverUrl=\(.*\)/\1/p' "${metadataFile}")"
|
|
ceTaskUrl="$(sed -n 's/ceTaskUrl=\(.*\)/\1/p' "${metadataFile}")"
|
|
fi
|
|
|
|
if [[ -z "${serverUrl}" || -z "${ceTaskUrl}" ]]; then
|
|
echo "Invalid report metadata file."
|
|
exit 1
|
|
fi
|
|
|
|
if [[ -n "${SONAR_ROOT_CERT}" ]]; then
|
|
echo "Adding custom root certificate to ~/.curlrc"
|
|
rm -f /tmp/tmpcert.pem
|
|
echo "${SONAR_ROOT_CERT}" > /tmp/tmpcert.pem
|
|
echo "--cacert /tmp/tmpcert.pem" >> ~/.curlrc
|
|
fi
|
|
|
|
task="$(curl --location --location-trusted --max-redirs 10 --silent --fail --show-error --user "${SONAR_TOKEN}": "${ceTaskUrl}")"
|
|
status="$(jq -r '.task.status' <<< "$task")"
|
|
|
|
endTime=$(( ${SECONDS} + ${pollingTimeoutSec} ))
|
|
|
|
until [[ ${status} != "PENDING" && ${status} != "IN_PROGRESS" || ${SECONDS} -ge ${endTime} ]]; do
|
|
printf '.'
|
|
sleep 5
|
|
task="$(curl --location --location-trusted --max-redirs 10 --silent --fail --show-error --user "${SONAR_TOKEN}": "${ceTaskUrl}")"
|
|
status="$(jq -r '.task.status' <<< "$task")"
|
|
done
|
|
printf '\n'
|
|
|
|
if [[ ${status} == "PENDING" || ${status} == "IN_PROGRESS" ]] && [[ ${SECONDS} -ge ${endTime} ]]; then
|
|
echo "Polling timeout reached for waiting for finishing of the Sonar scan! Aborting the check for SonarQube's Quality Gate."
|
|
exit 1
|
|
fi
|
|
|
|
if [[ ${status} == "CANCELED" ]]; then
|
|
fail "The SonarQube background task was CANCELED."
|
|
fi
|
|
|
|
if [[ ${status} == "FAILED" ]]; then
|
|
errorMessage="$(jq -r '.task.errorMessage // "No error message provided."' <<< "${task}")"
|
|
fail "The SonarQube background task ${status}.${reset}\n\n${errorMessage}"
|
|
fi
|
|
|
|
analysisId="$(jq -r '.task.analysisId' <<< "${task}")"
|
|
qualityGateUrl="${serverUrl}/api/qualitygates/project_status?analysisId=${analysisId}"
|
|
qualityGateStatus="$(curl --location --location-trusted --max-redirs 10 --silent --fail --show-error --user "${SONAR_TOKEN}": "${qualityGateUrl}" | jq -r '.projectStatus.status')"
|
|
|
|
dashboardUrl="$(sed -n 's/dashboardUrl=\(.*\)/\1/p' "${metadataFile}")"
|
|
analysisResultMsg="Detailed information can be found at: ${dashboardUrl}\n"
|
|
|
|
if [[ ${qualityGateStatus} == "OK" ]]; then
|
|
set_output "quality-gate-status" "PASSED"
|
|
success "Quality Gate has PASSED."
|
|
elif [[ ${qualityGateStatus} == "WARN" ]]; then
|
|
set_output "quality-gate-status" "WARN"
|
|
warn "Warnings on Quality Gate.${reset}\n\n${analysisResultMsg}"
|
|
elif [[ ${qualityGateStatus} == "ERROR" ]]; then
|
|
set_output "quality-gate-status" "FAILED"
|
|
fail "Quality Gate has FAILED.${reset}\n\n${analysisResultMsg}"
|
|
else
|
|
set_output "quality-gate-status" "FAILED"
|
|
fail "Quality Gate not set for the project. Please configure the Quality Gate in SonarQube or remove sonarqube-quality-gate action from the workflow."
|
|
fi
|
|
|