static_analysis/checkpatch_presubmit.sh

#!/bin/bash

# Copyright (C) 2019 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.

# Wrapper around checkpatch.sh to gather necessary information from the
# dist dir. Notably, this includes the git_sha1 and whether to suppress
# the check for post-submit.

set -e

export STATIC_ANALYSIS_SRC_DIR=$(dirname $(readlink -f $0))

source ${STATIC_ANALYSIS_SRC_DIR}/../_setup_env.sh
export OUT_DIR=$(readlink -m ${OUT_DIR:-${ROOT_DIR}/out/${BRANCH}})
export DIST_DIR=$(readlink -m ${DIST_DIR:-${OUT_DIR}/dist})

APPLIED_PROP_PATH=${DIST_DIR}/applied.prop
BUILD_INFO_PATH=${DIST_DIR}/BUILD_INFO

verify_file_exists() {
  if [[ ! -f $1 ]]; then
    echo "Missing $1"
    exit 1
  fi
}

# Parse flags.
BUILD_ID=""
FORWARDED_ARGS=()
while [[ $# -gt 0 ]]; do
  next="$1"
  case ${next} in
  --bid)
    BUILD_ID="$2"
    shift
    ;;
  --help)
    echo "Checks whether given build is for presubmit. If so, extract git_sha1"
    echo "from repo.prop and invoke checkpatch.sh."
    echo ""
    echo "Usage: $0"
    echo "  <--bid nnn> (The build ID. Required.)"
    echo "  <args for checkpatch.sh>"
    exit 0
    ;;
  *)
    FORWARDED_ARGS+=("$1")
    ;;
  esac
  shift
done

if [[ -z $BUILD_ID ]]; then
  echo "WARNING: No --bid supplied. Assuming not presubmit build. Exiting."
  exit 0
fi

# Skip checkpatch for postsubmit (b/35390488).
set +e
echo "${BUILD_ID}" | grep -E "^P[0-9]+"
if [[ $? -ne 0 ]]; then
   echo "Did not identify a presubmit build. Exiting."
   exit 0
fi
set -e

# Pick the correct patch to test.
verify_file_exists ${APPLIED_PROP_PATH}

# Check for external modules first
if EXT_MODULES=$(. ${ROOT_DIR}/build.config 2>/dev/null && echo ${EXT_MODULES}); then
  for EXT_MOD in ${EXT_MODULES}; do
    EXT_GIT_SHA1=$(sed -nE "s#^${EXT_MOD} .*([0-9a-f]{40}).*#\\1#p" "${APPLIED_PROP_PATH}")
    if [[ -n "${EXT_GIT_SHA1}" ]]; then
      # Skip merge commits
      if [ $(git -C ${EXT_MOD} show --no-patch --format="%p" ${EXT_GIT_SHA1} | wc -w) -gt 1 ] ; then
        echo "Merge commit detected for ${EXT_MOD}. Skipping this check."
      else
        ${STATIC_ANALYSIS_SRC_DIR}/checkpatch.sh --git_sha1 ${EXT_GIT_SHA1} \
          --ext_mod ${EXT_MOD} ${FORWARDED_ARGS[*]}
      fi
    fi
  done
fi

GIT_SHA1=$(sed -nE "s#^${KERNEL_DIR} .*([0-9a-f]{40}).*#\\1#p" "${APPLIED_PROP_PATH}")
if [[ -z ${GIT_SHA1} ]]; then
  # Since applied.prop only tracks user changes, ignore projects that are
  # included in presubmit without any changed files.
  echo "No changes to apply for ${KERNEL_DIR}."
  exit 0
fi

# Skip checkpatch for merge commits on common kernels
# These are upstream merges that likely hit issues in checkpatch.pl or merges
# from other common kernel repositories where _this_ check has been run as part
# of the developement process.
if [ "${KERNEL_DIR}" == "common" ]; then
    if [ $(git -C ${KERNEL_DIR} show --no-patch --format="%p" ${GIT_SHA1} | wc -w) -gt 1 ] ; then
        echo "Merge commit detected for a ${KERNEL_DIR} kernel. Skipping this check."
        exit 0
    fi

    SUBJECT=$(git -C ${KERNEL_DIR} show --no-patch --format="%s" ${GIT_SHA1})
    if [[ "$SUBJECT" =~ ^UPSTREAM|^BACKPORT|^FROMGIT ]]; then
        echo "Not linting upstream patches for a ${KERNEL_DIR} kernel. Skipping this check."
        exit 0
    fi
fi

${STATIC_ANALYSIS_SRC_DIR}/checkpatch.sh --git_sha1 ${GIT_SHA1} ${FORWARDED_ARGS[*]}