test: Correctly test traverse-get argument validation

Author: hyperupcall

pkg/lib/traverse-get.sh

@@ -12,8 +12,23 @@ bash_object.traverse-get() {
 	local root_object_name="$2"
 	local filter="$3"
 
+	# Ensure correct number of arguments have been passed
 	if (( $# != 3)); then
-		bash_object.util.die 'ERROR_INVALID_ARGS' "Incorrect arguments for subcommand 'get-$final_value_type'"
+		bash_object.util.die 'ERROR_INVALID_ARGS' "Expected '3' arguments, but received '$#'"
+		return
+	fi
+
+	# Ensure parameters are not empty
+	if [ -z "$final_value_type" ]; then
+		bash_object.util.die 'ERROR_INVALID_ARGS' "Positional parameter '1' is empty. Please check passed parameters"
+		return
+	fi
+	if [ -z "$root_object_name" ]; then
+		bash_object.util.die 'ERROR_INVALID_ARGS' "Positional parameter '2' is empty. Please check passed parameters"
+		return
+	fi
+	if [ -z "$filter" ]; then
+		bash_object.util.die 'ERROR_INVALID_ARGS' "Positional parameter '3' is empty. Please check passed parameters"
 		return
 	fi
 

pkg/lib/traverse-set.sh

@@ -7,28 +7,31 @@ bash_object.traverse-set() {
 	fi
 
 	local flag_pass_by_what=''
+	local -a args=()
 
 	for arg; do case "$arg" in
 		--pass-by-ref) flag_pass_by_what='by-ref'; shift ;;
 		--pass-by-value) flag_pass_by_what='by-value'; shift ;;
-		--) break ;;
+		--) shift; break ;;
+		*) args+=("$arg") ;;
 	esac done
 
 	if [ -z "$flag_pass_by_what" ]; then
 		bash_object.util.die 'ERROR_INVALID_ARGS' "Must pass either the '--pass-by-ref' or '--pass-by-value' flag"
 		return
 	fi
 
-	local final_value_type="$1"
-	local root_object_name="$2"
-	local filter="$3"
-	local final_value="$4"
+	local final_value_type="${args[0]}"
+	local root_object_name="${args[1]}"
+	local filter="${args[2]}"
+	local final_value="${args[3]}"
 
-	# We can only check the correct argument number under certain conditions
-	if [ "$flag_pass_by_what" = 'by-ref' ] && (( $# != 4)); then
-		bash_object.util.die 'ERROR_INVALID_ARGS' "Expected '4' arguments, but received '$#'"
+	# Ensure correct number of arguments have been passed. Only do this
+	# for circumstances in which we know the correct argument amount
+	if [ "$flag_pass_by_what" = 'by-ref' ] && (( ${#args[@]} != 4)); then
+		bash_object.util.die 'ERROR_INVALID_ARGS' "Expected '4' arguments, but received '${#args[@]}'"
 		return
-	elif [[ "$flag_pass_by_what" == 'by-value' && "$final_value_type" == 'string' ]] && (( $# != 4 )); then
+	elif [[ "$flag_pass_by_what" == 'by-value' && "$final_value_type" == 'string' ]] && (( ${#args[@]} != 4 )); then
 		bash_object.util.die 'ERROR_INVALID_ARGS' "Expected '4' arguments, but received '$#'"
 		return
 	fi
@@ -54,12 +57,6 @@ bash_object.traverse-set() {
 		return
 	fi
 
-	shift 4
-	# Do not do 'shift 5', since 5 is greater than 4, the minimum amount of valid parameters
-	if [ "$1" = -- ]; then
-		shift
-	fi
-
 	if [ -n "${VERIFY_BASH_OBJECT+x}" ]; then
 		# Ensure the root object exists, and is an associative array
 		local root_object_type=

tests/get-errors.bats

@@ -0,0 +1,54 @@
+#!/usr/bin/env bats
+
+# @file Contains tests that ensure the positional
+# parameters have been validated properly, when possible
+
+load './util/init.sh'
+
+@test "Error with \$# of 1" {
+	run bash_object.traverse-get string
+
+	assert_failure
+	assert_line -p "ERROR_INVALID_ARGS"
+	assert_line -p ", but received '1'"
+}
+
+@test "Error with \$# of 2" {
+	run bash_object.traverse-get string 'OBJECT'
+
+	assert_failure
+	assert_line -p "ERROR_INVALID_ARGS"
+	assert_line -p ", but received '2'"
+}
+
+@test "Error with \$# of 4" {
+	run bash_object.traverse-get string 'OBJECT' '.obj' extraneous
+
+	assert_failure
+	assert_line -p "ERROR_INVALID_ARGS"
+	assert_line -p ", but received '4'"
+}
+
+@test "Error on empty \$1" {
+	run bash_object.traverse-get "" 'OBJECT' '.obj'
+
+	assert_failure
+	assert_line -p "ERROR_INVALID_ARGS"
+	assert_line -p "'1' is empty"
+}
+
+@test "Error on empty \$2" {
+	run bash_object.traverse-get string "" '.obj'
+
+	assert_failure
+	assert_line -p "ERROR_INVALID_ARGS"
+	assert_line -p "'2' is empty"
+}
+
+@test "Error on empty \$3" {
+	run bash_object.traverse-get string 'OBJECT' ""
+
+	assert_failure
+	assert_line -p "ERROR_INVALID_ARGS"
+	assert_line -p "'3' is empty"
+}

tests/set-errors.bats

@@ -1,4 +1,8 @@
 #!/usr/bin/env bats
+
+# @file Contains tests that ensure the positional
+# parameters have been validated properly, when possible
+
 load './util/init.sh'
 
 @test "Error if neither '--pass-by-ref' nor '--pass-by-value' are passed" {