Skip to content

[Metricbeat] Mocked Tests: Do not halt if doc check fails #11780

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
sayden merged 3 commits into from
Apr 15, 2019
Merged

[Metricbeat] Mocked Tests: Do not halt if doc check fails #11780

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
de6c995
Atomic commit
sayden Apr 12, 2019
b1995be
Rebase and update error description
sayden Apr 15, 2019
2aae699
make fmt
sayden Apr 15, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 11 additions & 6 deletions metricbeat/mb/testing/data/data_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -194,7 +194,10 @@ func runTest(t *testing.T, file string, module, metricSetName string, config Con
return h1 < h2
})

checkDocumented(t, data, config.OmitDocumentedFieldsCheck)
if err := checkDocumented(t, data, config.OmitDocumentedFieldsCheck); err != nil {
t.Errorf("'%v' check if fields are documented in `metricbeat/{module}/{metricset}/_meta/fields.yml` "+
"file or run 'make update' on Metricbeat folder to update root `metricbeat/fields.yml` in ", err)
}

// Overwrites the golden files if run with -generate
if *generateFlag {
Expand Down Expand Up @@ -259,15 +262,15 @@ func writeDataJSON(t *testing.T, data common.MapStr, module, metricSet string) {
}

// checkDocumented checks that all fields which show up in the events are documented
func checkDocumented(t *testing.T, data []common.MapStr, omitFields []string) {
func checkDocumented(t *testing.T, data []common.MapStr, omitFields []string) error {
fieldsData, err := asset.GetFields("metricbeat")
if err != nil {
t.Fatal(err)
return err
}

fields, err := mapping.LoadFields(fieldsData)
if err != nil {
t.Fatal(err)
return err
}

documentedFields := fields.GetKeys()
Expand All @@ -280,9 +283,11 @@ func checkDocumented(t *testing.T, data []common.MapStr, omitFields []string) {
for _, d := range data {
flat := d.Flatten()
if err := documentedFieldCheck(flat, keys, omitFields); err != nil {
t.Fatal(err)
return err
}
}

return nil
}

func documentedFieldCheck(foundKeys common.MapStr, knownKeys map[string]interface{}, omitFields []string) error {
Expand All @@ -300,7 +305,7 @@ func documentedFieldCheck(foundKeys common.MapStr, knownKeys map[string]interfac
if _, ok := knownKeys[prefix+".*"]; ok {
continue
}
return errors.Errorf("check if fields are documented error: key missing '%s'", foundKey)
return errors.Errorf("field missing '%s'", foundKey)
}
}

Expand Down