development/build_log_processor.sh

#!/bin/bash
#
# Copyright (C) 2020 The Android Open Source Project
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#      http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

set -e

usage() {
  echo "usage: $0 <command> <arguments> [options]"
  echo
  echo "Executes <command> <arguments> and then runs build_log_simplifier.py against its output"
  echo
  echo "-Pandroidx.validateNoUnrecognizedMessages"
  echo "  Run build_log_simplifier.py --validate on success to confirm that the build generated no unrecognized messages"
  exit 1
}

if [[ "$1" == "" ]]; then
  usage
fi

validateNoUnrecognizedMessagesOnSuccess=false
validateArgument="-Pandroidx.validateNoUnrecognizedMessages"
if [[ " ${@} " =~ " $validateArgument " ]]; then
  validateNoUnrecognizedMessagesOnSuccess=true
fi
if [[ " ${@} " =~ " ${validateArgument}=false " ]]; then
  validateNoUnrecognizedMessagesOnSuccess=false
fi
printTimestamps=false
timestampsArgument="-Pandroidx.printTimestamps"
if [[ " ${@} " =~ " ${timestampsArgument} " ]]; then
  printTimestamps=true
fi

# identify some filepaths
SCRIPT_PATH="$(cd $(dirname $0) && pwd)"
CHECKOUT="$(cd "$SCRIPT_PATH/../../.." && pwd)"
if [ -n "$DIST_DIR" ]; then
  LOG_DIR="$DIST_DIR/logs"
else
  LOG_DIR="$CHECKOUT/out/dist/logs"
fi

mkdir -p "$LOG_DIR"
logFile="$LOG_DIR/gradle.log"

# Move any preexisting $logFile to make room for a new one
# After moving $logFile several times it eventually gets deleted
function rotateLogs() {
  iPlus1="10"
  for i in $(seq 9 -1 1); do
    mv "$LOG_DIR/gradle.${i}.log" "$LOG_DIR/gradle.${iPlus1}.log" 2>/dev/null || true
    iPlus1=$i
  done
  mv $logFile "$LOG_DIR/gradle.1.log" 2>/dev/null || true
}
rotateLogs

# Save OUT_DIR and some other variables into the log file so build_log_simplifier.py can
# identify them later
echo "OUT_DIR=$OUT_DIR" | tee -a $logFile
if [ "$DIST_DIR" == "" ]; then
  DIST_DIR="$OUT_DIR/dist"
fi
echo "DIST_DIR=$DIST_DIR" | tee -a $logFile
echo "CHECKOUT=$CHECKOUT" | tee -a $logFile
if [ "$GRADLE_USER_HOME" == "" ]; then
  GRADLE_USER_HOME="$(cd && pwd)/.gradle"
fi
echo "GRADLE_USER_HOME=$GRADLE_USER_HOME" | tee -a $logFile
programName="$1"
shift

if [ "$printTimestamps" == "true" ]; then
  # this program adds a timestamp to each line of input, and echos the result
  timestampPrinter="$SCRIPT_PATH/ts.py"
else
  # this program just echos its input
  timestampPrinter=cat
fi

if "$programName" "$@" > >(tee -a "$logFile" | "$timestampPrinter") 2>&1; then
  if [ "$validateNoUnrecognizedMessagesOnSuccess" == "true" ]; then
    if $SCRIPT_PATH/build_log_simplifier.py --validate $logFile >&2; then
      echo No unrecognized messages found in build log
    else
      exit 1
    fi
  fi
else
  echo >&2
  echo "############################################################################" >&2
  echo "Attempting to locate the relevant error messages via build_log_simplifier.py" >&2
  echo "############################################################################" >&2
  echo >&2
  # Try to identify the most relevant lines of output, and put them at the bottom of the
  # output where they will also be placed into the build failure email.
  # TODO: We may be able to stop cleaning up Gradle's output after Gradle can do this on its own:
  # https://github.com/gradle/gradle/issues/1005
  # and https://github.com/gradle/gradle/issues/13090
  summaryLog="$LOG_DIR/error_summary.log"
  $SCRIPT_PATH/build_log_simplifier.py $logFile | tee "$summaryLog" >&2
  exit 1
fi