Add consistency check for qualifiers in CF and JDK (#1142)

Co-authored-by: Werner Dietl <[email protected]>

Author: Ao-senXiong

checker/bin-devel/test-misc.sh

@@ -70,3 +70,57 @@ git diff --exit-code docs/manual/contributors.tex || \
      echo "    https://github.com/eisop-plume-lib/git-scripts/blob/master/git-authors.sed" &&
      echo "    and remake contributors.tex after that pull request is merged." &&
      false)
+
+# Check the definition of qualifiers in Checker Framework against the JDK
+echo "Checking the definition of qualifiers in Checker Framework against the JDK"
+CURRENT_PATH=$(pwd)
+src_dir="$CURRENT_PATH/checker-qual/src/main/java/org/checkerframework"
+jdk_dir="$CURRENT_PATH/../jdk/src/java.base/share/classes/org/checkerframework"
+set +o xtrace  # Turn off xtrace to avoid verbose output
+
+difference_found=false
+file_missing_in_jdk=false
+file_removed_in_cf=false
+
+while read -r file; do
+    # Use parameter expansion to get the relative path of the file
+    # e.g. rel_path= "checker/nullness/qual/Nullable.java"
+    rel_path="${file#"$src_dir"/}"
+    jdk_file="$jdk_dir/$rel_path"
+
+    # Check if the file exists in the JDK directory
+    if [ ! -f "$jdk_file" ]; then
+        echo "File missing in JDK: $rel_path"
+        file_missing_in_jdk=true
+    else
+        diff_output=$(diff -q "$file" "$jdk_file" || true)
+
+        if [ "$diff_output" ]; then
+            echo "Difference found in: $rel_path"
+            diff "$file" "$jdk_file" || true  # Show the full diff
+
+            difference_found=true
+        fi
+    fi
+done < <(find "$src_dir" -name "*.java")
+
+# Check for files in the JDK that are not in CF
+while read -r jdk_file; do
+    rel_path="${jdk_file#"$jdk_dir"/}"
+    cf_file="$src_dir/$rel_path"
+
+    if [ ! -f "$cf_file" ]; then
+        echo "File removed in CF: $rel_path"
+        file_removed_in_cf=true
+    fi
+done < <(find "$jdk_dir" -name "*.java")
+
+# If any difference, missing, or removed file was found, exit with failure
+if [ "$difference_found" = true ] || [ "$file_missing_in_jdk" = true ] || [ "$file_removed_in_cf" = true ]; then
+    echo "Differences found or files missing/removed. Exiting with failure."
+    exit 1  # Exit with failure
+else
+    echo "No differences found and no files missing/removed."
+fi
+
+set -o xtrace  # Turn on xtrace output