chore(travis): add folding to logging output

This folds the output of the logging (karma, sauce-connect etc).
Sometimes, an individual log will still be output completely,
but overall the logs are folded, which makes it easy to scroll
to the bottom of the Travis log and see the last non-log output
(e.g. test failures).

Author: Narretz

lib/saucelabs/start_tunnel.sh

@@ -16,7 +16,7 @@ CONNECT_URL="https://saucelabs.com/downloads/sc-$SC_VERSION-linux.tar.gz"
 CONNECT_DIR="/tmp/sauce-connect-$RANDOM"
 CONNECT_DOWNLOAD="sc-$SC_VERSION-linux.tar.gz"
 
-CONNECT_LOG="$LOGS_DIR/sauce-connect"
+CONNECT_LOG="$LOGS_DIR/sauce-connect.log"
 CONNECT_STDOUT="$LOGS_DIR/sauce-connect.stdout"
 CONNECT_STDERR="$LOGS_DIR/sauce-connect.stderr"
 

scripts/travis/_travis_fold.sh

@@ -0,0 +1,77 @@
+# Based on https://github.com/angular/angular/blob/410aa33005f2dc6f6500db71e7f019a744f909d9/scripts/ci/_travis-fold.sh
+# private variable to track folds within this script
+travisFoldStack=()
+
+function travisFoldStart() {
+  local foldName="${0#./}  ${1}"
+  # get current time as nanoseconds since the beginning of the epoch
+  foldStartTime=$(date +%s%N)
+  # convert all non alphanum chars except for "-" and "." to "--"
+  local sanitizedFoldName=${foldName//[^[:alnum:]\-\.]/--}
+  # strip trailing "-"
+  sanitizedFoldName=${sanitizedFoldName%-}
+  # push the foldName onto the stack
+  travisFoldStack+=("${sanitizedFoldName}|${foldStartTime}")
+
+  echo ""
+  if [[ ${TRAVIS:-} ]]; then
+    echo "travis_fold:start:${sanitizedFoldName}"
+    echo "travis_time:start:${sanitizedFoldName}"
+  fi
+  local enterArrow="===>  ${foldName}  ==>==>==>==>==>==>==>==>==>==>==>==>==>==>==>==>==>==>==>==>==>==>==>==>==>==>==>==>==>"
+  # keep all messages consistently wide 80chars regardless of the foldName
+  echo ${enterArrow:40:100}
+  # turn on verbose mode so that we have better visibility into what's going on
+  # http://tldp.org/LDP/Bash-Beginners-Guide/html/sect_02_03.html#table_02_01
+  set -x
+}
+
+function travisFoldEnd() {
+  set +x
+  local foldName="${0#./}  ${1}"
+  # convert all non alphanum chars except for "-" and "." to "--"
+  local sanitizedFoldName=${foldName//[^[:alnum:]\-\.]/--}
+  # strip trailing "-"
+  sanitizedFoldName=${sanitizedFoldName%-}
+
+  # consult and update travisFoldStack
+  local lastFoldIndex=$(expr ${#travisFoldStack[@]} - 1)
+  local lastFoldString=${travisFoldStack[$lastFoldIndex]}
+  # split the string by | and then turn that into an array
+  local lastFoldArray=(${lastFoldString//\|/ })
+  local lastSanitizedFoldName=${lastFoldArray[0]}
+
+  if [[ ${TRAVIS:-} ]]; then
+    local lastFoldStartTime=${lastFoldArray[1]}
+    local foldFinishTime=$(date +%s%N)
+    local foldDuration=$(expr ${foldFinishTime} - ${lastFoldStartTime})
+  fi
+
+  # pop
+  travisFoldStack=(${travisFoldStack[@]:0:lastFoldIndex})
+
+  # check for misalignment
+  if [[ ${lastSanitizedFoldName} != ${sanitizedFoldName} ]]; then
+    echo "Travis fold mis-alignment detected! travisFoldEnd expected sanitized fold name '${lastSanitizedFoldName}', but received '${sanitizedFoldName}' (after sanitization)"
+    exit 1
+  fi
+
+  local returnArrow="<===  ${foldName}  <==<==<==<==<==<==<==<==<==<==<==<==<==<==<==<==<==<==<==<==<==<==<==<==<==<==<==<==<==<==<==<=="
+  # keep all messages consistently wide 80chars regardless of the foldName
+  echo ${returnArrow:40:100}
+  echo ""
+  if [[ ${TRAVIS:-} ]]; then
+    echo "travis_time:end:${sanitizedFoldName}:start=${lastFoldStartTime},finish=${foldFinishTime},duration=${foldDuration}"
+    echo "travis_fold:end:${sanitizedFoldName}"
+  fi
+}
+
+function travisFoldReturnArrows() {
+  # print out return arrows so that it's easy to see the end of the script in the log
+  echo ""
+  returnArrow="<===  ${0#./}  <==<==<==<==<==<==<==<==<==<==<==<==<==<==<==<==<==<==<==<==<==<==<==<==<==<==<==<==<==<==<=="
+  # keep all messages consistently wide 80chars regardless of the foldName
+  echo ${returnArrow:40:100}
+  echo "<==<==<==<==<==<==<==<==<==<==<==<==<==<==<==<==<==<==<==<==<==<==<==<==<==<==<==<==<==<==<==<==<==="
+  echo ""
+}

scripts/travis/print_logs.sh

@@ -2,10 +2,21 @@
 
 LOG_FILES=$LOGS_DIR/*
 
+#!/usr/bin/env bash
+
+set -u -e -o pipefail
+
+# Setup environment
+readonly thisDir=$(cd $(dirname $0); pwd)
+source ${thisDir}/_travis_fold.sh
+
+
 for FILE in $LOG_FILES; do
-  echo -e "\n\n\n"
-  echo "================================================================================"
-  echo " $FILE"
-  echo "================================================================================"
-  cat $FILE
+  travisFoldStart "print log file: ${FILE}"
+    cat $FILE
+  travisFoldEnd "print log file: ${FILE}"
 done
+
+
+# Print return arrows as a log separator
+travisFoldReturnArrows