minor cleanup and lint

Author: davidnewhall

cnfgfile/file.go

@@ -13,25 +13,27 @@ import (
 	"strings"
 
 	toml "github.com/BurntSushi/toml"
-	yaml "gopkg.in/yaml.v2"
+	yaml "gopkg.in/yaml.v3"
 )
 
+var ErrNoFile = fmt.Errorf("must provide at least 1 file to unmarshal")
+
 // Unmarshal parses a configuration file (of any format) into a config struct.
 // This is a shorthand method for calling Unmarshal against the json, xml, yaml
 // or toml packages. If the file name contains an appropriate suffix it is
 // unmarshaled with the corresponding package. If the suffix is missing, TOML
 // is assumed. Works with multiple files, so you can have stacked configurations.
 func Unmarshal(c interface{}, configFile ...string) error {
 	if len(configFile) < 1 {
-		return fmt.Errorf("must provide at least 1 file to unmarshal")
+		return ErrNoFile
 	}
 
 	for _, f := range configFile {
 		buf, err := ioutil.ReadFile(f)
 
 		switch {
 		case err != nil:
-			return err
+			return fmt.Errorf("reading file %s: %w", configFile, err)
 		case strings.Contains(f, ".json"):
 			err = json.Unmarshal(buf, c)
 		case strings.Contains(f, ".xml"):
@@ -43,7 +45,7 @@ func Unmarshal(c interface{}, configFile ...string) error {
 		}
 
 		if err != nil {
-			return err
+			return fmt.Errorf("unmarshaling file %s: %w", configFile, err)
 		}
 	}
 

cnfgfile/file_test.go

@@ -146,7 +146,7 @@ func ExampleUnmarshal() {
 	yaml := []byte("---\ninterval: 5m\nlocation: Earth\nprovided: true")
 	path := "/tmp/path_to_config.yaml"
 
-	err := ioutil.WriteFile(path, yaml, 0644)
+	err := ioutil.WriteFile(path, yaml, 0600)
 	if err != nil {
 		panic(err)
 	}

config.go

@@ -3,6 +3,7 @@ package cnfg
 import (
 	"encoding"
 	"encoding/json"
+	"fmt"
 	"time"
 )
 
@@ -33,7 +34,7 @@ type parser struct {
 	Vals Pairs  // pairs of env variables (saved at start)
 }
 
-// satify goconst
+// Satify goconst.
 const (
 	typeINT     = "int"
 	typeINT8    = "int8"
@@ -64,15 +65,20 @@ type Duration struct{ time.Duration }
 // env variables in the same struct. You won't generally call this directly.
 func (d *Duration) UnmarshalText(b []byte) (err error) {
 	d.Duration, err = time.ParseDuration(string(b))
-	return
+
+	if err != nil {
+		return fmt.Errorf("parsing duration '%s': %w", b, err)
+	}
+
+	return nil
 }
 
-// MarshalText returns the string representation of a Duration. ie. 1m32s
+// MarshalText returns the string representation of a Duration. ie. 1m32s.
 func (d *Duration) MarshalText() ([]byte, error) {
 	return []byte(d.Duration.String()), nil
 }
 
-// MarshalJSON returns the string representation of a Duration for JSON. ie. "1m32s"
+// MarshalJSON returns the string representation of a Duration for JSON. ie. "1m32s".
 func (d *Duration) MarshalJSON() ([]byte, error) {
 	return []byte(`"` + d.Duration.String() + `"`), nil
 }

config_test.go

@@ -33,12 +33,12 @@ func (t *TimeX) UnmarshalENV(tag, val string) error {
 
 	multiplier, err := strconv.Atoi(xString)
 	if err != nil {
-		return fmt.Errorf("multiplier invalid %s: %v", xTag, err)
+		return fmt.Errorf("multiplier invalid %s: %w", xTag, err)
 	}
 
 	t.Duration, err = time.ParseDuration(val)
 	if err != nil {
-		return fmt.Errorf("duration invalid %s: %v", tag, err)
+		return fmt.Errorf("duration invalid %s: %w", tag, err)
 	}
 
 	t.Duration *= time.Duration(multiplier)

doc_test.go

@@ -6,7 +6,7 @@ import (
 	"time"
 )
 
-// Complete working example for ENV.Unmarshal()
+// Complete working example for ENV.Unmarshal().
 func ExampleENV_Unmarshal_simple() {
 	// Systems is used to show an example of how to access nested slices.
 	type System struct {
@@ -26,8 +26,10 @@ func ExampleENV_Unmarshal_simple() {
 	// Make a pointer to your struct with some default data.
 	// Maybe this data came from a config file? Using ParseFile()!
 	c := &Config{
-		Debug: true,
-		Users: []string{"me", "you", "them"},
+		Debug:    true,
+		Users:    []string{"me", "you", "them"},
+		Interval: nil,
+		Systems:  nil,
 	}
 
 	// Okay set some ENV variables. Pretend you did this in bash.

env.go

@@ -6,6 +6,8 @@ import (
 	"reflect"
 )
 
+var ErrInvalidInterface = fmt.Errorf("can only unmarshal ENV into pointer to struct")
+
 // UnmarshalENV copies environment variables into configuration values.
 // This is useful for Docker users that find it easier to pass ENV variables
 // than a specific configuration file. Uses reflection to find struct tags.
@@ -18,7 +20,7 @@ func UnmarshalENV(i interface{}, prefix string) (bool, error) {
 func (e *ENV) Unmarshal(i interface{}) (bool, error) {
 	value := reflect.ValueOf(i)
 	if value.Kind() != reflect.Ptr || value.Elem().Kind() != reflect.Struct {
-		return false, fmt.Errorf("can only unmarshal ENV into pointer to struct")
+		return false, ErrInvalidInterface
 	}
 
 	if e.Tag == "" {

go.mod

@@ -4,12 +4,6 @@ go 1.15
 
 require (
 	github.com/BurntSushi/toml v0.3.1
-	github.com/creack/pty v1.1.11 // indirect
-	github.com/kr/pty v1.1.8 // indirect
-	github.com/kr/text v0.2.0 // indirect
-	github.com/niemeyer/pretty v0.0.0-20200227124842-a10e7caefd8e // indirect
 	github.com/stretchr/testify v1.6.1
-	golang.org/x/sys v0.0.0-20200926100807-9d91bd62050c // indirect
-	gopkg.in/check.v1 v1.0.0-20200902074654-038fdea0a05b // indirect
-	gopkg.in/yaml.v2 v2.3.0
+	gopkg.in/yaml.v3 v3.0.0-20200615113413-eeeca48fe776
 )

go.sum

@@ -1,34 +1,13 @@
 github.com/BurntSushi/toml v0.3.1 h1:WXkYYl6Yr3qBf1K79EBnL4mak0OimBfB0XUf9Vl28OQ=
 github.com/BurntSushi/toml v0.3.1/go.mod h1:xHWCNGjB5oqiDr8zfno3MHue2Ht5sIBksp03qcyfWMU=
-github.com/creack/pty v1.1.7/go.mod h1:lj5s0c3V2DBrqTV7llrYr5NG6My20zk30Fl46Y7DoTY=
-github.com/creack/pty v1.1.9 h1:uDmaGzcdjhF4i/plgjmEsriH11Y0o7RKapEf/LDaM3w=
-github.com/creack/pty v1.1.9/go.mod h1:oKZEueFk5CKHvIhNR5MUki03XCEU+Q6VDXinZuGJ33E=
-github.com/creack/pty v1.1.11 h1:07n33Z8lZxZ2qwegKbObQohDhXDQxiMMz1NOUGYlesw=
-github.com/creack/pty v1.1.11/go.mod h1:oKZEueFk5CKHvIhNR5MUki03XCEU+Q6VDXinZuGJ33E=
 github.com/davecgh/go-spew v1.1.0 h1:ZDRjVQ15GmhC3fiQ8ni8+OwkZQO4DARzQgrnXU1Liz8=
 github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
-github.com/kr/pty v1.1.1 h1:VkoXIwSboBpnk99O/KFauAEILuNHv5DVFKZMBN/gUgw=
-github.com/kr/pty v1.1.1/go.mod h1:pFQYn66WHrOpPYNljwOMqo10TkYh1fy3cYio2l3bCsQ=
-github.com/kr/pty v1.1.8 h1:AkaSdXYQOWeaO3neb8EM634ahkXXe3jYbVh/F9lq+GI=
-github.com/kr/pty v1.1.8/go.mod h1:O1sed60cT9XZ5uDucP5qwvh+TE3NnUj51EiZO/lmSfw=
-github.com/kr/text v0.1.0 h1:45sCR5RtlFHMR4UwH9sdQ5TC8v0qDQCHnXt+kaKSTVE=
-github.com/kr/text v0.1.0/go.mod h1:4Jbv+DJW3UT/LiOwJeYQe1efqtUx/iVham/4vfdArNI=
-github.com/kr/text v0.2.0 h1:5Nx0Ya0ZqY2ygV366QzturHI13Jq95ApcVaJBhpS+AY=
-github.com/kr/text v0.2.0/go.mod h1:eLer722TekiGuMkidMxC/pM04lWEeraHUUmBw8l2grE=
-github.com/niemeyer/pretty v0.0.0-20200227124842-a10e7caefd8e h1:fD57ERR4JtEqsWbfPhv4DMiApHyliiK5xCTNVSPiaAs=
-github.com/niemeyer/pretty v0.0.0-20200227124842-a10e7caefd8e/go.mod h1:zD1mROLANZcx1PVRCS0qkT7pwLkGfwJo4zjcN/Tysno=
 github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=
 github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
 github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME=
 github.com/stretchr/testify v1.6.1 h1:hDPOHmpOpP40lSULcqw7IrRb/u7w6RpDC9399XyoNd0=
 github.com/stretchr/testify v1.6.1/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg=
-golang.org/x/sys v0.0.0-20200926100807-9d91bd62050c h1:38q6VNPWR010vN82/SB121GujZNIfAUb4YttE2rhGuc=
-golang.org/x/sys v0.0.0-20200926100807-9d91bd62050c/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
-gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405 h1:yhCVgyC4o1eVCa2tZl7eS0r+SDo693bJlVdllGtEeKM=
 gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
-gopkg.in/check.v1 v1.0.0-20200902074654-038fdea0a05b h1:QRR6H1YWRnHb4Y/HeNFCTJLFVxaq6wH4YuVdsUOr75U=
-gopkg.in/check.v1 v1.0.0-20200902074654-038fdea0a05b/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
-gopkg.in/yaml.v2 v2.3.0 h1:clyUAQHOM3G0M3f5vQj7LuJrETvjVot3Z5el9nffUtU=
-gopkg.in/yaml.v2 v2.3.0/go.mod h1:hI93XBmqTisBFMUTm0b8Fm+jr3Dg1NNxqwp+5A1VGuI=
-gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c h1:dUUwHk2QECo/6vqA44rthZ8ie2QXMNeKRTHCNY2nXvo=
 gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=
+gopkg.in/yaml.v3 v3.0.0-20200615113413-eeeca48fe776 h1:tQIYjPdBoyREyB9XMu+nnTclpTYkz2zFM+lzLJFO4gQ=
+gopkg.in/yaml.v3 v3.0.0-20200615113413-eeeca48fe776/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=

map.go

@@ -1,7 +1,6 @@
 package cnfg
 
 import (
-	"fmt"
 	"reflect"
 	"strings"
 )
@@ -38,7 +37,7 @@ func UnmarshalMap(pairs map[string]string, i interface{}) (bool, error) {
 func (e *ENV) UnmarshalMap(pairs map[string]string, i interface{}) (bool, error) {
 	value := reflect.ValueOf(i)
 	if value.Kind() != reflect.Ptr || value.Elem().Kind() != reflect.Struct {
-		return false, fmt.Errorf("can only unmarshal into pointer to struct")
+		return false, ErrInvalidInterface
 	}
 
 	if e.Tag == "" {

parse.go

@@ -12,6 +12,11 @@ import (
 /* This file contains all the logic to parse a data structure
    using reflection tags from a map of keys and values. */
 
+var (
+	ErrUnsupported = fmt.Errorf("unsupported type, please report this if this type should be supported")
+	ErrInvalidByte = fmt.Errorf("invalid byte")
+)
+
 // Struct does most of the heavy lifting. Called every time a struct is encountered.
 // The entire process begins here. It's very recursive.
 func (p *parser) Struct(field reflect.Value, prefix string) (bool, error) {
@@ -154,18 +159,17 @@ func (p *parser) Member(field reflect.Value, tag, envval string) (bool, error) {
 		val, err = strconv.ParseBool(envval)
 		field.SetBool(val)
 	case typeError: // lul
-		field.Set(reflect.ValueOf(fmt.Errorf(envval)))
+		field.Set(reflect.ValueOf(fmt.Errorf(envval))) // nolint: goerr113
 	default:
 		var ok bool
 
 		if ok, err = p.Interface(field, tag, envval); err == nil && !ok {
-			err = fmt.Errorf("unsupported type: %v (val: %s) - please report this if "+
-				"this type should be supported", field.Type(), envval)
+			err = fmt.Errorf("%w: %v (val: %s)", ErrUnsupported, field.Type(), envval)
 		}
 	}
 
 	if err != nil {
-		return false, fmt.Errorf("%s: %v", tag, err)
+		return false, fmt.Errorf("%s: %w", tag, err)
 	}
 
 	return true, nil
@@ -295,7 +299,7 @@ func parseUint(field reflect.Value, intType, envval string) error {
 			field.Set(reflect.ValueOf(envval[0]))
 			return nil
 		default:
-			return fmt.Errorf("invalid byte: %s", envval)
+			return fmt.Errorf("%w: %s", ErrInvalidByte, envval)
 		}
 	case typeUINT16:
 		val, err = strconv.ParseUint(envval, 10, 16)
@@ -307,9 +311,10 @@ func parseUint(field reflect.Value, intType, envval string) error {
 
 	if err == nil {
 		field.SetUint(val)
+		return nil
 	}
 
-	return err
+	return fmt.Errorf("integer parse error: %w", err)
 }
 
 func parseInt(intType, envval string) (int64, error) {