shellcheck: clean up shellcheck warnings and enable

Signed-off-by: Patrick Williams <[email protected]>
Change-Id: Ibc843b98c0fea97a31d3d15b556a32f091bf8e47

Author: williamspatrick

Diff for: .shellcheck

@@ -91,16 +91,16 @@ launch=${launch:-docker}
 j_url=https://repo.jenkins-ci.org/public/org/jenkins-ci/main/jenkins-war/${j_vrsn}/jenkins-war-${j_vrsn}.war
 
 # Make or Clean WORKSPACE
-if [[ -d ${workspace} ]]; then
-  rm -rf ${workspace}/Dockerfile \
-         ${workspace}/docker-jenkins \
-         ${workspace}/plugins.* \
-         ${workspace}/install-plugins.sh \
-         ${workspace}/jenkins.sh \
-         ${workspace}/jenkins-support \
-         ${workspace}/init.groovy
+if [[ -d "${workspace}" ]]; then
+  rm -rf "${workspace}/Dockerfile" \
+         "${workspace}/docker-jenkins" \
+         "${workspace}/plugins.*" \
+         "${workspace}/install-plugins.sh" \
+         "${workspace}/jenkins.sh" \
+         "${workspace}/jenkins-support" \
+         "${workspace}/init.groovy"
 else
-  mkdir -p ${workspace}
+  mkdir -p "${workspace}"
 fi
 
 # Determine the prefix of the Dockerfile's base image
@@ -119,7 +119,7 @@ case ${ARCH} in
 esac
 
 # Move Into the WORKSPACE
-cd ${workspace}
+cd "${workspace}"
 
 # Make the Dockerfile
 ################################################################################
@@ -200,31 +200,33 @@ EOF
 ################################################################################
 
 # Build the image
-docker build -t ${img_name} .
+docker build -t "${img_name}" .
 
-if [[ ${launch} == "docker" ]]; then
+if [[ "${launch}" == "docker" ]]; then
 
   # Ensure directories that will be mounted exist
-  if [[ ! -z ${host_import_mnt} && ! -d ${host_import_mnt} ]]; then
-      mkdir -p ${host_import_mnt}
+  if [[ -n "${host_import_mnt}" && ! -d "${host_import_mnt}" ]]; then
+      mkdir -p "${host_import_mnt}"
   fi
 
-  if [[ ! -d ${home_mnt} ]]; then
-    mkdir -p ${home_mnt}
+  if [[ ! -d "${home_mnt}" ]]; then
+    mkdir -p "${home_mnt}"
   fi
 
   # Ensure directories that will be mounted are owned by the jenkins user
   if [[ "$(id -u)" != 0 ]]; then
     echo "Not running as root:"
     echo "Checking if j_gid and j_uid are the owners of mounted directories"
-    test_1=$(ls -nd ${home_mnt} | awk '{print $3 " " $4}')
+    # shellcheck disable=SC2012 # use ls to get permissions.
+    test_1="$(ls -nd "${home_mnt}" | awk '{print $3 " " $4}')"
     if [[ "${test_1}" != "${j_uid} ${j_gid}" ]]; then
       echo "Owner of ${home_mnt} is not the jenkins user"
       echo "${test_1} != ${j_uid} ${j_gid}"
       will_fail=1
     fi
-    if [[ ! -z "${host_import_mnt}" ]]; then
-      test_2=$(ls -nd ${host_import_mnt} | awk '{print $3 " " $4}' )
+    if [[ -n "${host_import_mnt}" ]]; then
+      # shellcheck disable=SC2012 # use ls to get permissions.
+      test_2="$(ls -nd "${host_import_mnt}" | awk '{print $3 " " $4}' )"
       if [[ "${test_2}" != "${j_uid} ${j_gid}" ]]; then
         echo "Owner of ${host_import_mnt} is not the jenkins user"
         echo "${test_2} != ${j_uid} ${j_gid}"
