github/kubernetes
1
0
Fork 0
mirror of https://github.com/k3s-io/kubernetes.git synced 2025-10-21 22:49:31 +00:00
Code Issues Projects Releases Wiki Activity

verify: pick relevant lines from verify-golangci-lint.sh as failure message

Browse Source 
When sh2ju.sh was called to generate the junit_verify.xml, it used to include
the entire output of a failed script twice: once as failure message, once as
log output.

This output can be large and often the actual failure isn't near the top, but
rather at the end or (in the case of the different golangci-lint invocations)
embedded in the log. This makes them hard to see at a glance when looking at
the Prow result page for a job.

Now a verify script can prefix relevant lines with "ERROR: " and then only
those lines are used as failure message in JUnit, without that prefix.

That string was chosen because Prow itself also then picks up those lines when
viewing the entire build log and it is unlikely that some script prints such
lines when they are not meant to be part of the failure.

If some script outputs no such lines, "see stderr for details" is used as
failure message. This is better than before because it avoids the redundancy.
This commit is contained in:
Patrick Ohly
2023-06-02 11:41:05 +02:00
parent 1c9f08a1c5
commit dbbb21469f
3 changed files with 38 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

22
third_party/forked/shell2junit/sh2ju.sh vendored
View File

@@ -18,6 +18,10 @@
### -name="TestName" : the test name which will be shown in the junit report
### -error="RegExp" : a regexp which sets the test as failure when the output matches it
### -ierror="RegExp" : same as -error but case insensitive
### -fail="RegExp" : Any line from stderr which contains this pattern becomes part of
### the failure messsage, without the text matching that pattern.
### Example: -failure="^ERROR: "
### Default is to use the entire stderr as failure message.
### -output="Path" : path to output directory, defaults to "./results"
### - Junit reports are left in the folder 'result' under the directory where the script is executed.
### - Configure Jenkins to parse junit files from the generated folder
@@ -61,6 +65,7 @@ function juLog() {
errfile=/tmp/evErr.$$.log
date="$(which gdate 2>/dev/null || which date)"
asserts=00; errors=0; total=0; content=""
local failureRe=""
# parse arguments
ya=""; icase=""
@@ -70,6 +75,7 @@ function juLog() {
-class=*) class="$(echo "$1" | ${SED} -e 's/-class=//')"; shift;;
-ierror=*) ereg="$(echo "$1" | ${SED} -e 's/-ierror=//')"; icase="-i"; shift;;
-error=*) ereg="$(echo "$1" | ${SED} -e 's/-error=//')"; shift;;
-fail=*) failureRe="$(echo "$1" | ${SED} -e 's/-fail=//')"; shift;;
-output=*) juDIR="$(echo "$1" | ${SED} -e 's/-output=//')"; shift;;
*) ya=1;;
esac
@@ -135,9 +141,21 @@ function juLog() {
# write the junit xml report
## failure tag
[[ ${err} = 0 ]] && failure="" || failure="
<failure type=\"ScriptError\" message=\"Script Error\"><![CDATA[${errMsg}]]></failure>
local failure=""
if [[ ${err} != 0 ]]; then
local failureMsg
if [ -n "${failureRe}" ]; then
failureMsg="$(echo "${errMsg}" | grep -e "${failureRe}" | ${SED} -e "s;${failureRe};;")"
if [ -z "${failureMsg}" ]; then
failureMsg="see stderr for details"
fi
else
failureMsg="${errMsg}"
fi
failure="
<failure type=\"ScriptError\" message=\"Script Error\"><![CDATA[${failureMsg}]]></failure>
"
fi
## testcase tag
content="${content}
<testcase assertions=\"1\" name=\"${name}\" time=\"${time}\" classname=\"${class}\">