From f9fe214a5be5769c40619de2fff2726c36d2d5eb Mon Sep 17 00:00:00 2001
From: Bart Skowron <bart@bxsx.dev>
Date: Sat, 19 Aug 2023 02:35:05 +0200
Subject: [PATCH] Display dashboard URL if `qualityGateStatus` is WARN or ERROR

---
 script/check-quality-gate.sh      | 9 ++++++---
 test/check-quality-gate-test.bats | 5 +++++
 2 files changed, 11 insertions(+), 3 deletions(-)

diff --git a/script/check-quality-gate.sh b/script/check-quality-gate.sh
index 9fa4d1b..925f70b 100755
--- a/script/check-quality-gate.sh
+++ b/script/check-quality-gate.sh
@@ -43,21 +43,24 @@ until [[ ${status} != "PENDING" && ${status} != "IN_PROGRESS" ]]; do
     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'
 
 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')"
 
-printf '\n'
+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."
+   warn "Warnings on Quality Gate.${reset}\n\n${analysisResultMsg}"
 elif [[ ${qualityGateStatus} == "ERROR" ]]; then
    set_output "quality-gate-status" "FAILED"
-   fail "Quality Gate has 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."
diff --git a/test/check-quality-gate-test.bats b/test/check-quality-gate-test.bats
index 1e5c534..21af383 100755
--- a/test/check-quality-gate-test.bats
+++ b/test/check-quality-gate-test.bats
@@ -81,6 +81,7 @@ teardown() {
   export SONAR_TOKEN="test"
   echo "serverUrl=http://localhost:9000" >> metadata_tmp
   echo "ceTaskUrl=http://localhost:9000/api/ce/task?id=AXlCe3gsFwOUsY8YKHTn" >> metadata_tmp
+  echo "dashboardUrl=http://localhost:9000/dashboard?id=project&branch=master" >> metadata_tmp
 
   #mock curl
   function curl() {
@@ -100,12 +101,14 @@ teardown() {
   [ "$status" -eq 1 ]
   [[ "${github_out_actual}" = "quality-gate-status=WARN" ]]
   [[ "$output" = *"Warnings on Quality Gate."* ]]
+  [[ "$output" = *"Detailed information can be found at: http://localhost:9000/dashboard?id=project&branch=master"* ]]
 }
 
 @test "fail when Quality Gate status ERROR" {
   export SONAR_TOKEN="test"
   echo "serverUrl=http://localhost:9000" >> metadata_tmp
   echo "ceTaskUrl=http://localhost:9000/api/ce/task?id=AXlCe3gsFwOUsY8YKHTn" >> metadata_tmp
+  echo "dashboardUrl=http://localhost:9000/dashboard?id=project&branch=master" >> metadata_tmp
 
   #mock curl
   function curl() {
@@ -125,6 +128,7 @@ teardown() {
   [ "$status" -eq 1 ]
   [[ "${github_out_actual}" = "quality-gate-status=FAILED" ]]
   [[ "$output" = *"Quality Gate has FAILED."* ]]
+  [[ "$output" = *"Detailed information can be found at: http://localhost:9000/dashboard?id=project&branch=master"* ]]
 }
 
 @test "pass when Quality Gate status OK" {
@@ -150,6 +154,7 @@ teardown() {
   [ "$status" -eq 0 ]
   [[ "${github_out_actual}" = "quality-gate-status=PASSED" ]]
   [[ "$output" = *"Quality Gate has PASSED."* ]]
+  [[ "$output" != *"Detailed information can be found at:"* ]]
 }
 
 @test "pass when Quality Gate status OK and status starts from IN_PROGRESS" {