@@ -237,27 +239,29 @@ if [[ ${launch} == "docker" ]]; then
       exit 1
     fi
   else
-    if [[ ! -z ${host_import_mnt} ]]; then
-      chown -R ${j_uid}:${j_gid} ${host_import_mnt}
+    if [[ -n "${host_import_mnt}" ]]; then
+      chown -R "${j_uid}:${j_gid}" "${host_import_mnt}"
     fi
-    chown -R ${j_uid}:${j_gid} ${home_mnt}
+    chown -R "${j_uid}:${j_gid}" "${home_mnt}"
   fi
 
   #If we don't have import mount don't add to docker command
-  if [[ ! -z ${host_import_mnt} ]]; then
+  if [[ -n "${host_import_mnt}" ]]; then
    import_vol_cmd="-v ${host_import_mnt}:${cont_import_mnt}"
   fi
   # Launch the jenkins image with Docker
+  # shellcheck disable=SC2086 # import_vol_cmd is intentially word-split.
   docker run -d \
     ${import_vol_cmd} \
-    -v ${home_mnt}:${j_home} \
-    -p ${http_port}:8080 \
-    -p ${agent_port}:${agent_port} \
-    --env JAVA_OPTS=\"${java_options}\" \
-    --env JENKINS_OPTS=\"${jenkins_options}\" \
-    ${img_name}
+    -v "${home_mnt}:${j_home}" \
+    -p "${http_port}:8080" \
+    -p "${agent_port}:${agent_port}" \
+    --env JAVA_OPTS=\""${java_options}"\" \
+    --env JENKINS_OPTS=\""${jenkins_options}"\" \
+    "${img_name}"
 
 elif [[ ${launch} == "k8s" ]]; then
   # launch using the k8s template
-  source ${build_scripts_dir}/kubernetes/kubernetes-launch.sh Build-Jenkins false false
+  # shellcheck source=kubernetes/kubernetes-launch.sh
+  source "${build_scripts_dir}/kubernetes/kubernetes-launch.sh" Build-Jenkins false false
 fi

Diff for: build-jenkins.sh

@@ -49,9 +49,9 @@ RUN apt-get update && apt-get install -yy \
     squashfs-tools
 
 # Final configuration for the workspace
-RUN grep -q ${GROUPS} /etc/group || groupadd -g ${GROUPS} ${USER}
-RUN mkdir -p $(dirname ${HOME})
-RUN grep -q ${UID} /etc/passwd || useradd -d ${HOME} -m -u ${UID} -g ${GROUPS} ${USER}
+RUN grep -q ${GROUPS[0]} /etc/group || groupadd -g ${GROUPS[0]} ${USER}
+RUN mkdir -p $(dirname "${HOME}")
+RUN grep -q ${UID} /etc/passwd || useradd -d ${HOME} -m -u ${UID} -g ${GROUPS[0]} ${USER}
 RUN sed -i '1iDefaults umask=000' /etc/sudoers
 RUN echo "${USER} ALL=(ALL) NOPASSWD: ALL" >>/etc/sudoers
 
@@ -62,4 +62,4 @@ fi
 ################################# docker img # #################################
 
 # Build above image
-docker build --network=host -t ${DOCKER_IMG_NAME} - <<< "${Dockerfile}"
+docker build --network=host -t "${DOCKER_IMG_NAME}" - <<< "${Dockerfile}"

Diff for: build-rootfs-size-docker.sh

@@ -133,16 +133,16 @@ esac
 echo "Build started, $(date)"
 
 # If the obmc_dir directory doesn't exist clone it in
-if [ ! -d ${obmc_dir} ]; then
+if [ ! -d "${obmc_dir}" ]; then
   echo "Clone in openbmc master to ${obmc_dir}"
-  git clone https://github.com/openbmc/openbmc ${obmc_dir}
+  git clone https://github.com/openbmc/openbmc "${obmc_dir}"
 fi
 
 # Make and chown the xtrct_path directory to avoid permission errors
