HBASE-16241 Allow specification of annotations to use when running check_compatibility.sh

* Also some trivial cleanup of spacing to undo poor formatting decisions
  of the past.

Signed-off-by: stack <stack@apache.org>
Signed-off-by: Sean Busbey <busbey@apache.org>

dev-support/check_compatibility.sh

@@ -47,6 +47,8 @@
 #          $ ./check_compatibility.sh 0.98.5 0.98.6
 
 SCRIPT_DIRECTORY=$(dirname ${BASH_SOURCE[0]})
+# Save the InterfaceAudience package name as a variable to make annotation listing more convenient.
+IA_PACKAGE="org.apache.hadoop.hbase.classification.InterfaceAudience"
 
 # Usage message.
 usage () {
@@ -70,15 +72,21 @@ Options:
   -f, --force-download                  Download dependencies (i.e. Java ACC), even if they are
                                         already present.
   -h, --help                            Show this screen.
-  -j, --java-acc                Specify which version of Java ACC to use to run the analysis. This
+  -j, --java-acc                        Specify which version of Java ACC to use to run the
-                                can be a tag, branch, or commit hash. Defaults to master.
+                                        analysis. This can be a tag, branch, or commit hash.
+                                        Defaults to master.
+  -l <list>, --annotation-list=<list>   A comma-separated list of annotations to limit compatibility
+                                        checks to. Defaults to
+                                        "${IA_PACKAGE}.Public,${IA_PACKAGE}.LimitedPrivate".
   -n, --no-checkout                     Run the tool without first using Git to checkout the two
                                         HBase versions. If this option is selected,
                                         dev-support/target/compatibility/1 and
-                                dev-support/target compatibility/2 must each be Git repositories.
+                                        dev-support/target compatibility/2 must each be Git
-                                Also note that the references must still be specified as these are
+                                        repositories. Also note that the references must still be
-                                used when naming the compatibility report.
+                                        specified as these are used when naming the compatibility
-  -o <opts>, --options=<opts>   A comma-separated list of options to pass directly to Java ACC.
+                                        report.
+  -o <opts>, --options=<opts>           A comma-separated list of options to pass directly to Java
+                                        ACC.
   -q, --quick                           Runs Java ACC in quick analysis mode, which disables a
                                         number of checks for things that may break compatibility.
   -r <url>, --repo=<url>                URL of the HBase Git repository to use. Defaults to Apache
@@ -90,9 +98,10 @@ __EOF
 # Allow a user to override which GETOPT to use, as described in the header.
 GETOPT=${GETOPT:-/usr/bin/env getopt}
 
-# Parse command line arguments and check for proper syntax.
+# Parse command line arguments. We split long options (-l) to stay under 100 chars.
-if ! ARG_LIST=$(${GETOPT} -q -o abfhj:no:qr:s \
+if ! ARG_LIST=$(${GETOPT} -q -o abfhj:nl:o:qr:s \
-    -l all,binary-only,force-download,help,java-acc:,no-checkout,options:,quick,repo:,source-only \
+    -l all,annotation-list:,binary-only,force-download,help \
+    -l java-acc:,no-checkout,options:,quick,repo:,source-only \
     -- "${@}"); then
   usage >&2
   exit 2
@@ -100,6 +109,7 @@ fi
 eval set -- "${ARG_LIST[@]}"
 
 # Set defaults for options in case they're not specified on the command line.
+ANNOTATION_LIST=(${IA_PACKAGE}.Public ${IA_PACKAGE}.LimitedPrivate)
 JAVA_ACC_COMMIT="master"
 REPO_URL="https://github.com/apache/hbase.git"
 
@@ -120,6 +130,10 @@ while ((${#})); do
     -j | --java-acc )
       JAVA_ACC_COMMIT="${2}"
       shift 2 ;;
+    -l | --annotation-list )
+      # Process the comma-separated list of annotations and overwrite the default list.
+      ANNOTATION_LIST=($(tr "," "\n" <<< "${2}"))
+      shift 2 ;;
     -n | --no-checkout )
       NO_CHECKOUT=true
       shift 1 ;;
@@ -260,16 +274,8 @@ if [ ! -d ${SCRIPT_DIRECTORY}/target/compatibility/javaACC ] || [ -n "${FORCE_DO
   fi
 fi
 
-# Generate annotation list dynamically; this way, there's no chance the file
+# Generate one-per-line list of annotations.
-# gets stale and you have better visiblity into what classes are actually analyzed.
+tr " " "\n" <<< "${ANNOTATION_LIST[@]}" > "${SCRIPT_DIRECTORY}/target/compatibility/annotations"
-declare -a ANNOTATION_LIST
-ANNOTATION_LIST+=(org.apache.hadoop.hbase.classification.InterfaceAudience.Public)
-ANNOTATION_LIST+=(org.apache.hadoop.hbase.classification.InterfaceAudience.LimitedPrivate)
-if ! [ -f ${SCRIPT_DIRECTORY}/target/compatibility/annotations ]; then
-  cat > ${SCRIPT_DIRECTORY}/target/compatibility/annotations << __EOF
-$(tr " " "\n" <<< "${ANNOTATION_LIST[@]}")
-__EOF
-fi
 
 # Generate command line arguments for Java ACC.
 JAVA_ACC_COMMAND+=(-l HBase)
@@ -288,4 +294,5 @@ rm -rf ${SCRIPT_DIRECTORY}/target/compatibility/report
 # compatible, an exit code of 1 if the two versions are not, and several other codes
 # for various errors. See the tool's website for details.
 echo "Running the Java API Compliance Checker..."
-perl ${SCRIPT_DIRECTORY}/target/compatibility/javaACC/japi-compliance-checker.pl ${JAVA_ACC_COMMAND[@]}
+perl "${SCRIPT_DIRECTORY}/target/compatibility/javaACC/japi-compliance-checker.pl" \
+    "${JAVA_ACC_COMMAND[@]}"