Merge pull request #74 from buildkite-plugins/ivannalisetska/SUP-1821

Test Collector Plugin Issue  - error parsing report url

Author: ivannalisetska

README.md

@@ -96,6 +96,14 @@ The number of concurrent file uploads to perform to the Buildkite analytics API.
 
 Default value: `1`
 
+## Requirements
+
+This plugin requires `jq` for parsing JSON data. If `jq` is not found on the agent, `sed` will be used as a fallback. Ensure that `sed` is also available to handle scenarios where `jq` cannot be used.
+
+## Fallback Behavior
+
+If `jq` is unavailable, the plugin will attempt to parse the results using `sed`. This ensures that the plugin remains functional even if the preferred JSON parser is missing.
+
 ## Examples
 
 ### Upload a JUnit file

hooks/pre-exit

@@ -73,23 +73,36 @@ save-report-url() {
     echo "Could not get the tests report URL from $json_file. File not found."
     return
   fi
-  # Could be easier with jq, but we don't want to require it
+
   if which jq >/dev/null; then
-      echo "Using jq to parse the report URL"
-      report_url=$(jq -r '.run_url' "${json_file}")
+    echo "Using jq to parse the report URL"
+    report_url=$(jq -r '.run_url' "${json_file}" 2>&1) # Capture stderr for error reporting
+    if [[ "$report_url" == "null" || "$report_url" == "" || "$report_url" =~ "parse error" ]]; then
+      echo "jq parsing failed with the message: $report_url"
+      echo "Contents of $json_file:"
+      cat "$json_file"
+      return
+    fi
   else
-      echo "Not using jq to parse the report URL"
-      report_url=$(sed 's/.*"run_url" *: *"\([^"]*\)".*/\1/g' "${json_file}")
+    echo "jq not installed, attempting to parse with sed"
+    report_url=$(sed 's/.*"run_url" *: *"\([^"]*\)".*/\1/g' "${json_file}")
+    if [[ "$report_url" == "null" || "$report_url" == "" ]]; then
+      echo "sed parsing failed, no valid URL extracted."
+      echo "Contents of $json_file:"
+      cat "$json_file"
+      return
+    fi
   fi
 
-  if [ "$report_url" == "null" ]; then
-    echo "Could not get the tests report URL from $json_file. 'run_url' property not found."
+  if [ -z "$report_url" ]; then
+    echo "No report URL found or extracted. Unable to save."
     return
   fi
 
   echo "$report_url" >> "$REPORT_URLS_FILE"
 }
 
+
 # Uploads files to the Test Analytics API
 #
 # Upload failures should not fail the build, and should have a sensible timeout,
@@ -239,4 +252,4 @@ else
 fi
 if [ "$ANNOTATE" != "false" ]; then
   annotation-link "${REPORT_URLS_FILE}"
-fi
+fi

tests/fixtures/response_missing_url.json

@@ -0,0 +1 @@
+{"id": "2","run_id": "2","queued": 130,"skipped": 0,"errors": []}

tests/fixtures/response_null_url.json

@@ -0,0 +1 @@
+{"id": "4","run_id": "4","queued": 150,"skipped": 0,"errors": [],"run_url": null}

tests/pre-exit-report-link.bats

@@ -1,8 +1,8 @@
 #!/usr/bin/env bats
 
 # To debug stubs, uncomment these lines:
-# export CURL_STUB_DEBUG=/dev/tty
-# export GIT_STUB_DEBUG=/dev/tty
+#export CURL_STUB_DEBUG=/dev/tty
+#export GIT_STUB_DEBUG=/dev/tty
 
 setup() {
   load "$BATS_PLUGIN_PATH/load.bash"
@@ -53,7 +53,7 @@ COMMON_CURL_OPTIONS='--form \* --form \* --form \* --form \* --form \* --form \*
   assert_success
   assert_output --partial "Uploading './tests/fixtures/junit-1.xml'..."
   assert_output --partial "curl success"
-  assert_output --partial "Not using jq"
+  assert_output --partial "jq not installed, attempting to parse with sed"
   assert_output --partial "annotation success"
 
   unstub which
@@ -117,6 +117,7 @@ COMMON_CURL_OPTIONS='--form \* --form \* --form \* --form \* --form \* --form \*
   unstub jq
   unstub curl
 }
+
 @test "Annotates report link absorbs empty file error" {
   export CURL_RESP_FILE="response.json"
   stub curl "-X POST --silent --show-error --max-time 30 --form format=junit ${COMMON_CURL_OPTIONS} \* \* \* -H \* : echo 'curl success'"
@@ -141,8 +142,54 @@ COMMON_CURL_OPTIONS='--form \* --form \* --form \* --form \* --form \* --form \*
   assert_success
   assert_output --partial "Uploading './tests/fixtures/junit-1.xml'..."
   assert_output --partial "curl success"
-  assert_output --partial "'run_url' property not found"
+  assert_output --partial "jq parsing failed with the message: "
+  assert_output --partial "Contents of ./tests/fixtures/response_no_url.json:"
+  assert_output --partial "There are no report URLs to annotate"
+
+  unstub curl
+}
+
+@test "No annotation when 'run_url' property is missing in JSON response" {
+  export CURL_RESP_FILE="./tests/fixtures/response_missing_url.json"
+  stub curl "-X POST --silent --show-error --max-time 30 --form format=junit ${COMMON_CURL_OPTIONS} \* \* \* -H \* : echo 'curl success'"
+
+  run "$PWD/hooks/pre-exit"
+
+  assert_success
+  assert_output --partial "jq parsing failed with the message:"
+  assert_output --partial "Contents of ./tests/fixtures/response_missing_url.json:"
+  assert_output --partial "There are no report URLs to annotate"
+
+  unstub curl
+}
+
+@test "No annotation when 'run_url' is null in JSON response" {
+  export CURL_RESP_FILE="./tests/fixtures/response_null_url.json"
+  stub curl "-X POST --silent --show-error --max-time 30 --form format=junit ${COMMON_CURL_OPTIONS} \* \* \* -H \* : echo 'curl success'"
+
+  run "$PWD/hooks/pre-exit"
+
+  assert_success
+  assert_output --partial "jq parsing failed with the message: null"
+  assert_output --partial "Contents of ./tests/fixtures/response_null_url.json:"
   assert_output --partial "There are no report URLs to annotate"
 
   unstub curl
 }
+
+@test "Fallback to sed when jq is missing" {
+  stub which "jq : exit 1"
+  stub curl "-X POST --silent --show-error --max-time 30 --form format=junit ${COMMON_CURL_OPTIONS} \* \* \* -H \* : echo 'curl success'"
+  stub buildkite-agent "annotate --style info --context \"test-collector\" --append : echo 'annotation success'"
+
+  run "$PWD/hooks/pre-exit"
+
+  assert_success
+  assert_output --partial "jq not installed, attempting to parse with sed"
+  assert_output --partial "curl success"
+  assert_output --partial "annotation success"
+
+  unstub which
+  unstub curl
+}
+