refactor(shellcheck): enable for entire repo and fix all warnings (rapidsai#1971)

xref rapidsai/build-planning#135

Authors:
  - Gil Forsyth (https://github.com/gforsyth)

Approvers:
  - Bradley Dice (https://github.com/bdice)

URL: rapidsai#1971

Author: gforsyth

.github/CODEOWNERS

@@ -14,6 +14,7 @@ python/            @rapidsai/rmm-python-codeowners
 /.github/                @rapidsai/ci-codeowners
 /ci/                     @rapidsai/ci-codeowners
 /.pre-commit-config.yaml @rapidsai/ci-codeowners
+/.shellcheckrc           @rapidsai/ci-codeowners
 
 #packaging code owners
 /.devcontainer/    @rapidsai/packaging-codeowners

.pre-commit-config.yaml

@@ -99,8 +99,6 @@ repos:
     rev: v0.10.0.1
     hooks:
       - id: shellcheck
-        args: ["--severity=warning"]
-        files: ^ci/
 
 default_language_version:
   python: python3

.shellcheckrc

@@ -0,0 +1,2 @@
+# Disable file checks (otherwise every use of `gha-tools` will get flagged)
+disable=SC1091

build.sh

@@ -16,7 +16,7 @@ ARGS=$*
 
 # NOTE: ensure all dir changes are relative to the location of this
 # script, and that this script resides in the repo dir!
-REPODIR=$(cd $(dirname $0); pwd)
+REPODIR=$(cd "$(dirname "$0")"; pwd)
 
 VALIDARGS="clean librmm rmm -v -g -n -s --ptds -h tests benchmarks"
 HELP="$0 [clean] [librmm] [rmm] [-v] [-g] [-n] [-s] [--ptds] [--cmake-args=\"<args>\"] [-h]
@@ -61,24 +61,25 @@ function hasArg {
 
 function cmakeArgs {
     # Check for multiple cmake args options
-    if [[ $(echo $ARGS | { grep -Eo "\-\-cmake\-args" || true; } | wc -l ) -gt 1 ]]; then
+    if [[ $(echo "$ARGS" | { grep -Eo "\-\-cmake\-args" || true; } | wc -l ) -gt 1 ]]; then
         echo "Multiple --cmake-args options were provided, please provide only one: ${ARGS}"
         exit 1
     fi
 
     # Check for cmake args option
-    if [[ -n $(echo $ARGS | { grep -E "\-\-cmake\-args" || true; } ) ]]; then
+    if [[ -n $(echo "$ARGS" | { grep -E "\-\-cmake\-args" || true; } ) ]]; then
         # There are possible weird edge cases that may cause this regex filter to output nothing and fail silently
         # the true pipe will catch any weird edge cases that may happen and will cause the program to fall back
         # on the invalid option error
-        EXTRA_CMAKE_ARGS=$(echo $ARGS | { grep -Eo "\-\-cmake\-args=\".+\"" || true; })
+        EXTRA_CMAKE_ARGS=$(echo "$ARGS" | { grep -Eo "\-\-cmake\-args=\".+\"" || true; })
         if [[ -n ${EXTRA_CMAKE_ARGS} ]]; then
             # Remove the full  EXTRA_CMAKE_ARGS argument from list of args so that it passes validArgs function
             ARGS=${ARGS//$EXTRA_CMAKE_ARGS/}
             # Filter the full argument down to just the extra string that will be added to cmake call
-            EXTRA_CMAKE_ARGS=$(echo $EXTRA_CMAKE_ARGS | grep -Eo "\".+\"" | sed -e 's/^"//' -e 's/"$//')
+            EXTRA_CMAKE_ARGS=$(echo "$EXTRA_CMAKE_ARGS" | grep -Eo "\".+\"" | sed -e 's/^"//' -e 's/"$//')
         fi
     fi
+    read -ra EXTRA_CMAKE_ARGS <<< "$EXTRA_CMAKE_ARGS"
 }
 
 
@@ -88,14 +89,14 @@ function ensureCMakeRan {
     mkdir -p "${LIBRMM_BUILD_DIR}"
     if (( RAN_CMAKE == 0 )); then
         echo "Executing cmake for librmm..."
-        cmake -S ${REPODIR}/cpp -B "${LIBRMM_BUILD_DIR}" \
+        cmake -S "${REPODIR}"/cpp -B "${LIBRMM_BUILD_DIR}" \
               -DCMAKE_INSTALL_PREFIX="${INSTALL_PREFIX}" \
               -DCUDA_STATIC_RUNTIME="${CUDA_STATIC_RUNTIME}" \
               -DPER_THREAD_DEFAULT_STREAM="${PER_THREAD_DEFAULT_STREAM}" \
               -DCMAKE_BUILD_TYPE=${BUILD_TYPE} \
               -DBUILD_TESTS=${BUILD_TESTS} \
               -DBUILD_BENCHMARKS=${BUILD_BENCHMARKS} \
-              ${EXTRA_CMAKE_ARGS}
+              "${EXTRA_CMAKE_ARGS[@]}"
         RAN_CMAKE=1
     fi
 }
@@ -106,7 +107,7 @@ if hasArg -h || hasArg --help; then
 fi
 
 # Check for valid usage
-if (( ${NUMARGS} != 0 )); then
+if (( NUMARGS != 0 )); then
     # Check for cmake args
     cmakeArgs
     for a in ${ARGS}; do
@@ -160,7 +161,7 @@ fi
 if (( NUMARGS == 0 )) || hasArg librmm; then
     ensureCMakeRan
     echo "building librmm..."
-    cmake --build "${LIBRMM_BUILD_DIR}" -j${PARALLEL_LEVEL} ${VERBOSE_FLAG}
+    cmake --build "${LIBRMM_BUILD_DIR}" -j"${PARALLEL_LEVEL}" ${VERBOSE_FLAG}
     if [[ ${INSTALL_TARGET} != "" ]]; then
         echo "installing librmm..."
         cmake --build "${LIBRMM_BUILD_DIR}" --target install -v ${VERBOSE_FLAG}
@@ -170,9 +171,9 @@ fi
 # Build and install the rmm Python package
 if (( NUMARGS == 0 )) || hasArg rmm; then
     echo "building and installing rmm..."
-    SKBUILD_CMAKE_ARGS="-DCMAKE_PREFIX_PATH=${INSTALL_PREFIX};${EXTRA_CMAKE_ARGS}" python -m pip install \
+    SKBUILD_CMAKE_ARGS="-DCMAKE_PREFIX_PATH=${INSTALL_PREFIX};$(IFS=';'; echo "${EXTRA_CMAKE_ARGS[*]}")" python -m pip install \
         --no-build-isolation \
         --no-deps \
         --config-settings rapidsai.disable-cuda=true \
-        ${REPODIR}/python/rmm
+        "${REPODIR}"/python/rmm
 fi

ci/build_wheel_cpp.sh

@@ -26,6 +26,6 @@ rapids-telemetry-record sccache-stats.txt sccache --show-adv-stats
 python -m auditwheel repair \
     --exclude librapids_logger.so \
     -w "${RAPIDS_WHEEL_BLD_OUTPUT_DIR}" \
-    ${dist_dir}/*
+    "${dist_dir}"/*
 
 ../../ci/validate_wheel.sh "${RAPIDS_WHEEL_BLD_OUTPUT_DIR}"

ci/build_wheel_python.sh

@@ -50,4 +50,4 @@ python -m auditwheel repair \
 absolute_wheel_dir=$(realpath "${RAPIDS_WHEEL_BLD_OUTPUT_DIR}")
 # switch back to the root of the repo and check symbol visibility
 popd
-ci/check_symbols.sh "$(echo ${absolute_wheel_dir}/rmm_*.whl)"
+ci/check_symbols.sh "$(echo "${absolute_wheel_dir}"/rmm_*.whl)"

ci/test_cpp.sh

@@ -39,11 +39,11 @@ export GTEST_OUTPUT=xml:${RAPIDS_TESTS_DIR}/
 ./ci/run_ctests.sh -j20 && EXITCODE=$? || EXITCODE=$?;
 
 # Run all examples from librmm-example package
-for example in ${CONDA_PREFIX}/bin/examples/librmm/*; do
+for example in "${CONDA_PREFIX}"/bin/examples/librmm/*; do
     if [ -x "$example" ]; then
         rapids-logger "Running example: $(basename "$example")"
         "$example" && EXAMPLE_EXITCODE=$? || EXAMPLE_EXITCODE=$?;
-        if [ $EXAMPLE_EXITCODE -ne 0 ]; then
+        if [ "$EXAMPLE_EXITCODE" -ne 0 ]; then
             rapids-logger "Example $(basename "$example") failed with exit code: $EXAMPLE_EXITCODE"
             EXITCODE=$EXAMPLE_EXITCODE
             break

cpp/examples/build.sh

@@ -13,6 +13,7 @@ INSTALL_EXAMPLES=false
 # Check for -i or --install flags to enable installation
 ARGS=$(getopt -o i --long install -- "$@")
 eval set -- "$ARGS"
+# shellcheck disable=SC2078
 while [ : ]; do
   case "$1" in
     -i | --install)
@@ -46,12 +47,12 @@ build_example() {
   build_dir="${example_dir}/build"
 
   # Configure
-  cmake -S ${example_dir} -B ${build_dir} -Drmm_ROOT="${LIB_BUILD_DIR}"
+  cmake -S "${example_dir}" -B "${build_dir}" -Drmm_ROOT="${LIB_BUILD_DIR}"
   # Build
-  cmake --build ${build_dir} -j${PARALLEL_LEVEL}
+  cmake --build "${build_dir}" -j"${PARALLEL_LEVEL}"
   # Install if needed
   if [ "$INSTALL_EXAMPLES" = true ]; then
-    cmake --install ${build_dir} --prefix ${INSTALL_PREFIX:-${example_dir}/install}
+    cmake --install "${build_dir}" --prefix "${INSTALL_PREFIX:-${example_dir}/install}"
   fi
 }
 

cpp/scripts/doxygen.sh

@@ -14,23 +14,25 @@ fi
 function version { echo "$@" | awk -F. '{ printf("%d%03d%03d%03d\n", $1,$2,$3,$4); }'; }
 
 # doxygen supported version 1.9.1
-DOXYGEN_VERSION=`doxygen --version`
-if [ ! $(version "$DOXYGEN_VERSION") -eq $(version "1.9.1") ] ; then
+DOXYGEN_VERSION=$(doxygen --version)
+if [ ! "$(version "$DOXYGEN_VERSION")" -eq "$(version "1.9.1")" ] ; then
   echo -e "warning: Unsupported doxygen version $DOXYGEN_VERSION"
   echo -e "Expecting doxygen version 1.9.1"
   exit 0
 fi
 
-export RAPIDS_VERSION="$(sed -E -e 's/^([0-9]{2})\.([0-9]{2})\.([0-9]{2}).*$/\1.\2.\3/' VERSION)"
-export RAPIDS_VERSION_MAJOR_MINOR="$(sed -E -e 's/^([0-9]{2})\.([0-9]{2})\.([0-9]{2}).*$/\1.\2/' VERSION)"
+RAPIDS_VERSION="$(sed -E -e 's/^([0-9]{2})\.([0-9]{2})\.([0-9]{2}).*$/\1.\2.\3/' VERSION)"
+RAPIDS_VERSION_MAJOR_MINOR="$(sed -E -e 's/^([0-9]{2})\.([0-9]{2})\.([0-9]{2}).*$/\1.\2/' VERSION)"
+export RAPIDS_VERSION
+export RAPIDS_VERSION_MAJOR_MINOR
 
 # Run doxygen, ignore missing tag files error
 TAG_ERROR1="error: Tag file '.*.tag' does not exist or is not a file. Skipping it..."
 TAG_ERROR2="error: cannot open tag file .*.tag for writing"
-DOXYGEN_STDERR=`cd cpp/doxygen && { cat Doxyfile ; echo QUIET = YES; echo GENERATE_HTML = NO; }  | doxygen - 2>&1 | sed "/\($TAG_ERROR1\|$TAG_ERROR2\)/d"`
+DOXYGEN_STDERR=$(cd cpp/doxygen && { cat Doxyfile ; echo QUIET = YES; echo GENERATE_HTML = NO; }  | doxygen - 2>&1 | sed "/\($TAG_ERROR1\|$TAG_ERROR2\)/d")
 RETVAL=$?
 
-if [ "$RETVAL" != "0" ] || [ ! -z "$DOXYGEN_STDERR" ]; then
+if [ "$RETVAL" != "0" ] || [ -n "$DOXYGEN_STDERR" ]; then
   echo -e "$DOXYGEN_STDERR"
   RETVAL=1 #because return value is not generated by doxygen 1.8.20
 fi

cpp/scripts/run-cmake-format.sh

@@ -37,7 +37,7 @@ if ! [ ${status} -eq 0 ]; then
         echo "This script must be run inside the rmm repository, or the RMM_ROOT environment variable must be set."
     else
         echo "Script failed with unknown error attempting to determine project root:"
-        echo ${RMM_BUILD_DIR}
+        echo "${RMM_BUILD_DIR}"
     fi
     exit 1
 fi
@@ -48,8 +48,8 @@ DEFAULT_FORMAT_FILE_LOCATIONS=(
 )
 
 if [ -z ${RAPIDS_CMAKE_FORMAT_FILE:+PLACEHOLDER} ]; then
-    for file_path in ${DEFAULT_FORMAT_FILE_LOCATIONS[@]}; do
-        if [ -f ${file_path} ]; then
+    for file_path in "${DEFAULT_FORMAT_FILE_LOCATIONS[@]}"; do
+        if [ -f "${file_path}" ]; then
             RAPIDS_CMAKE_FORMAT_FILE=${file_path}
             break
         fi
@@ -68,7 +68,7 @@ else
 fi
 
 if [[ $1 == "cmake-format" ]]; then
-  cmake-format -i --config-files cpp/cmake/config.json ${RAPIDS_CMAKE_FORMAT_FILE} -- ${@:2}
+  cmake-format -i --config-files cpp/cmake/config.json "${RAPIDS_CMAKE_FORMAT_FILE}" -- "${@:2}"
 elif [[ $1 == "cmake-lint" ]]; then
-  cmake-lint --config-files cpp/cmake/config.json ${RAPIDS_CMAKE_FORMAT_FILE} -- ${@:2}
+  cmake-lint --config-files cpp/cmake/config.json "${RAPIDS_CMAKE_FORMAT_FILE}" -- "${@:2}"
 fi