Although the current result files "check.log" and "check.time" is enough
for human to read, it's not that easy to parse.
Thus this patch will introduce a json output to "$RESULT_BASE/check.json".
The example output would look like this:
{
"section": "(none)",
"fstype": "btrfs",
"start_time": 1671103264,
"arch": "x86_64",
"kernel": "6.1.0-rc8-custom+",
"results": [
{
"testcase": "btrfs/001",
"status": "pass",
"start_time": 1671103264,
"end_time": 1671103266
},
{
"testcase": "btrfs/006",
"status": "pass",
"start_time": 1671103266,
"end_time": 1671103268
},
{
"testcase": "btrfs/007",
"status": "pass",
"start_time": 1671103268,
"end_time": 1671103271
}
]
}
Which should make later parsing much easier.
Signed-off-by: Qu Wenruo <wqu@xxxxxxxx>
---
Reason for RFC:
- Not crash safe
If one test case caused a crash, the "check.json" file will be an
invalid one, missing the closing "] }" string.
- Is json really a good choice?
It may be much easier to convert to a web page, but we will still
need to parse and handle the result using another languages anyway,
like to determine a regression.
Another alternative is .csv, and it can be much easier to handle.
(pure "echo >> $output", no need to handle the comma rule).
But for .csv, we may waste a lot of columes for things like "arch",
"kernel", "section".
- No good way to handle old results.
Unlike check.log, which can save old results without any problem, json
can not allow multiple top-level json objects.
Thus currently old "check.json" will be saved to "check.json.old",
further older results will be lost.
---
check | 32 ++++++++++++--
common/json | 117 ++++++++++++++++++++++++++++++++++++++++++++++++++++
2 files changed, 145 insertions(+), 4 deletions(-)
create mode 100644 common/json
diff --git a/check b/check
index d2e51296..cdb7f793 100755
--- a/check
+++ b/check
@@ -364,6 +364,11 @@ if ! . ./common/rc; then
exit 1
fi
+if ! . ./common/json; then
+ echo "check: failed to source common/json"
+ exit 1
+fi
+
if [ -n "$subdir_xfile" ]; then
for d in $SRC_GROUPS $FSTYP; do
[ -f $SRC_DIR/$d/$subdir_xfile ] || continue
@@ -576,6 +581,11 @@ _stash_fail_loop_files() {
_stash_test_status() {
local test_seq="$1"
local test_status="$2"
+ local start_epoch="$3"
+ local end_epoch="$4"
+
+ _json_add_one_result "${REPORT_DIR}/check.json" \
+ "$test_seq" "$test_status" "$start_epoch" "$end_epoch"
if $do_report && [[ $test_status != "expunge" ]]; then
_make_testcase_report "$section" "$test_seq" \
@@ -804,6 +814,19 @@ function run_section()
seqres="$check"
_check_test_fs
+ local json_out
+ local json_section
+ if $OPTIONS_HAVE_SECTIONS; then
+ mkdir -p "$RESULT_BASE/$section"
+ json_out="$RESULT_BASE/$section/check.json"
+ json_section="$section"
+ else
+ mkdir -p "$RESULT_BASE"
+ json_out="$RESULT_BASE/check.json"
+ json_section=""
+ fi
+
+ _json_start "$json_out" "$(_full_fstyp_details)" "$json_section"
loop_status=() # track rerun-on-failure state
local tc_status ix
local -a _list=( $list )
@@ -863,7 +886,7 @@ function run_section()
tc_status="pass"
if [ ! -f $seq ]; then
echo " - no such test?"
- _stash_test_status "$seqnum" "$tc_status"
+ _stash_test_status "$seqnum" "non-exist"
continue
fi
@@ -936,7 +959,7 @@ function run_section()
echo -n " $seqnum -- "
cat $seqres.notrun
tc_status="notrun"
- _stash_test_status "$seqnum" "$tc_status"
+ _stash_test_status "$seqnum" "$tc_status" "$start" "$stop"
# Unmount the scratch fs so that we can wipe the scratch
# dev state prior to the next test run.
@@ -991,7 +1014,7 @@ function run_section()
if [ ! -f $seq.out ]; then
_dump_err "no qualified output"
tc_status="fail"
- _stash_test_status "$seqnum" "$tc_status"
+ _stash_test_status "$seqnum" "$tc_status" "$start" "$stop"
continue;
fi
@@ -1027,11 +1050,12 @@ function run_section()
rm -f $seqres.hints
fi
fi
- _stash_test_status "$seqnum" "$tc_status"
+ _stash_test_status "$seqnum" "$tc_status" "$start" "$stop"
done
sect_stop=`_wallclock`
interrupt=false
+ _json_end "$json_out"
_wrapup
interrupt=true
echo
diff --git a/common/json b/common/json
new file mode 100644
index 00000000..762c9e3e
--- /dev/null
+++ b/common/json
@@ -0,0 +1,117 @@
+#!/bin/bash
+# SPDX-License-Identifier: GPL-2.0+
+#
+# The json output would look like this:
+#{
+# "section": "(none)",
+# "fstype": "btrfs",
+# "start_time": 1671102736,
+# "arch": "x86_64",
+# "kernel": "6.1.0-rc8-custom+",
+# "results": [
+# {
+# "testcase": "btrfs/001",
+# "status": "pass",
+# "start_time": 1671102736,
+# "end_time": 1671102738
+# },
+# {
+# "testcase": "btrfs/006",
+# "status": "pass",
+# "start_time": 1671102738,
+# "end_time": 1671102740
+# },
+# {
+# "testcase": "btrfs/007",
+# "status": "pass",
+# "start_time": 1671102740,
+# "end_time": 1671102742
+# }
+# ]
+#}
+
+# Add the header for one section.
+#
+# @section can be empty, in that case, it will be turned into "(none)".
+#
+# Caller can then call one or more _json_add_one_result() calls, then
+# finish with _json_end()
+_json_start()
+{
+ local output="$1"
+ local fstype="$2"
+ local section="$3"
+ local time=$(date "+%s")
+ local kernel=$(uname -r)
+
+ if [ "$section" = "" ]; then
+ section="(none)"
+ fi
+
+ # If the file exists, we can not write new JSON top-level
+ # object into it, or it will be invalid.
+ # So here we just save it to "$output.old"
+ if [ -s "$output" ]; then
+ mv "$output" "$output.old"
+ fi
+
+ echo "{" >> "$output"
+ echo " \"section\": \"${section}\"," >> "$output"
+ echo " \"fstype\": \"${fstype}\"," >> "$output"
+ echo " \"start_time\": ${time}," >> "$output"
+ echo " \"arch\": \"$(uname -m)\"," >> "$output"
+ echo " \"kernel\": \"$(uname -r)\"," >> "$output"
+ echo " \"results\": [" >> "$output"
+}
+
+# $1 is the json file to append the result. Must call _json_start() first.
+# $2 is the test case name, e.g. "btrfs/001"
+# $3 is the result, "pass"|"fail"|"notrun"|"expunge"|list"
+# $4 is the start epoch time, e.g. 1671090884, can be empty
+# $5 is the end epoch time, e.g. 1671090890, can be empty
+#
+# If any of $4 and $5 is empty, it will use current epoch time.
+# Normally empty $4 or $5 can only be utilized for cases like "notrun"
+_json_add_one_result()
+{
+ local output="$1"
+ local testcase="$2"
+ local status="$3"
+ local start_time="$4"
+ local end_time="$5"
+
+ if [ ! -s "$output" ]; then
+ echo "error: the output file is not prepared with _json_start()"
+ exit 1
+ fi
+
+ if [ "$start_time" = "" ]; then
+ start_time=$(date "+%s")
+ fi
+ if [ "$end_time" = "" ]; then
+ end_time=$(date "+%s")
+ fi
+
+
+ # Check if the we have some results before us.
+ if tail -n1 "$output" | grep -q "}"; then
+ # I hate the JSON comma rule.
+ echo "," >> "$output"
+ fi
+ echo " {" >> "$output"
+
+ echo " \"testcase\": \"${testcase}\"," >> "$output"
+ echo " \"status\": \"${status}\"," >> "$output"
+ echo " \"start_time\": ${start_time}," >> "$output"
+ echo " \"end_time\": ${end_time}" >> "$output"
+ echo -n " }" >> "$output"
+}
+
+_json_end()
+{
+ local output="$1"
+
+ echo >> "$output"
+ echo " ]" >> "$output"
+ echo -n "}" >> "$output"
+}
--
2.38.0
