Add various Map key and value validators

helper/validation/map.go

@@ -0,0 +1,155 @@
+package validation
+
+import (
+	"fmt"
+	"regexp"
+	"sort"
+
+	"github.com/hashicorp/go-cty/cty"
+	"github.com/hashicorp/terraform-plugin-sdk/v2/diag"
+	"github.com/hashicorp/terraform-plugin-sdk/v2/helper/schema"
+)
+
+// MapKeyLenBetween returns a SchemaValidateDiagFunc which tests if the provided value
+// is of type map and the length of all keys are between min and max (inclusive)
+func MapKeyLenBetween(min, max int) schema.SchemaValidateDiagFunc {
+	return func(v interface{}, path cty.Path) diag.Diagnostics {
+		var diags diag.Diagnostics
+
+		for _, key := range sortedKeys(v.(map[string]interface{})) {
+			len := len(key)
+			if len < min || len > max {
+				diags = append(diags, diag.Diagnostic{
+					Severity:      diag.Error,
+					Summary:       "Bad map key length",
+					Detail:        fmt.Sprintf("Map key lengths should be in the range (%d - %d): %s (length = %d)", min, max, key, len),
+					AttributePath: append(path, cty.IndexStep{Key: cty.StringVal(key)}),
+				})
+			}
+		}
+
+		return diags
+	}
+}
+
+// MapValueLenBetween returns a SchemaValidateDiagFunc which tests if the provided value
+// is of type map and the length of all values are between min and max (inclusive)
+func MapValueLenBetween(min, max int) schema.SchemaValidateDiagFunc {
+	return func(v interface{}, path cty.Path) diag.Diagnostics {
+		var diags diag.Diagnostics
+
+		m := v.(map[string]interface{})
+
+		for _, key := range sortedKeys(m) {
+			val := m[key]
+
+			if _, ok := val.(string); !ok {
+				diags = append(diags, diag.Diagnostic{
+					Severity:      diag.Error,
+					Summary:       "Bad map value type",
+					Detail:        fmt.Sprintf("Map values should be strings: %s => %v (type = %T)", key, val, val),
+					AttributePath: append(path, cty.IndexStep{Key: cty.StringVal(key)}),
+				})
+				continue
+			}
+
+			len := len(val.(string))
+			if len < min || len > max {
+				diags = append(diags, diag.Diagnostic{
+					Severity:      diag.Error,
+					Summary:       "Bad map value length",
+					Detail:        fmt.Sprintf("Map value lengths should be in the range (%d - %d): %s => %v (length = %d)", min, max, key, val, len),
+					AttributePath: append(path, cty.IndexStep{Key: cty.StringVal(key)}),
+				})
+			}
+		}
+
+		return diags
+	}
+}
+
+// MapKeyMatch returns a SchemaValidateDiagFunc which tests if the provided value
+// is of type map and all keys match a given regexp. Optionally an error message
+// can be provided to return something friendlier than "expected to match some globby regexp".
+func MapKeyMatch(r *regexp.Regexp, message string) schema.SchemaValidateDiagFunc {
+	return func(v interface{}, path cty.Path) diag.Diagnostics {
+		var diags diag.Diagnostics
+
+		for _, key := range sortedKeys(v.(map[string]interface{})) {
+			if ok := r.MatchString(key); !ok {
+				var detail string
+				if message == "" {
+					detail = fmt.Sprintf("Map key expected to match regular expression %q: %s", r, key)
+				} else {
+					detail = fmt.Sprintf("%s: %s", message, key)
+				}
+
+				diags = append(diags, diag.Diagnostic{
+					Severity:      diag.Error,
+					Summary:       "Invalid map key",
+					Detail:        detail,
+					AttributePath: append(path, cty.IndexStep{Key: cty.StringVal(key)}),
+				})
+			}
+		}
+
+		return diags
+	}
+}
+
+// MapValueMatch returns a SchemaValidateDiagFunc which tests if the provided value
+// is of type map and all values match a given regexp. Optionally an error message
+// can be provided to return something friendlier than "expected to match some globby regexp".
+func MapValueMatch(r *regexp.Regexp, message string) schema.SchemaValidateDiagFunc {
+	return func(v interface{}, path cty.Path) diag.Diagnostics {
+		var diags diag.Diagnostics
+
+		m := v.(map[string]interface{})
+
+		for _, key := range sortedKeys(m) {
+			val := m[key]
+
+			if _, ok := val.(string); !ok {
+				diags = append(diags, diag.Diagnostic{
+					Severity:      diag.Error,
+					Summary:       "Bad map value type",
+					Detail:        fmt.Sprintf("Map values should be strings: %s => %v (type = %T)", key, val, val),
+					AttributePath: append(path, cty.IndexStep{Key: cty.StringVal(key)}),
+				})
+				continue
+			}
+
+			if ok := r.MatchString(val.(string)); !ok {
+				var detail string
+				if message == "" {
+					detail = fmt.Sprintf("Map value expected to match regular expression %q: %s => %v", r, key, val)
+				} else {
+					detail = fmt.Sprintf("%s: %s => %v", message, key, val)
+				}
+
+				diags = append(diags, diag.Diagnostic{
+					Severity:      diag.Error,
+					Summary:       "Invalid map value",
+					Detail:        detail,
+					AttributePath: append(path, cty.IndexStep{Key: cty.StringVal(key)}),
+				})
+			}
+		}
+
+		return diags
+	}
+}
+
+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
+}