feat: Print warning/error when package.sh values are unusable

Author: hyperupcall

pkg/lib/util/abstract-bins.sh

@@ -41,7 +41,14 @@ abstract.bins() {
 			IFS=':' read -ra bins <<< "$REPLY"
 
 			for file in "${bins[@]}"; do
-				abstract.bins_do_action "$action" "$BPM_PACKAGES_PATH/$id/$file" "$remove_extensions"
+				local full_path="$BPM_PACKAGES_PATH/$id/$file"
+				if [ -d "$full_path" ]; then
+					die "Specified directory '$file' in package.sh; only files are valid"
+				elif [ ! -f "$full_path" ]; then
+					log.warn "Executable file '$file' not found in repository. Skipping"
+				else
+					abstract.bins_do_action "$action" "$full_path" "$remove_extensions"
+				fi
 			done
 		else
 			abstract.bins_search_heuristics "$action" "$id" "$remove_extensions"

pkg/lib/util/abstract-completions.sh

@@ -38,7 +38,14 @@ abstract.completions() {
 			IFS=':' read -ra bash_completion_files <<< "$REPLY"
 
 			for file in "${bash_completion_files[@]}"; do
-				abstract.completions_do_action_bash "$action" "$BPM_PACKAGES_PATH/$id/$file"
+				local full_path="$BPM_PACKAGES_PATH/$id/$file"
+				if [ -d "$full_path" ]; then
+					die "Specified directory '$file' in package.sh; only files are valid"
+				elif [ ! -f "$full_path" ]; then
+					log.warn "Completion file '$file' not found in repository. Skipping"
+				else
+					abstract.completions_do_action_bash "$action" "$full_path"
+				fi
 			done
 		else
 			abstract.completions_search_heuristics "$action" "$id" 'bash'
@@ -48,7 +55,14 @@ abstract.completions() {
 			IFS=':' read -ra zsh_completion_files <<< "$REPLY"
 
 			for file in "${zsh_completion_files[@]}"; do
-				abstract.completions_do_action_zsh "$action" "$BPM_PACKAGES_PATH/$id/$file"
+				local full_path="$BPM_PACKAGES_PATH/$id/$file"
+				if [ -d "$full_path" ]; then
+					die "Specified directory '$file' in package.sh; only files are valid"
+				elif [ ! -f "$full_path" ]; then
+					log.warn "Completion file '$file' not found in repository. Skipping"
+				else
+					abstract.completions_do_action_zsh "$action" "$full_path"
+				fi
 			done
 		else
 			abstract.completions_search_heuristics "$action" "$id" 'zsh'

tests/do-add.bats

@@ -204,3 +204,6 @@ load 'util/init.sh'
 	assert_success
 	assert_line "do-plumbing-clone https://github.com/username/package.git github.com/username/package"
 }
+
+
+

tests/do-plumbing-link-bins.bats

@@ -300,3 +300,35 @@ load 'util/init.sh'
 	assert [ ! -e "$BPM_PREFIX/bin/package" ]
 	assert [ ! -e "$BPM_PREFIX/bin/package2" ]
 }
+
+@test "fails link bins when specifying directory in package.sh" {
+	local site='github.com'
+	local pkg="username/package"
+
+	test_util.setup_pkg "$pkg"; {
+		echo 'BINS="dir"' > 'package.sh'
+
+		mkdir 'dir'
+		touch 'dir/.gitkeep'
+	}; test_util.finish_pkg
+	test_util.fake_clone "$site/$pkg"
+
+	run do-plumbing-link-bins "$site/$pkg"
+
+	assert_failure
+	assert_line -p "Specified directory 'dir' in package.sh; only files are valid"
+}
+
+@test "warns link bins when specifying non-existent file in package.sh" {
+	local site='github.com'
+	local pkg="username/package"
+
+	test_util.setup_pkg "$pkg"; {
+		echo 'BINS="some_file"' > 'package.sh'
+	}; test_util.finish_pkg
+	test_util.fake_clone "$site/$pkg"
+
+	run do-plumbing-link-bins "$site/$pkg"
+
+	assert_line -p "Executable file 'some_file' not found in repository. Skipping"
+}

tests/do-plumbing-link-completions.bats

@@ -512,3 +512,69 @@ load 'util/init.sh'
 	assert [ "$(readlink "$BPM_INSTALL_COMPLETIONS/bash/prog2.bash")" = "$BPM_PACKAGES_PATH/$site/$pkg/completions/prog2.bash" ]
 	assert [ "$(readlink "$BPM_INSTALL_COMPLETIONS/zsh/compctl/prog.zsh")" = "$BPM_PACKAGES_PATH/$site/$pkg/completions/prog.zsh" ]
 }
+
+@test "fails bash link completions when specifying directory in package.sh" {
+	local site='github.com'
+	local pkg="username/package"
+
+	test_util.setup_pkg "$pkg"; {
+		echo 'BASH_COMPLETIONS="dir"' > 'package.sh'
+
+		mkdir 'dir'
+		touch 'dir/.gitkeep'
+	}; test_util.finish_pkg
+	test_util.fake_clone "$site/$pkg"
+
+	run do-plumbing-link-completions "$site/$pkg"
+
+	assert_failure
+	assert_line -p "Specified directory 'dir' in package.sh; only files are valid"
+}
+
+@test "fails zsh link completions when specifying directory in package.sh" {
+	local site='github.com'
+	local pkg="username/package"
+
+	test_util.setup_pkg "$pkg"; {
+		echo 'ZSH_COMPLETIONS="dir"' > 'package.sh'
+
+		mkdir 'dir'
+		touch 'dir/.gitkeep'
+	}; test_util.finish_pkg
+	test_util.fake_clone "$site/$pkg"
+
+	run do-plumbing-link-completions "$site/$pkg"
+
+	assert_failure
+	assert_line -p "Specified directory 'dir' in package.sh; only files are valid"
+}
+
+
+@test "warns bash link completions when specifying non-existent file in package.sh" {
+	local site='github.com'
+	local pkg="username/package"
+
+	test_util.setup_pkg "$pkg"; {
+		echo 'BASH_COMPLETIONS="some_file"' > 'package.sh'
+	}; test_util.finish_pkg
+	test_util.fake_clone "$site/$pkg"
+
+	run do-plumbing-link-completions "$site/$pkg"
+
+	assert_line -p "Completion file 'some_file' not found in repository. Skipping"
+}
+
+
+@test "warns zsh link completions when specifying non-existent file in package.sh" {
+	local site='github.com'
+	local pkg="username/package"
+
+	test_util.setup_pkg "$pkg"; {
+		echo 'ZSH_COMPLETIONS="some_file"' > 'package.sh'
+	}; test_util.finish_pkg
+	test_util.fake_clone "$site/$pkg"
+
+	run do-plumbing-link-completions "$site/$pkg"
+
+	assert_line -p "Completion file 'some_file' not found in repository. Skipping"
+}