[chore] activate shellcheck in lint target (#136)

* resolve shellcheck issues, add .shellcheckrc, add shellcheck-lint dependency to lint target

Author: sultanowskii

.shellcheckrc

@@ -0,0 +1,3 @@
+enable=useless-use-of-cat
+
+disable=SC2164 # cd/popd/push failure check

Makefile

@@ -101,7 +101,7 @@ injector-integration-tests-for-all-architectures:
 	test/scripts/test-all.sh
 
 .PHONY: lint
-lint: zig-fmt-check # TODO add the `shellcheck-lint` target here as well, in a follow-up PR.
+lint: zig-fmt-check shellcheck-lint
 
 .PHONY: zig-fmt-check
 zig-fmt-check: check-zig-installed

packaging/fpm/common.sh

@@ -1,9 +1,10 @@
 #!/bin/bash
+# shellcheck disable=SC2034 # Some of the variables are used in other scripts
 
 # Copyright The OpenTelemetry Authors
 # SPDX-License-Identifier: Apache-2.0
 
-FPM_DIR="$( cd "$( dirname ${BASH_SOURCE[0]} )" && pwd )"
+FPM_DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )"
 REPO_DIR="$( cd "$FPM_DIR/../../" && pwd )"
 
 PKG_NAME="opentelemetry-injector"
@@ -60,7 +61,7 @@ download_java_agent() {
     fi
 
     echo "Downloading $dl_url ..."
-    mkdir -p "$( dirname $dest )"
+    mkdir -p "$( dirname "$dest" )"
     curl -sfL "$dl_url" -o "$dest"
 }
 
