Add ability to disable validation (#213)

* Add ability to disable validation. * Update to go.mod to 1.17 minimum to match the go version installation. * Pin go-licence-detector to v0.8.0 to work with go 1.17. * Add changelog entry.

Author: blakerouse

.ci/check.sh

@@ -21,5 +21,5 @@ go install github.com/elastic/go-licenser@latest
 checkformat go-licenser -license ASL2
 
 echo "Check notice file"
-go install go.elastic.co/go-licence-detector@latest
+go install go.elastic.co/go-licence-detector@v0.8.0
 checkformat dev-tools/generate_notice

CHANGELOG.md

@@ -5,6 +5,7 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 ## [Unreleased]
 
 ### Added
+- Add ability to skip validation with new `NoValidate` option. #213
 
 ### Changed
 

go.mod

@@ -1,12 +1,16 @@
 module github.com/elastic/go-ucfg
 
-go 1.13
+go 1.17
 
 require (
 github.com/davecgh/go-spew v1.1.1
-github.com/niemeyer/pretty v0.0.0-20200227124842-a10e7caefd8e // indirect
 github.com/stretchr/testify v1.4.0
-gopkg.in/check.v1 v1.0.0-20200227125254-8fa46927fb4f // indirect
 gopkg.in/hjson/hjson-go.v3 v3.0.1
 gopkg.in/yaml.v2 v2.2.8
 )
+
+require (
+github.com/niemeyer/pretty v0.0.0-20200227124842-a10e7caefd8e // indirect
+github.com/pmezard/go-difflib v1.0.0 // indirect
+gopkg.in/check.v1 v1.0.0-20200227125254-8fa46927fb4f // indirect
+)

opts.go

@@ -36,6 +36,7 @@ type Option func(*options)
 type options struct {
 tag string
 validatorTag string
+noValidate bool
 pathSep string
 escapePath bool
 meta *Meta
@@ -100,6 +101,13 @@ func ValidatorTag(tag string) Option {
 }
 }
 
+// NoValidate disables validation when unpacking.
+func NoValidate() Option {
+return func(o *options) {
+o.noValidate = true
+}
+}
+
 // PathSep sets the path separator used to split up names into a tree like hierarchy.
 // If PathSep is not set, field names will not be split.
 func PathSep(sep string) Option {

reify.go

@@ -203,8 +203,10 @@ func reifyMap(opts *options, to reflect.Value, from *Config, validators []valida
 
 fields := from.fields.dict()
 if len(fields) == 0 {
-if err := tryRecursiveValidate(to, opts, validators); err != nil {
-return raiseValidation(from.ctx, from.metadata, "", err)
+if !opts.noValidate {
+if err := tryRecursiveValidate(to, opts, validators); err != nil {
+return raiseValidation(from.ctx, from.metadata, "", err)
+}
 }
 return nil
 }
@@ -231,11 +233,13 @@ func reifyMap(opts *options, to reflect.Value, from *Config, validators []valida
 }
 }
 
-if err := runValidators(to.Interface(), validators); err != nil {
-return raiseValidation(from.ctx, from.metadata, "", err)
-}
-if err := tryValidate(to); err != nil {
-return raiseValidation(from.ctx, from.metadata, "", err)
+if !opts.noValidate {
+if err := runValidators(to.Interface(), validators); err != nil {
+return raiseValidation(from.ctx, from.metadata, "", err)
+}
+if err := tryValidate(to); err != nil {
+return raiseValidation(from.ctx, from.metadata, "", err)
+}
 }
 
 return nil
@@ -296,8 +300,10 @@ func reifyStruct(opts *options, orig reflect.Value, cfg *Config) Error {
 }
 }
 
-if err := tryValidate(to); err != nil {
-return raiseValidation(cfg.ctx, cfg.metadata, "", err)
+if !opts.noValidate {
+if err := tryValidate(to); err != nil {
+return raiseValidation(cfg.ctx, cfg.metadata, "", err)
+}
 }
 
 orig.Set(pointerize(orig.Type(), to.Type(), to))
@@ -324,16 +330,20 @@ func reifyGetField(
 // When fieldType is a pointer and the value is nil, return nil as the
 // underlying type should not be allocated.
 if fieldType.Kind() == reflect.Ptr {
-if err := tryRecursiveValidate(to, opts.opts, opts.validators); err != nil {
-return raiseValidation(cfg.ctx, cfg.metadata, name, err)
+if !opts.opts.noValidate {
+if err := tryRecursiveValidate(to, opts.opts, opts.validators); err != nil {
+return raiseValidation(cfg.ctx, cfg.metadata, name, err)
+}
 }
 return nil
 }
 
 // Primitive types return early when it doesn't implement the Initializer interface.
 if fieldType.Kind() != reflect.Struct && !hasInitDefaults(fieldType) {
-if err := tryRecursiveValidate(to, opts.opts, opts.validators); err != nil {
-return raiseValidation(cfg.ctx, cfg.metadata, name, err)
+if !opts.opts.noValidate {
+if err := tryRecursiveValidate(to, opts.opts, opts.validators); err != nil {
+return raiseValidation(cfg.ctx, cfg.metadata, name, err)
+}
 }
 return nil
 }
@@ -604,21 +614,23 @@ func reifyDoArray(
 if v.IsValid() {
 to.Index(idx).Set(v)
 }
-} else {
+} else if !opts.opts.noValidate {
 if err := tryRecursiveValidate(to.Index(idx), opts.opts, nil); err != nil {
 return reflect.Value{}, raiseValidation(val.Context(), val.meta(), "", err)
 }
 }
 }
 
-if err := runValidators(to.Interface(), opts.validators); err != nil {
-ctx := val.Context()
-return reflect.Value{}, raiseValidation(ctx, val.meta(), "", err)
-}
+if !opts.opts.noValidate {
+if err := runValidators(to.Interface(), opts.validators); err != nil {
+ctx := val.Context()
+return reflect.Value{}, raiseValidation(ctx, val.meta(), "", err)
+}
 
-if err := tryValidate(to); err != nil {
-ctx := val.Context()
-return reflect.Value{}, raiseValidation(ctx, val.meta(), "", err)
+if err := tryValidate(to); err != nil {
+ctx := val.Context()
+return reflect.Value{}, raiseValidation(ctx, val.meta(), "", err)
+}
 }
 
 return to, nil
@@ -679,12 +691,14 @@ func reifyPrimitive(
 }
 }
 
-if err := runValidators(v.Interface(), opts.validators); err != nil {
-return reflect.Value{}, raiseValidation(val.Context(), val.meta(), "", err)
-}
+if !opts.opts.noValidate {
+if err := runValidators(v.Interface(), opts.validators); err != nil {
+return reflect.Value{}, raiseValidation(val.Context(), val.meta(), "", err)
+}
 
-if err := tryValidate(v); err != nil {
-return reflect.Value{}, raiseValidation(val.Context(), val.meta(), "", err)
+if err := tryValidate(v); err != nil {
+return reflect.Value{}, raiseValidation(val.Context(), val.meta(), "", err)
+}
 }
 
 return pointerize(t, baseType, chaseValuePointers(v)), nil

validator_test.go

@@ -24,6 +24,7 @@ import (
 "testing"
 "time"
 
+"github.com/davecgh/go-spew/spew"
 "github.com/elastic/go-ucfg/cfgtest"
 )
 
@@ -531,11 +532,23 @@ func TestValidationFail(t *testing.T) {
 },
 }
 
-for i, test := range tests {
-t.Run(fmt.Sprintf("Test config (%v): %#v", i, test), func(t *testing.T) {
-cfgtest.MustFailUnpack(t, c, test)
-})
-}
+t.Run("validate", func(t *testing.T) {
+for i, test := range tests {
+t.Run(fmt.Sprintf("Test config (%v): %#v", i, test), func(t *testing.T) {
+cfgtest.MustFailUnpack(t, c, test)
+})
+}
+})
+t.Run("noValidate", func(t *testing.T) {
+for i, test := range tests {
+t.Run(fmt.Sprintf("Test config (%v): %#v", i, test), func(t *testing.T) {
+err := c.Unpack(test, NoValidate())
+if err != nil {
+t.Fatalf("config:%s test:%s error:%v", spew.Sdump(c), spew.Sdump(test), err)
+}
+})
+}
+})
 }
 
 func TestValidateRequiredFailing(t *testing.T) {