chore: Add comments for the script

Author: lqiu96

.github/scripts/test_dependency_compatibility.sh

@@ -29,6 +29,18 @@ function print_help() {
   echo "Use -l {deps_list} for a comma-separated list of dependencies to test (Format: dep1=1.0,dep2=2.0)"
 }
 
+# Function to parse a dependency string and append it to the Maven command
+function add_dependency_to_maven_command() {
+  local dep_pair=$1
+  if [[ ! "${dep_pair}" =~ .*=.* ]]; then
+    echo "Malformed dependency string: ${dep_pair}. Expected format: dependency=version"
+    exit 1
+  fi
+  local dependency=$(echo "${dep_pair}" | cut -d'=' -f1 | tr -d '[:space:]')
+  local version=$(echo "${dep_pair}" | cut -d'=' -f2 | sed 's/^[[:space:]]*//;s/[[:space:]]*$//')
+  MAVEN_COMMAND+=" -D${dependency}.version=${version}"
+}
+
 # Default to the upper bounds file in the root of the repo
 file='dependencies.txt'
 dependency_list=''
@@ -65,15 +77,7 @@ if [ -z "${dependency_list}" ]; then
     if [[ "${line}" =~ ^[[:space:]]*# ]] || [[ -z "${line}" ]]; then
       continue
     fi
-
-    # Extract the dependency name and version
-    # We use 'cut' to split the line by '=' and trim whitespace
-    # The sed command is used to remove potential trailing whitespace from the version number
-    dependency=$(echo "${line}" | cut -d'=' -f1 | tr -d '[:space:]')
-    version=$(echo "${line}" | cut -d'=' -f2 | sed 's/^[[:space:]]*//;s/[[:space:]]*$//')
-
-    # Append the formatted property to the Maven command
-    MAVEN_COMMAND+=" -D${dependency}.version=${version}"
+    add_dependency_to_maven_command "${line}"
   done < "${UPPER_BOUND_DEPENDENCY_FILE}"
 else # This else block means that a list of dependencies was inputted
   # Set the Internal Field Separator (IFS) to a comma.
@@ -87,15 +91,7 @@ else # This else block means that a list of dependencies was inputted
     if [ -z "${DEP_PAIR}" ]; then
       continue
     fi
-
-    # Extract the dependency name and version
-    # We use 'cut' to split the line by '=' and trim whitespace
-    # The sed command is used to remove potential trailing whitespace from the version number
-    dependency=$(echo "${DEP_PAIR}" | cut -d'=' -f1 | tr -d '[:space:]')
-    version=$(echo "${DEP_PAIR}" | cut -d'=' -f2 | sed 's/^[[:space:]]*//;s/[[:space:]]*$//')
-
-    # Append the formatted property to the PROPERTIES string.
-    MAVEN_COMMAND+=" -D${dependency}.version=${version}"
+    add_dependency_to_maven_command "${DEP_PAIR}"
   done
 fi
 

dependencies.txt

@@ -1,3 +1,8 @@
+# This file contains a list of dependencies and their versions to be tested for compatibility.
+# The format is key=value, where the key is the dependency name and the value is the version.
+# "1P" refers to First-Party dependencies (owned by Google).
+# "3P" refers to Third-Party dependencies.
+
 # 1P Parent-Pom
 javax.annotation-api=1.3.2
 grpc=1.74.0