Skip to content

Commit

Permalink
Fix for #24
Browse files Browse the repository at this point in the history
  • Loading branch information
@creasty
creasty committed Aug 27, 2021
1 parent b261feb commit fe456c4
Show file tree
Hide file tree
Showing 2 changed files with 67 additions and 58 deletions.
7 changes: 3 additions & 4 deletions defaults.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -59,9 +59,8 @@ func setField(field reflect.Value, defaultVal string) error {
return nil
}

defaultValueSet := false
if isInitialValue(field) {
defaultValueSet = true
isInitial := isInitialValue(field)
if isInitial {
switch field.Kind() {
case reflect.Bool:
if val, err := strconv.ParseBool(defaultVal); err == nil {
Expand Down Expand Up @@ -155,7 +154,7 @@ func setField(field reflect.Value, defaultVal string) error {

switch field.Kind() {
case reflect.Ptr:
if defaultValueSet || field.Elem().Kind() == reflect.Struct {
if isInitial || field.Elem().Kind() == reflect.Struct {
setField(field.Elem(), defaultVal)
callSetter(field.Interface())
}
Expand Down
118 changes: 64 additions & 54 deletions defaults_test.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -44,12 +44,10 @@ type Sample struct {
Float64 float64 `default:"1.64"`
BoolTrue bool `default:"true"`
BoolFalse bool `default:"false"`
BoolPtr *bool `default:"true"`
String string `default:"hello"`
Duration time.Duration `default:"10s"`

IntOct int `default:"0o1"`
IntOctPtr *int `default:"0o1"`
Int8Oct int8 `default:"0o10"`
Int16Oct int16 `default:"0o20"`
Int32Oct int32 `default:"0o40"`
Expand Down Expand Up @@ -82,10 +80,18 @@ type Sample struct {
Uint32Bin uint32 `default:"0b100000"`
Uint64Bin uint64 `default:"0b1000000"`

Struct Struct `default:"{}"`
StructPtr *Struct `default:"{}"`
Map map[string]int `default:"{}"`
Slice []string `default:"[]"`
Struct Struct `default:"{}"`
Map map[string]int `default:"{}"`
Slice []string `default:"[]"`

IntPtr *int `default:"1"`
UintPtr *uint `default:"1"`
Float32Ptr *float32 `default:"1"`
BoolPtr *bool `default:"true"`
StringPtr *string `default:"hello"`
StructPtr *Struct `default:"{}"`
MapPtr *map[string]int `default:"{}"`
SlicePtr *[]string `default:"[]"`

MyInt MyInt `default:"1"`
MyInt8 MyInt8 `default:"8"`
Expand Down Expand Up @@ -116,11 +122,11 @@ type Sample struct {
NoDefault *string `default:"-"`
NoDefaultStruct Struct `default:"-"`

MapWithNoTag map[string]int
SliceWithNoTag []string
StructPtrWithNoTag *Struct
StructWithNoTag Struct
DeepSliceOfStructsWithNoTag [][][]Struct
MapWithNoTag map[string]int
SliceWithNoTag []string
StructPtrWithNoTag *Struct
StructWithNoTag Struct
DeepSliceOfStructWithNoTag [][][]Struct

NonInitialString string `default:"foo"`
NonInitialSlice []int `default:"[123]"`
Expand All @@ -129,7 +135,7 @@ type Sample struct {
}

type Struct struct {
Emmbeded `default:"{}"`
Embedded `default:"{}"`

Foo int
Bar int
Expand All @@ -140,7 +146,7 @@ func (s *Struct) SetDefaults() {
s.Bar = 456
}

type Emmbeded struct {
type Embedded struct {
Int int `default:"1"`
}

Expand All @@ -153,11 +159,11 @@ func TestMustSet(t *testing.T) {
}
}()
sample := &Sample{
NonInitialString: "string",
NonInitialSlice: []int{1, 2, 3},
NonInitialStruct: Struct{Foo: 123},
NonInitialStructPtr: &Struct{Foo: 123},
DeepSliceOfStructsWithNoTag: [][][]Struct{{{{Foo: 123}}}},
NonInitialString: "string",
NonInitialSlice: []int{1, 2, 3},
NonInitialStruct: Struct{Foo: 123},
NonInitialStructPtr: &Struct{Foo: 123},
DeepSliceOfStructWithNoTag: [][][]Struct{{{{Foo: 123}}}},
}
MustSet(sample)
})
Expand All @@ -179,11 +185,11 @@ func TestMustSet(t *testing.T) {
}
}()
sample := Sample{
NonInitialString: "string",
NonInitialSlice: []int{1, 2, 3},
NonInitialStruct: Struct{Foo: 123},
NonInitialStructPtr: &Struct{Foo: 123},
DeepSliceOfStructsWithNoTag: [][][]Struct{{{{Foo: 123}}}},
NonInitialString: "string",
NonInitialSlice: []int{1, 2, 3},
NonInitialStruct: Struct{Foo: 123},
NonInitialStructPtr: &Struct{Foo: 123},
DeepSliceOfStructWithNoTag: [][][]Struct{{{{Foo: 123}}}},
}
MustSet(sample)
})
Expand All @@ -192,11 +198,11 @@ func TestMustSet(t *testing.T) {

func TestInit(t *testing.T) {
sample := &Sample{
NonInitialString: "string",
NonInitialSlice: []int{1, 2, 3},
NonInitialStruct: Struct{Foo: 123},
NonInitialStructPtr: &Struct{Foo: 123},
DeepSliceOfStructsWithNoTag: [][][]Struct{{{{Foo: 123}}}},
NonInitialString: "string",
NonInitialSlice: []int{1, 2, 3},
NonInitialStruct: Struct{Foo: 123},
NonInitialStructPtr: &Struct{Foo: 123},
DeepSliceOfStructWithNoTag: [][][]Struct{{{{Foo: 123}}}},
}

if err := Set(sample); err != nil {
Expand All @@ -214,7 +220,7 @@ func TestInit(t *testing.T) {

Set(&fixture.Sample{}) // should not panic

t.Run("scalar types", func(t *testing.T) {
t.Run("primitive types", func(t *testing.T) {
if sample.Int != 1 {
t.Errorf("it should initialize int")
}
Expand Down Expand Up @@ -270,9 +276,6 @@ func TestInit(t *testing.T) {
if sample.IntOct != 0o1 {
t.Errorf("it should initialize int with octal literal")
}
if *sample.IntOctPtr != 0o1 {
t.Errorf("it should initialize int with octal literal")
}
if sample.Int8Oct != 0o10 {
t.Errorf("it should initialize int8 with octal literal")
}
Expand Down Expand Up @@ -362,7 +365,6 @@ func TestInit(t *testing.T) {
if sample.Uint64Bin != 0b1000000 {
t.Errorf("it should initialize uint64 with binary literal")
}

})

t.Run("complex types", func(t *testing.T) {
Expand All @@ -377,6 +379,30 @@ func TestInit(t *testing.T) {
}
})

t.Run("pointer types", func(t *testing.T) {
if sample.IntPtr == nil || *sample.IntPtr != 1 {
t.Errorf("it should initialize int pointer")
}
if sample.UintPtr == nil || *sample.UintPtr != 1 {
t.Errorf("it should initialize uint pointer")
}
if sample.Float32Ptr == nil || *sample.Float32Ptr != 1 {
t.Errorf("it should initialize float32 pointer")
}
if sample.BoolPtr == nil || *sample.BoolPtr != true {
t.Errorf("it should initialize bool pointer")
}
if sample.StringPtr == nil || *sample.StringPtr != "hello" {
t.Errorf("it should initialize string pointer")
}
if sample.MapPtr == nil {
t.Errorf("it should initialize map ptr")
}
if sample.SlicePtr == nil {
t.Errorf("it should initialize slice ptr")
}
})

t.Run("aliased types", func(t *testing.T) {
if sample.MyInt != 1 {
t.Errorf("it should initialize int")
Expand Down Expand Up @@ -442,8 +468,8 @@ func TestInit(t *testing.T) {
if sample.StructPtr == nil || sample.StructPtr.WithDefault != "foo" {
t.Errorf("it should set default on inner field in struct pointer")
}
if sample.Struct.Emmbeded.Int != 1 {
t.Errorf("it should set default on an emmbeded struct")
if sample.Struct.Embedded.Int != 1 {
t.Errorf("it should set default on an Embedded struct")
}
})

Expand Down Expand Up @@ -508,10 +534,10 @@ func TestInit(t *testing.T) {
if !reflect.DeepEqual(sample.NonInitialSlice, []int{1, 2, 3}) {
t.Errorf("it should not override non-initial value")
}
if !reflect.DeepEqual(sample.NonInitialStruct, Struct{Emmbeded: Emmbeded{Int: 1}, Foo: 123, Bar: 456, WithDefault: "foo"}) {
if !reflect.DeepEqual(sample.NonInitialStruct, Struct{Embedded: Embedded{Int: 1}, Foo: 123, Bar: 456, WithDefault: "foo"}) {
t.Errorf("it should not override non-initial value but set defaults for fields")
}
if !reflect.DeepEqual(sample.NonInitialStructPtr, &Struct{Emmbeded: Emmbeded{Int: 1}, Foo: 123, Bar: 456, WithDefault: "foo"}) {
if !reflect.DeepEqual(sample.NonInitialStructPtr, &Struct{Embedded: Embedded{Int: 1}, Foo: 123, Bar: 456, WithDefault: "foo"}) {
t.Errorf("it should not override non-initial value but set defaults for fields")
}
})
Expand All @@ -529,7 +555,7 @@ func TestInit(t *testing.T) {
if sample.StructWithNoTag.WithDefault != "foo" {
t.Errorf("it should automatically recurse into a struct even without a tag")
}
if !reflect.DeepEqual(sample.DeepSliceOfStructsWithNoTag, [][][]Struct{{{{Emmbeded: Emmbeded{Int: 1}, Foo: 123, Bar: 456, WithDefault: "foo"}}}}) {
if !reflect.DeepEqual(sample.DeepSliceOfStructWithNoTag, [][][]Struct{{{{Embedded: Embedded{Int: 1}, Foo: 123, Bar: 456, WithDefault: "foo"}}}}) {
t.Errorf("it should automatically recurse into a slice of structs even without a tag")
}
})
Expand Down Expand Up @@ -588,22 +614,6 @@ func TestPointerStructMember(t *testing.T) {
}
}

func TestPointerNonStructMember(t *testing.T) {
falseVal := false
intVal := 10
m := Sample{
IntOctPtr: &intVal,
BoolPtr: &falseVal,
}
MustSet(&m)
if *m.BoolPtr != false {
t.Errorf("BoolPtr with valid value should not be modified by Set")
}
if *m.IntOctPtr != 10 {
t.Errorf("IntOctPtr with valid value should not be modified by Set")
}
}

type Main struct {
MainInt int `default:"-"`
*Other `default:"{}"`
Expand Down

0 comments on commit fe456c4

Please sign in to comment.