Improve alloc tests failure messages (#3173)

This PR improves the messaging when tests fail so it's easier to
troubleshoot failures.

Author: gjcairo

IntegrationTests/test_functions.sh

@@ -19,7 +19,7 @@ function fail() {
 
 function assert_equal() {
     if [[ "$1" != "$2" ]]; then
-        fail "expected '$1', got '$2' ${3-}"
+        fail "expected '$1', got '$2'${3+: }${3-}"
     fi
 }
 
@@ -33,31 +33,38 @@ function assert_equal_files() {
         echo "--- SNIP ($2, size=$(wc "$2"), SHA=$(shasum "$2")) ---"
         cat "$2"
         echo "--- SNAP ($2) ---"
-        fail "file '$1' not equal to '$2'"
+        fail "file '$1' not equal to '$2'${3+: }${3-}"
     fi
 }
 
 function assert_less_than() {
     if [[ ! "$1" -lt "$2" ]]; then
-        fail "assertion '$1' < '$2' failed"
+        fail "assertion '$1' < '$2' failed${3+: }${3-}"
     fi
 }
 
 function assert_less_than_or_equal() {
     if [[ ! "$1" -le "$2" ]]; then
-        fail "assertion '$1' <= '$2' failed"
+        fail "assertion '$1' <= '$2' failed${3+: }${3-}"
     fi
 }
 
 function assert_greater_than() {
     if [[ ! "$1" -gt "$2" ]]; then
-        fail "assertion '$1' > '$2' failed"
+        fail "assertion '$1' > '$2' failed${3+: }${3-}"
     fi
 }
 
 function assert_greater_than_or_equal() {
     if [[ ! "$1" -ge "$2" ]]; then
-        fail "assertion '$1' >= '$2' failed"
+        fail "assertion '$1' >= '$2' failed${3+: }${3-}"
+    fi
+}
+
+function assert_is_number() {
+    re='^[0-9]+$'
+    if ! [[ $1 =~ $re ]]; then
+       fail "$1 is not a number${2+: }${2-}"
     fi
 }
 

IntegrationTests/tests_04_performance/test_01_allocation_counts.sh

@@ -55,14 +55,16 @@ for test in "${all_tests[@]}"; do
         leaked_fds=$(grep "^test_$test_case.leaked_fds:" "$tmp/output" | cut -d: -f2 | sed 's/ //g')
         max_allowed_env_name="MAX_ALLOCS_ALLOWED_$test_case"
         max_allowed=$(jq '.'\""$test_case"\" "$here/Thresholds/$SWIFT_VERSION.json")
+        
+        assert_is_number "$max_allowed" "Malformed or nonexistent ${SWIFT_VERSION}.json thresholds file"
 
         info "$test_case: allocations not freed: $not_freed_allocations"
         info "$test_case: total number of mallocs: $total_allocations"
         info "$test_case: leaked fds: $leaked_fds"
 
-        assert_less_than "$not_freed_allocations" 5     # allow some slack
-        assert_greater_than "$not_freed_allocations" -5 # allow some slack
-        assert_less_than "$leaked_fds" 1  # No slack allowed here though
+        assert_less_than "$not_freed_allocations" 5 "Allocations not freed are greater than expected"     # allow some slack
+        assert_greater_than "$not_freed_allocations" -5 "Allocations not freed are less than expected" # allow some slack
+        assert_less_than "$leaked_fds" 1 "There are leaked file descriptors" # No slack allowed here though
         if [[ -z "${!max_allowed_env_name+x}" ]] && [ -z "${max_allowed}" ]; then
             if [[ -z "${!max_allowed_env_name+x}" ]]; then
                 warn "no reference number of allocations set (set to \$$max_allowed_env_name)"
@@ -74,8 +76,8 @@ for test in "${all_tests[@]}"; do
             if [ -z "${max_allowed}" ]; then
                 max_allowed=${!max_allowed_env_name}
             fi
-            assert_less_than_or_equal "$total_allocations" "$max_allowed"
-            assert_greater_than "$total_allocations" "$(( max_allowed - 1000))"
+            assert_less_than_or_equal "$total_allocations" "$max_allowed" "Total allocations exceed the max allowed"
+            assert_greater_than "$total_allocations" "$(( max_allowed - 1000))" "Total allocations are less than expected"
         fi
     done < <(grep "^test_${test}[^\W]*.total_allocations:" "$tmp/output" | cut -d: -f1 | cut -d. -f1 | sort | uniq)
 done