Corrected bug with du in tests, added summary with huge annotations

Author: toote

hooks/command

@@ -78,8 +78,19 @@ if [ $has_errors -eq 0 ]; then
   fi
 elif ! check_size; then
   echo "--- :warning: Failures too large to annotate"
-  echo "The failures are too large to create a build annotation. Please inspect the failed JUnit artifacts manually."
-  create_annotation=0
+
+  # creating a simplified version of the annotation
+  mv "${annotation_path}" "${annotation_path}2"
+  head -4 "${annotation_path}2" >"${annotation_path}"
+  # || true is to avoid issues if no summary is found
+  grep '<summary>' "${annotation_path}2" >>"${annotation_path}" || true
+
+  if ! check_size; then
+    echo "The failures are too large to create a build annotation. Please inspect the failed JUnit artifacts manually."
+    create_annotation=0
+  else
+    echo "The failures are too large to create complete annotation, using a simplified annotation"
+  fi
 fi
 
 if [ $create_annotation -ne 0 ]; then

tests/2-tests-1-failure.output

@@ -0,0 +1,13 @@
+Failures: 0
+Errors: 1
+Total tests: 2
+
+<details>
+<summary><code>Account#maximum_jobs_added_by_pipeline_changer returns 250 by default in spec.models.account_spec</code></summary>
+
+<p>expected: 250 got: 500 (compared using eql?)</p>
+
+<pre><code>First line of failure output
+      Second line of failure output</code></pre>
+
+</details>

tests/command.bats

@@ -161,7 +161,7 @@ export annotation_input="tests/tmp/annotation.input"
   run "$PWD/hooks/command"
 
   assert_success
-  assert_output --partial "No tests errors"
+  assert_output --partial "No test errors"
   assert_output --partial "Will create annotation anyways"
 
   unstub mktemp
@@ -178,7 +178,7 @@ export annotation_input="tests/tmp/annotation.input"
   refute_output --partial ":junit:"
 }
 
-@test "fails if the annotation is larger than 1MB" {
+@test "fails if the annotation is larger than 1MB even after summary" {
   export BUILDKITE_PLUGIN_JUNIT_ANNOTATE_ARTIFACTS="junits/*.xml"
 
   stub mktemp \
@@ -187,7 +187,8 @@ export annotation_input="tests/tmp/annotation.input"
 
   # 1KB over the 1MB size limit of annotations
   stub du \
-    "-k \* : echo 1025 \$2"
+    "-k \* : echo 1025$'\t'\$2" \
+    "-k \* : echo 1025$'\t'\$2"
 
   stub buildkite-agent \
     "artifact download \* \* : echo Downloaded artifact \$3 to \$4"
@@ -200,13 +201,47 @@ export annotation_input="tests/tmp/annotation.input"
   assert_success
 
   assert_output --partial "Failures too large to annotate"
+  assert_output --partial "failures are too large to create a build annotation"
 
   unstub docker
   unstub du
   unstub buildkite-agent
   unstub mktemp
 }
 
+@test "creates summary annotation if original is larger than 1MB" {
+  export BUILDKITE_PLUGIN_JUNIT_ANNOTATE_ARTIFACTS="junits/*.xml"
+
+  stub mktemp \
+    "-d \* : mkdir -p '$artifacts_tmp'; echo '$artifacts_tmp'" \
+    "-d \* : mkdir -p '$annotation_tmp'; echo '$annotation_tmp'"
+
+  # 1KB over the 1MB size limit of annotations
+  stub du \
+    "-k \* : echo 1025$'\t'\$2" \
+    "-k \* : echo 10$'\t'\$2"
+
+  stub buildkite-agent \
+    "artifact download \* \* : echo Downloaded artifact \$3 to \$4" \
+    "annotate --context \* --style \* : cat >'${annotation_input}'; echo Annotation added with context \$3 and style \$5, content saved"
+
+  stub docker \
+    "--log-level error run --rm --volume \* --volume \* --env \* --env \* --env \* ruby:2.7-alpine ruby /src/bin/annotate /junits : cat tests/2-tests-1-failure.output && exit 64"
+
+  run "$PWD/hooks/command"
+
+  assert_success
+
+  assert_output --partial "Failures too large to annotate"
+  assert_output --partial "using a simplified annotation"
+  assert_equal "5 ${annotation_input}" "$(wc -l "${annotation_input}" | cut -f 1)"
+
+  unstub docker
+  unstub du
+  unstub buildkite-agent
+  unstub mktemp
+  rm "${annotation_input}"
+}
 
 @test "returns an error if fail-build-on-error is true" {
   export BUILDKITE_PLUGIN_JUNIT_ANNOTATE_ARTIFACTS="junits/*.xml"
@@ -243,7 +278,8 @@ export annotation_input="tests/tmp/annotation.input"
 
   # 1KB over the 1MB size limit of annotations
   stub du \
-    "-k \* : echo 1025 \$2"
+    "-k \* : echo 1025$'\t'\$2" \
+    "-k \* : echo 1025$'\t'\$2"
 
   stub buildkite-agent \
     "artifact download \* \* : echo Downloaded artifact \$3 to \$4"