feat: Add '--dry' subcommand to 'bpm-load'

Author: hyperupcall

docs/getting-started.md

@@ -70,7 +70,7 @@ bash: z.sh: command not found
 
 But it doesn't work - this is standard behavior. When looking for binaries, bpm _does_ look at the root directory, but only for shell scripts that are marked as _executable_ (`chmod +x z.sh`)
 
-The authors of `z` did not mark the file as executable because they did not intend for you to execute the file - you are supposed to `source` it. This is why the `package-path` command exists:
+The authors of `z` did not mark the file as executable because they did not intend for you to execute the file - you are supposed to `source` it. This is why the `bpm-load` command exists:
 
 ```sh
 $ bpm --global package-path rupa/z

pkg/lib/cmd/bpm-load.sh

@@ -13,12 +13,18 @@ fi
 # @exitcode 1 Miscellaneous errors
 bpm-load() {
 	local __bpm_flag_global='no'
+	local __bpm_flag_dry='no'
+
 	for arg; do
 		case "$arg" in
 			--global|-g)
 				__bpm_flag_global='yes'
 				shift
 				;;
+			--dry)
+				__bpm_flag_dry='yes'
+				shift
+				;;
 		esac
 	done
 
@@ -88,13 +94,20 @@ bpm-load() {
 			__bpm_bpm_load_restore_options
 			return 3
 		elif [ -e "$__bpm_full_path" ]; then
-			# Ensure the error can be properly handled at the callsite, and not
-			# bail here if errexit is set
-			if ! source "$__bpm_full_path"; then
-				return 2
+			if [ "$__bpm_flag_dry" = yes ]; then
+				printf '%s\n' "bpm-load: Would source file '$__bpm_full_path'"
+				__bpm_bpm_load_restore_options
+				return
+			else
+				# Ensure the error can be properly handled at the callsite, and not
+				# bail here if errexit is set
+				if ! source "$__bpm_full_path"; then
+					__bpm_bpm_load_restore_options
+					return 2
+				fi
 			fi
 		else
-			printf '%s\n' "bpm-load: Error: '$__bpm_full_path' does not exist"
+			printf '%s\n' "bpm-load: Error: File '$__bpm_full_path' does not exist"
 			__bpm_bpm_load_restore_options
 			return 3
 		fi
@@ -107,10 +120,17 @@ bpm-load() {
 			if [ -f "$__bpm_full_path" ]; then
 				__bpm_file_was_sourced='yes'
 
-				# Ensure the error can be properly handled at the callsite, and not
-				# bail here if errexit is set
-				if ! source "$__bpm_full_path"; then
-					return 2
+				if [ "$__bpm_flag_dry" = yes ]; then
+					printf '%s\n' "bpm-load: Would source file '$__bpm_full_path'"
+					__bpm_bpm_load_restore_options
+					return
+				else
+					# Ensure the error can be properly handled at the callsite, and not
+					# bail here if errexit is set
+					if ! source "$__bpm_full_path"; then
+						__bpm_bpm_load_restore_options
+						return 2
+					fi
 				fi
 			fi
 		done

tests/bpm-load.bats

@@ -21,6 +21,46 @@ load 'util/init.sh'
 	assert_output "it works :)"
 }
 
+@test "works without file argument in local mode" {
+	local site='github.com'
+	local pkg="user/project2"
+
+	BPM_REPO_SOURCE="$BPM_TEST_REPO_ROOT/../source"
+	BPM_CELLAR="$BPM_TEST_DIR/cellar"
+
+	test_util.setup_pkg "$pkg"; {
+		echo "printf '%s\n' 'it works :)'" > 'load.bash'
+	}; test_util.finish_pkg
+
+	echo "dependencies = ['file://$BPM_ORIGIN_DIR/$pkg']" > 'bpm.toml'
+	BPM_MODE='local' do-add --all
+
+	source bpm-load
+	BPM_MODE='local' run bpm-load "$pkg"
+
+	assert_success
+	assert_output "it works :)"
+}
+
+@test "works with --dry argument" {
+	local site='github.com'
+	local pkg="user/project2"
+
+	BPM_REPO_SOURCE="$BPM_TEST_REPO_ROOT/../source"
+	BPM_CELLAR="$BPM_TEST_DIR/cellar"
+
+	test_util.setup_pkg "$pkg"; {
+		echo "printf '%s\n' 'it works :)'" > 'load.bash'
+	}; test_util.finish_pkg
+	test_util.mock_add "$pkg"
+
+	source bpm-load
+	run bpm-load --global --dry "$pkg"
+
+	assert_success
+	assert_output -p "bpm-load: Would source file"
+}
+
 @test "works with file argument" {
 	local site='github.com'
 	local pkg="user/project2"