fix: Properly check array/object indexing (closes #10)

How an object or an array is indexed is now checked. If an object is
indexed with a number or an array is indexed with a string, an error is
thrown. Four old tests were modified because the new check caught
indexing errors within them

Author: hyperupcall

pkg/src/traverse-get.sh

@@ -67,6 +67,7 @@ bash_object.traverse-get() {
 	# Start traversing at the root object
 	local current_object_name="$root_object_name"
 	local -n __current_object="$root_object_name"
+	local vmd_dtype=
 
 	# A stack of all the evaluated querytree elements
 	# local -a querytree_stack=()
@@ -92,11 +93,19 @@ bash_object.traverse-get() {
 
 		bash_object.trace_loop
 
+		# If the past vmd_dtype is an array and 'key' is not a number
+		if [[ $vmd_dtype == 'array' && $key == *[!0-9]* ]]; then
+			bash_object.util.die 'ERROR_ARGUMENTS_INCORRECT_TYPE' "Cannot index an array with a non-integer ($key)"
+			return
+		# If the past vmd_dtype is an array and 'key' is a number
+		elif [[ $vmd_dtype == 'object' && $key != *[!0-9]* ]]; then
+			bash_object.util.die 'ERROR_ARGUMENTS_INCORRECT_TYPE' "Cannot index an object with an integer ($key)"
+			return
 		# If 'key' is not a member of object or index of array, error
-		if [ -z "${__current_object[$key]+x}" ]; then
+		elif [ -z "${__current_object[$key]+x}" ]; then
 			bash_object.util.die 'ERROR_NOT_FOUND' "Key or index '$key' (querytree index '$i') does not exist"
 			return
-		# If 'key' is a member of an object or index of array
+		# If 'key' is a valid member of an object or index of array
 		else
 			local key_value="${__current_object[$key]}"
 

pkg/src/traverse-set.sh

@@ -208,6 +208,7 @@ bash_object.traverse-set() {
 	# Start traversing at the root object
 	local current_object_name="$root_object_name"
 	local -n __current_object="$root_object_name"
+	local vmd_dtype=
 
 	# A stack of all the evaluated querytree elements
 	local -a querytree_stack=()
@@ -233,8 +234,16 @@ bash_object.traverse-set() {
 
 		bash_object.trace_loop
 
+		# If the past vmd_dtype is an array and 'key' is not a number
+		if [[ $vmd_dtype == 'array' && $key == *[!0-9]* ]]; then
+			bash_object.util.die 'ERROR_ARGUMENTS_INCORRECT_TYPE' "Cannot index an array with a non-integer ($key)"
+			return
+		# If the past vmd_dtype is an array and 'key' is a number
+		elif [[ $vmd_dtype == 'object' && $key != *[!0-9]* ]]; then
+			bash_object.util.die 'ERROR_ARGUMENTS_INCORRECT_TYPE' "Cannot index an object with an integer ($key)"
+			return
 		# If 'key' is not a member of object or index of array, error
-		if [ -z "${__current_object[$key]+x}" ]; then
+		elif [ -z "${__current_object[$key]+x}" ]; then
 			# If we are before the last element in the query, then error
 			if ((i+1 < ${#REPLIES[@]})); then
 				bash_object.util.die 'ERROR_NOT_FOUND' "Key or index '$key' (querytree index '$i') does not exist"
@@ -293,7 +302,7 @@ bash_object.traverse-set() {
 					return
 				fi
 			fi
-		# If 'key' is already a member of object or index of array
+		# If 'key' is a valid member of an object or index of array
 		else
 			local key_value="${__current_object[$key]}"
 

pkg/src/util/util.sh

@@ -1,14 +1,14 @@
 # shellcheck shell=bash
 
-# shellcheck disable=SC2192
+# shellcheck disable=SC2192,SC2034
 declare -gA ERRORS_BASH_OBJECT=(
 	[ERROR_NOT_FOUND]=
 	[ERROR_INTERNAL]=
 	[ERROR_SELF_REFERENCE]="A virtual object cannot reference itself"
 
 	[ERROR_ARGUMENTS_INVALID]="Wrong number, empty, or missing required arguments to function"
 	[ERROR_ARGUMENTS_INVALID_TYPE]="The type of the final value specified by the user is neither 'object', 'array', nor 'string'"
-	[ERROR_ARGUMENTS_INCORRECT_TYPE]="The type of the final value does not match that of the actual final value (at end of query string)"
+	[ERROR_ARGUMENTS_INCORRECT_TYPE]="The type of the final value does not match that of the actual final value (at end of query string). Or, the type implied by your query string does not match up with the queried object"
 
 	[ERROR_QUERYTREE_INVALID]="The querytree could not be parsed"
 

tests/errors-bad-index.bats

@@ -0,0 +1,49 @@
+#!/usr/bin/env bats
+
+load './util/init.sh'
+
+# object
+@test "Correctly errors when indexing an object with an integer (get)" {
+	declare -A OBJECT=()
+
+	bobject set-object --value 'OBJECT' '.uwu' -- one two three four
+
+	run bobject get-string --value 'OBJECT' '.["uwu"].[3]'
+	assert_failure
+	assert_line -p "ERROR_ARGUMENTS_INCORRECT_TYPE"
+	assert_line -p "Cannot index an object with an integer"
+}
+
+@test "Correctly errors when indexing an object with an integer (set)" {
+	declare -A OBJECT=()
+
+	bobject set-object --value 'OBJECT' '.uwu' -- one two three four
+
+	run bobject set-string --value 'OBJECT' '.["uwu"].[3]' -- value
+	assert_failure
+	assert_line -p "ERROR_ARGUMENTS_INCORRECT_TYPE"
+	assert_line -p "Cannot index an object with an integer"
+}
+
+# array
+@test "Correctly errors when indexing an array with a non-integer (get)" {
+	declare -A OBJECT=()
+
+	bobject set-array --value 'OBJECT' '.uwu' -- one two three
+
+	run bobject get-string --value 'OBJECT' '.["uwu"].["f"]'
+	assert_failure
+	assert_line -p "ERROR_ARGUMENTS_INCORRECT_TYPE"
+	assert_line -p "Cannot index an array with a non-integer"
+}
+
+@test "Correctly errors when indexing an array with a non-integer (set)" {
+	declare -A OBJECT=()
+
+	bobject set-array --value 'OBJECT' '.uwu' -- one two three
+
+	run bobject set-string --value 'OBJECT' '.["uwu"].["f"]' -- value
+	assert_failure
+	assert_line -p "ERROR_ARGUMENTS_INCORRECT_TYPE"
+	assert_line -p "Cannot index an array with a non-integer"
+}

tests/errors-circular-reference.bats

@@ -26,21 +26,21 @@ load './util/init.sh'
 }
 
 @test "get-array stops on circular reference" {
-	declare -a SUB_ARRAY=([nested]=$'\x1C\x1Dtype=array;&SUB_ARRAY')
+	declare -a SUB_ARRAY=($'\x1C\x1Dtype=array;&SUB_ARRAY')
 	declare -A OBJECT=([my_key]=$'\x1C\x1Dtype=array;&SUB_ARRAY')
 
-	run bobject get-array --value OBJECT '.my_key.nested'
+	run bobject get-array --value OBJECT '.["my_key"].[0]'
 
 	assert_failure
 	assert_line -p "ERROR_SELF_REFERENCE"
 	assert_line -p "Virtual object 'SUB_ARRAY' cannot reference itself"
 }
 
 @test "get-array stops on circular reference 2" {
-	declare -a SUB_ARRAY=([nested]=$'\x1C\x1Dtype=array;&SUB_ARRAY')
+	declare -a SUB_ARRAY=($'\x1C\x1Dtype=array;&SUB_ARRAY')
 	declare -A OBJECT=([my_key]=$'\x1C\x1Dtype=array;&SUB_ARRAY')
 
-	run bobject get-array --value OBJECT '.my_key.nested.nested'
+	run bobject get-array --value OBJECT '.["my_key"].[0].[0]'
 
 	assert_failure
 	assert_line -p "ERROR_SELF_REFERENCE"
@@ -73,23 +73,23 @@ load './util/init.sh'
 }
 
 @test "set-array stops on circular reference" {
-	declare -a SUB_ARRAY=([nested]=$'\x1C\x1Dtype=array;&SUB_ARRAY')
+	declare -a SUB_ARRAY=($'\x1C\x1Dtype=array;&SUB_ARRAY')
 	declare -A OBJECT=([my_key]=$'\x1C\x1Dtype=array;&SUB_ARRAY')
 	declare -a arr=()
 
-	run bobject set-array OBJECT --ref '.my_key.nested' arr
+	run bobject set-array OBJECT --ref '.["my_key"].[0]' arr
 
 	assert_failure
 	assert_line -p "ERROR_SELF_REFERENCE"
 	assert_line -p "Virtual object 'SUB_ARRAY' cannot reference itself"
 }
 
 @test "set-array stops on circular reference 2" {
-	declare -a SUB_ARRAY=([nested]=$'\x1C\x1Dtype=array;&SUB_ARRAY')
+	declare -a SUB_ARRAY=($'\x1C\x1Dtype=array;&SUB_ARRAY')
 	declare -A OBJECT=([my_key]=$'\x1C\x1Dtype=array;&SUB_ARRAY')
 	declare -a arr=()
 
-	run bobject set-array OBJECT --ref '.my_key.nested.gone' arr
+	run bobject set-array OBJECT --ref '.["my_key"].[0].[0]' arr
 
 	assert_failure
 	assert_line -p "ERROR_SELF_REFERENCE"