selftests/ftrace: Use colored output when available
PATCH 1/1 selftests/ftrace: Use colored output when available
If test is being directly executed (with stdout opened on the terminal) and the terminal capabilities indicate enough colors, then use the existing scheme of green, red, and blue to show when tests pass, fail or end in a different way.
When running the tests redirecting the stdout, for instance, to a file, then colors are not shown, thus producing a more readable output.
--- tools/testing/selftests/ftrace/ftracetest | 29 +++++++++++++++++------ 1 file changed, 22 insertions(+), 7 deletions(-)
tools/testing/selftests/ftrace/ftracetest +22 -7
@@ -152,6 +152,21 @@ else date > $LOG_FILE fi +# Define text colors +# Check available colors on the terminal, if any +ncolors=`tput colors 2>/dev/null` +color_reset= +color_red= +color_green= +color_blue= +# If stdout exists and number of colors is eight or more, use them +if [ -t 1 -a "$ncolors" -a "$ncolors" -ge 8 ]; then + color_reset="\e[0m" + color_red="\e[31m" + color_green="\e[32m" + color_blue="\e[34m" +fi + prlog() { # messages [ -z "$LOG_FILE" ] && echo -e "$@" || echo -e "$@" | tee -a $LOG_FILE }
@@ -195,37 +210,37 @@ test_on_instance() { # testfile eval_result() { # sigval case $1 in $PASS) - prlog " [\e[32mPASS\e[30m]" + prlog " [${color_green}PASS${color_reset}]" PASSED_CASES="$PASSED_CASES $CASENO" return 0 ;; $FAIL) - prlog " [\e[31mFAIL\e[30m]" + prlog " [${color_red}FAIL${color_reset}]" FAILED_CASES="$FAILED_CASES $CASENO" return 1 # this is a bug. ;; $UNRESOLVED) - prlog " [\e[34mUNRESOLVED\e[30m]" + prlog " [${color_blue}UNRESOLVED${color_reset}]" UNRESOLVED_CASES="$UNRESOLVED_CASES $CASENO" return 1 # this is a kind of bug.. something happened. ;; $UNTESTED) - prlog " [\e[34mUNTESTED\e[30m]" + prlog " [${color_blue}UNTESTED${color_reset}]" UNTESTED_CASES="$UNTESTED_CASES $CASENO" return 0 ;; $UNSUPPORTED) - prlog " [\e[34mUNSUPPORTED\e[30m]" + prlog " [${color_blue}UNSUPPORTED${color_reset}]" UNSUPPORTED_CASES="$UNSUPPORTED_CASES $CASENO" return $UNSUPPORTED_RESULT # depends on use case ;; $XFAIL) - prlog " [\e[31mXFAIL\e[30m]" + prlog " [${color_red}XFAIL${color_reset}]" XFAILED_CASES="$XFAILED_CASES $CASENO" return 0 ;; *) - prlog " [\e[34mUNDEFINED\e[30m]" + prlog " [${color_blue}UNDEFINED${color_reset}]" UNDEFINED_CASES="$UNDEFINED_CASES $CASENO" return 1 # this must be a test bug ;;
Signature · 1 line
2.17.1
Steven Rostedt
maintainerMasami,
Does this fix the issues you reported?
-- Steve
Quoted 85 lines · On Tue, 16 Oct 2018 12:02:20 -0500 Daniel Díaz <daniel.diaz at linaro.org>…
If test is being directly executed (with stdout opened on the terminal) and the terminal capabilities indicate enough colors, then use the existing scheme of green, red, and blue to show when tests pass, fail or end in a different way.
When running the tests redirecting the stdout, for instance, to a file, then colors are not shown, thus producing a more readable output.
Signed-off-by Daniel Díaz <daniel.diaz at linaro.org>--- tools/testing/selftests/ftrace/ftracetest | 29 +++++++++++++++++------ 1 file changed, 22 insertions(+), 7 deletions(-)tools/testing/selftests/ftrace/ftracetest +22
-7@@ -152,6 +152,21 @@ else date > $LOG_FILE fi +# Define text colors +# Check available colors on the terminal, if any +ncolors=`tput colors 2>/dev/null` +color_reset= +color_red= +color_green= +color_blue= +# If stdout exists and number of colors is eight or more, use them +if [ -t 1 -a "$ncolors" -a "$ncolors" -ge 8 ]; then + color_reset="\e[0m" + color_red="\e[31m" + color_green="\e[32m" + color_blue="\e[34m" +fi + prlog() { # messages [ -z "$LOG_FILE" ] && echo -e "$@" || echo -e "$@" | tee -a $LOG_FILE }@@ -195,37 +210,37 @@ test_on_instance() { # testfile eval_result() { # sigval case $1 in $PASS) - prlog " [\e[32mPASS\e[30m]" + prlog " [${color_green}PASS${color_reset}]" PASSED_CASES="$PASSED_CASES $CASENO" return 0 ;; $FAIL) - prlog " [\e[31mFAIL\e[30m]" + prlog " [${color_red}FAIL${color_reset}]" FAILED_CASES="$FAILED_CASES $CASENO" return 1 # this is a bug. ;; $UNRESOLVED) - prlog " [\e[34mUNRESOLVED\e[30m]" + prlog " [${color_blue}UNRESOLVED${color_reset}]" UNRESOLVED_CASES="$UNRESOLVED_CASES $CASENO" return 1 # this is a kind of bug.. something happened. ;; $UNTESTED) - prlog " [\e[34mUNTESTED\e[30m]" + prlog " [${color_blue}UNTESTED${color_reset}]" UNTESTED_CASES="$UNTESTED_CASES $CASENO" return 0 ;; $UNSUPPORTED) - prlog " [\e[34mUNSUPPORTED\e[30m]" + prlog " [${color_blue}UNSUPPORTED${color_reset}]" UNSUPPORTED_CASES="$UNSUPPORTED_CASES $CASENO" return $UNSUPPORTED_RESULT # depends on use case ;; $XFAIL) - prlog " [\e[31mXFAIL\e[30m]" + prlog " [${color_red}XFAIL${color_reset}]" XFAILED_CASES="$XFAILED_CASES $CASENO" return 0 ;; *) - prlog " [\e[34mUNDEFINED\e[30m]" + prlog " [${color_blue}UNDEFINED${color_reset}]" UNDEFINED_CASES="$UNDEFINED_CASES $CASENO" return 1 # this must be a test bug ;;
Masami Hiramatsu
Acked-byQuoted 4 lines · On Tue, 16 Oct 2018 13:09:56 -0400 Steven Rostedt <[email protected]> wrote:
Masami,
Does this fix the issues you reported?
Yes, a half. We still need to strip out the escape sequences from log file even if the terminal accepts colors.
Anyway, this fixes the "black character" issue for me :)
Thanks Daniel!
I'll add a filter patch on top of this.
Thank you,
Quoted 92 lines
-- Steve
Quoted 85 lines · On Tue, 16 Oct 2018 12:02:20 -0500 Daniel Díaz <[email protected]> wrote:
If test is being directly executed (with stdout opened on the terminal) and the terminal capabilities indicate enough colors, then use the existing scheme of green, red, and blue to show when tests pass, fail or end in a different way.
When running the tests redirecting the stdout, for instance, to a file, then colors are not shown, thus producing a more readable output.
Signed-off-by Daniel Díaz <daniel.diaz at linaro.org>--- tools/testing/selftests/ftrace/ftracetest | 29 +++++++++++++++++------ 1 file changed, 22 insertions(+), 7 deletions(-)tools/testing/selftests/ftrace/ftracetest +22
-7@@ -152,6 +152,21 @@ else date > $LOG_FILE fi +# Define text colors +# Check available colors on the terminal, if any +ncolors=`tput colors 2>/dev/null` +color_reset= +color_red= +color_green= +color_blue= +# If stdout exists and number of colors is eight or more, use them +if [ -t 1 -a "$ncolors" -a "$ncolors" -ge 8 ]; then + color_reset="\e[0m" + color_red="\e[31m" + color_green="\e[32m" + color_blue="\e[34m" +fi + prlog() { # messages [ -z "$LOG_FILE" ] && echo -e "$@" || echo -e "$@" | tee -a $LOG_FILE }@@ -195,37 +210,37 @@ test_on_instance() { # testfile eval_result() { # sigval case $1 in $PASS) - prlog " [\e[32mPASS\e[30m]" + prlog " [${color_green}PASS${color_reset}]" PASSED_CASES="$PASSED_CASES $CASENO" return 0 ;; $FAIL) - prlog " [\e[31mFAIL\e[30m]" + prlog " [${color_red}FAIL${color_reset}]" FAILED_CASES="$FAILED_CASES $CASENO" return 1 # this is a bug. ;; $UNRESOLVED) - prlog " [\e[34mUNRESOLVED\e[30m]" + prlog " [${color_blue}UNRESOLVED${color_reset}]" UNRESOLVED_CASES="$UNRESOLVED_CASES $CASENO" return 1 # this is a kind of bug.. something happened. ;; $UNTESTED) - prlog " [\e[34mUNTESTED\e[30m]" + prlog " [${color_blue}UNTESTED${color_reset}]" UNTESTED_CASES="$UNTESTED_CASES $CASENO" return 0 ;; $UNSUPPORTED) - prlog " [\e[34mUNSUPPORTED\e[30m]" + prlog " [${color_blue}UNSUPPORTED${color_reset}]" UNSUPPORTED_CASES="$UNSUPPORTED_CASES $CASENO" return $UNSUPPORTED_RESULT # depends on use case ;; $XFAIL) - prlog " [\e[31mXFAIL\e[30m]" + prlog " [${color_red}XFAIL${color_reset}]" XFAILED_CASES="$XFAILED_CASES $CASENO" return 0 ;; *) - prlog " [\e[34mUNDEFINED\e[30m]" + prlog " [${color_blue}UNDEFINED${color_reset}]" UNDEFINED_CASES="$UNDEFINED_CASES $CASENO" return 1 # this must be a test bug ;;
Signature · 1 line
Masami Hiramatsu
Masami Hiramatsu
maintainerPATCH 1/1 selftests/ftrace: Strip escape sequences for log file
Strip escape sequences from the stream to the ftracetest summary log file. Note that all test-case results are dumped raw in each file.
--- tools/testing/selftests/ftrace/ftracetest | 11 +++++++++-- 1 file changed, 9 insertions(+), 2 deletions(-)
tools/testing/selftests/ftrace/ftracetest +9 -2
@@ -167,11 +167,18 @@ if [ -t 1 -a "$ncolors" -a "$ncolors" -ge 8 ]; then color_blue="\e[34m" fi +strip_esc() { + # busybox sed implementation doesn't accept "\x1B", so use [:cntrl:] instead. + sed -E "s/[[:cntrl:]]\[([0-9]{1,2}(;[0-9]{1,2})?)?[m|K]//g" +} + prlog() { # messages - [ -z "$LOG_FILE" ] && echo -e "$@" || echo -e "$@" | tee -a $LOG_FILE + echo -e "$@" + [ "$LOG_FILE" ] && echo -e "$@" | strip_esc >> $LOG_FILE } catlog() { #file - [ -z "$LOG_FILE" ] && cat $1 || cat $1 | tee -a $LOG_FILE + cat $1 + [ "$LOG_FILE" ] && cat $1 | strip_esc >> $LOG_FILE } prlog "=== Ftrace unit tests ==="
Re: [PATCH] selftests/ftrace: Strip escape sequences for log file
Quoted 4 lines · On Wed, 17 Oct 2018 12:33:23 +0900 Masami Hiramatsu <[email protected]> wrote:
Strip escape sequences from the stream to the ftracetest summary log file. Note that all test-case results are dumped raw in each file.
Shuah,
Please take this one too.
Thanks!
-- Steve
Shuah Khan
maintainerRe: [PATCH] selftests/ftrace: Strip escape sequences for log file
Quoted 8 lines · Steven Rostedt
Quoted 4 lines · On Wed, 17 Oct 2018 12:33:23 +0900 Masami Hiramatsu <mhiramat at kernel.org>…
Strip escape sequences from the stream to the ftracetest summary log file. Note that all test-case results are dumped raw in each file.
Quoted 6 lines
Acked-by Steven Rostedt (VMware) <rostedt at goodmis.org>Shuah,
Please take this one too.
Yup. Applied to linux-kselftest for 4.20-rc1.
thanks,
-- Shuah
Shuah Khan
maintainerQuoted 11 lines · Daniel Díaz
If test is being directly executed (with stdout opened on the terminal) and the terminal capabilities indicate enough colors, then use the existing scheme of green, red, and blue to show when tests pass, fail or end in a different way.
When running the tests redirecting the stdout, for instance, to a file, then colors are not shown, thus producing a more readable output.
Signed-off-by Daniel Díaz <daniel.diaz at linaro.org>---
Hi Daniel,
Thanks for the patch. Steve is working on adding this functionality. Please see the latest linux-kselftest next for the patch.
Steve just sent an update to the patch to fix an issue. Please test and see if that solves the problem you are trying address with this patch.
thanks,
-- Shuah
Hello!
Quoted 10 lines · Shuah Khan
Quoted 9 lines · Daniel Díaz
If test is being directly executed (with stdout opened on the terminal) and the terminal capabilities indicate enough colors, then use the existing scheme of green, red, and blue to show when tests pass, fail or end in a different way.
When running the tests redirecting the stdout, for instance, to a file, then colors are not shown, thus producing a more readable output.
Quoted 6 lines
Quoted 2 lines
Signed-off-by Daniel Díaz <daniel.diaz at linaro.org>---
Hi Daniel,
Thanks for the patch. Steve is working on adding this functionality. Please see the latest linux-kselftest next for the patch.
I hadn't seen today's discussion until after Steve replied to this patch. Mine is based on your next branch, building upon Steve's patch.
These changes here are somewhat different, in that color is enabled only if color is available in the terminal in the first place! And if the standard output is redirected to a file (which is what Masami reported today), then colors are avoided even if available.
Greetings!
Daniel Díaz
daniel.diaz at linaro.org
Quoted 5 lines
Steve just sent an update to the patch to fix an issue. Please test and see if that solves the problem you are trying address with this patch.
thanks,
-- Shuah
Steven Rostedt
maintainerQuoted 13 lines · On Tue, 16 Oct 2018 11:43:29 -0600 Shuah Khan <[email protected]> wrote:
Quoted 11 lines · Daniel Díaz
If test is being directly executed (with stdout opened on the terminal) and the terminal capabilities indicate enough colors, then use the existing scheme of green, red, and blue to show when tests pass, fail or end in a different way.
When running the tests redirecting the stdout, for instance, to a file, then colors are not shown, thus producing a more readable output.
Signed-off-by: Daniel Díaz <daniel.diaz at linaro.org>
---
Quoted 8 lines
Hi Daniel,
Thanks for the patch. Steve is working on adding this functionality. Please see the latest linux-kselftest next for the patch.
Steve just sent an update to the patch to fix an issue. Please test and see if that solves the problem you are trying address with this patch.
Hi Shuah,
I think this patch actually addresses the issue of my last patch, and I haven't sent another one.
I'm waiting to hear from Masami if it fixes the issues he saw.
-- Steve
Shuah Khan
maintainerQuoted 25 lines · Steven Rostedt
Quoted 13 lines · On Tue, 16 Oct 2018 11:43:29 -0600 Shuah Khan <[email protected]> wrote:
Quoted 11 lines · Daniel Díaz
If test is being directly executed (with stdout opened on the terminal) and the terminal capabilities indicate enough colors, then use the existing scheme of green, red, and blue to show when tests pass, fail or end in a different way.
When running the tests redirecting the stdout, for instance, to a file, then colors are not shown, thus producing a more readable output.
Signed-off-by: Daniel Díaz <daniel.diaz at linaro.org>
---Quoted 8 lines
Hi Daniel,
Thanks for the patch. Steve is working on adding this functionality. Please see the latest linux-kselftest next for the patch.
Steve just sent an update to the patch to fix an issue. Please test and see if that solves the problem you are trying address with this patch.
Quoted 9 lines
Hi Shuah,
I think this patch actually addresses the issue of my last patch, and I haven't sent another one.
I'm waiting to hear from Masami if it fixes the issues he saw.
-- Steve
Steve,
Do you want me to apply this patch from Daniel or do you plan to send one. If you want to me take this one, just Ack it.
thanks,
-- Shuah
Quoted 10 lines · On Tue, 16 Oct 2018 12:02:20 -0500 Daniel Díaz <daniel.diaz at linaro.org>…
If test is being directly executed (with stdout opened on the terminal) and the terminal capabilities indicate enough colors, then use the existing scheme of green, red, and blue to show when tests pass, fail or end in a different way.
When running the tests redirecting the stdout, for instance, to a file, then colors are not shown, thus producing a more readable output.
Signed-off-by Daniel Díaz <daniel.diaz at linaro.org>
Shuah, can you pull this into your tree?
Thanks,
-- Steve
Shuah Khan
maintainerQuoted 12 lines · Steven Rostedt
Quoted 9 lines · On Tue, 16 Oct 2018 12:02:20 -0500 Daniel Díaz <daniel.diaz at linaro.org>…
If test is being directly executed (with stdout opened on the terminal) and the terminal capabilities indicate enough colors, then use the existing scheme of green, red, and blue to show when tests pass, fail or end in a different way.
When running the tests redirecting the stdout, for instance, to a file, then colors are not shown, thus producing a more readable output.
Quoted 6 lines
Quoted 1 line
Signed-off-by Daniel Díaz <daniel.diaz at linaro.org>Acked-by Steven Rostedt (VMware) <rostedt at goodmis.org>Shuah, can you pull this into your tree?
Applied to linux-ksefltest next for 4.20-rc1
thanks,
-- Shuah