Resolve shellcheck issues in build-functions

Author: zbeekman

prerequisites/build-functions/build_and_install.sh

@@ -1,32 +1,33 @@
 # Make the build directory, configure, and build
+# shellcheck disable=SC2154
 build_and_install()
 {
   num_threads=${arg_j}
   build_path="${OPENCOARRAYS_SRC_DIR}/prerequisites/builds/${package_to_build}-${version_to_build}"
 
-  info "Building ${package_to_build} ${version_to_build}" 
-  info "Build path: ${build_path}" 
+  info "Building ${package_to_build} ${version_to_build}"
+  info "Build path: ${build_path}"
 
   set_SUDO_if_needed_to_write_to_directory "${build_path}"
   set_SUDO_if_needed_to_write_to_directory "${install_path}"
   mkdir -p "${build_path}"
   info "pushd ${build_path}"
   pushd "${build_path}"
   if [[ "${package_to_build}" == "gcc" ]]; then
-    info 'pushd ${download_path}/${package_source_directory} '
+    info "pushd ${download_path}/${package_source_directory} "
     pushd "${download_path}/${package_source_directory}"
-    "${PWD}"/contrib/download_prerequisites 
+    "${PWD}"/contrib/download_prerequisites
     info "popd"
-    popd 
+    popd
     info "Configuring with the following command:"
-    info "${download_path}/${package_source_directory}/configure --prefix=${install_path} --enable-languages=c,c++,fortran,lto --disable-multilib --disable-werror" 
+    info "${download_path}/${package_source_directory}/configure --prefix=${install_path} --enable-languages=c,c++,fortran,lto --disable-multilib --disable-werror"
     "${download_path}/${package_source_directory}/configure" --prefix="${install_path}" --enable-languages=c,c++,fortran,lto --disable-multilib --disable-werror
     info "Building with the following command: 'make -j${num_threads} bootstrap'"
     make "-j${num_threads}" bootstrap
     if [[ ! -z "${SUDO:-}" ]]; then
       info "You do not have write permissions to the installation path ${install_path}"
       info "If you have administrative privileges, enter your password to install ${package_to_build}"
-    fi 
+    fi
     info "Installing with the following command: ${SUDO:-} make install"
     ${SUDO:-} make install
   else
@@ -41,9 +42,9 @@ build_and_install()
       info "You do not have write permissions to the installation path ${install_path}"
       info "If you have administrative privileges, enter your password to install ${package_to_build}"
     fi
-    info "Installing with the following command: ${SUDO:-} make install" 
+    info "Installing with the following command: ${SUDO:-} make install"
     ${SUDO:-} make install
-  fi 
+  fi
   info "popd"
   popd
 }

prerequisites/build-functions/download_if_necessary.sh

@@ -1,16 +1,19 @@
+# shellcheck source=./ftp-url.sh
 source "${OPENCOARRAYS_SRC_DIR:-}/prerequisites/build-functions/ftp-url.sh"
+# shellcheck source=./set_SUDO_if_needed_to_write_to_directory.sh
 source "${OPENCOARRAYS_SRC_DIR:-}/prerequisites/build-functions/set_SUDO_if_needed_to_write_to_directory.sh"
 
 # Download pkg-config if the tar ball is not already in the present working directory
