report: encode XML Character Entities in xUnit report
PATCH 1/1 report: encode XML Character Entities in xUnit report
Since the xUnit report is an XML document, special XML characters such as '<', '>', '&', etc. have to be encoded as "<", ">", etc. Otherwise programs parsing something like this:
<testcase classname="xfstests.global" name="generic/450" time="0"> <skipped message="Only test on sector size < half of block size" /> </testcase>
Will get choke the unescaped '<' character in the skipped message.
Signed-off-by Theodore Ts'o <[email protected]>
Cc Dmitry Monakhov <[email protected]>
--- common/report | 17 +++++++++++++---- 1 file changed, 13 insertions(+), 4 deletions(-)
common/report +13 -4
@@ -25,6 +25,15 @@ REPORT_ENV_LIST="$REPORT_ENV_LIST OVL_UPPER" REPORT_ENV_LIST="$REPORT_ENV_LIST OVL_LOWER" REPORT_ENV_LIST="$REPORT_ENV_LIST OVL_WORK" +encode_xml() +{ + sed -e 's/&/\&/g' \ + -e 's/>/\>/g' \ + -e 's/</\</g' \ + -e "s/'/\'/g" \ + -e 's/"/\"/g' +} + # # Xunit format report functions _xunit_add_property()
@@ -86,7 +95,7 @@ _xunit_make_testcase_report() ;; "notrun") if [ -f $seqres.notrun ]; then - local msg=`cat $seqres.notrun` + local msg=`cat $seqres.notrun | encode_xml` echo -e "\t\t<skipped message=\"$msg\" />" >> $report else echo -e "\t\t<skipped/>" >> $report
@@ -103,20 +112,20 @@ _xunit_make_testcase_report() if [ -s $seqres.full ]; then echo -e "\t\t<system-out>" >> $report printf '<![CDATA[\n' >>$report - cat $seqres.full | tr -dc '[:print:][:space:]' >>$report + cat $seqres.full | tr -dc '[:print:][:space:]' | encode_xml >>$report printf ']]>\n' >>$report echo -e "\t\t</system-out>" >> $report fi if [ -f $seqres.dmesg ]; then echo -e "\t\t<system-err>" >> $report printf '<![CDATA[\n' >>$report - cat $seqres.dmesg | tr -dc '[:print:][:space:]' >>$report + cat $seqres.dmesg | tr -dc '[:print:][:space:]' | encode_xml >>$report printf ']]>\n' >>$report echo -e "\t\t</system-err>" >> $report elif [ -s $seqres.out.bad ]; then echo -e "\t\t<system-err>" >> $report printf '<![CDATA[\n' >>$report - $diff $seq.out $seqres.out.bad >>$report + $diff $seq.out $seqres.out.bad | encode_xml >>$report printf ']]>\n' >>$report echo -e "\t\t</system-err>" >> $report fi
Signature · 1 line
2.11.0.rc0.7.gbe5a750
Quoted 9 lines · Theodore Ts'o
Since the xUnit report is an XML document, special XML characters such as '<', '>', '&', etc. have to be encoded as "<", ">", etc. Otherwise programs parsing something like this:
<testcase classname="xfstests.global" name="generic/450" time="0"> <skipped message="Only test on sector size < half of block size" /> </testcase>Will get choke the unescaped '<' character in the skipped message.
The last line should be replaced by:
... will choke on the unescaped '<' character in the 'messages' attribute of the 'skipped' element.