Skip to content

Fix configreader struct nil handling #106

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
merged 2 commits into from
May 24, 2019
Merged

Fix configreader struct nil handling #106

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2c40b85
Fix configreader struct nil handling
deliahu May 24, 2019
1050a53
Add comments to tests
deliahu May 24, 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
57 changes: 32 additions & 25 deletions pkg/lib/configreader/reader.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -79,17 +79,17 @@ type StructFieldValidation struct {
type StructValidation struct {
StructFieldValidations []*StructFieldValidation
Required bool
AllowNull bool
DefualtNil bool // If this struct is nested and it's key is not defined, set it to nil instead of defaults or erroring (e.g. if any subfields are required)
AllowExplicitNull bool
DefaultNil bool // If this struct is nested and its key is not defined, set it to nil instead of defaults or erroring (e.g. if any subfields are required)
ShortCircuit bool
AllowExtraFields bool
}

type StructListValidation struct {
StructValidation *StructValidation
Required bool
AllowNull bool
ShortCircuit bool
StructValidation *StructValidation
Required bool
AllowExplicitNull bool
ShortCircuit bool
}

type InterfaceStructValidation struct {
Expand All @@ -99,7 +99,7 @@ type InterfaceStructValidation struct {
ParsedInterfaceStructTypes map[interface{}]*InterfaceStructType // must specify Parser if using this
Parser func(string) (interface{}, error)
Required bool
AllowNull bool
AllowExplicitNull bool
ShortCircuit bool
AllowExtraFields bool
}
Expand All @@ -112,7 +112,7 @@ type InterfaceStructType struct {
type InterfaceStructListValidation struct {
InterfaceStructValidation *InterfaceStructValidation
Required bool
AllowNull bool
AllowExplicitNull bool
ShortCircuit bool
}

Expand All @@ -122,9 +122,10 @@ func Struct(dest interface{}, inter interface{}, v *StructValidation) []error {
var ok bool

if inter == nil {
if !v.AllowNull {
if !v.AllowExplicitNull {
return []error{ErrorCannotBeNull()}
}
return nil
}

interMap, ok := cast.InterfaceToStrInterfaceMap(inter)
Expand Down Expand Up @@ -271,14 +272,17 @@ func Struct(dest interface{}, inter interface{}, v *StructValidation) []error {
interMapVal, ok := ReadInterfaceMapValue(key, interMap)
if !ok && validation.Required {
err = errors.Wrap(ErrorMustBeDefined(), key)
} else if !ok && validation.DefualtNil {
} else if !ok && validation.DefaultNil {
val = nil
} else {
if !ok {
interMapVal = make(map[string]interface{}) // Distinguish between null and not defined
interMapVal = make(map[string]interface{}) // Here validation.DefaultNil == false, so create an empty map to hold the nested default values
}
val = reflect.New(nestedType.Elem()).Interface()
errs = Struct(val, interMapVal, &validation)
if interMapVal == nil {
val = nil // If the object was nil, set val to nil rather than a pointer to the initialized zero value
}
errs = errors.WrapMultiple(errs, key)
}

Expand Down Expand Up @@ -358,7 +362,7 @@ func Struct(dest interface{}, inter interface{}, v *StructValidation) []error {

func StructList(dest interface{}, inter interface{}, v *StructListValidation) (interface{}, []error) {
if inter == nil {
if !v.AllowNull {
if !v.AllowExplicitNull {
return nil, []error{ErrorCannotBeNull()}
}
return nil, nil
Expand All @@ -380,6 +384,9 @@ func StructList(dest interface{}, inter interface{}, v *StructListValidation) (i
}
continue
}
if interItem == nil {
val = nil // If the object was nil, set val to nil rather than a pointer to the initialized zero value
}
dest = appendVal(dest, val)
}

Expand All @@ -388,7 +395,7 @@ func StructList(dest interface{}, inter interface{}, v *StructListValidation) (i

func InterfaceStruct(inter interface{}, v *InterfaceStructValidation) (interface{}, []error) {
if inter == nil {
if !v.AllowNull {
if !v.AllowExplicitNull {
return nil, []error{ErrorCannotBeNull()}
}
return nil, nil
Expand Down Expand Up @@ -457,7 +464,7 @@ func InterfaceStruct(inter interface{}, v *InterfaceStructValidation) (interface
structValidation := &StructValidation{
StructFieldValidations: append(structType.StructFieldValidations, typeFieldValidation),
Required: v.Required,
AllowNull: v.AllowNull,
AllowExplicitNull: v.AllowExplicitNull,
ShortCircuit: v.ShortCircuit,
AllowExtraFields: v.AllowExtraFields,
}
Expand All @@ -467,7 +474,7 @@ func InterfaceStruct(inter interface{}, v *InterfaceStructValidation) (interface

func InterfaceStructList(dest interface{}, inter interface{}, v *InterfaceStructListValidation) (interface{}, []error) {
if inter == nil {
if !v.AllowNull {
if !v.AllowExplicitNull {
return nil, []error{ErrorCannotBeNull()}
}
return nil, nil
Expand Down Expand Up @@ -595,11 +602,11 @@ func prompt(opts *PromptOptions) string {
prompt := opts.Prompt

if opts.defaultStr != "" {
defualtStr := opts.defaultStr
defaultStr := opts.defaultStr
if opts.MaskDefault {
defualtStr = s.MaskString(defualtStr, 4)
defaultStr = s.MaskString(defaultStr, 4)
}
prompt = fmt.Sprintf("%s [%s]", opts.Prompt, defualtStr)
prompt = fmt.Sprintf("%s [%s]", opts.Prompt, defaultStr)
}

val, err := ui.Ask(prompt, &input.Options{
Expand Down Expand Up @@ -700,13 +707,13 @@ func appendVal(slice interface{}, val interface{}) interface{} {
func setField(val interface{}, destStruct interface{}, fieldName string) error {
v := reflect.ValueOf(destStruct).Elem().FieldByName(fieldName)
if !v.IsValid() || !v.CanSet() {
debug.Pp(val)
debug.Pp(destStruct)
debug.Ppg(val)
debug.Ppg(destStruct)
return errors.Wrap(ErrorCannotSetStructField(), fieldName)
}
if !reflect.ValueOf(val).Type().AssignableTo(v.Type()) {
debug.Pp(val)
debug.Pp(destStruct)
debug.Ppg(val)
debug.Ppg(destStruct)
return errors.Wrap(ErrorCannotSetStructField(), fieldName)
}
v.Set(reflect.ValueOf(val))
Expand All @@ -717,8 +724,8 @@ func setField(val interface{}, destStruct interface{}, fieldName string) error {
func setFirstField(val interface{}, destStruct interface{}) error {
v := reflect.ValueOf(destStruct).Elem().FieldByIndex([]int{0})
if !v.IsValid() || !v.CanSet() {
debug.Pp(val)
debug.Pp(destStruct)
debug.Ppg(val)
debug.Ppg(destStruct)
return errors.Wrap(ErrorCannotSetStructField(), "first field")
}
v.Set(reflect.ValueOf(val))
Expand All @@ -729,7 +736,7 @@ func setFirstField(val interface{}, destStruct interface{}) error {
func setFieldNil(destStruct interface{}, fieldName string) error {
v := reflect.ValueOf(destStruct).Elem().FieldByName(fieldName)
if !v.IsValid() || !v.CanSet() {
debug.Pp(destStruct)
debug.Ppg(destStruct)
return errors.Wrap(ErrorCannotSetStructField(), fieldName)
}
v.Set(reflect.Zero(v.Type()))
Expand Down
Loading