Allow tags to be specified on the upload

These tags will propagate onto all the executions within the upload.

Author: pda

README.md

@@ -78,6 +78,18 @@ This should allow you to use a special exit code to soft-fail on when no files t
 
 Default value: `1`
 
+#### `tags` (array of strings)
+
+A list of tags to apply to all test results in the upload, in the format `key=value`.
+
+For example:
+
+```yaml
+tags:
+  - "arch=arm64"
+  - "language.version=1.2.3"
+```
+
 #### `timeout` (number)
 
 Maximum number of seconds to wait for each file to upload before timing out.

hooks/pre-exit

@@ -131,6 +131,22 @@ upload() {
     "--form" "run_env[collector]=test-collector-buildkite-plugin"
   )
 
+  if [ -n "${BUILDKITE_PLUGIN_TEST_COLLECTOR_TAGS:-}" ]; then
+    curl_args+=("--form" "$(build_tag_form_field "${BUILDKITE_PLUGIN_TEST_COLLECTOR_TAGS}")")
+  elif [ -n "${BUILDKITE_PLUGIN_TEST_COLLECTOR_TAGS_0:-}" ]; then
+    prefix="BUILDKITE_PLUGIN_TEST_COLLECTOR_TAGS"
+    parameter="${prefix}_0"
+    if [ -n "${!parameter:-}" ]; then
+      i=0
+      parameter="${prefix}_${i}"
+      while [ -n "${!parameter:-}" ]; do
+        curl_args+=("--form" "$(build_tag_form_field "${!parameter}")")
+        i=$((i+1))
+        parameter="${prefix}_${i}"
+      done
+    fi
+  fi
+
   if [[ "$DEBUG" == "true" ]]; then
     curl_args+=("--form" "run_env[debug]=\"$DEBUG\"")
   fi
@@ -154,6 +170,14 @@ upload() {
   curl "${curl_args[@]}" -H @<(printf 'Authorization: Token token=\"%s\"\n' "${TOKEN_VALUE}")
 }
 
+# input: "key=value"
+# output: "tags[key]=value"
+build_tag_form_field() {
+  local key="${1%%=*}" # longest matching trailing pattern deleted; keep the part before the first "="
+  local value="${1#*=}" # shortest matching leading pattern deleted; keep the part after the first "="
+  echo "tags[$key]=$value"
+}
+
 # Runs the whole plugin logic for a particular find pattern
 find_and_upload() {
   FILES_PATTERN="$1"

tests/pre-exit-success.bats

@@ -135,6 +135,38 @@ COMMON_CURL_OPTIONS='--form \* --form \* --form \* --form \* --form \* --form \*
   unstub curl
 }
 
+@test "Single tag from string" {
+  export BUILDKITE_PLUGIN_TEST_COLLECTOR_TAGS="hello=world"
+
+  stub curl \
+    "-X POST --silent --show-error --max-time 30 --form format=junit ${COMMON_CURL_OPTIONS} --form tags[hello]=world \* -H \* : echo 'curl success'"
+
+  run "$PWD/hooks/pre-exit"
+
+  assert_success
+  assert_output --partial "Uploading './tests/fixtures/junit-1.xml'..."
+  assert_output --partial "curl success"
+
+  unstub curl
+}
+
+@test "Multiple tags from array" {
+  export BUILDKITE_PLUGIN_TEST_COLLECTOR_TAGS_0="hello=world"
+  export BUILDKITE_PLUGIN_TEST_COLLECTOR_TAGS_1="foo=bar=baz"
+  unset BUILDKITE_PLUGIN_TEST_COLLECTOR_TAGS
+
+  stub curl \
+    "-X POST --silent --show-error --max-time 30 --form format=junit ${COMMON_CURL_OPTIONS} --form tags[hello]=world --form tags[foo]=bar=baz \* -H \* : echo 'curl success'"
+
+  run "$PWD/hooks/pre-exit"
+
+  assert_success
+  assert_output --partial "Uploading './tests/fixtures/junit-1.xml'..."
+  assert_output --partial "curl success"
+
+  unstub curl
+}
+
 @test "Debug true prints the curl info w/o token" {
   export BUILDKITE_PLUGIN_TEST_COLLECTOR_DEBUG="true"