Add tests for shell execution on artifacts build (#2884)

shreyas-goenka · denik · web-flow · commit 48fdfb2f621e · 2025-06-06T14:20:10.000Z
## Why This part of the codebase was missing test coverage. I plan on changing the execution of commands to inline the script content and these tests are required to ensure I don't break anything (relevant discussion: #2862 (comment)) --------- Co-authored-by: Denis Bilenko <denis.bilenko@databricks.com>
diff --git a/acceptance/bundle/artifacts/shell/bash/databricks.yml b/acceptance/bundle/artifacts/shell/bash/databricks.yml
@@ -0,0 +1,11 @@
+bundle:
+  name: shell-bash
+
+artifacts:
+  my_artifact:
+    executable: bash
+    # echo in bash does not treat \n as a newline.
+    build: |
+      echo "\n\n\n should not see new lines" > out.shell.txt
+      echo "multiline scripts should work" >> out.shell.txt
+      pwd >> out.shell.txt
diff --git a/acceptance/bundle/artifacts/shell/bash/out.shell.txt b/acceptance/bundle/artifacts/shell/bash/out.shell.txt
@@ -0,0 +1,3 @@
+\n\n\n should not see new lines
+multiline scripts should work
+[TEST_TMP_DIR]
diff --git a/acceptance/bundle/artifacts/shell/bash/output.txt b/acceptance/bundle/artifacts/shell/bash/output.txt
@@ -0,0 +1,6 @@
+
+>>> [CLI] bundle deploy
+Building my_artifact...
+Uploading bundle files to /Workspace/Users/[USERNAME]/.bundle/shell-bash/default/files...
+Deploying resources...
+Deployment complete!
diff --git a/acceptance/bundle/artifacts/shell/bash/script b/acceptance/bundle/artifacts/shell/bash/script
@@ -0,0 +1 @@
+trace $CLI bundle deploy
diff --git a/acceptance/bundle/artifacts/shell/bash/test.toml b/acceptance/bundle/artifacts/shell/bash/test.toml
@@ -0,0 +1,5 @@
+# Line feed (\n) characters are rendered differently by bash vs sh on Unix based systems.
+# However that does not hold true for Windows WSL. Since the goal of this test is to assert
+# the chosen shell is being used, we skip this test on Windows.
+[GOOS]
+windows = false
diff --git a/acceptance/bundle/artifacts/shell/basic/databricks.yml b/acceptance/bundle/artifacts/shell/basic/databricks.yml
@@ -0,0 +1,8 @@
+bundle:
+  name: shell-basic
+
+artifacts:
+  my_artifact:
+    build: |
+      echo "Hello, World!" > out.shell.txt
+      echo "Bye, World!" >> out.shell.txt
diff --git a/acceptance/bundle/artifacts/shell/basic/out.shell.txt b/acceptance/bundle/artifacts/shell/basic/out.shell.txt
@@ -0,0 +1,2 @@
+Hello, World!
+Bye, World!
diff --git a/acceptance/bundle/artifacts/shell/basic/output.txt b/acceptance/bundle/artifacts/shell/basic/output.txt
@@ -0,0 +1,6 @@
+
+>>> [CLI] bundle deploy
+Building my_artifact...
+Uploading bundle files to /Workspace/Users/[USERNAME]/.bundle/shell-basic/default/files...
+Deploying resources...
+Deployment complete!
diff --git a/acceptance/bundle/artifacts/shell/basic/script b/acceptance/bundle/artifacts/shell/basic/script
@@ -0,0 +1 @@
+trace $CLI bundle deploy
diff --git a/acceptance/bundle/artifacts/shell/cmd/databricks.yml b/acceptance/bundle/artifacts/shell/cmd/databricks.yml
@@ -0,0 +1,12 @@
+bundle:
+  name: shell-cmd
+
+artifacts:
+  my_artifact:
+    executable: cmd
+    build: |
+      if defined CMDCMDLINE (
+        echo shell is cmd.exe> out.shell.txt
+      )
+      echo multiline scripts should work>> out.shell.txt
+      echo %CD%>> out.shell.txt
diff --git a/acceptance/bundle/artifacts/shell/cmd/out.shell.txt b/acceptance/bundle/artifacts/shell/cmd/out.shell.txt
@@ -0,0 +1,3 @@
+shell is cmd.exe
+multiline scripts should work
+[TEST_TMP_DIR]
diff --git a/acceptance/bundle/artifacts/shell/cmd/output.txt b/acceptance/bundle/artifacts/shell/cmd/output.txt
@@ -0,0 +1,6 @@
+
+>>> [CLI] bundle deploy
+Building my_artifact...
+Uploading bundle files to /Workspace/Users/[USERNAME]/.bundle/shell-cmd/default/files...
+Deploying resources...
+Deployment complete!
diff --git a/acceptance/bundle/artifacts/shell/cmd/script b/acceptance/bundle/artifacts/shell/cmd/script
@@ -0,0 +1 @@
+trace $CLI bundle deploy
diff --git a/acceptance/bundle/artifacts/shell/cmd/test.toml b/acceptance/bundle/artifacts/shell/cmd/test.toml
@@ -0,0 +1,4 @@
+# cmd.exe is only available on Windows.
+[GOOS]
+darwin = false
+linux = false
diff --git a/acceptance/bundle/artifacts/shell/default/databricks.yml b/acceptance/bundle/artifacts/shell/default/databricks.yml
@@ -0,0 +1,10 @@
+bundle:
+  name: shell-bash
+
+artifacts:
+  my_artifact:
+    # Default shell is bash. echo in bash does not treat \n as a newline.
+    build: |
+      echo "\n\n\n should not see new lines" > out.shell.txt
+      echo "multiline scripts should work" >> out.shell.txt
+      pwd >> out.shell.txt
diff --git a/acceptance/bundle/artifacts/shell/default/out.shell.txt b/acceptance/bundle/artifacts/shell/default/out.shell.txt
@@ -0,0 +1,3 @@
+\n\n\n should not see new lines
+multiline scripts should work
+[TEST_TMP_DIR]
diff --git a/acceptance/bundle/artifacts/shell/default/output.txt b/acceptance/bundle/artifacts/shell/default/output.txt
@@ -0,0 +1,6 @@
+
+>>> [CLI] bundle deploy
+Building my_artifact...
+Uploading bundle files to /Workspace/Users/[USERNAME]/.bundle/shell-bash/default/files...
+Deploying resources...
+Deployment complete!
diff --git a/acceptance/bundle/artifacts/shell/default/script b/acceptance/bundle/artifacts/shell/default/script
@@ -0,0 +1 @@
+trace $CLI bundle deploy
diff --git a/acceptance/bundle/artifacts/shell/default/test.toml b/acceptance/bundle/artifacts/shell/default/test.toml
@@ -0,0 +1,5 @@
+# Line feed (\n) characters are rendered differently by bash vs sh on Unix based systems.
+# However that does not hold true for Windows WSL. Since the goal of this test is to assert
+# the chosen shell is being used, we skip this test on Windows.
+[GOOS]
+windows = false
diff --git a/acceptance/bundle/artifacts/shell/invalid/databricks.yml b/acceptance/bundle/artifacts/shell/invalid/databricks.yml
@@ -0,0 +1,7 @@
+bundle:
+  name: shell-invalid
+
+artifacts:
+  my_artifact:
+    executable: invalid
+    build: foobar
diff --git a/acceptance/bundle/artifacts/shell/invalid/output.txt b/acceptance/bundle/artifacts/shell/invalid/output.txt
@@ -0,0 +1,7 @@
+
+>>> [CLI] bundle deploy
+Building my_artifact...
+Error: invalid is not supported as an artifact executable, options are: bash, sh or cmd
+
+
+Exit code: 1
diff --git a/acceptance/bundle/artifacts/shell/invalid/script b/acceptance/bundle/artifacts/shell/invalid/script
@@ -0,0 +1 @@
+trace $CLI bundle deploy
diff --git a/acceptance/bundle/artifacts/shell/sh/databricks.yml b/acceptance/bundle/artifacts/shell/sh/databricks.yml
@@ -0,0 +1,11 @@
+bundle:
+  name: shell-sh
+
+artifacts:
+  my_artifact:
+    executable: sh
+    # echo in sh treats \n as a newline.
+    build: |
+      echo "\n\n\nshould see new lines" > out.shell.txt
+      echo "multiline scripts should work" >> out.shell.txt
+      pwd >> out.shell.txt
diff --git a/acceptance/bundle/artifacts/shell/sh/out.shell.txt b/acceptance/bundle/artifacts/shell/sh/out.shell.txt
@@ -0,0 +1,6 @@
+
+
+
+should see new lines
+multiline scripts should work
+[TEST_TMP_DIR]
diff --git a/acceptance/bundle/artifacts/shell/sh/output.txt b/acceptance/bundle/artifacts/shell/sh/output.txt
@@ -0,0 +1,6 @@
+
+>>> [CLI] bundle deploy
+Building my_artifact...
+Uploading bundle files to /Workspace/Users/[USERNAME]/.bundle/shell-sh/default/files...
+Deploying resources...
+Deployment complete!
diff --git a/acceptance/bundle/artifacts/shell/sh/script b/acceptance/bundle/artifacts/shell/sh/script
@@ -0,0 +1 @@
+trace $CLI bundle deploy
diff --git a/acceptance/bundle/artifacts/shell/sh/test.toml b/acceptance/bundle/artifacts/shell/sh/test.toml
@@ -0,0 +1,5 @@
+# Line feed (\n) characters are rendered differently by bash vs sh on Unix based systems.
+# However that does not hold true for Windows WSL. Since the goal of this test is to assert
+# the chosen shell is being used, we skip this test on Windows.
+[GOOS]
+windows = false
diff --git a/acceptance/bundle/artifacts/shell/test.toml b/acceptance/bundle/artifacts/shell/test.toml
@@ -0,0 +1,3 @@
+Local = true
+Cloud = false
+RecordRequests = false
diff --git a/acceptance/selftest/basic/test.toml b/acceptance/selftest/basic/test.toml
@@ -8,7 +8,7 @@ Ignore = ['ignore*']
 #windows = false
 
 # Disable on Mac
-#mac = false
+#darwin = false
 
 # Disable on Linux
 #linux = false
diff --git a/libs/exec/shell_execv.go b/libs/exec/shell_execv.go
@@ -23,7 +23,7 @@ func shellExecvOpts(content, dir string, env []string) (ExecvOptions, error) {
 
 // Variant of [Execv] that runs the given script through a shell
 func ShellExecv(content, dir string, env []string) error {
-	newOpts, err := shellExecvOpts(content, dir, env)
+	opts, err := shellExecvOpts(content, dir, env)
 	if err != nil {
 		return err
 	}
@@ -38,5 +38,5 @@ func ShellExecv(content, dir string, env []string) error {
 	//
 	// For windows the temp files are not automatically cleaned up. Automatic cleanup
 	// is a opt-in behavior.
-	return Execv(newOpts)
+	return Execv(opts)
 }

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+\n\n\n should not see new lines`
	`2`	`+multiline scripts should work`
	`3`	`+[TEST_TMP_DIR]`