fix: Improved error handling

Author: hyperupcall

pkg/lib/traverse-get.sh

@@ -1,7 +1,7 @@
 # shellcheck shell=bash
 
 bash_object.traverse-get() {
-	REPLY=
+	unset REPLY
 
 	if [ -n "${TRACE_BASH_OBJECT_TRAVERSE+x}" ]; then
 		stdtrace.log 0 ''
@@ -26,10 +26,17 @@ bash_object.traverse-get() {
 	esac
 	for ((i=0; i<${#REPLIES[@]}; i++)); do
 		local key="${REPLIES[$i]}"
+		local is_index_of_array='no'
+
 		filter_stack+=("$key")
 
 		bash_object.trace_loop
 
+		if [ "${key::1}" = $'\x1C' ]; then
+			key="${key#?}"
+			is_index_of_array='yes'
+		fi
+
 		# If 'key' is not a member of object or index of array, error
 		if [ -z "${current_object["$key"]+x}" ]; then
 			echo "Error: Key '$key' is not in object '$current_object_name'"
@@ -54,9 +61,27 @@ bash_object.traverse-get() {
 				local -n current_object="$current_object_name"
 
 				if ((i+1 < ${#REPLIES[@]})); then
-					# Do nothing, we have already set 'current_object'
+					# TODO: test these internal invalid errors
+					# Do nothing (assuming the type is correct), we have already set 'current_object'
 					# for the next iteration
-					:
+					case "$vmd_dtype" in
+					object)
+						if [ "$is_index_of_array" = yes ]; then
+							bash_object.util.traverse_fail 'ERROR_INTERNAL_INVALID_VOBJ' "Expected object, but reference to array was found"
+							return
+						fi
+						;;
+					array)
+						if [ "$is_index_of_array" = no ]; then
+							bash_object.util.traverse_fail 'ERROR_INTERNAL_INVALID_VOBJ' "Expected array, but reference to object was found"
+							return
+						fi
+						;;
+					*)
+						bash_object.util.traverse_fail 'ERROR_INTERNAL_INVALID_VOBJ' "vmd_dtype: $vmd_dtype"
+						return
+						;;
+					esac
 				elif ((i+1 == ${#REPLIES[@]})); then
 					# We are last element of query, return the object
 					if [ "$final_value_type" = object ]; then
@@ -80,6 +105,7 @@ bash_object.traverse-get() {
 							return
 							;;
 						array)
+							declare -ga REPLY=()
 							local key=
 							for key in "${!current_object[@]}"; do
 								REPLY["$key"]="${current_object["$key"]}"
@@ -136,7 +162,7 @@ bash_object.traverse-get() {
 
 			bash_object.trace_current_object
 			if [ -n "${TRACE_BASH_OBJECT_TRAVERSE+x}" ]; then
-				stdtrace.log 1 "END BLOCK"
+				stdtrace.log 0 "END BLOCK"
 			fi
 		fi
 	done

tests/get-array.bats

@@ -45,3 +45,41 @@ load './util/init.sh'
 	assert_line -p "ERROR_VALUE_INCORRECT_TYPE"
 	assert_line -p 'Queried for array, but found object'
 }
+
+@test "correctly gets array" {
+	declare -a SUB_ARRAY=(omicron pi rho)
+	declare -A OBJECT=([my_key]=$'\x1C\x1Dtype=array;&SUB_ARRAY')
+
+	bash_object.traverse-get array OBJECT '.my_key'
+
+	assert [ ${#REPLY[@]} -eq 3 ]
+	assert [ "${REPLY[0]}" = omicron ]
+	assert [ "${REPLY[1]}" = pi ]
+	assert [ "${REPLY[2]}" = rho ]
+}
+
+@test "correctly gets array in subobject" {
+	declare -a SUB_SUB_ARRAY=(pi rho sigma)
+	declare -A SUB_OBJECT=([subkey]=$'\x1C\x1Dtype=array;&SUB_SUB_ARRAY')
+	declare -A OBJECT=([my_key]=$'\x1C\x1Dtype=object;&SUB_OBJECT')
+
+	bash_object.traverse-get array OBJECT '.my_key.subkey'
+
+	assert [ ${#REPLY[@]} -eq 3 ]
+	assert [ "${REPLY[0]}" = pi ]
+	assert [ "${REPLY[1]}" = rho ]
+	assert [ "${REPLY[2]}" = sigma ]
+}
+
+@test "correctly gets array in subarray" {
+	declare -a SUB_SUB_ARRAY=(omicron pi rho)
+	declare -a SUB_ARRAY=('foo' 'bar' $'\x1C\x1Dtype=array;&SUB_SUB_ARRAY')
+	declare -A OBJECT=([my_key]=$'\x1C\x1Dtype=array;&SUB_ARRAY')
+
+	bash_object.traverse-get array OBJECT '.["my_key"].[2]'
+
+	assert [ ${#REPLY[@]} -eq 3 ]
+	assert [ "${REPLY[0]}" = omicron ]
+	assert [ "${REPLY[1]}" = pi ]
+	assert [ "${REPLY[2]}" = rho ]
+}

tests/get-object.bats

@@ -46,7 +46,7 @@ load './util/init.sh'
 	assert_line -p 'Queried for object, but found array'
 }
 
-# # { "stars": { "cool": "Wolf 359" } }
+# { "stars": { "cool": "Wolf 359" } }
 @test "properly gets 4" {
 	declare -A inner_object=([cool]='Wolf 359')
 	declare -A OBJ=([stars]=$'\x1C\x1Dtype=object;&inner_object')
@@ -55,7 +55,7 @@ load './util/init.sh'
 	assert [ "${REPLY[cool]}" = 'Wolf 359' ]
 }
 
-# # { "stars": { "cool": "Wolf 359" } }
+# { "stars": { "cool": "Wolf 359" } }
 @test "properly gets 5" {
 	declare -a inner_array=('Alpha Centauri A' 'Proxima Centauri')
 	declare -A OBJ=([nearby]=$'\x1C\x1Dtype=object;&inner_array')