Repeatable error messages for metric documentation checks (#28034) (#…

…28190)

* Sort all keys before checking them for documentation to make sure missing documentation error messages are produced in a predictable and repeatable order.

This is really helpful when someone is trying to fix multiple issues and wants to make sure a specific issue is fixed before moving one to the next one. Otherwise, the errors are thrown in a random order and every time a new message is presented to the developer making it very confusing if the previous one had been resolved or not.

(cherry picked from commit a07837e)

Co-authored-by: Oleksiy Kovyrin <[email protected]>
Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com>

metricbeat/mb/testing/testdata.go

@@ -344,7 +344,15 @@ func checkDocumented(data []common.MapStr, omitFields []string) error {
 }
 
 func documentedFieldCheck(foundKeys common.MapStr, knownKeys map[string]interface{}, omitFields []string) error {
- for foundKey := range foundKeys {
+ // Sort all found keys to guarantee consistent validation messages
+ sortedFoundKeys := make([]string, 0, len(foundKeys))
+ for k := range foundKeys {
+ sortedFoundKeys = append(sortedFoundKeys, k)
+ }
+ sort.Strings(sortedFoundKeys)
+
+ for k := range sortedFoundKeys {
+ foundKey := sortedFoundKeys[k]
  if _, ok := knownKeys[foundKey]; !ok {
  for _, omitField := range omitFields {
  if omitDocumentedField(foundKey, omitField) {