CL-Softwares
/
telegraf
8
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

fix(config): Reword error message about missing config option (#14858)

This commit is contained in:
Joshua Powers 2024-02-20 15:38:28 -05:00 committed by GitHub
parent 8346f36682
commit 2e481081de
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
2 changed files with 37 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
config/config.go
View File

@ -540,7 +540,10 @@ func (c *Config) LoadConfigData(data []byte) error {
} }
if len(c.UnusedFields) > 0 { if len(c.UnusedFields) > 0 {
return fmt.Errorf("line %d: configuration specified the fields %q, but they weren't used", tbl.Line, keys(c.UnusedFields)) return fmt.Errorf(
"line %d: configuration specified the fields %q, but they were not used. "+
"This is either a typo or this config option does not exist in this version.",
tbl.Line, keys(c.UnusedFields))
} }
// Initialize the file-sorting slices // Initialize the file-sorting slices
@ -575,7 +578,9 @@ func (c *Config) LoadConfigData(data []byte) error {
pluginName) pluginName)
} }
if len(c.UnusedFields) > 0 { if len(c.UnusedFields) > 0 {
return fmt.Errorf("plugin %s.%s: line %d: configuration specified the fields %q, but they weren't used", return fmt.Errorf(
"plugin %s.%s: line %d: configuration specified the fields %q, but they were not used. "+
"This is either a typo or this config option does not exist in this version.",
name, pluginName, subTable.Line, keys(c.UnusedFields)) name, pluginName, subTable.Line, keys(c.UnusedFields))
} }
} }
@ -598,7 +603,9 @@ func (c *Config) LoadConfigData(data []byte) error {
pluginName) pluginName)
} }
if len(c.UnusedFields) > 0 { if len(c.UnusedFields) > 0 {
return fmt.Errorf("plugin %s.%s: line %d: configuration specified the fields %q, but they weren't used", return fmt.Errorf(
"plugin %s.%s: line %d: configuration specified the fields %q, but they were not used. "+
"This is either a typo or this config option does not exist in this version.",
name, pluginName, subTable.Line, keys(c.UnusedFields)) name, pluginName, subTable.Line, keys(c.UnusedFields))
} }
} }
@ -617,7 +624,8 @@ func (c *Config) LoadConfigData(data []byte) error {
} }
if len(c.UnusedFields) > 0 { if len(c.UnusedFields) > 0 {
return fmt.Errorf( return fmt.Errorf(
"plugin %s.%s: line %d: configuration specified the fields %q, but they weren't used", "plugin %s.%s: line %d: configuration specified the fields %q, but they were not used. "+
"This is either a typo or this config option does not exist in this version.",
name, name,
pluginName, pluginName,
subTable.Line, subTable.Line,
@ -639,7 +647,9 @@ func (c *Config) LoadConfigData(data []byte) error {
pluginName) pluginName)
} }
if len(c.UnusedFields) > 0 { if len(c.UnusedFields) > 0 {
return fmt.Errorf("plugin %s.%s: line %d: configuration specified the fields %q, but they weren't used", return fmt.Errorf(
"plugin %s.%s: line %d: configuration specified the fields %q, but they were not used. "+
"This is either a typo or this config option does not exist in this version.",
name, pluginName, subTable.Line, keys(c.UnusedFields)) name, pluginName, subTable.Line, keys(c.UnusedFields))
} }
} }
@ -656,7 +666,8 @@ func (c *Config) LoadConfigData(data []byte) error {
return fmt.Errorf("unsupported config format: %s", pluginName) return fmt.Errorf("unsupported config format: %s", pluginName)
} }
if len(c.UnusedFields) > 0 { if len(c.UnusedFields) > 0 {
msg := "plugin %s.%s: line %d: configuration specified the fields %q, but they weren't used" msg := "plugin %s.%s: line %d: configuration specified the fields %q, but they were not used. " +
"This is either a typo or this config option does not exist in this version."
return fmt.Errorf(msg, name, pluginName, subTable.Line, keys(c.UnusedFields)) return fmt.Errorf(msg, name, pluginName, subTable.Line, keys(c.UnusedFields))
} }
} }

30
config/config_test.go
View File

