hack/e2e.sh create a junit file when running e2e.sh

Author: chrischdi

hack/ci-e2e-lib.sh

@@ -210,3 +210,38 @@ kind::prepullImage () {
     echo "+ image $image already present in the system, skipping pre-pull"
   fi
 }
+
+# junit::createJunitReportE2Esh creates a junit report file for the e2e.sh script.
+junit::createJunitReportE2Esh() {
+  failure="$1"
+  output_file="$2"
+  failure_data_file="$3"
+  timestamp="$(date -u +%Y-%m-%dT%H:%M:%S)"
+  # Write header
+  cat > "$output_file" << EOF
+<?xml version="1.0" encoding="UTF-8"?>
+<testsuites name="e2e.sh Suite" tests="1" failures="${failure}" errors="0" skipped="0" time="0.1">
+    <testsuite name="Preparation" tests="1" failures="${failure}" errors="0" skipped="0" time="0.1" timestamp="${timestamp}">
+        <testcase name="hack_e2e_sh" classname="Preparation.hack_e2e_sh" time="0.1">
+            <system-out>
+              <![CDATA[
+EOF
+  # Write content
+  if [[ "$failure" == 0 ]]; then
+    # No error, just write a message to the output file.
+    echo "No error, see e2e-sh.log for full output" >> ${output_file}
+  else
+    # Erorr case, write the content of the failure data file to the output file.
+    # Note: the sed ensures that the content does not close the CDATA section.
+    cat "${failure_data_file}" | sed 's/]]>/]]>]]&gt;<![CDATA[/g' >> "$output_file" 
+  fi
+  # Write footer
+  cat >> "$output_file" << EOF
+            ]]>
+          </system-out>
+        </testcase>
+    </testsuite>
+</testsuites>
+EOF
+
+}

hack/e2e.sh

@@ -36,6 +36,11 @@ if [[ "${ARTIFACTS}" != "${REPO_ROOT}/_artifacts" ]]; then
   ARTIFACTS=$(mktemp -d)
 fi
 
+# Redirect all output of this script additionally to a file in artifacts,
+# so we can create a junit file with its content in case of general CI failures.
+# This way the bash script's log can be analyzed using k8s-triage.
+exec &> >(tee script.log)
+
 # shellcheck source=./hack/ensure-go.sh
 source "${REPO_ROOT}/hack/ensure-go.sh"
 
@@ -97,6 +102,18 @@ on_exit() {
     # Move all artifacts to the original artifacts location.
     mv "${ARTIFACTS}"/* "${ORIGINAL_ARTIFACTS}/"
   fi
+
+  # Create a junit file for running this script.
+
+  # Delete output file from this script because it contains a duplicate output
+  if ls -1 "${ORIGINAL_ARTIFACTS}" 2>/dev/null | grep -q "^junit\..*\.xml$"; then
+    # There are junit files in artifacts
+    junit::createJunitReportE2Esh 0 "${ORIGINAL_ARTIFACTS}/junit.e2e-sh.xml"
+  else
+    junit::createJunitReportE2Esh 1 "${ORIGINAL_ARTIFACTS}/junit.e2e-sh.xml" "${ORIGINAL_ARTIFACTS}/e2e-sh.log"
+  fi
+  # Cleanup the additionally written log file, the same content will be in build-log.txt.
+  rm "${ORIGINAL_ARTIFACTS}/e2e-sh.log"
 }
 
 trap on_exit EXIT