Run shellcheck

Author: rafaelfranca

.devcontainer/Dockerfile

@@ -0,0 +1,3 @@
+FROM mcr.microsoft.com/devcontainers/base:1-bookworm
+
+RUN apt-get update && apt-get install -y shellcheck 

.devcontainer/devcontainer.json

@@ -2,8 +2,9 @@
 // README at: https://github.com/devcontainers/templates/tree/main/src/docker-in-docker
 {
 	"name": "Docker in Docker",
-	// Or use a Dockerfile or Docker Compose file. More info: https://containers.dev/guide/dockerfile
-	"image": "mcr.microsoft.com/devcontainers/javascript-node:1-20-bookworm",
+	"build": {
+		"dockerfile": "Dockerfile"
+	},
 
 	"features": {
 		"ghcr.io/devcontainers/features/docker-in-docker:2": {

.github/workflows/test-features.yaml

@@ -51,3 +51,15 @@ jobs:
       - name: "Generating tests for '${{ matrix.features }}' scenarios"
         working-directory: features
         run: devcontainer features test -f ${{ matrix.features }} --skip-autogenerated --skip-duplicated .
+
+  shellcheck:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: "Install shellcheck"
+        run: sudo apt-get update && sudo apt-get install -y shellcheck
+
+      - name: "Run shellcheck"
+        working-directory: features
+        run: find . -name "*.sh" -type f -exec shellcheck {} +

features/src/bun/install.sh

@@ -3,10 +3,10 @@ set -e
 
 USERNAME="${USERNAME:-"${_REMOTE_USER:-"automatic"}"}"
 
-if ! command -v curl &> /dev/null; then
+if ! command -v curl > /dev/null 2>&1; then
     apt update && apt install -y curl unzip
 fi
 
-su ${USERNAME} -c "curl -fsSL https://bun.sh/install | bash"
+su "${USERNAME}" -c "curl -fsSL https://bun.sh/install | bash"
 
 rm -rf /var/lib/apt/lists/*

features/src/bundler-cache/install.sh

@@ -1 +1,3 @@
+#!/bin/sh
+
 # This is a no op

features/src/postgres-client/install.sh

@@ -7,13 +7,15 @@ apt-get update -qq
 
 apt-get install -y gnupg ca-certificates
 
-VERSION_EXISTS=$(apt-cache search --names-only postgresql-client-$POSTGRES_CLIENT_VERSION | wc -l)
+client_package="postgresql-client-$POSTGRES_CLIENT_VERSION"
+
+VERSION_EXISTS=$(apt-cache search --names-only "$client_package" | wc -l)
 
 if [ "$VERSION_EXISTS" -ge 1 ]; then
-  apt-get install --no-install-recommends -y libpq-dev postgresql-client-$POSTGRES_CLIENT_VERSION
+  apt-get install --no-install-recommends -y libpq-dev "$client_package"
 else
   apt-get install --no-install-recommends -y postgresql-common libpq-dev
-  /usr/share/postgresql-common/pgdg/apt.postgresql.org.sh -y && apt-get install --no-install-recommends -y postgresql-client-$POSTGRES_CLIENT_VERSION
+  /usr/share/postgresql-common/pgdg/apt.postgresql.org.sh -y && apt-get install --no-install-recommends -y "$client_package"
 fi
 
 rm -rf /var/lib/apt/lists/*

features/src/ruby/install.sh

@@ -5,7 +5,7 @@ USERNAME="${USERNAME:-"${_REMOTE_USER:-"automatic"}"}"
 
 apt-get update -y
 apt-get -y install --no-install-recommends git curl ca-certificates libssl-dev libreadline-dev zlib1g-dev autoconf bison build-essential \
- libyaml-dev libncurses5-dev libffi-dev libgdbm-dev libxml2-dev rustc
+    libyaml-dev libncurses5-dev libffi-dev libgdbm-dev libxml2-dev rustc
 
 git clone https://github.com/rbenv/rbenv.git /usr/local/share/rbenv
 git clone https://github.com/rbenv/ruby-build.git /usr/local/share/ruby-build
@@ -14,20 +14,23 @@ mkdir -p /root/.rbenv/plugins
 ln -s /usr/local/share/ruby-build /root/.rbenv/plugins/ruby-build
 
 if [ "${USERNAME}" != "root" ]; then
-    mkdir -p /home/${USERNAME}/.rbenv/plugins
-    ln -s /usr/local/share/ruby-build /home/${USERNAME}/.rbenv/plugins/ruby-build
+    user_home="/home/${USERNAME}"
+    mkdir -p "${user_home}/.rbenv/plugins"
+    ln -s /usr/local/share/ruby-build "${user_home}/.rbenv/plugins/ruby-build"
 
-    chown -R "${USERNAME}" "/home/${USERNAME}/.rbenv/"
-    chmod -R g+r+w "/home/${USERNAME}/.rbenv"
+    chown -R "${USERNAME}" "${user_home}/.rbenv/"
+    chmod -R g+r+w "${user_home}/.rbenv"
 
-    echo 'eval "$(rbenv init -)"' >> /home/${USERNAME}/.bashrc
+    # shellcheck disable=SC2016
+    echo 'eval "$(rbenv init -)"' >> "${user_home}/.bashrc"
 
-    if [ -f /home/${USERNAME}/.zshrc ]; then
-        echo 'eval "$(rbenv init -)"' >> /home/${USERNAME}/.zshrc
+    if [ -f "${user_home}/.zshrc" ]; then
+        # shellcheck disable=SC2016
+        echo 'eval "$(rbenv init -)"' >> "${user_home}/.zshrc"
     fi
 fi
 
-su ${USERNAME} -c "/usr/local/share/rbenv/bin/rbenv install $VERSION"
-su ${USERNAME} -c "/usr/local/share/rbenv/bin/rbenv global $VERSION"
+su "${USERNAME}" -c "/usr/local/share/rbenv/bin/rbenv install $VERSION"
+su "${USERNAME}" -c "/usr/local/share/rbenv/bin/rbenv global $VERSION"
 
 rm -rf /var/lib/apt/lists/*

features/test/activestorage/image_processor_imagemagick.sh

@@ -1,6 +1,7 @@
 #!/bin/bash
 set -e
 
+# shellcheck source=/dev/null
 source dev-container-features-test-lib
 
 check "imagemagick is installed" bash -c "convert --version"

features/test/activestorage/test.sh

@@ -1,6 +1,7 @@
 #!/bin/bash
 set -e
 
+# shellcheck source=/dev/null
 source dev-container-features-test-lib
 
 check "libvips is installed" bash -c "dpkg -l | grep libvips"

features/test/bun/test.sh

@@ -1,6 +1,7 @@
 #!/bin/bash
 set -e
 
+# shellcheck source=/dev/null
 source dev-container-features-test-lib
 
 check "Bun is in the PATH" bash -c "which bun"