Skip to content
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.

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

[component] Allow calling component.ValidateConfig at the top level #12102

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
25 changes: 25 additions & 0 deletions .chloggen/toplevel-component-validateconfig.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
# Use this changelog template to create an entry for release notes.

# One of 'breaking', 'deprecation', 'new_component', 'enhancement', 'bug_fix'
change_type: enhancement

# The name of the component, or a single word describing the area of concern, (e.g. otlpreceiver)
component: component

# A brief description of the change. Surround your text with quotes ("") if it needs to start with a backtick (`).
note: Allow `component.ValidateConfig` to recurse through all fields in a config object

# One or more tracking issues or pull requests related to the change
issues: [11524]

# (Optional) One or more lines of additional information to render under the primary note.
# These lines will be padded with 2 spaces and then inserted directly into the document.
# Use pipe (|) for multiline entries.
subtext:

# Optional: The change log or logs in which this entry should be included.
# e.g. '[user]' or '[user, api]'
# Include 'user' if the change is relevant to end users.
# Include 'api' if there is a change to a library API.
# Default: '[user]'
change_logs: [api]
2 changes: 1 addition & 1 deletion component/config.go
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ func validate(v reflect.Value) error {
switch v.Kind() {
case reflect.Invalid:
return nil
case reflect.Ptr:
case reflect.Ptr, reflect.Interface:
return validate(v.Elem())
case reflect.Struct:
var errs error
Expand Down
34 changes: 34 additions & 0 deletions component/config_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,10 @@ type configChildTypeDef struct {
ChildPtr *errType
}

type configChildInterface struct {
Child Config
}

type errConfig struct {
err error
}
Expand Down Expand Up @@ -95,6 +99,16 @@ func TestValidateConfig(t *testing.T) {
cfg: newErrType("pointer type"),
expected: errors.New("pointer type"),
},
{
name: "child interface with nil",
cfg: configChildInterface{},
expected: nil,
},
{
name: "pointer to child interface with nil",
cfg: &configChildInterface{},
expected: nil,
},
{
name: "nil",
cfg: nil,
Expand Down Expand Up @@ -125,6 +139,26 @@ func TestValidateConfig(t *testing.T) {
cfg: &configChildStruct{ChildPtr: &errConfig{err: errors.New("child struct pointer")}},
expected: errors.New("child struct pointer"),
},
{
name: "child interface",
cfg: configChildInterface{Child: errConfig{err: errors.New("child interface")}},
expected: errors.New("child interface"),
},
{
name: "pointer to child interface",
cfg: &configChildInterface{Child: errConfig{err: errors.New("pointer to child interface")}},
expected: errors.New("pointer to child interface"),
},
{
name: "child interface with pointer",
cfg: configChildInterface{Child: &errConfig{err: errors.New("child interface with pointer")}},
expected: errors.New("child interface with pointer"),
},
{
name: "pointer to child interface with pointer",
cfg: &configChildInterface{Child: &errConfig{err: errors.New("pointer to child interface with pointer")}},
expected: errors.New("pointer to child interface with pointer"),
},
{
name: "child slice",
cfg: configChildSlice{Child: []errConfig{{}, {err: errors.New("child slice")}}},
Expand Down
Loading