-if [ ! -d ${xtrct_path} ]; then
-  mkdir -p ${xtrct_path}
+if [ ! -d "${xtrct_path}" ]; then
+  mkdir -p "${xtrct_path}"
 fi
-chown ${UID}:${GROUPS} ${xtrct_path}
+chown "${UID}:${GROUPS[0]}" "${xtrct_path}"
 
 # Work out what build target we should be running and set BitBake command
 MACHINE=""
@@ -264,8 +264,8 @@ if [[ "${distro}" == fedora ]];then
   ENV LANG=en_US.utf8
   RUN localedef -f UTF-8 -i en_US en_US.UTF-8
 
-  RUN grep -q ${GROUPS} /etc/group || groupadd -g ${GROUPS} ${USER}
-  RUN grep -q ${UID} /etc/passwd || useradd -d ${HOME} -m -u ${UID} -g ${GROUPS} ${USER}
+  RUN grep -q ${GROUPS[0]} /etc/group || groupadd -g ${GROUPS[0]} ${USER}
+  RUN grep -q ${UID} /etc/passwd || useradd -d ${HOME} -m -u ${UID} -g ${GROUPS[0]} ${USER}
 
   USER ${USER}
   ENV HOME ${HOME}
@@ -313,8 +313,8 @@ elif [[ "${distro}" == ubuntu ]]; then
   ENV LANGUAGE en_US:en
   ENV LC_ALL en_US.UTF-8
 
-  RUN grep -q ${GROUPS} /etc/group || groupadd -g ${GROUPS} ${USER}
-  RUN grep -q ${UID} /etc/passwd || useradd -d ${HOME} -m -u ${UID} -g ${GROUPS} ${USER}
+  RUN grep -q ${GROUPS[0]} /etc/group || groupadd -g ${GROUPS[0]} ${USER}
+  RUN grep -q ${UID} /etc/passwd || useradd -d ${HOME} -m -u ${UID} -g ${GROUPS[0]} ${USER}
 
   USER ${USER}
   ENV HOME ${HOME}
