[LTP] [RFC PATCH v2 1/1] test.sh: colorize the output
Petr Vorel
pvorel@suse.cz
Fri Jan 20 17:10:24 CET 2017
By default colorize unless using pipe or redirect to file.
It's possible to force behaviour with LTP_COLORIZE_OUTPUT environment
variable:
y or 1: allways colorize
n or 0: never colorize
Signed-off-by: Petr Vorel <pvorel@suse.cz>
---
TODO:
* Allow user to define colors (overwrite with environment variables) -
allow to handle dark vs. light terminal background.
* Colorize also "ltp-pan reported PASS|FAIL".
* DOC: where to put docs?
* DRY: Keep default definition only on one place => generate with make?
---
include/ansi_colors.h | 68 +++++++++++++++++++++++++++++++++++++++++++++++++++
lib/tst_res.c | 32 +++++++++++++++++++++---
lib/tst_test.c | 30 ++++++++++++++++++-----
testcases/lib/test.sh | 37 +++++++++++++++++++++++++++-
4 files changed, 157 insertions(+), 10 deletions(-)
create mode 100644 include/ansi_colors.h
diff --git a/include/ansi_colors.h b/include/ansi_colors.h
new file mode 100644
index 000000000..fbe602f00
--- /dev/null
+++ b/include/ansi_colors.h
@@ -0,0 +1,68 @@
+/*
+ * Copyright (c) 2017 Petr Vorel <pvorel@suse.cz>
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program. If not, see <http://www.gnu.org/licenses/>.
+ */
+
+/*
+ * NOTE: these colors should match colors defined in tst_flag2color() in
+ * testcases/lib/test.sh
+ */
+#define ANSI_COLOR_BLUE "\e[1;34m"
+#define ANSI_COLOR_GREEN "\e[1;32m"
+#define ANSI_COLOR_RED "\e[1;31m"
+#define ANSI_COLOR_YELLOW "\e[1;33m"
+#define ANSI_COLOR_RESET "\E[00m"
+
+static inline char* ttype2color(int ttype) {
+ switch (TTYPE_RESULT(ttype)) {
+ case TPASS:
+ return ANSI_COLOR_GREEN;
+ break;
+ case TFAIL:
+ return ANSI_COLOR_RED;
+ break;
+ case TBROK:
+ return ANSI_COLOR_YELLOW;
+ break;
+ case TCONF:
+ return ANSI_COLOR_YELLOW;
+ break;
+ case TWARN:
+ return ANSI_COLOR_YELLOW;
+ break;
+ case TINFO:
+ return ANSI_COLOR_GREEN;
+ break;
+ default:
+ return "";
+ }
+}
+
+static inline int color_enabled() {
+ char *env = getenv("LTP_COLORIZE_OUTPUT");
+
+ if (env != NULL) {
+ if (strcmp(env, "n") == 0 || strcmp(env, "0") == 0)
+ return 0;
+
+ if (strcmp(env, "y") == 0 || strcmp(env, "1") == 0)
+ return 1;
+ }
+
+ if (isatty(STDOUT_FILENO) == 0)
+ return 0;
+
+ return 1;
+}
diff --git a/lib/tst_res.c b/lib/tst_res.c
index 61daaeb49..fe8d15112 100644
--- a/lib/tst_res.c
+++ b/lib/tst_res.c
@@ -50,6 +50,7 @@
#include "test.h"
#include "usctest.h"
#include "ltp_priv.h"
+#include "ansi_colors.h"
long TEST_RETURN;
int TEST_ERRNO;
@@ -254,7 +255,8 @@ static void tst_print(const char *tcid, int tnum, int ttype, const char *tmesg)
const char *type;
int ttype_result = TTYPE_RESULT(ttype);
char message[USERMESG];
- size_t size;
+ size_t size = 0;
+ int color = color_enabled();
/*
* Save the test result type by ORing ttype into the current exit value
@@ -280,11 +282,23 @@ static void tst_print(const char *tcid, int tnum, int ttype, const char *tmesg)
* Build the result line and print it.
*/
type = strttype(ttype);
+
+ if (color) {
+ char *color = ttype2color(ttype);
+
+ size += snprintf(message + size, sizeof(message) - size, color);
+
+ if (size >= sizeof(message)) {
+ printf("%s: %i: line too long\n", __func__, __LINE__);
+ abort();
+ }
+ }
+
if (T_mode == VERBOSE) {
- size = snprintf(message, sizeof(message),
+ size += snprintf(message + size, sizeof(message) - size,
"%-8s %4d %s : %s", tcid, tnum, type, tmesg);
} else {
- size = snprintf(message, sizeof(message),
+ size += snprintf(message + size, sizeof(message) - size,
"%-8s %4d %s : %s",
tcid, tnum, type, tmesg);
}
@@ -305,6 +319,8 @@ static void tst_print(const char *tcid, int tnum, int ttype, const char *tmesg)
abort();
}
+
+
if (ttype & TTERRNO) {
size += snprintf(message + size, sizeof(message) - size,
": TEST_ERRNO=%s(%i): %s",
@@ -324,6 +340,16 @@ static void tst_print(const char *tcid, int tnum, int ttype, const char *tmesg)
strerror(TEST_RETURN));
}
+ if (color) {
+ if (size >= sizeof(message)) {
+ printf("%s: %i: line too long\n", __func__, __LINE__);
+ abort();
+ }
+
+ size += snprintf(message + size, sizeof(message) - size,
+ ANSI_COLOR_RESET);
+ }
+
if (size + 1 >= sizeof(message)) {
printf("%s: %i: line too long\n", __func__, __LINE__);
abort();
diff --git a/lib/tst_test.c b/lib/tst_test.c
index c48d71877..bd47d8f2f 100644
--- a/lib/tst_test.c
+++ b/lib/tst_test.c
@@ -29,6 +29,7 @@
#include "tst_test.h"
#include "tst_device.h"
#include "lapi/futex.h"
+#include "ansi_colors.h"
#include "old_resource.h"
#include "old_device.h"
@@ -164,6 +165,7 @@ static void print_result(const char *file, const int lineno, int ttype,
int ret, size = sizeof(buf);
const char *str_errno = NULL;
const char *res;
+ int color = color_enabled();
switch (TTYPE_RESULT(ttype)) {
case TPASS:
@@ -194,20 +196,36 @@ static void print_result(const char *file, const int lineno, int ttype,
if (ttype & TTERRNO)
str_errno = tst_strerrno(TEST_ERRNO);
- ret = snprintf(str, size, "%s:%i: %s: ", file, lineno, res);
+ if (color) {
+ char *color = ttype2color(ttype);
+
+ ret = snprintf(str, size, "%s", color);
+ str += ret;
+ size -= ret;
+ }
+ ret = snprintf(str, size, "%s:%i: %s: ", file, lineno, res);
str += ret;
size -= ret;
ret = vsnprintf(str, size, fmt, va);
-
str += ret;
size -= ret;
- if (str_errno)
- snprintf(str, size, ": %s\n", str_errno);
- else
- snprintf(str, size, "\n");
+ if (str_errno) {
+ ret = snprintf(str, size, ": %s", str_errno);
+ str += ret;
+ size -= ret;
+ }
+
+ if (color) {
+ ret = snprintf(str, size, ANSI_COLOR_RESET);
+ str += ret;
+ size -= ret;
+ }
+
+ snprintf(str, size, "\n");
+
fputs(buf, stderr);
}
diff --git a/testcases/lib/test.sh b/testcases/lib/test.sh
index 76b706267..c3321f706 100644
--- a/testcases/lib/test.sh
+++ b/testcases/lib/test.sh
@@ -39,15 +39,50 @@ tst_flag2mask()
esac
}
+tst_flag2color()
+{
+ # NOTE: these colors should match colors defined in include/ansi_colors.h
+ local blue='\e[1;34m'
+ local green='\e[1;32m'
+ local red='\e[1;31m'
+ local yellow='\e[1;33m'
+
+ case "$1" in
+ TPASS) printf $green;;
+ TFAIL) printf $red;;
+ TBROK) printf $yellow;;
+ TWARN) printf $yellow;;
+ TINFO) printf $blue;;
+ TCONF) printf $yellow;;
+ *) tst_brkm TBROK "Invalid resm type '$1'";;
+ esac
+}
+
+tst_color_enabled()
+{
+ [ "$LTP_COLORIZE_OUTPUT" = "n" ] || [ "$LTP_COLORIZE_OUTPUT" = "0" ] && return 0
+ [ "$LTP_COLORIZE_OUTPUT" = "y" ] || [ "$LTP_COLORIZE_OUTPUT" = "1" ] && return 1
+ [ -t 1 ] || return 0
+ return 1
+}
+
tst_resm()
{
- tst_flag2mask "$1"
+ local ttype="$1"
+
+ tst_flag2mask "$ttype"
local mask=$?
LTP_RET_VAL=$((LTP_RET_VAL|mask))
+ tst_color_enabled
+ local color=$?
+
local ret=$1
shift
+
+ [ "$color" = "1" ] && tst_flag2color "$ttype"
echo "$TCID $TST_COUNT $ret : $@"
+ [ "$color" = "1" ] && printf '\E[00m'
case "$ret" in
TPASS|TFAIL)
--
2.11.0
More information about the ltp
mailing list