@@ -70,8 +71,8 @@ download_nodejs_agent() {
     pushd "$(dirname "$dest")"
     mkdir -p "js"
     pushd "js"
-    npm pack @opentelemetry/auto-instrumentations-node@${tag#v}
-    mv *.tgz otel-js.tgz
+    npm pack "@opentelemetry/auto-instrumentations-node@${tag#v}"
+    mv ./*.tgz otel-js.tgz
     npm install --global=false otel-js.tgz
     rm otel-js.tgz
     popd
@@ -82,7 +83,7 @@ download_dotnet_agent() {
     local tag="$1"
     local dest="$2"
 
-    case "$ARCH" in
+    case "${ARCH:-}" in
       amd64) local dotnet_arch="x64" ;;
       arm64) local dotnet_arch="arm64" ;;
       *)
@@ -109,21 +110,24 @@ download_and_unzip_dotnet_agent_for_libc_flavor() {
     local dl_url="$DOTNET_AGENT_RELEASE_URL/$tag/$pkg"
 
     echo "Downloading $dl_url ..."
-    curl -sSfL "$dl_url" -o /tmp/$pkg
+    curl -sSfL "$dl_url" -o "/tmp/$pkg"
 
     echo "Extracting $pkg to $destination_folder_for_libc_flavor ..."
     mkdir -p "$destination_folder_for_libc_flavor"
-    unzip -d "$destination_folder_for_libc_flavor" /tmp/$pkg
-    rm -f /tmp/$pkg
+    unzip -d "$destination_folder_for_libc_flavor" "/tmp/$pkg"
+    rm -f "/tmp/$pkg"
 }
 
 setup_files_and_permissions() {
     local arch="$1"
     local buildroot="$2"
     local libotelinject="$REPO_DIR/dist/libotelinject_${arch}.so"
-    local java_agent_release="$(cat "$JAVA_AGENT_RELEASE_PATH" | tail -n 1)"
-    local nodejs_agent_release="$(cat "$NODEJS_AGENT_RELEASE_PATH" | tail -n 1)"
-    local dotnet_agent_release="$(cat "$DOTNET_AGENT_RELEASE_PATH" | tail -n 1)"
+    local java_agent_release
+    local nodejs_agent_release
+    local dotnet_agent_release
+    java_agent_release="$(tail -n 1 <"$JAVA_AGENT_RELEASE_PATH")"
+    nodejs_agent_release="$(tail -n 1 <"$NODEJS_AGENT_RELEASE_PATH")"
+    dotnet_agent_release="$(tail -n 1 <"$DOTNET_AGENT_RELEASE_PATH")"
 
     mkdir -p "$buildroot/$(dirname $libotelinject_INSTALL_PATH)"
     cp -f "$libotelinject" "$buildroot/$libotelinject_INSTALL_PATH"

packaging/fpm/deb/build.sh

@@ -5,8 +5,10 @@
 
 set -euxo pipefail
 
-SCRIPT_DIR="$( cd "$( dirname ${BASH_SOURCE[0]} )" && pwd )"
-. $SCRIPT_DIR/../common.sh
+SCRIPT_DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )"
+
+# shellcheck disable=SC1091 # Including common.sh
+. "$SCRIPT_DIR/../common.sh"
 
 VERSION="${1:-}"
 ARCH="${2:-amd64}"

packaging/fpm/install-deps.sh

@@ -5,10 +5,10 @@
 
 set -euxo pipefail
 
-SCRIPT_DIR="$( cd "$( dirname ${BASH_SOURCE[0]} )" && pwd )"
+SCRIPT_DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )"
 
 apt-get update
 
 apt-get install -y ruby ruby-dev rubygems build-essential git rpm sudo curl jq ruby-bundler unzip
 
-bundle install --gemfile ${SCRIPT_DIR}/Gemfile
+bundle install --gemfile "${SCRIPT_DIR}/Gemfile"

packaging/fpm/rpm/build.sh

@@ -5,8 +5,10 @@
 
 set -euxo pipefail
 
-SCRIPT_DIR="$( cd "$( dirname ${BASH_SOURCE[0]} )" && pwd )"
-. $SCRIPT_DIR/../common.sh
+SCRIPT_DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )"
+
+# shellcheck disable=SC1091 # Including common.sh
+. "$SCRIPT_DIR/../common.sh"
 
 VERSION="${1:-}"
 ARCH="${2:-amd64}"

packaging/fpm/test.sh

@@ -2,8 +2,10 @@
 
 set -euo pipefail
 
-SCRIPT_DIR="$( cd "$( dirname ${BASH_SOURCE[0]} )" && pwd )"
-. $SCRIPT_DIR/common.sh
+SCRIPT_DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )"
+
+# shellcheck disable=SC1091 # Including common.sh
+. "$SCRIPT_DIR/common.sh"
 
 PKG_TYPE="${1:-rpm}"
 ARCH="${2:-amd64}"
@@ -27,7 +29,7 @@ PKG_PATH="${REPO_DIR}/instrumentation/dist/${PKG_NAME}*${ARCH}.${PKG_TYPE}"
 
 # install
 echo "Installing $PKG_PATH"
-$INSTALL_CMD $PKG_PATH
+$INSTALL_CMD "$PKG_PATH"
 if [ ! -f /etc/ld.so.preload ]; then
     echo "/etc/ld.so.preload not found" >&2
     exit 1
@@ -41,7 +43,7 @@ ldd "$LIBOTELINJECT_INSTALL_PATH"
 
 # upgrade
 echo "Upgrading $PKG_PATH"
-$UPGRADE_CMD $PKG_PATH
+$UPGRADE_CMD "$PKG_PATH"
 if [ ! -f /etc/ld.so.preload ]; then
     echo "/etc/ld.so.preload not found" >&2
     exit 1
@@ -64,7 +66,7 @@ fi
 # install with pre-existing /etc/ld.so.preload
 touch /etc/ld.so.preload
 echo "Installing $PKG_PATH"
-$INSTALL_CMD $PKG_PATH
+$INSTALL_CMD "$PKG_PATH"
 if [ ! -f /etc/ld.so.preload ]; then
     echo "/etc/ld.so.preload not found" >&2
     exit 1

packaging/tests/deb/dotnet/run.sh

@@ -12,8 +12,8 @@ else
   exit 1
 fi
 
-SCRIPT_DIR="$( cd "$( dirname ${BASH_SOURCE[0]} )" && pwd )"
-cd $SCRIPT_DIR/../../../..
+SCRIPT_DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )"
+cd "$SCRIPT_DIR/../../../.."
 
 docker build \
   --platform "$docker_platform" \

packaging/tests/deb/java/run.sh

@@ -12,8 +12,8 @@ else
   exit 1
 fi
 
-SCRIPT_DIR="$( cd "$( dirname ${BASH_SOURCE[0]} )" && pwd )"
-cd $SCRIPT_DIR/../../../..
+SCRIPT_DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )"
+cd "$SCRIPT_DIR/../../../.."
 
 tomcat_download_url=$(packaging/tests/shared/determine-tomcat-download-url.sh)
 if [[ ! "$tomcat_download_url" =~ dlcdn.apache.org ]]; then

packaging/tests/deb/nodejs/run.sh

@@ -12,8 +12,8 @@ else
   exit 1
 fi
 
-SCRIPT_DIR="$( cd "$( dirname ${BASH_SOURCE[0]} )" && pwd )"
-cd $SCRIPT_DIR/../../../..
+SCRIPT_DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )"
+cd "$SCRIPT_DIR/../../../.."
 
 docker build \
   --platform "$docker_platform" \