test.sh: colorize the output

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 <[email protected]>

---
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

include/ansi_colors.h new file +18 -0

new file mode 100644
index 000000000..fbe602f00
@@ -0,0 +1,68 @@
+/*
+ * Copyright (c) 2017 Petr Vorel <[email protected]>
+ *
+ * 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/>.
+ */
+
+/*

lib/tst_res.c +17 -3

index 61daaeb49..fe8d15112 100644
@@ -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);
 	}

lib/tst_res.c +10 -0

 	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();

lib/tst_test.c +3 -1

index c48d71877..bd47d8f2f 100644
@@ -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) {

testcases/lib/test.sh +16 -0

index 76b706267..c3321f706 100644
@@ -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'";;

Quoted 2 lines

* Allow user to define colors (overwrite with environment variables) - allow to handle dark vs. light terminal background.

I still think that this is too much work for no real gain...

Quoted 1 line

* Colorize also "ltp-pan reported PASS|FAIL".

I would avoid doing any changes to ltp-pan, that code is old and complex and in maintenance mode only.

Quoted 1 line

* DOC: where to put docs?

I'm unsure as well. I guess that we can start a new file under doc/ if we do not find a better fit.

I mean these:

$ git grep -i "echo ltp-pan reported"
testscripts/diskio.sh:  echo ltp-pan reported PASS
testscripts/diskio.sh:  echo ltp-pan reported FAIL
testscripts/network.sh:	echo ltp-pan reported PASS
testscripts/network.sh:	echo ltp-pan reported FAIL
testscripts/runEALtests.sh:  echo ltp-pan reported PASS
testscripts/runEALtests.sh:  echo ltp-pan reported FAIL

Not really important, just nice to have complete. It'd just use colors from tst_ansi_color.sh (separate color file).

Quoted 4 lines

Quoted 1 line

* DOC: where to put docs?

I'm unsure as well. I guess that we can start a new file under doc/ if we do not find a better fit.

Syntax: plain doc or github markdown? Some of files are used for github wiki, but not all.