Feature #8894: Test suite should be able to log to file too, without losing colors on the terminal

Feature #8894

Test suite should be able to log to file too, without losing colors on the terminal

Added by intrigeri 2015-02-12 15:46:02 . Updated 2015-03-23 02:01:37 .

Status:

Resolved

Priority:

Low

Assignee:

Category:

Test suite

Target version:

Tails_1.3.1

Start date:

2015-02-12

Due date:

% Done:

100%

Feature Branch:

test/8894-log-file

Type of work:

Code

Blueprint:

Starter:

Affected tool:

Deliverable for:

Description

By default the test suite logs to the terminal, with fancy colors. Fine. I can also duplicate the output with tee so that I get a log file. However, if I do that, then I lose the nice colors and the output is harder to read. Dear test suite folks, how hard would it be to add a --log-file FILE option that sends a copy of the output to a file, without losing the fancy colored output on the terminal?

Subtasks

History

#1 Updated by anonym 2015-02-12 16:11:36

Assignee set to intrigeri
QA Check set to Info Needed

What about the following? I’m not sure it will log stderr (mostly relevant witht the --debug parameter), FWIW.

--- a/run_test_suite
+++ b/run_test_suite
@@ -103,6 +103,7 @@ capture_session() {
 # main script

 CAPTURE_FILE=
+CUCUMBER_OPTS=
 VNC_VIEWER=
 VNC_SERVER=
 DEBUG=
@@ -113,7 +114,7 @@ TEMP_DIR=
 ISO=
 OLD_ISO=

-LONGOPTS="view,vnc-server-only,capture:,help,temp-dir:,keep-snapshots,retry-find,iso:,old-iso:,debug,pause-on-fail"
+LONGOPTS="view,vnc-server-only,capture:,help,temp-dir:,keep-snapshots,retry-find,iso:,old-iso:,debug,pause-on-fail,log-to-file:"
 OPTS=$(getopt -o "" --longoptions $LONGOPTS -n "${NAME}" -- "$@")
 eval set -- "$OPTS"
 while [ $# -gt 0 ]; do
@@ -133,6 +134,10 @@ while [ $# -gt 0 ]; do
         --debug)
             export DEBUG="yes"
             ;;
+        --log-to-file)
+            shift
+            CUCUMBER_OPTS="${CUCUMBER_OPTS} --out ${1}"
+            ;;
         --pause-on-fail)
             export PAUSE_ON_FAIL="yes"
             ;;
@@ -189,8 +194,10 @@ export JAVA_HOME="/usr/lib/jvm/java-7-openjdk-amd64"
 export SIKULI_HOME="/usr/share/java"
 export DISPLAY=${TARGET_DISPLAY}
 check_dependency cucumber
-if [ -z "${*}" ]; then
-    cucumber --format ExtraHooks::Pretty features
-else
-    cucumber --format ExtraHooks::Pretty features/step_definitions features/support ${*}
+
+FEATURES="${@}"
+if [ -z "${FEATURES}" ]; then
+     FEATURES="features"
 fi
+
+cucumber --format ExtraHooks::Pretty ${CUCUMBER_OPTS} features/step_definitions features/support ${FEATURES}

#2 Updated by anonym 2015-02-12 16:28:44

I missed that you wanted it to log in addition to writing to the terminal. The following patch is better, and also captures stderr FWIW:

--- a/run_test_suite
+++ b/run_test_suite
@@ -103,6 +103,7 @@ capture_session() {
 # main script

 CAPTURE_FILE=
+LOG_FILE=
 VNC_VIEWER=
 VNC_SERVER=
 DEBUG=
@@ -113,7 +114,7 @@ TEMP_DIR=
 ISO=
 OLD_ISO=

-LONGOPTS="view,vnc-server-only,capture:,help,temp-dir:,keep-snapshots,retry-find,iso:,old-iso:,debug,pause-on-fail"
+LONGOPTS="view,vnc-server-only,capture:,help,temp-dir:,keep-snapshots,retry-find,iso:,old-iso:,debug,pause-on-fail,log-to-file:"
 OPTS=$(getopt -o "" --longoptions $LONGOPTS -n "${NAME}" -- "$@")
 eval set -- "$OPTS"
 while [ $# -gt 0 ]; do
@@ -130,6 +131,10 @@ while [ $# -gt 0 ]; do
             shift
             CAPTURE_FILE="$1"
             ;;
+        --log-to-file)
+            shift
+            LOG_FILE="${1}"
+            ;;
         --debug)
             export DEBUG="yes"
             ;;
@@ -189,8 +194,15 @@ export JAVA_HOME="/usr/lib/jvm/java-7-openjdk-amd64"
 export SIKULI_HOME="/usr/share/java"
 export DISPLAY=${TARGET_DISPLAY}
 check_dependency cucumber
-if [ -z "${*}" ]; then
-    cucumber --format ExtraHooks::Pretty features
+
+FEATURES="${@}"
+if [ -z "${FEATURES}" ]; then
+    FEATURES="features" 
+fi
+CUCUMBER_COMMAND="cucumber --format ExtraHooks::Pretty features/step_definitions features/support ${FEATURES}"
+
+if [ -n "${LOG_FILE}" ]; then
+    script -q ${LOG_FILE} -c "${CUCUMBER_COMMAND}" | cat
 else
-    cucumber --format ExtraHooks::Pretty features/step_definitions features/support ${*}
+    ${CUCUMBER_COMMAND}
 fi