@ -373,52 +373,62 @@ func TestConfig_FieldNotDefined(t *testing.T) {
{ {
name: "in input plugin without parser", name: "in input plugin without parser",
filename: "./testdata/invalid_field.toml", filename: "./testdata/invalid_field.toml",
expected: `line 1: configuration specified the fields ["not_a_field"], but they weren't used`, expected: "line 1: configuration specified the fields [\"not_a_field\"], but they were not used. " +
"This is either a typo or this config option does not exist in this version.",
}, },
{ {
name: "in input plugin with parser", name: "in input plugin with parser",
filename: "./testdata/invalid_field_with_parser.toml", filename: "./testdata/invalid_field_with_parser.toml",
expected: `line 1: configuration specified the fields ["not_a_field"], but they weren't used`, expected: "line 1: configuration specified the fields [\"not_a_field\"], but they were not used. " +
"This is either a typo or this config option does not exist in this version.",
}, },
{ {
name: "in input plugin with parser func", name: "in input plugin with parser func",
filename: "./testdata/invalid_field_with_parserfunc.toml", filename: "./testdata/invalid_field_with_parserfunc.toml",
expected: `line 1: configuration specified the fields ["not_a_field"], but they weren't used`, expected: "line 1: configuration specified the fields [\"not_a_field\"], but they were not used. " +
"This is either a typo or this config option does not exist in this version.",
}, },
{ {
name: "in parser of input plugin", name: "in parser of input plugin",
filename: "./testdata/invalid_field_in_parser_table.toml", filename: "./testdata/invalid_field_in_parser_table.toml",
expected: `line 1: configuration specified the fields ["not_a_field"], but they weren't used`, expected: "line 1: configuration specified the fields [\"not_a_field\"], but they were not used. " +
"This is either a typo or this config option does not exist in this version.",
}, },
{ {
name: "in parser of input plugin with parser-func", name: "in parser of input plugin with parser-func",
filename: "./testdata/invalid_field_in_parserfunc_table.toml", filename: "./testdata/invalid_field_in_parserfunc_table.toml",
expected: `line 1: configuration specified the fields ["not_a_field"], but they weren't used`, expected: "line 1: configuration specified the fields [\"not_a_field\"], but they were not used. " +
"This is either a typo or this config option does not exist in this version.",
}, },
{ {
name: "in processor plugin without parser", name: "in processor plugin without parser",
filename: "./testdata/invalid_field_processor.toml", filename: "./testdata/invalid_field_processor.toml",
expected: `line 1: configuration specified the fields ["not_a_field"], but they weren't used`, expected: "line 1: configuration specified the fields [\"not_a_field\"], but they were not used. " +
"This is either a typo or this config option does not exist in this version.",
}, },
{ {
name: "in processor plugin with parser", name: "in processor plugin with parser",
filename: "./testdata/invalid_field_processor_with_parser.toml", filename: "./testdata/invalid_field_processor_with_parser.toml",
expected: `line 1: configuration specified the fields ["not_a_field"], but they weren't used`, expected: "line 1: configuration specified the fields [\"not_a_field\"], but they were not used. " +
"This is either a typo or this config option does not exist in this version.",
}, },
{ {
name: "in processor plugin with parser func", name: "in processor plugin with parser func",
filename: "./testdata/invalid_field_processor_with_parserfunc.toml", filename: "./testdata/invalid_field_processor_with_parserfunc.toml",
expected: `line 1: configuration specified the fields ["not_a_field"], but they weren't used`, expected: "line 1: configuration specified the fields [\"not_a_field\"], but they were not used. " +
"This is either a typo or this config option does not exist in this version.",
}, },
{ {
name: "in parser of processor plugin", name: "in parser of processor plugin",
filename: "./testdata/invalid_field_processor_in_parser_table.toml", filename: "./testdata/invalid_field_processor_in_parser_table.toml",
expected: `line 1: configuration specified the fields ["not_a_field"], but they weren't used`, expected: "line 1: configuration specified the fields [\"not_a_field\"], but they were not used. " +
"This is either a typo or this config option does not exist in this version.",
}, },
{ {
name: "in parser of processor plugin with parser-func", name: "in parser of processor plugin with parser-func",
filename: "./testdata/invalid_field_processor_in_parserfunc_table.toml", filename: "./testdata/invalid_field_processor_in_parserfunc_table.toml",
expected: `line 1: configuration specified the fields ["not_a_field"], but they weren't used`, expected: "line 1: configuration specified the fields [\"not_a_field\"], but they were not used. " +
"This is either a typo or this config option does not exist in this version.",
}, },
} }