+# shellcheck disable=SC2154
 download_if_necessary()
 {
   download_path="${PWD}/downloads"
   set_SUDO_if_needed_to_write_to_directory "${download_path}"
-  if [ -f $url_tail ] || [ -d $url_tail ]; then
+  if [ -f "$url_tail" ] || [ -d "$url_tail" ]; then
     info "Found '${url_tail}' in ${PWD}."
     info "If it resulted from an incomplete download, building ${package_name} could fail."
     info "Would you like to proceed anyway? (Y/n)"
-    read proceed
+    read -r proceed
     if [[ "${proceed}" == "n" || "${proceed}" == "N" || "${proceed}" == "no"  ]]; then
       info "n"
       info "Please remove $url_tail and restart the installation to to ensure a fresh download." 1>&2
@@ -23,7 +26,7 @@ download_if_necessary()
     info "The default download mechanism for ${package_name} is ${fetch}."
     info "Please either ensure that ${fetch} is installed and in your PATH"
     info "or download the ${package_name} source from "
-    info "${package_url}" 
+    info "${package_url}"
    #called_by_install_sh=`echo "$(ps -p $PPID -o args=)" | grep install.sh`
     info "Place the downloaded file in ${download_path} and restart this script."
    #if [[ ! -z $called_by_install_sh ]]; then
@@ -57,7 +60,7 @@ download_if_necessary()
     info "Download command: ${fetch} ${args} ${package_url}"
     info "Depending on the file size and network bandwidth, this could take several minutes or longer."
     pushd "${download_path}"
-    "${fetch}" "${args}" "${package_url}" 
+    "${fetch}" "${args}" "${package_url}"
     popd
     if [[ "${version_to_build}" == '--avail' || "${version_to_build}" == '-a' ]]; then
       # In this case, args="ls" and the list of available versions has been printed so we can move on.
@@ -69,10 +72,10 @@ download_if_necessary()
       search_path="${download_path}/${url_tail}"
     fi
     if [ -f "${search_path}" ] || [ -d "${search_path}" ]; then
-      info "Download succeeded. The "${package_name}" source is in the following location:"
+      info "Download succeeded. The ${package_name} source is in the following location:"
       info "${search_path}"
     else
-      info "Download failed. The "${package_name}" source is not in the following, expected location:"
+      info "Download failed. The ${package_name} source is not in the following, expected location:"
       info "${search_path}"
       emergency "Aborting. [exit 110]"
     fi

prerequisites/build-functions/ftp-url.sh

@@ -1,9 +1,9 @@
-# Download a file from an anonymous ftp site 
+# Download a file from an anonymous ftp site
 #
 # Usage:
 #    ftp-url  <ftp-mode>  <ftp-site-address>:/<path-to-file>/<file-name>
 #
-# Example:  
+# Example:
 #    ftp-url -n ftp.gnu.org:/gnu/m4/m4-1.4.17.tar.bz2
 ftp-url()
 {

prerequisites/build-functions/set_SUDO_if_needed_to_write_to_directory.sh

@@ -6,11 +6,11 @@ set_SUDO_if_needed_to_write_to_directory()
   else
     directory_to_create=$1
   fi
-  if [[ -z "${LD_LIBRARY_PATH:-}" ]]; then 
+  if [[ -z "${LD_LIBRARY_PATH:-}" ]]; then
      info "\${LD_LIBRARY_PATH} is empty. Try setting it if the compiler encounters linking problems."
   fi
   SUDO_COMMAND="sudo env LD_LIBRARY_PATH=${LD_LIBRARY_PATH:-""}"
-  info "Checking whether the directory ${directory_to_create} exists... " 
+  info "Checking whether the directory ${directory_to_create} exists... "
   if [[ -d "${directory_to_create}" ]]; then
     info "yes"
     info "Checking whether I have write permissions to ${directory_to_create} ... "
@@ -27,6 +27,7 @@ set_SUDO_if_needed_to_write_to_directory()
       info "yes."
     else
       info "no."
+      # shellcheck disable=SC2034
       SUDO="${SUDO_COMMAND}"
     fi
   fi

prerequisites/build-functions/set_compilers.sh

@@ -1,41 +1,42 @@
 # Set CC, CXX, and FC
+# shellcheck disable=SC2154
 set_compilers()
 {
   # If FC is already set, use the set value.
-  # Else if FC is empty, use the value specified via the -f or --with-fortran command-line arguments. 
+  # Else if FC is empty, use the value specified via the -f or --with-fortran command-line arguments.
   # Else use the default specifed in ../build.sh-usage.
   FC=${FC:-${arg_f}}
-  info "Fortran compiler: ${FC}" 
+  info "Fortran compiler: ${FC}"
 
-  if [[ `uname` == "Darwin" && "${package_to_build}" == "cmake"  ]]; then
+  if [[ $(uname) == "Darwin" && "${package_to_build}" == "cmake"  ]]; then
     if [[ -x "/usr/bin/gcc" ]]; then
-      [ ! -z ${CC:-} ] && info "Overriding CC: cmake build requires Apple LLVM gcc, which XCode command-line tools puts in /usr/bin"
+      [ ! -z "${CC:-}" ] && info "Overriding CC: cmake build requires Apple LLVM gcc, which XCode command-line tools puts in /usr/bin"
       CC=/usr/bin/gcc
     else
       info      "OS X detected.  Please install XCode command-line tools and "
       emergency "ensure that /usr/bin/gcc exists and is executable. Aborting."
-    fi  
+    fi
   else
     # If CC is already set, use the set value.
-    # Else if CC is empty, use the value specified via the -c or --with-c command-line arguments. 
+    # Else if CC is empty, use the value specified via the -c or --with-c command-line arguments.
     # Else use the default specifed in ../build.sh-usage.
     CC=${CC:-${arg_c}}
-  fi  
-  info "C compiler: ${CC}" 
+  fi
+  info "C compiler: ${CC}"
 
-  if [[ `uname` == "Darwin" && ${package_to_build} == "cmake"  ]]; then
+  if [[ $(uname) == "Darwin" && ${package_to_build} == "cmake"  ]]; then
     if [[ -x "/usr/bin/g++" ]]; then
-      [ ! -z ${CXX:-} ] && info "Overriding CXX: cmake build requires Apple LLVM g++, which XCode command-line tools puts in /usr/bin"
+      [ ! -z "${CXX:-}" ] && info "Overriding CXX: cmake build requires Apple LLVM g++, which XCode command-line tools puts in /usr/bin"
       CXX=/usr/bin/g++
     else
       info      "OS X detected.  Please install XCode command-line tools and "
       emergency "ensure that /usr/bin/g++ exists and is executable. Aborting."
-    fi  
+    fi
   else
     # If CXX is already set, use the set value.
-    # Else if CXX is empty, use the value specified via the -C or --with-cxx command-line arguments. 
+    # Else if CXX is empty, use the value specified via the -C or --with-cxx command-line arguments.
     # Else use the default specifed in ../build.sh-usage.
     CXX=${CXX:-${arg_C}}
   fi
-  info "C++ compiler: ${CXX}" 
+  info "C++ compiler: ${CXX}"
 }

prerequisites/build-functions/set_or_print_default_version.sh

@@ -1,13 +1,14 @@
 # If -p, -D, -P, or -U specifies a package, set default_version
 # If -V specifies a package, print the default_version and exit with normal status
 # If -l is present, list all packages and versions and exit with normal status
+# shellcheck disable=SC2154
 set_or_print_default_version()
 {
-  # Verify requirements 
+  # Verify requirements
   [ "${arg_l}" == "${__flag_present}" ] && [ ! -z "${arg_D:-${arg_p:-${arg_P:-${arg_U:-${arg_V}}}}}" ] &&
     emergency "Please pass only one of {-l, -D, -p, -P, -U, -V} or a longer equivalent (multiple detected)."
 
-  if [[ "${arg_l}" == "${__flag_present}" ]]; then 
+  if [[ "${arg_l}" == "${__flag_present}" ]]; then
     echo "This script can build the following packages:"
   fi
   # Get package name from argument passed with -p, -V, -D, or -U
@@ -36,8 +37,8 @@ set_or_print_default_version()
      elif [[ "${package_name}" == "${KEY}" ]]; then
        # We recognize the package name so we set the default version:
        default_version=${VALUE}
-       # If a printout of the default version number was requested, then print it and exit with normal status 
-       [[ ! -z "${arg_V}" ]] && printf "${default_version}\n" && exit 0
+       # If a printout of the default version number was requested, then print it and exit with normal status
+       [[ ! -z "${arg_V}" ]] && printf "%s\n" "${default_version}" && exit 0
        break # exit the for loop
      fi
   done

prerequisites/build-functions/set_or_print_downloader.sh

@@ -1,9 +1,10 @@
 # If -p, -P, -U, or -V specifies a package, set fetch variable
 # If -D specifies a package, print "${fetch}" and exit with normal status
 # If -l is present, list all packages and versions and exit with normal status
+# shellcheck disable=SC2154
 set_or_print_downloader()
 {
-  # Verify requirements 
+  # Verify requirements
   [ ! -z "${arg_D}" ] && [ ! -z "${arg_p:-${arg_P:-${arg_U:-${arg_V}}}}" ] &&
     emergency "Please pass only one of {-D, -p, -P, -U, -V} or a longer equivalent (multiple detected)."
 
@@ -12,7 +13,7 @@ set_or_print_downloader()
     gcc_fetch="ftp-url"
   else
     gcc_fetch="svn"
-  fi  
+  fi
   # This is a bash 3 hack standing in for a bash 4 hash (bash 3 is the lowest common
   # denominator because, for licensing reasons, OS X only has bash 3 by default.)
   # See http://stackoverflow.com/questions/1494178/how-to-define-hash-tables-in-bash
@@ -34,13 +35,12 @@ set_or_print_downloader()
      if [[ "${package_name}" == "${KEY}" ]]; then
        # We recognize the package name so we set the download mechanism:
        fetch=${VALUE}
-       # If a printout of the download mechanism was requested, then print it and exit with normal status 
-       [[ ! -z "${arg_D}" ]] && printf "${fetch}\n" && exit 0
+       # If a printout of the download mechanism was requested, then print it and exit with normal status
+       [[ ! -z "${arg_D}" ]] && printf "%s\n" "${fetch}" && exit 0
        break # exit the for loop
      fi
   done
   if [[ -z "${fetch:-}" ]]; then
     emergency "Package ${package_name:-} not recognized.  Use --l or --list-packages to list the allowable names."
   fi
 }
-

prerequisites/build-functions/set_or_print_installation_path.sh

@@ -1,16 +1,17 @@
 # If -P specifies a package, print the installation path and exit with normal status
 # Otherwise, set install_path
+# shellcheck disable=SC2154
 set_or_print_installation_path()
 {
-  # Verify requirements 
+  # Verify requirements
   [ ! -z "${arg_P}" ] && [ ! -z "${arg_D:-${arg_p:-${arg_U:-${arg_V}}}}" ] &&
     emergency "Please pass only one of {-D, -p, -P, -U, -V} or a longer equivalent (multiple detected)."
- 
+
   # ../build.sh-usage specifies the following installation path default for illustrative purposes only:
   # Default="${OPENCOARRAYS_SRC_DIR}/prerequisites/installations/${package_name:-}/"
   # When the parse_command_line function executes, ${package_name:-} is empty, but it has
   # been set before reaching the current function so now we can get the true values if the
-  # user didn't override the default: 
+  # user didn't override the default:
 
   path_in_usage_file="${OPENCOARRAYS_SRC_DIR}/prerequisites/installations//"
   if [[ "${arg_i}" == "${path_in_usage_file}" ]]; then
@@ -20,10 +21,10 @@ set_or_print_installation_path()
   fi
 
   # If -P is present, print ${install_path} and exit with normal status
-  if [[ ! -z "${arg_P:-}" ]]; then 
-    printf "${install_path}\n" 
+  if [[ ! -z "${arg_P:-}" ]]; then
+    printf "%s\n" "${install_path}"
     exit 0
   fi
 
-  info "${package_name} ${version_to_build} installation path: ${install_path}" 
+  info "${package_name} ${version_to_build} installation path: ${install_path}"
 }

prerequisites/build-functions/set_or_print_url.sh

@@ -1,8 +1,9 @@
 # If -p, -D, -P, or -V specifies a package, set package_url
 # If -U specifies a package, print the package_url and exit with normal status
+# shellcheck disable=SC2154
 set_or_print_url()
 {
-  # Verify requirements 
+  # Verify requirements
   [ ! -z "${arg_U}" ] && [ ! -z "${arg_D:-${arg_p:-${arg_P:-${arg_V}}}}" ] &&
     emergency "Please pass only one of {-D, -p, -P, -U, -V} or a longer equivalent (multiple detected)."
 
@@ -76,9 +77,9 @@ set_or_print_url()
 
   package_url="${url_head}""${url_tail}"
 
-  # If a printout of the package URL was requested, then print it and exit with normal status 
-  if [[ ! -z "${arg_U:-}" ]]; then 
-    printf "${package_url}\n" 
+  # If a printout of the package URL was requested, then print it and exit with normal status
+  if [[ ! -z "${arg_U:-}" ]]; then
+    printf "%s\n" "${package_url}"
     exit 0
   fi
 }

prerequisites/build-functions/unpack_if_necessary.sh

@@ -1,4 +1,5 @@
 # Unpack if the unpacked tar ball is not in the present working directory
+# shellcheck disable=SC2154
 unpack_if_necessary()
 {
   if [[ "${fetch}" == "svn" || "${fetch}" == "git" ]]; then
@@ -11,6 +12,7 @@ unpack_if_necessary()
     tar xf "${url_tail}"
     info "popd"
     popd
+    # shellcheck disable=SC2034
     package_source_directory="${package_name}-${version_to_build}"
   fi
 }