fix: Do not allow 'add', 'remove', 'upgrade' in local mode

Script prints (somewhat verbose) message

Author: hyperupcall

README.md

@@ -38,7 +38,7 @@ See [Installation](./docs/installation.md) and [Getting Started](./docs/getting-
 - Local and user-wide package installation
 - Configure (optionally) exactly which directories are used for completions, binaries, or man pages
 - Works with essentially all popular Bash projects out of the box
-- 250+ Tests
+- 260+ Tests
 
 ## Alternatives Comparison
 

pkg/lib/commands/do-add.sh

@@ -32,17 +32,21 @@ do-add() {
 		esac
 	done
 
+	if [ "$flag_all" = yes ] && (( ${#pkgs[@]} > 0 )); then
+		die "No packages may be supplied when using '--all'"
+	fi
+
+	if [ "$BPM_IS_LOCAL" = yes ] && (( ${#pkgs[@]} > 0 )); then
+		die "Cannot specify individual packages for subcommand 'add' in local projects. Please edit your 'bpm.toml' and use either 'add --all' or 'remove --all'"
+	fi
+
 	if [[ "$BPM_IS_LOCAL" == no && "$flag_all" == yes ]]; then
 		die "Cannot pass '--all' without a 'bpm.toml' file"
 	fi
 
 	if [ "$flag_all" = yes ]; then
 		local bpm_toml_file="$BPM_ROOT/bpm.toml"
 
-		if (( ${#pkgs[@]} > 0 )); then
-			die "No packages may be supplied when using '--all'"
-		fi
-
 		if util.get_toml_array "$bpm_toml_file" 'dependencies'; then
 			log.info "Adding all dependencies"
 
@@ -58,11 +62,11 @@ do-add() {
 
 	if (( ${#pkgs[@]} == 0 )); then
 		die "At least one package must be supplied"
+	else
+		for repoSpec in "${pkgs[@]}"; do
+			do-actual-add "$repoSpec" "$flag_ssh" "$flag_branch"
+		done
 	fi
-
-	for repoSpec in "${pkgs[@]}"; do
-		do-actual-add "$repoSpec" "$flag_ssh" "$flag_branch"
-	done
 }
 
 do-actual-add() {
@@ -100,23 +104,4 @@ do-actual-add() {
 	do-plumbing-link-bins "$site/$package"
 	do-plumbing-link-completions "$site/$package"
 	do-plumbing-link-man "$site/$package"
-
-	# Install transitive dependencies
-	local subDep="$BPM_PACKAGES_PATH/$site/$package"
-
-	if [[ ! -d "$subDep" && -n "${BPM_MODE_TEST+x}" ]]; then
-		# During some tests, plumbing-* or Git commands may be stubbed,
-		# so the package may not actually be cloned
-		return
-	fi
-
-	local oldWd="$PWD"
-	ensure.cd "$subDep"
-	local bpm_toml_file="$subDep/bpm.toml"
-	if [ -f "$bpm_toml_file" ]; then
-		if util.get_toml_array "$bpm_toml_file" 'dependencies'; then
-			do-add --all
-		fi
-	fi
-	ensure.cd "$oldWd"
 }

pkg/lib/commands/do-plumbing-add-deps.sh

@@ -16,6 +16,14 @@ do-plumbing-add-deps() {
 	local bpm_toml_file="$BPM_PACKAGES_PATH/$id/bpm.toml"
 	local package_sh_file="$BPM_PACKAGES_PATH/$id/package.sh"
 
+	# Install transitive dependencies
+	local subDep="$BPM_PACKAGES_PATH/$id"
+	if [[ ! -d "$subDep" && -n "${BPM_MODE_TEST+x}" ]]; then
+		# During some tests, plumbing-* or Git commands may be stubbed,
+		# so the package may not actually be cloned
+		return
+	fi
+
 	if [ -f "$bpm_toml_file" ]; then
 		if util.get_toml_array "$bpm_toml_file" 'dependencies'; then
 			deps=("${REPLIES[@]}")
@@ -31,6 +39,13 @@ do-plumbing-add-deps() {
 	fi
 
 	for dep in "${deps[@]}"; do
-		do-add "$dep"
+		local oldWd="$PWD"
+		ensure.cd "$subDep"
+		util.setup_mode
+
+		do-actual-add "$dep"
+
+		ensure.cd "$oldWd"
+		util.setup_mode
 	done
 }

pkg/lib/commands/do-remove.sh

@@ -24,17 +24,21 @@ do-remove() {
 		esac
 	done
 
+	if [ "$flag_all" = yes ] && (( ${#pkgs[@]} > 0 )); then
+		die "No packages may be supplied when using '--all'"
+	fi
+
+	if [ "$BPM_IS_LOCAL" = yes ] && (( ${#pkgs[@]} > 0 )); then
+		die "Cannot specify individual packages for subcommand 'remove' in local projects. Please edit your 'bpm.toml' and use either 'add --all' or 'remove --all'"
+	fi
+
 	if [[ $flag_all == yes && $flag_force == yes ]]; then
 		die "Flags '--all' and '--force' are mutually exclusive"
 	fi
 
 	if [ "$flag_all" = yes ]; then
 		local bpm_toml_file="$BPM_ROOT/bpm.toml"
 
-		if (( ${#pkgs[@]} > 0 )); then
-			die "No packages may be supplied when using '--all'"
-		fi
-
 		if util.get_toml_array "$bpm_toml_file" 'dependencies'; then
 			log.info "Removing all dependencies"
 

pkg/lib/commands/do-upgrade.sh

@@ -24,6 +24,14 @@ do-upgrade() {
 		esac
 	done
 
+	if [ "$flag_all" = yes ] && (( ${#pkgs[@]} > 0 )); then
+		die "No packages may be supplied when using '--all'"
+	fi
+
+	if [ "$BPM_IS_LOCAL" = yes ] && (( ${#pkgs[@]} > 0 )); then
+		die "Cannot specify individual packages for subcommand 'upgrade' in local projects. Please edit your 'bpm.toml' and use either 'add --all' or 'remove --all'"
+	fi
+
 	if [[ $upgrade_bpm == yes && "$flag_all" = yes ]]; then
 		die "Upgrading bpm and using '--all' are mutually exclusive behaviors"
 	fi
@@ -54,10 +62,6 @@ do-upgrade() {
 
 	# TODO: test this
 	if [ "$flag_all" = yes ]; then
-		if (( ${#pkgs[@]} > 0 )); then
-			die "No packages may be supplied when using '--all'"
-		fi
-
 		local bpm_toml_file="$BPM_ROOT/bpm.toml"
 
 		if util.get_toml_array "$bpm_toml_file" 'dependencies'; then

pkg/lib/util/ensure.sh

@@ -36,7 +36,9 @@ ensure.package_exists() {
 	local id="$1"
 
 	if [ ! -d "$BPM_PACKAGES_PATH/$id" ]; then
-		die "Package '$id' does not exist"
+		log.error "Package '$id' does not exist"
+		printf "  --> %s" "'$BPM_PACKAGES_PATH/$id'"
+		exit 1
 	fi
 }
 

pkg/lib/util/util.sh

@@ -273,6 +273,9 @@ util.setup_mode() {
 		if project_root_dir="$(util.get_project_root_dir)"; then
 			# Output to standard error because some subcommands may be scriptable (ex. list)
 			log.info "Operating in context of local bpm.toml" >&2
+			if [ "${BPM_MODE_TEST+x}" ]; then
+				printf "  -> %s\n" "'$project_root_dir'"
+			fi
 
 			BPM_ROOT="$project_root_dir"
 			BPM_PREFIX="$project_root_dir/bpm_packages"

tests/do-add.bats

@@ -333,3 +333,17 @@ load 'util/init.sh'
 	assert [ -d "./bpm_packages/packages/$site/$pkg2" ]
 	assert [ -d "./bpm_packages/packages/$site/$pkg2/.git" ]
 }
+
+@test "fails if in local mode" {
+	local site='github.com'
+	local pkg1='user/project'
+
+	touch 'bpm.toml'
+
+	test_util.create_package "$pkg1"
+
+	BPM_IS_LOCAL='yes' run do-add "$pkg1"
+
+	assert_failure
+	assert_line -p "Cannot specify individual packages for subcommand 'add' in local projects. Please edit your 'bpm.toml' and use either 'add --all' or 'remove --all'"
+}

tests/do-plumbing-add-deps.bats

@@ -23,7 +23,7 @@ load 'util/init.sh'
 	local site='github.com'
 	local pkg='username/package'
 
-	test_util.stub_command 'do-add'
+	test_util.stub_command 'do-actual-add'
 
 	test_util.setup_pkg "$pkg"; {
 		echo 'DEPS=user/dep1:user/dep2' > 'package.sh'
@@ -33,15 +33,15 @@ load 'util/init.sh'
 	run do-plumbing-add-deps "$site/$pkg"
 
 	assert_success
-	assert_line "do-add user/dep1"
-	assert_line "do-add user/dep2"
+	assert_line "do-actual-add user/dep1"
+	assert_line "do-actual-add user/dep2"
 }
 
 @test "on bpm.toml dependencies, installs properly" {
 	local site='github.com'
 	local pkg='username/package'
 
-	test_util.stub_command 'do-add'
+	test_util.stub_command 'do-actual-add'
 
 	test_util.setup_pkg "$pkg"; {
 		echo 'dependencies = [ "user/dep1", "user/dep2" ]' > 'bpm.toml'
@@ -51,15 +51,17 @@ load 'util/init.sh'
 	run do-plumbing-add-deps "$site/$pkg"
 
 	assert_success
-	assert_line "do-add user/dep1"
-	assert_line "do-add user/dep2"
+	assert_line "do-actual-add user/dep1"
+	assert_line "do-actual-add user/dep2"
 }
 
 @test "bpm.toml has presidence over package.sh add deps" {
 	local site='github.com'
 	local pkg='username/package'
 
-	test_util.stub_command do-add
+	touch 'bpm.toml'
+
+	test_util.stub_command 'do-actual-add'
 
 	test_util.setup_pkg "$pkg"; {
 		echo 'DEPS=user/bad_dep' > 'package.sh'
@@ -70,6 +72,6 @@ load 'util/init.sh'
 	run do-plumbing-add-deps "$site/$pkg"
 
 	assert_success
-	refute_line "do-add user/bad_dep"
-	assert_line "do-add user/good_dep"
+	refute_line "do-actual-add user/bad_dep"
+	assert_line "do-actual-add user/good_dep"
 }

tests/do-plumbing-remove-deps.bats

@@ -6,7 +6,7 @@ load 'util/init.sh'
 	local site='github.com'
 	local pkg='username/package'
 
-	test_util.stub_command 'do-add'
+	test_util.stub_command 'do-actual-add'
 
 	test_util.setup_pkg "$pkg"; {
 		echo 'DEPS=user/dep1:user/dep2' > 'package.sh'
@@ -24,7 +24,7 @@ load 'util/init.sh'
 	local site='github.com'
 	local pkg='username/package'
 
-	test_util.stub_command 'do-add'
+	test_util.stub_command 'do-actual-add'
 
 	test_util.setup_pkg "$pkg"; {
 		echo 'dependencies = [ "user/dep1", "user/dep2" ]' > 'bpm.toml'