chore: Replace hardcoded paths in scripts with env lookup

ThomasK33 · ThomasK33 · commit c89b06d6788e · 2025-02-04T12:12:27.000+01:00
Change-Id: Id159eea95ce16be1881fb290f5958d505222cb83
Signed-off-by: Thomas Kosiewski &lt;tk@coder.com&gt;
diff --git a/agent/agent_test.go b/agent/agent_test.go
@@ -2243,7 +2243,7 @@ func TestAgent_ScriptLogging(t *testing.T) {
 				{
 					LogSourceID: lsStart,
 					RunOnStart:  true,
-					Script: `#!/bin/sh
+					Script: `#!/usr/bin/env sh
 i=0
 while [ $i -ne 5 ]
 do
@@ -2255,7 +2255,7 @@ done
 				{
 					LogSourceID: lsStop,
 					RunOnStop:   true,
-					Script: `#!/bin/sh
+					Script: `#!/usr/bin/env sh
 i=0
 while [ $i -ne 3000 ]
 do
diff --git a/agent/agentssh/agentssh_test.go b/agent/agentssh/agentssh_test.go
@@ -86,7 +86,7 @@ func TestNewServer_ExecuteShebang(t *testing.T) {
 
 	t.Run("Basic", func(t *testing.T) {
 		t.Parallel()
-		cmd, err := s.CreateCommand(ctx, `#!/bin/bash
+		cmd, err := s.CreateCommand(ctx, `#!/usr/bin/env bash
 		echo test`, nil)
 		require.NoError(t, err)
 		output, err := cmd.AsExec().CombinedOutput()
diff --git a/agent/reaper/reaper_test.go b/agent/reaper/reaper_test.go
@@ -35,7 +35,7 @@ func TestReap(t *testing.T) {
 	err := reaper.ForkReap(
 		reaper.WithPIDCallback(pids),
 		// Provide some argument that immediately exits.
-		reaper.WithExecArgs("/bin/sh", "-c", "exit 0"),
+		reaper.WithExecArgs("/usr/bin/env sh", "-c", "exit 0"),
 	)
 	require.NoError(t, err)
 
@@ -89,7 +89,7 @@ func TestReapInterrupt(t *testing.T) {
 			reaper.WithCatchSignals(os.Interrupt),
 			// Signal propagation does not extend to children of children, so
 			// we create a little bash script to ensure sleep is interrupted.
-			reaper.WithExecArgs("/bin/sh", "-c", fmt.Sprintf("pid=0; trap 'kill -USR2 %d; kill -TERM $pid' INT; sleep 10 &\npid=$!; kill -USR1 %d; wait", os.Getpid(), os.Getpid())),
+			reaper.WithExecArgs("/usr/bin/env", "sh", "-c", fmt.Sprintf("pid=0; trap 'kill -USR2 %d; kill -TERM $pid' INT; sleep 10 &\npid=$!; kill -USR1 %d; wait", os.Getpid(), os.Getpid())),
 		)
 	}()
 
diff --git a/cli/configssh_internal_test.go b/cli/configssh_internal_test.go
@@ -167,7 +167,7 @@ func Test_sshConfigExecEscape(t *testing.T) {
 			err := os.MkdirAll(dir, 0o755)
 			require.NoError(t, err)
 			bin := filepath.Join(dir, "coder")
-			contents := []byte("#!/bin/sh\necho yay\n")
+			contents := []byte("#!/usr/bin/env sh\necho yay\n")
 			err = os.WriteFile(bin, contents, 0o755) //nolint:gosec
 			require.NoError(t, err)
 
@@ -178,7 +178,7 @@ func Test_sshConfigExecEscape(t *testing.T) {
 			}
 			require.NoError(t, err)
 
-			b, err := exec.Command("/bin/sh", "-c", escaped).CombinedOutput() //nolint:gosec
+			b, err := exec.Command("/usr/bin/env", "sh", "-c", escaped).CombinedOutput() //nolint:gosec
 			require.NoError(t, err)
 			got := strings.TrimSpace(string(b))
 			require.Equal(t, "yay", got)
diff --git a/cli/dotfiles_test.go b/cli/dotfiles_test.go
@@ -121,7 +121,7 @@ func TestDotfiles(t *testing.T) {
 		testRepo := testGitRepo(t, root)
 
 		// nolint:gosec
-		err := os.WriteFile(filepath.Join(testRepo, "install.sh"), []byte("#!/bin/bash\necho wow > "+filepath.Join(string(root), ".bashrc")), 0o750)
+		err := os.WriteFile(filepath.Join(testRepo, "install.sh"), []byte("#!/usr/bin/env bash\necho wow > "+filepath.Join(string(root), ".bashrc")), 0o750)
 		require.NoError(t, err)
 
 		c := exec.Command("git", "add", "install.sh")
@@ -155,7 +155,7 @@ func TestDotfiles(t *testing.T) {
 		err := os.MkdirAll(filepath.Join(testRepo, "script"), 0o750)
 		require.NoError(t, err)
 		// nolint:gosec
-		err = os.WriteFile(filepath.Join(testRepo, scriptPath), []byte("#!/bin/bash\necho wow > "+filepath.Join(string(root), ".bashrc")), 0o750)
+		err = os.WriteFile(filepath.Join(testRepo, scriptPath), []byte("#!/usr/bin/env bash\necho wow > "+filepath.Join(string(root), ".bashrc")), 0o750)
 		require.NoError(t, err)
 
 		c := exec.Command("git", "add", scriptPath)
@@ -192,7 +192,7 @@ func TestDotfiles(t *testing.T) {
 		require.NoError(t, err)
 
 		// nolint:gosec
-		err = os.WriteFile(filepath.Join(testRepo, "install.sh"), []byte("#!/bin/bash\necho wow > "+filepath.Join(string(root), ".bashrc")), 0o750)
+		err = os.WriteFile(filepath.Join(testRepo, "install.sh"), []byte("#!/usr/bin/env bash\necho wow > "+filepath.Join(string(root), ".bashrc")), 0o750)
 		require.NoError(t, err)
 
 		c = exec.Command("git", "checkout", "-b", "other_branch")
diff --git a/docs/admin/templates/extending-templates/docker-in-workspaces.md b/docs/admin/templates/extending-templates/docker-in-workspaces.md
@@ -38,7 +38,7 @@ resource "coder_agent" "main" {
   arch           = data.coder_provisioner.me.arch
   os             = "linux"
   startup_script = <<EOF
-    #!/bin/sh
+    #!/usr/bin/env sh
 
     # Start Docker
     sudo dockerd &
@@ -79,7 +79,7 @@ resource "coder_agent" "main" {
   arch = "amd64"
   dir  = "/home/coder"
   startup_script = <<EOF
-    #!/bin/sh
+    #!/usr/bin/env sh
 
     # Start Docker
     sudo dockerd &
diff --git a/docs/admin/templates/extending-templates/modules.md b/docs/admin/templates/extending-templates/modules.md
@@ -23,7 +23,7 @@ module "coder-base" {
 resource "coder_agent" "dev" {
   # Modules can provide outputs, such as helper scripts
   startup_script=<<EOF
-  #!/bin/sh
+  #!/usr/bin/env sh
   ${module.coder-base.code_server_install_command}
   EOF
 }
diff --git a/docs/admin/templates/extending-templates/web-ides.md b/docs/admin/templates/extending-templates/web-ides.md
@@ -40,7 +40,7 @@ resource "coder_agent" "main" {
     arch           = "amd64"
     os             = "linux"
     startup_script = <<EOF
-    #!/bin/sh
+    #!/usr/bin/env sh
     # install code-server
     # add '-s -- --version x.x.x' to install a specific code-server version
     curl -fsSL https://code-server.dev/install.sh | sh -s -- --method=standalone --prefix=/tmp/code-server
@@ -121,7 +121,7 @@ command. To add VS Code web as a web IDE, you have two options.
        arch           = "amd64"
        os             = "linux"
        startup_script = <<EOF
-       #!/bin/sh
+       #!/usr/bin/env sh
        # install VS Code
        curl -Lk 'https://code.visualstudio.com/sha/download?build=stable&os=cli-alpine-x64' --output vscode_cli.tar.gz
        mkdir -p /tmp/vscode-cli
@@ -231,7 +231,7 @@ resource "coder_agent" "coder" {
   arch           = "amd64"
   dir            = "/home/coder"
   startup_script = <<EOT
-#!/bin/bash
+#!/usr/bin/env bash
 # start rstudio
 /usr/lib/rstudio-server/bin/rserver --server-daemonize=1 --auth-none=1 &
 EOT
@@ -278,7 +278,7 @@ resource "coder_agent" "coder" {
   arch = "amd64"
   dir  = "/home/coder"
   startup_script = <<EOT
-#!/bin/bash
+#!/usr/bin/env bash
 # install and start airflow
 pip3 install apache-airflow
 /home/coder/.local/bin/airflow standalone &
@@ -329,7 +329,7 @@ resource "coder_agent" "coder" {
   arch = "amd64"
   dir  = "/home/coder"
   startup_script = <<EOT
-#!/bin/bash
+#!/usr/bin/env bash
 
 curl -fsSL https://raw.githubusercontent.com/filebrowser/get/master/get.sh | bash
 filebrowser --noauth --root /home/coder --port 13339 >/tmp/filebrowser.log 2>&1 &
diff --git a/docs/reference/index.md b/docs/reference/index.md
@@ -87,7 +87,7 @@ activity.
   long-running machine learning job).
 
   ```shell
-  #!/bin/bash
+  #!/usr/bin/env bash
   # Send workspace activity as long as the job is still running
 
   while true
diff --git a/docs/tutorials/reverse-proxy-apache.md b/docs/tutorials/reverse-proxy-apache.md
@@ -164,7 +164,7 @@
 3. And add this code:
 
    ```shell
-   #!/bin/sh
+   #!/usr/bin/env sh
    sudo certbot renew -q
    ```
 
diff --git a/docs/tutorials/reverse-proxy-nginx.md b/docs/tutorials/reverse-proxy-nginx.md
@@ -165,7 +165,7 @@
 3. And add this code:
 
    ```shell
-   #!/bin/sh
+   #!/usr/bin/env sh
    sudo certbot renew -q
    ```
 
diff --git a/docs/user-guides/workspace-dotfiles.md b/docs/user-guides/workspace-dotfiles.md
@@ -31,7 +31,7 @@ You can even fill `personalize` with `coder dotfiles <repo>`, but those looking
 for a simpler approach can inline commands like so:
 
 ```bash
-#!/bin/bash
+#!/usr/bin/env bash
 sudo apt update
 # Install some of my favorite tools every time my workspace boots
 sudo apt install -y neovim fish cargo
diff --git a/examples/lima/coder.yaml b/examples/lima/coder.yaml
@@ -38,7 +38,7 @@ provision:
     # Names defined in /etc/hosts inside the VM are not resolved inside containers when
     # using the hostResolver; use hostResolver.hosts instead (requires lima 0.8.3 or later).
     script: |
-      #!/bin/sh
+      #!/usr/bin/env sh
       set -eux -o pipefail
       sed -i 's/host.lima.internal.*/host.lima.internal host.docker.internal/' /etc/hosts
   - mode: system
diff --git a/examples/parameters-dynamic-options/main.tf b/examples/parameters-dynamic-options/main.tf
@@ -55,7 +55,7 @@ resource "coder_agent" "main" {
   arch           = data.coder_provisioner.me.arch
   os             = "linux"
   startup_script = <<EOF
-    #!/bin/sh
+    #!/usr/bin/env sh
     # Install the latest code-server.
     # Append "-s -- --version x.x.x" to install a specific version of code-server.
     curl -fsSL https://code-server.dev/install.sh | sh
diff --git a/examples/templates/gcp-linux/main.tf b/examples/templates/gcp-linux/main.tf
@@ -62,7 +62,7 @@ resource "coder_agent" "main" {
     interval     = 5
     timeout      = 5
     script       = <<-EOT
-      #!/bin/bash
+      #!/usr/bin/env bash
       set -e
       top -bn1 | grep "Cpu(s)" | awk '{print $2 + $4 "%"}'
     EOT
@@ -73,7 +73,7 @@ resource "coder_agent" "main" {
     interval     = 5
     timeout      = 5
     script       = <<-EOT
-      #!/bin/bash
+      #!/usr/bin/env bash
       set -e
       free -m | awk 'NR==2{printf "%.2f%%\t", $3*100/$2 }'
     EOT
@@ -84,7 +84,7 @@ resource "coder_agent" "main" {
     interval     = 600 # every 10 minutes
     timeout      = 30  # df can take a while on large filesystems
     script       = <<-EOT
-      #!/bin/bash
+      #!/usr/bin/env bash
       set -e
       df /home/coder | awk '$NF=="/"{printf "%s", $5}'
     EOT
diff --git a/examples/templates/incus/main.tf b/examples/templates/incus/main.tf
@@ -229,7 +229,7 @@ write_files:
 runcmd:
   - chown -R ${local.workspace_user}:${local.workspace_user} /home/${local.workspace_user}
   - |
-    #!/bin/bash
+    #!/usr/bin/env bash
     apt-get update && apt-get install -y curl docker.io
     usermod -aG docker ${local.workspace_user}
     newgrp docker
diff --git a/examples/templates/kubernetes-envbox/main.tf b/examples/templates/kubernetes-envbox/main.tf
@@ -85,7 +85,7 @@ resource "coder_agent" "main" {
   os             = "linux"
   arch           = "amd64"
   startup_script = <<EOT
-    #!/bin/bash
+    #!/usr/bin/env bash
     # home folder can be empty, so copying default bash settings
     if [ ! -f ~/.profile ]; then
       cp /etc/skel/.profile $HOME
diff --git a/examples/templates/scratch/main.tf b/examples/templates/scratch/main.tf
@@ -53,7 +53,7 @@ resource "coder_script" "startup_script" {
   agent_id           = coder_agent.main.id
   display_name       = "Startup Script"
   script             = <<-EOF
-    #!/bin/sh
+    #!/usr/bin/env sh
     set -e
     # Run programs at workspace startup
   EOF
diff --git a/examples/workspace-tags/main.tf b/examples/workspace-tags/main.tf
@@ -71,7 +71,7 @@ resource "coder_agent" "main" {
   arch           = data.coder_provisioner.me.arch
   os             = "linux"
   startup_script = <<EOF
-    #!/bin/sh
+    #!/usr/bin/env sh
     # Install the latest code-server.
     # Append "-s -- --version x.x.x" to install a specific version of code-server.
     curl -fsSL https://code-server.dev/install.sh | sh
diff --git a/install.sh b/install.sh
@@ -1,4 +1,4 @@
-#!/bin/sh
+#!/usr/bin/env sh
 set -eu
 
 # Coder's automatic install script.
diff --git a/provisioner/terraform/provision_test.go b/provisioner/terraform/provision_test.go
@@ -157,7 +157,7 @@ func TestProvision_Cancel(t *testing.T) {
 			binPath := filepath.Join(dir, "terraform")
 
 			// Example: exec /path/to/terrafork_fake_cancel.sh 1.2.1 apply "$@"
-			content := fmt.Sprintf("#!/bin/sh\nexec %q %s %s \"$@\"\n", fakeBin, terraform.TerraformVersion.String(), tt.mode)
+			content := fmt.Sprintf("#!/usr/bin/env sh\nexec %q %s %s \"$@\"\n", fakeBin, terraform.TerraformVersion.String(), tt.mode)
 			err := os.WriteFile(binPath, []byte(content), 0o755) //#nosec
 			require.NoError(t, err)
 			t.Logf("wrote fake terraform script to %s", binPath)
@@ -227,7 +227,7 @@ func TestProvision_CancelTimeout(t *testing.T) {
 	binPath := filepath.Join(dir, "terraform")
 
 	// Example: exec /path/to/terraform_fake_cancel.sh 1.2.1 apply "$@"
-	content := fmt.Sprintf("#!/bin/sh\nexec %q %s \"$@\"\n", fakeBin, terraform.TerraformVersion.String())
+	content := fmt.Sprintf("#!/usr/bin/env sh\nexec %q %s \"$@\"\n", fakeBin, terraform.TerraformVersion.String())
 	err = os.WriteFile(binPath, []byte(content), 0o755) //#nosec
 	require.NoError(t, err)
 
@@ -290,7 +290,7 @@ func TestProvision_TextFileBusy(t *testing.T) {
 	binPath := filepath.Join(dir, "terraform")
 
 	// Example: exec /path/to/terraform_fake_cancel.sh 1.2.1 apply "$@"
-	content := fmt.Sprintf("#!/bin/sh\nexec %q %s \"$@\"\n", fakeBin, terraform.TerraformVersion.String())
+	content := fmt.Sprintf("#!/usr/bin/env sh\nexec %q %s \"$@\"\n", fakeBin, terraform.TerraformVersion.String())
 	err = os.WriteFile(binPath, []byte(content), 0o755) //#nosec
 	require.NoError(t, err)
 
diff --git a/provisioner/terraform/resources_test.go b/provisioner/terraform/resources_test.go
@@ -473,7 +473,7 @@ func TestConvertResources(t *testing.T) {
 							RunOnStart:  true,
 							LogPath:     "coder-startup-script.log",
 							Icon:        "/emojis/25b6.png",
-							Script:      "    #!/bin/bash\n    # home folder can be empty, so copying default bash settings\n    if [ ! -f ~/.profile ]; then\n      cp /etc/skel/.profile $HOME\n    fi\n    if [ ! -f ~/.bashrc ]; then\n      cp /etc/skel/.bashrc $HOME\n    fi\n    # install and start code-server\n    curl -fsSL https://code-server.dev/install.sh | sh  | tee code-server-install.log\n    code-server --auth none --port 13337 | tee code-server-install.log &\n",
+							Script:      "    #!/usr/bin/env bash\n    # home folder can be empty, so copying default bash settings\n    if [ ! -f ~/.profile ]; then\n      cp /etc/skel/.profile $HOME\n    fi\n    if [ ! -f ~/.bashrc ]; then\n      cp /etc/skel/.bashrc $HOME\n    fi\n    # install and start code-server\n    curl -fsSL https://code-server.dev/install.sh | sh  | tee code-server-install.log\n    code-server --auth none --port 13337 | tee code-server-install.log &\n",
 						}},
 					}},
 				},
diff --git a/provisioner/terraform/serve_internal_test.go b/provisioner/terraform/serve_internal_test.go
@@ -57,7 +57,7 @@ func Test_absoluteBinaryPath(t *testing.T) {
 			log := testutil.Logger(t)
 			// Create a temp dir with the binary
 			tempDir := t.TempDir()
-			terraformBinaryOutput := fmt.Sprintf(`#!/bin/sh
+			terraformBinaryOutput := fmt.Sprintf(`#!/usr/bin/env sh
 			cat <<-EOF
 			{
 				"terraform_version": "%s",
diff --git a/provisioner/terraform/testdata/fake_cancel.sh b/provisioner/terraform/testdata/fake_cancel.sh
@@ -1,4 +1,4 @@
-#!/bin/sh
+#!/usr/bin/env sh
 
 VERSION=$1
 MODE=$2
diff --git a/provisioner/terraform/testdata/fake_cancel_hang.sh b/provisioner/terraform/testdata/fake_cancel_hang.sh
@@ -1,4 +1,4 @@
-#!/bin/sh
+#!/usr/bin/env sh
 
 VERSION=$1
 shift 1
diff --git a/provisioner/terraform/testdata/fake_text_file_busy.sh b/provisioner/terraform/testdata/fake_text_file_busy.sh
@@ -1,4 +1,4 @@
-#!/bin/sh
+#!/usr/bin/env sh
 
 VERSION=$1
 shift 1
diff --git a/provisioner/terraform/testdata/kubernetes-metadata/kubernetes-metadata.tf b/provisioner/terraform/testdata/kubernetes-metadata/kubernetes-metadata.tf
@@ -45,7 +45,7 @@ resource "coder_agent" "main" {
   os             = "linux"
   arch           = "amd64"
   startup_script = <<EOT
-    #!/bin/bash
+    #!/usr/bin/env bash
     # home folder can be empty, so copying default bash settings
     if [ ! -f ~/.profile ]; then
       cp /etc/skel/.profile $HOME
diff --git a/pty/start_other_test.go b/pty/start_other_test.go
@@ -69,7 +69,7 @@ func TestStart(t *testing.T) {
 				Height: 24,
 			},
 		}))
-		pty, ps := ptytest.Start(t, pty.Command(`/bin/sh`, `-c`, `env | grep SSH_TTY`), opts)
+		pty, ps := ptytest.Start(t, pty.Command(`/usr/bin/env`, `sh`, `-c`, `env | grep SSH_TTY`), opts)
 		pty.ExpectMatch("SSH_TTY=/dev/")
 		err := ps.Wait()
 		require.NoError(t, err)
diff --git a/scripts/linux-pkg/preinstall.sh b/scripts/linux-pkg/preinstall.sh
@@ -1,4 +1,4 @@
-#!/bin/sh
+#!/usr/bin/env sh
 set -eu
 
 USER="coder"
diff --git a/site/static/install.sh b/site/static/install.sh
@@ -1,4 +1,4 @@
-#!/bin/sh
+#!/usr/bin/env sh
 set -eu
 
 # Coder's automatic install script.

Original file line number	Diff line number	Diff line change
`@@ -23,7 +23,7 @@ module "coder-base" {`
`23`	`23`	`resource "coder_agent" "dev" {`
`24`	`24`	`# Modules can provide outputs, such as helper scripts`
`25`	`25`	`startup_script=<<EOF`
`26`		`- #!/bin/sh`
	`26`	`+ #!/usr/bin/env sh`
`27`	`27`	`${module.coder-base.code_server_install_command}`
`28`	`28`	`EOF`
`29`	`29`	`}`