mirror of
https://github.com/google/nomulus.git
synced 2025-04-29 19:47:51 +02:00
e3ab5ed4c1
* Don't use --fork-point to determine merge base It turns out that the --fork-point option is subtle and error-prone. Its intent is not to show the nearest common base commit, but rather the commit on a branch that the HEAD (in this case) was originally forked off of, _whether it is currently part of the history of the specified branch or not_ (this can happen if the branch is rewritten). The option also relies on the presence of the fork point in the reflog for the branch, which can be discarded in the course of a "git gc". It is fairly easy to construct a case where the use of --fork-point causes an error and outputs nothing. In fact, I discovered the problem as a result of this occuring spontaneously on one of my own branches (likely related to a rebase). Since the fork-point is empty, we end up diffing against the index instead of the common commit. This may have been a factor in some of the unrelated reformatting that we've seen in past PRs. Change this to a simple "merge-base origin/master HEAD", which outputs the commit id of the most recent common base revision. This change also quotes the forkPoint variable, which likely would have resulted in an error in this case instead of silently producing the wrong output.
112 lines
3.6 KiB
Bash
Executable file
112 lines
3.6 KiB
Bash
Executable file
#!/bin/bash
|
|
# Copyright 2019 The Nomulus Authors. All Rights Reserved.
|
|
#
|
|
# 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.
|
|
#
|
|
# This script applies Google Java format to modified regions in Java source
|
|
# files in a Git repository. It assumes that the repository has a 'master'
|
|
# branch that is only used for merging and is never directly worked on.
|
|
#
|
|
# If invoked on the master branch, this script will format the modified lines
|
|
# relative to HEAD. Otherwise, it uses the
|
|
# 'git merge-base --fork-point origin/master' command to find the latest
|
|
# fork point from origin/master, and formats the modified lines between
|
|
# the fork point and the HEAD of the current branch.
|
|
#
|
|
# Background: existing code base does not conform to Google Java format. Since
|
|
# the team wants to keep the 'blame' feature (find last modifier of a line)
|
|
# usable, we do not want to reformat existing code.
|
|
|
|
set -e
|
|
|
|
USAGE="
|
|
$(basename "$0") [--help] check|format|show
|
|
Incrementally format modified java lines in Git.
|
|
|
|
where:
|
|
--help show this help text
|
|
check check if formatting is necessary
|
|
format format files in place
|
|
show show the effect of the formatting as unified diff"
|
|
|
|
SCRIPT_DIR="$(realpath $(dirname $0))"
|
|
JAR_NAME="google-java-format-1.8-all-deps.jar"
|
|
|
|
function showNoncompliantFiles() {
|
|
local forkPoint="$1"
|
|
local message="$2"
|
|
|
|
git diff -U0 ${forkPoint} | \
|
|
${SCRIPT_DIR}/google-java-format-diff.py \
|
|
--google-java-format-jar "${SCRIPT_DIR}/${JAR_NAME}" \
|
|
-p1 | awk -v "message=$message" \
|
|
'/\+\+\+ ([^ ]*)/ { print message $2 }' 1>&2
|
|
}
|
|
|
|
function callGoogleJavaFormatDiff() {
|
|
local forkPoint
|
|
forkPoint=$(git merge-base origin/master HEAD)
|
|
|
|
local callResult
|
|
case "$1" in
|
|
"check")
|
|
showNoncompliantFiles "$forkPoint" "\033[1mNeeds formatting: "
|
|
callResult=$(git diff -U0 ${forkPoint} | \
|
|
${SCRIPT_DIR}/google-java-format-diff.py \
|
|
--java-binary "$JAVA_HOME/bin/java" \
|
|
--google-java-format-jar "${SCRIPT_DIR}/${JAR_NAME}" \
|
|
-p1 | wc -l)
|
|
;;
|
|
"format")
|
|
showNoncompliantFiles "$forkPoint" "\033[1mReformatting: "
|
|
callResult=$(git diff -U0 ${forkPoint} | \
|
|
${SCRIPT_DIR}/google-java-format-diff.py \
|
|
--java-binary "$JAVA_HOME/bin/java" \
|
|
--google-java-format-jar "${SCRIPT_DIR}/${JAR_NAME}" \
|
|
-p1 -i)
|
|
;;
|
|
"show")
|
|
callResult=$(git diff -U0 ${forkPoint} | \
|
|
${SCRIPT_DIR}/google-java-format-diff.py \
|
|
--java-binary "$JAVA_HOME/bin/java" \
|
|
--google-java-format-jar "${SCRIPT_DIR}/${JAR_NAME}" \
|
|
-p1)
|
|
;;
|
|
esac
|
|
echo -e "\033[0m" 1>&2
|
|
echo "${callResult}"
|
|
exit 0
|
|
}
|
|
|
|
function isJavaFormatNeededOnDiffs() {
|
|
local modifiedLineCount
|
|
modifiedLineCount=$(callGoogleJavaFormatDiff "check")
|
|
|
|
if [[ ${modifiedLineCount} -ne 0 ]]; then
|
|
echo "true"
|
|
else
|
|
echo "false"
|
|
fi
|
|
exit 0
|
|
}
|
|
|
|
# The main function of this script:
|
|
if [[ $# -eq 1 && $1 == "check" ]]; then
|
|
isJavaFormatNeededOnDiffs
|
|
elif [[ $# -eq 1 && $1 == "format" ]]; then
|
|
callGoogleJavaFormatDiff "format"
|
|
elif [[ $# -eq 1 && $1 == "show" ]]; then
|
|
callGoogleJavaFormatDiff "show"
|
|
else
|
|
echo "${USAGE}"
|
|
fi
|