@@ -328,10 +328,10 @@ export PROXY_HOST=${http_proxy/#http*:\/\/}
 export PROXY_HOST=${PROXY_HOST/%:[0-9]*}
 export PROXY_PORT=${http_proxy/#http*:\/\/*:}
 
-mkdir -p ${WORKSPACE}
+mkdir -p "${WORKSPACE}"
 
 # Determine command for bitbake image build
-if [ $no_tar = "false" ]; then
+if [ "$no_tar" = "false" ]; then
     bitbake_target="${bitbake_target} obmc-phosphor-debug-tarball"
 fi
 
@@ -438,13 +438,13 @@ fi
 
 EOF_SCRIPT
 
-chmod a+x ${WORKSPACE}/build.sh
+chmod a+x "${WORKSPACE}/build.sh"
 
 # Give the Docker image a name based on the distro,tag,arch,and target
 img_name=${img_name:-openbmc/${distro}:${img_tag}-${target}-${ARCH}}
 
 # Build the Docker image
-docker build -t ${img_name} - <<< "${Dockerfile}"
+docker build -t "${img_name}" - <<< "${Dockerfile}"
 
 # If obmc_dir or ssc_dir are ${HOME} or a subdirectory they will not be mounted
 mount_obmc_dir="-v ""${obmc_dir}"":""${obmc_dir}"" "
@@ -461,23 +461,24 @@ mount_workspace_dir=""
 fi
 
 # Run the Docker container, execute the build.sh script
+# shellcheck disable=SC2086 # mount commands word-split purposefully
 docker run \
 --cap-add=sys_admin \
 --cap-add=sys_nice \
 --net=host \
 --rm=true \
--e WORKSPACE=${WORKSPACE} \
+-e WORKSPACE="${WORKSPACE}" \
 -w "${HOME}" \
--v "${HOME}":"${HOME}" \
+-v "${HOME}:${HOME}" \
 ${mount_obmc_dir} \
 ${mount_ssc_dir} \
 ${mount_workspace_dir} \
 --cpus="$num_cpu" \
--t ${img_name} \
-${WORKSPACE}/build.sh
+-t "${img_name}" \
+"${WORKSPACE}/build.sh"
 
 # To maintain function of resources that used an older path, add a link
-ln -sf ${xtrct_path}/deploy ${WORKSPACE}/deploy
+ln -sf "${xtrct_path}/deploy" "${WORKSPACE}/deploy"
 
 # Timestamp for build
 echo "Build completed, $(date)"

Diff for: build-setup.sh

@@ -75,7 +75,7 @@ generate_depcache_entry() {
         grep "refs/heads/$BRANCH" | awk '{ print $1 }' || true)
 
   # If specific branch is not found then try master
-  if [[ ! -n "$tip" ]]; then
+  if [[ -z "$tip" ]]; then
     tip=$(git ls-remote --heads "https://github.com/${package}" |
          grep "refs/heads/master" | awk '{ print $1 }')
   fi
@@ -123,10 +123,11 @@ declare -A PKG_REV=(
 )
 
 # Turn the depcache into a dictionary so we can reference the HEAD of each repo
-for line in $(cat "$DEPCACHE_FILE"); do
+while IFS= read -r line; do
+  # shellcheck disable=SC2207 # Expecting to word-split tr results.
   linearr=($(echo "$line" | tr ':' ' '))
   PKG_REV["${linearr[0]}"]="${linearr[1]}"
-done
+done < "$DEPCACHE_FILE"
 
 # Define common flags used for builds
 PREFIX="/usr/local"
@@ -159,7 +160,7 @@ COPY_CMDS=""
 # We must sort the packages, otherwise we might produce an unstable
 # docker file and rebuild the image unnecessarily
 for pkg in $(echo "${!PKG_REV[@]}" | tr ' ' '\n' | LC_COLLATE=C sort -s); do
-  COPY_CMDS+="COPY --from=$(stagename ${pkg}) ${PREFIX} ${PREFIX}"$'\n'
+  COPY_CMDS+="COPY --from=$(stagename "${pkg}") ${PREFIX} ${PREFIX}"$'\n'
   # Workaround for upstream docker bug and multiple COPY cmds
   # https://github.com/moby/moby/issues/37965
   COPY_CMDS+="RUN true"$'\n'
@@ -498,9 +499,9 @@ ${COPY_CMDS}
 RUN echo '$(LC_COLLATE=C sort -s "$DEPCACHE_FILE" | tr '\n' ',')' > /tmp/depcache
 
 # Final configuration for the workspace
-RUN grep -q ${GROUPS} /etc/group || groupadd -g ${GROUPS} ${USER}
+RUN grep -q ${GROUPS[0]} /etc/group || groupadd -g ${GROUPS[0]} ${USER}
 RUN mkdir -p "$(dirname "${HOME}")"
-RUN grep -q ${UID} /etc/passwd || useradd -d ${HOME} -m -u ${UID} -g ${GROUPS} ${USER}
+RUN grep -q ${UID} /etc/passwd || useradd -d ${HOME} -m -u ${UID} -g ${GROUPS[0]} ${USER}
 RUN sed -i '1iDefaults umask=000' /etc/sudoers
 RUN echo "${USER} ALL=(ALL) NOPASSWD: ALL" >>/etc/sudoers
 
@@ -517,4 +518,5 @@ if [[ -n "${http_proxy}" ]]; then
 fi
 
 # Build above image
-docker build ${proxy_args} --network=host -t ${DOCKER_IMG_NAME} - <<< "${Dockerfile}"
+# shellcheck disable=SC2086 # proxy_args requires word splitting.
+docker build ${proxy_args} --network=host -t "${DOCKER_IMG_NAME}" - <<< "${Dockerfile}"

Diff for: build-unit-test-docker.sh

@@ -23,16 +23,16 @@ FROM ubuntu:16.04
 
 ${PROXY}
 
-ENV DEBIAN_FRONTEND noninteractive 
+ENV DEBIAN_FRONTEND noninteractive
 RUN apt-get update && apt-get install -yy \
 	make \
 	texlive-xetex \
 	pandoc \
 	fonts-inconsolata \
 	fonts-linuxlibertine
 
-RUN grep -q ${GROUPS} /etc/group || groupadd -g ${GROUPS} ${USER}
-RUN grep -q ${UID} /etc/passwd || useradd -d ${HOME} -m -u ${UID} -g ${GROUPS} ${USER}
+RUN grep -q ${GROUPS[0]} /etc/group || groupadd -g ${GROUPS[0]} ${USER}
+RUN grep -q ${UID} /etc/passwd || useradd -d ${HOME} -m -u ${UID} -g ${GROUPS[0]} ${USER}
 
 USER ${USER}
 ENV HOME ${HOME}
@@ -41,8 +41,7 @@ EOF
 )
 
 # Build the docker container
-docker build -t linux-build/ubuntu - <<< "${Dockerfile}"
-if [[ "$?" -ne 0 ]]; then
+if ! docker build -t linux-build/ubuntu - <<< "${Dockerfile}" ; then
   echo "Failed to build docker container."
   exit 1
 fi
@@ -52,7 +51,7 @@ export PROXY_HOST=${http_proxy/#http*:\/\/}
 export PROXY_HOST=${PROXY_HOST/%:[0-9]*}
 export PROXY_PORT=${http_proxy/#http*:\/\/*:}
 
-mkdir -p ${WORKSPACE}
+mkdir -p "${WORKSPACE}"
 
 cat > "${WORKSPACE}"/build.sh << EOF_SCRIPT
 #!/bin/bash
@@ -68,8 +67,8 @@ make
 
 EOF_SCRIPT
 
-chmod a+x ${WORKSPACE}/build.sh
+chmod a+x "${WORKSPACE}/build.sh"
 
 # Run the docker container, execute the build script we just built
-docker run --cap-add=sys_admin --net=host --rm=true -e WORKSPACE=${WORKSPACE} --user="${USER}" \
-  -w "${HOME}" -v "${HOME}":"${HOME}" -t linux-build/ubuntu ${WORKSPACE}/build.sh
+docker run --cap-add=sys_admin --net=host --rm=true -e WORKSPACE="${WORKSPACE}" --user="${USER}" \
+  -w "${HOME}" -v "${HOME}":"${HOME}" -t linux-build/ubuntu "${WORKSPACE}/build.sh"

Diff for: docs-build.sh

@@ -4,7 +4,7 @@
 #
 
 # Debug
-if grep -q debug <<< $@; then
+if grep -q debug <<< "$@"; then
 	set -x
 fi
 set -o errexit
@@ -84,8 +84,8 @@ RUN apt-get update && apt-get install -yy \
 	iputils-ping \
 	locales
 
-RUN grep -q ${GROUPS} /etc/group || groupadd -g ${GROUPS} ${USER}
-RUN grep -q ${UID} /etc/passwd || useradd -d ${HOME} -m -u ${UID} -g ${GROUPS} ${USER}
+RUN grep -q ${GROUPS[0]} /etc/group || groupadd -g ${GROUPS[0]} ${USER}
+RUN grep -q ${UID} /etc/passwd || useradd -d ${HOME} -m -u ${UID} -g ${GROUPS[0]} ${USER}
 
 RUN locale-gen en_AU.utf8
 
@@ -96,8 +96,7 @@ EOF
 )
 
 # Build the docker container
-docker build -t initramfs-build/ubuntu - <<< "${Dockerfile}"
-if [[ "$?" -ne 0 ]]; then
+if ! docker build -t initramfs-build/ubuntu - <<< "${Dockerfile}" ; then
 	echo "Failed to build docker container."
 	exit 1
 fi