147 lines
3.7 KiB
Go
147 lines
3.7 KiB
Go
// Copyright The OpenTelemetry Authors
|
|
// SPDX-License-Identifier: Apache-2.0
|
|
|
|
package componenttest
|
|
|
|
import (
|
|
"io"
|
|
"testing"
|
|
|
|
"github.com/stretchr/testify/assert"
|
|
"github.com/stretchr/testify/require"
|
|
)
|
|
|
|
func TestCheckConfigStructPointerAndValue(t *testing.T) {
|
|
config := struct {
|
|
SomeFiled string `mapstructure:"test"`
|
|
}{}
|
|
assert.NoError(t, CheckConfigStruct(config))
|
|
assert.NoError(t, CheckConfigStruct(&config))
|
|
}
|
|
|
|
func TestCheckConfigStruct(t *testing.T) {
|
|
type BadConfigTag struct {
|
|
BadTagField int `mapstructure:"test-dash"`
|
|
}
|
|
|
|
tests := []struct {
|
|
name string
|
|
config any
|
|
wantErrMsgSubStr string
|
|
}{
|
|
{
|
|
name: "typical_config",
|
|
config: struct {
|
|
MyPublicString string `mapstructure:"string"`
|
|
}{},
|
|
},
|
|
{
|
|
name: "private_fields_ignored",
|
|
config: struct {
|
|
// A public type with proper tag.
|
|
MyPublicString string `mapstructure:"string"`
|
|
// A public type with proper tag.
|
|
MyPublicInt string `mapstructure:"int"`
|
|
// A public type that should be ignored.
|
|
MyFunc func() error
|
|
// A public type that should be ignored.
|
|
Reader io.Reader
|
|
// private type not tagged.
|
|
myPrivateString string
|
|
_someInt int
|
|
}{},
|
|
},
|
|
{
|
|
name: "not_struct_nor_pointer",
|
|
config: func(x int) int {
|
|
return x * x
|
|
},
|
|
wantErrMsgSubStr: "config must be a struct or a pointer to one, the passed object is a func",
|
|
},
|
|
{
|
|
name: "squash_on_non_struct",
|
|
config: struct {
|
|
MyInt int `mapstructure:",squash"`
|
|
}{},
|
|
wantErrMsgSubStr: "attempt to squash non-struct type on field \"MyInt\"",
|
|
},
|
|
{
|
|
name: "invalid_tag_detected",
|
|
config: BadConfigTag{},
|
|
wantErrMsgSubStr: "field \"BadTagField\" has config tag \"test-dash\" which doesn't satisfy",
|
|
},
|
|
{
|
|
name: "public_field_must_have_tag",
|
|
config: struct {
|
|
PublicFieldWithoutMapstructureTag string
|
|
}{},
|
|
wantErrMsgSubStr: "mapstructure tag not present on field \"PublicFieldWithoutMapstructureTag\"",
|
|
},
|
|
{
|
|
name: "invalid_map_item",
|
|
config: struct {
|
|
Map map[string]BadConfigTag `mapstructure:"test_map"`
|
|
}{},
|
|
wantErrMsgSubStr: "field \"BadTagField\" has config tag \"test-dash\" which doesn't satisfy",
|
|
},
|
|
{
|
|
name: "invalid_slice_item",
|
|
config: struct {
|
|
Slice []BadConfigTag `mapstructure:"test_slice"`
|
|
}{},
|
|
wantErrMsgSubStr: "field \"BadTagField\" has config tag \"test-dash\" which doesn't satisfy",
|
|
},
|
|
{
|
|
name: "invalid_array_item",
|
|
config: struct {
|
|
Array [2]BadConfigTag `mapstructure:"test_array"`
|
|
}{},
|
|
wantErrMsgSubStr: "field \"BadTagField\" has config tag \"test-dash\" which doesn't satisfy",
|
|
},
|
|
{
|
|
name: "invalid_map_item_ptr",
|
|
config: struct {
|
|
Map map[string]*BadConfigTag `mapstructure:"test_map"`
|
|
}{},
|
|
wantErrMsgSubStr: "field \"BadTagField\" has config tag \"test-dash\" which doesn't satisfy",
|
|
},
|
|
{
|
|
name: "invalid_slice_item_ptr",
|
|
config: struct {
|
|
Slice []*BadConfigTag `mapstructure:"test_slice"`
|
|
}{},
|
|
wantErrMsgSubStr: "field \"BadTagField\" has config tag \"test-dash\" which doesn't satisfy",
|
|
},
|
|
{
|
|
name: "invalid_array_item_ptr",
|
|
config: struct {
|
|
Array [2]*BadConfigTag `mapstructure:"test_array"`
|
|
}{},
|
|
wantErrMsgSubStr: "field \"BadTagField\" has config tag \"test-dash\" which doesn't satisfy",
|
|
},
|
|
{
|
|
name: "valid_map_item",
|
|
config: struct {
|
|
Map map[string]int `mapstructure:"test_map"`
|
|
}{},
|
|
},
|
|
{
|
|
name: "valid_slice_item",
|
|
config: struct {
|
|
Slice []string `mapstructure:"test_slice"`
|
|
}{},
|
|
},
|
|
}
|
|
|
|
for _, tt := range tests {
|
|
t.Run(tt.name, func(t *testing.T) {
|
|
err := CheckConfigStruct(tt.config)
|
|
if tt.wantErrMsgSubStr == "" {
|
|
assert.NoError(t, err)
|
|
} else {
|
|
require.ErrorContains(t, err, tt.wantErrMsgSubStr)
|
|
}
|
|
})
|
|
}
|
|
}
|