From 60540fd4bf1ea549a22b8a0dc473446379b88516 Mon Sep 17 00:00:00 2001
From: Michael Muller <mmuller@google.com>
Date: Wed, 17 Mar 2021 10:29:32 -0400
Subject: [PATCH] Allow java-format to use java from the PATH (#1014)

* Allow java-format to use java from the PATH

When invoking java from the google-java-format-git-diff.sh script, if there is
no JAVA_HOME environment variable, attempt to instead run the java binary that
is on the PATH.

This also adds a few checks to verify that a java binary is available in one
of those locations and that the version discovered is Java 11 (which we know
to be compatible with the google-java-format jar).

Tested:
- unset JAVA_HOME, verified that we get the version on the PATH
- Set JAVA_HOME to an invalid directory, verified that we get an error.
- Changed the "which" command to lookup an nonexistent binary, unset JAVA_HOME
  and verified that we get a "java not found" error.
- Changed the path to point to an old version of java, verified that we get a
  "bad java version" error.
- Verified that the script still runs normally.
---
 java-format/google-java-format-git-diff.sh | 28 +++++++++++++++++++---
 1 file changed, 25 insertions(+), 3 deletions(-)

diff --git a/java-format/google-java-format-git-diff.sh b/java-format/google-java-format-git-diff.sh
index 20601ca37..00356bc1b 100755
--- a/java-format/google-java-format-git-diff.sh
+++ b/java-format/google-java-format-git-diff.sh
@@ -42,6 +42,28 @@ where:
 SCRIPT_DIR="$(realpath $(dirname $0))"
 JAR_NAME="google-java-format-1.8-all-deps.jar"
 
+# Locate the java binary.
+if [ -n "$JAVA_HOME" ]; then
+  JAVA_BIN="$JAVA_HOME/bin/java"
+  if [ ! -x "$JAVA_BIN" ]; then
+    echo "No java binary found in JAVA_HOME (JAVA_HOME is $JAVA_HOME)"
+    exit 1
+  fi
+else
+  # Use java from the path.
+  JAVA_BIN="$(which java)" || JAVA_BIN=""
+  if [ -z "$JAVA_BIN" ]; then
+    echo "JAVA_HOME is not defined and java was not found on the path"
+    exit 1
+  fi
+fi
+
+if ! "$JAVA_BIN" -version 2>&1 | grep 'version "11\.' >/dev/null; then
+  echo "Bad java version.  Requires java 11, got:"
+  "$JAVA_BIN" -version
+  exit 1
+fi
+
 function showNoncompliantFiles() {
   local forkPoint="$1"
   local message="$2"
@@ -63,7 +85,7 @@ function callGoogleJavaFormatDiff() {
       showNoncompliantFiles "$forkPoint" "\033[1mNeeds formatting: "
       callResult=$(git diff -U0 ${forkPoint} | \
           ${SCRIPT_DIR}/google-java-format-diff.py \
-          --java-binary "$JAVA_HOME/bin/java" \
+          --java-binary "$JAVA_BIN" \
           --google-java-format-jar "${SCRIPT_DIR}/${JAR_NAME}" \
           -p1 | wc -l)
       ;;
@@ -71,14 +93,14 @@ function callGoogleJavaFormatDiff() {
       showNoncompliantFiles "$forkPoint" "\033[1mReformatting: "
       callResult=$(git diff -U0 ${forkPoint} | \
           ${SCRIPT_DIR}/google-java-format-diff.py \
-          --java-binary "$JAVA_HOME/bin/java" \
+          --java-binary "$JAVA_BIN" \
           --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" \
+          --java-binary "$JAVA_BIN" \
           --google-java-format-jar "${SCRIPT_DIR}/${JAR_NAME}" \
           -p1)
       ;;