Sort map keys and return a Diagnostic for all invalid keys.

Author: ewbankkit

helper/validation/map.go

@@ -3,6 +3,7 @@ package validation
 import (
 	"fmt"
 	"regexp"
+	"sort"
 
 	"github.com/hashicorp/go-cty/cty"
 	"github.com/hashicorp/terraform-plugin-sdk/v2/diag"
@@ -15,7 +16,7 @@ func MapKeyLenBetween(min, max int) schema.SchemaValidateDiagFunc {
 	return func(v interface{}, path cty.Path) diag.Diagnostics {
 		var diags diag.Diagnostics
 
-		for key := range v.(map[string]interface{}) {
+		for _, key := range sortedKeys(v.(map[string]interface{})) {
 			len := len(key)
 			if len < min || len > max {
 				diags = append(diags, diag.Diagnostic{
@@ -24,7 +25,6 @@ func MapKeyLenBetween(min, max int) schema.SchemaValidateDiagFunc {
 					Detail:        fmt.Sprintf("Key length should be in the range (%d - %d): %s (length = %d)", min, max, key, len),
 					AttributePath: append(path, cty.IndexStep{Key: cty.StringVal(key)}),
 				})
-				break
 			}
 		}
 
@@ -121,3 +121,17 @@ func MapValueMatch(r *regexp.Regexp, message string) schema.SchemaValidateFunc {
 		return warnings, errors
 	}
 }
+
+func sortedKeys(m map[string]interface{}) []string {
+	keys := make([]string, len(m))
+
+	i := 0
+	for key := range m {
+		keys[i] = key
+		i++
+	}
+
+	sort.Strings(keys)
+
+	return keys
+}

helper/validation/map_test.go

@@ -37,6 +37,23 @@ func TestValidationMapKeyLenBetween(t *testing.T) {
 				},
 			},
 		},
+		"TooLongAndTooShort": {
+			Value: map[string]interface{}{
+				"UVWXYZ": "123456",
+				"ABC":    "123",
+				"U":      "1",
+			},
+			ExpectedDiags: diag.Diagnostics{
+				{
+					Severity:      diag.Error,
+					AttributePath: append(cty.Path{}, cty.IndexStep{Key: cty.StringVal("U")}),
+				},
+				{
+					Severity:      diag.Error,
+					AttributePath: append(cty.Path{}, cty.IndexStep{Key: cty.StringVal("UVWXYZ")}),
+				},
+			},
+		},
 		"AllGood": {
 			Value: map[string]interface{}{
 				"AB":    "12",
@@ -52,17 +69,7 @@ func TestValidationMapKeyLenBetween(t *testing.T) {
 		t.Run(tn, func(t *testing.T) {
 			diags := fn(tc.Value, cty.Path{})
 
-			if len(diags) != len(tc.ExpectedDiags) {
-				t.Fatalf("%s: wrong number of diags, expected %d, got %d", tn, len(tc.ExpectedDiags), len(diags))
-			}
-			for j := range diags {
-				if diags[j].Severity != tc.ExpectedDiags[j].Severity {
-					t.Fatalf("%s: expected severity %v, got %v", tn, tc.ExpectedDiags[j].Severity, diags[j].Severity)
-				}
-				if !diags[j].AttributePath.Equals(tc.ExpectedDiags[j].AttributePath) {
-					t.Fatalf("%s: attribute paths do not match expected: %v, got %v", tn, tc.ExpectedDiags[j].AttributePath, diags[j].AttributePath)
-				}
-			}
+			checkDiagnostics(t, tn, diags, tc.ExpectedDiags)
 		})
 	}
 }
@@ -207,3 +214,17 @@ func TestValidationValueKeyMatch(t *testing.T) {
 		})
 	}
 }
+
+func checkDiagnostics(t *testing.T, tn string, got, expected diag.Diagnostics) {
+	if len(got) != len(expected) {
+		t.Fatalf("%s: wrong number of diags, expected %d, got %d", tn, len(expected), len(got))
+	}
+	for j := range got {
+		if got[j].Severity != expected[j].Severity {
+			t.Fatalf("%s: expected severity %v, got %v", tn, expected[j].Severity, got[j].Severity)
+		}
+		if !got[j].AttributePath.Equals(expected[j].AttributePath) {
+			t.Fatalf("%s: attribute paths do not match expected: %v, got %v", tn, expected[j].AttributePath, got[j].AttributePath)
+		}
+	}
+}