Add a parse config parser

This makes setup more testable.

Author: oz123

go.mod

@@ -7,5 +7,6 @@ require (
 	github.com/coredns/coredns v1.7.0
 	github.com/miekg/dns v1.1.29
 	github.com/prometheus/client_golang v1.7.1
+	github.com/stretchr/testify v1.5.1
 	gopkg.in/h2non/gock.v1 v1.0.15
 )

go.sum

@@ -103,6 +103,7 @@ github.com/cpu/goacmedns v0.0.1/go.mod h1:sesf/pNnCYwUevQEQfEwY0Y3DydlQWSGZbaMEl
 github.com/cpuguy83/go-md2man/v2 v2.0.0-20190314233015-f79a8a8ca69d/go.mod h1:maD7wRr/U5Z6m/iR4s+kqSMx2CaBsrgA7czyZG/E6dU=
 github.com/creack/pty v1.1.7/go.mod h1:lj5s0c3V2DBrqTV7llrYr5NG6My20zk30Fl46Y7DoTY=
 github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
+github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c=
 github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
 github.com/decker502/dnspod-go v0.2.0/go.mod h1:qsurYu1FgxcDwfSwXJdLt4kRsBLZeosEb9uq4Sy+08g=
 github.com/dgrijalva/jwt-go v3.2.0+incompatible/go.mod h1:E3ru+11k8xSBh+hMPgOLZmtrrCbhqsmaPHjLKYnJCaQ=
@@ -323,6 +324,7 @@ github.com/pierrec/lz4 v2.0.5+incompatible/go.mod h1:pdkljMzZIN41W+lC3N2tnIh5sFi
 github.com/pkg/errors v0.8.0/go.mod h1:bwawxfHBFNV+L2hUp1rHADufV3IMtnDRdf1r5NINEl0=
 github.com/pkg/errors v0.8.1/go.mod h1:bwawxfHBFNV+L2hUp1rHADufV3IMtnDRdf1r5NINEl0=
 github.com/pkg/errors v0.9.1/go.mod h1:bwawxfHBFNV+L2hUp1rHADufV3IMtnDRdf1r5NINEl0=
+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/prometheus/client_golang v0.9.1/go.mod h1:7SWBe2y4D6OKWSNQJUaRYU/AaXPKyh/dDVn+NZz0KFw=
 github.com/prometheus/client_golang v0.9.3-0.20190127221311-3c4408c8b829/go.mod h1:p2iRAGwDERtqlqzRXnrOVns+ignqQo//hLXqYxZYVNs=
@@ -376,6 +378,7 @@ github.com/stretchr/objx v0.1.1/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+
 github.com/stretchr/testify v1.2.2/go.mod h1:a8OnRcib4nhh0OaRAV+Yts87kKdq0PP7pXfy6kDkUVs=
 github.com/stretchr/testify v1.3.0/go.mod h1:M5WIy9Dh21IEIfnGCwXGc5bZfKNJtfHm1UVUgZn+9EI=
 github.com/stretchr/testify v1.4.0/go.mod h1:j7eGeouHqKxXV5pUuKE4zz7dFj8WfuZ+81PSLYec5m4=
+github.com/stretchr/testify v1.5.1 h1:nOGnQDM7FYENwehXlg/kFVnos3rEvtKTjRvOWSzb6H4=
 github.com/stretchr/testify v1.5.1/go.mod h1:5W2xD1RspED5o8YsWQXVCued0rvSQ+mT+I5cxcmMvtA=
 github.com/timewasted/linode v0.0.0-20160829202747-37e84520dcf7/go.mod h1:imsgLplxEC/etjIhdr3dNzV3JeT27LbVu5pYWm0JCBY=
 github.com/tinylib/msgp v1.1.2/go.mod h1:+d+yLhGm8mzTaHzB+wgMYrodPfmZrzkirds8fDWklFE=
@@ -672,6 +675,7 @@ gopkg.in/yaml.v2 v2.2.2/go.mod h1:hI93XBmqTisBFMUTm0b8Fm+jr3Dg1NNxqwp+5A1VGuI=
 gopkg.in/yaml.v2 v2.2.4/go.mod h1:hI93XBmqTisBFMUTm0b8Fm+jr3Dg1NNxqwp+5A1VGuI=
 gopkg.in/yaml.v2 v2.2.5/go.mod h1:hI93XBmqTisBFMUTm0b8Fm+jr3Dg1NNxqwp+5A1VGuI=
 gopkg.in/yaml.v2 v2.2.7/go.mod h1:hI93XBmqTisBFMUTm0b8Fm+jr3Dg1NNxqwp+5A1VGuI=
+gopkg.in/yaml.v2 v2.2.8 h1:obN1ZagJSUGI0Ek/LBmuj4SNLPfIny3KsKFopxRdj10=
 gopkg.in/yaml.v2 v2.2.8/go.mod h1:hI93XBmqTisBFMUTm0b8Fm+jr3Dg1NNxqwp+5A1VGuI=
 honnef.co/go/tools v0.0.0-20180728063816-88497007e858/go.mod h1:rf3lG4BRIbNafJWhAfAdb/ePZxsR/4RtNHQocxwk9r4=
 honnef.co/go/tools v0.0.0-20190102054323-c2f93a96b099/go.mod h1:rf3lG4BRIbNafJWhAfAdb/ePZxsR/4RtNHQocxwk9r4=

netbox.go

@@ -20,6 +20,7 @@ import (
 	"net"
 	"os"
 	"strings"
+	"time"
 
 	"github.com/coredns/coredns/plugin"
 	"github.com/coredns/coredns/plugin/metrics"
@@ -33,9 +34,10 @@ import (
 var log = clog.NewWithPlugin("netbox")
 
 type Netbox struct {
-	Url   string
-	Token string
-	Next  plugin.Handler
+	Url           string
+	Token         string
+	CacheDuration time.Duration
+	Next          plugin.Handler
 }
 
 func (n Netbox) ServeDNS(ctx context.Context, w dns.ResponseWriter, r *dns.Msg) (int, error) {

netbox_test.go

@@ -21,6 +21,7 @@ import (
 	"github.com/miekg/dns"
 	"gopkg.in/h2non/gock.v1"
 	"testing"
+	"time"
 )
 
 func TestNetbox(t *testing.T) {
@@ -29,7 +30,7 @@ func TestNetbox(t *testing.T) {
 		map[string]string{"dns_name": "my_host"}).Reply(
 		200).BodyString(
 		`{"count":1, "results":[{"address": "10.0.0.2/25", "dns_name": "my_host"}]}`)
-	nb := Netbox{Url: "https://example.org/api/ipam/ip-addresses", Token: "s3kr3tt0ken"}
+	nb := Netbox{Url: "https://example.org/api/ipam/ip-addresses", Token: "s3kr3tt0ken", CacheDuration: time.Second * 10}
 
 	if nb.Name() != "netbox" {
 		t.Errorf("expected plugin name: %s, got %s", "netbox", nb.Name())

setup.go

@@ -19,6 +19,7 @@ import (
 	"github.com/coredns/coredns/core/dnsserver"
 	"github.com/coredns/coredns/plugin"
 	"github.com/coredns/coredns/plugin/metrics"
+	"time"
 
 	"github.com/caddyserver/caddy"
 )
@@ -30,8 +31,36 @@ func init() { plugin.Register("netbox", setup) }
 // for parsing any extra options the example plugin may have. The first token this function sees is "example".
 func setup(c *caddy.Controller) error {
 
+	netboxPlugin, err := newNetBox(c)
+	if err != nil {
+		return plugin.Error("netbox", err)
+	}
+
+	// Add a startup function that will -- after all plugins have been loaded -- check if the
+	// prometheus plugin has been used - if so we will export metrics. We can only register
+	// this metric once, hence the "once.Do".
+	c.OnStartup(func() error {
+		once.Do(func() { metrics.MustRegister(c, requestCount) })
+		return nil
+	})
+
+	// Add the Plugin to CoreDNS, so Servers can use it in their plugin chain.
+	dnsserver.GetConfig(c).AddPlugin(func(next plugin.Handler) plugin.Handler {
+		return netboxPlugin
+	})
+
+	// All OK, return a nil error.
+	return nil
+}
+
+func newNetBox(c *caddy.Controller) (Netbox, error) {
+
 	url := ""
 	token := ""
+	localCacheDuration := ""
+	duration := time.Second
+	var err error
+
 	for c.Next() {
 		if c.NextBlock() {
 			for {
@@ -47,6 +76,16 @@ func setup(c *caddy.Controller) error {
 						c.ArgErr()
 					}
 					token = c.Val()
+
+				case "localCacheDuration":
+					if !c.NextArg() {
+						c.ArgErr()
+					}
+					localCacheDuration = c.Val()
+					duration, err = time.ParseDuration(localCacheDuration)
+					if err != nil {
+						localCacheDuration = ""
+					}
 				}
 
 				if !c.Next() {
@@ -56,22 +95,11 @@ func setup(c *caddy.Controller) error {
 		}
 
 	}
-	// Add a startup function that will -- after all plugins have been loaded -- check if the
-	// prometheus plugin has been used - if so we will export metrics. We can only register
-	// this metric once, hence the "once.Do".
-	c.OnStartup(func() error {
-		once.Do(func() { metrics.MustRegister(c, requestCount) })
-		return nil
-	})
-
-	// Add the Plugin to CoreDNS, so Servers can use it in their plugin chain.
-	dnsserver.GetConfig(c).AddPlugin(func(next plugin.Handler) plugin.Handler {
-		return Netbox{Url: url, Token: token, Next: next}
-	})
 
-	if url == "" || token == "" {
-		return errors.New("Could not find url or token in netbox config")
+	if url == "" || token == "" || localCacheDuration == "" {
+		return Netbox{}, errors.New("Could not parse netbox config")
 	}
-	// All OK, return a nil error.
-	return nil
+
+	return Netbox{Url: url, Token: token, CacheDuration: duration}, nil
+
 }

setup_test.go

@@ -15,15 +15,18 @@
 package netbox
 
 import (
+	//"fmt"
 	"testing"
+	"time"
 
 	"github.com/caddyserver/caddy"
+	"github.com/stretchr/testify/assert"
 )
 
 // TestSetup tests the various things that should be parsed by setup.
 // Make sure you also test for parse errors.
 func TestSetup(t *testing.T) {
-	c := caddy.NewTestController("dns", `netbox { url example.org\n token foobar}`)
+	c := caddy.NewTestController("dns", `netbox { url example.org\n token foobar\n localCacheDuration 10s }`)
 	if err := setup(c); err != nil {
 		t.Fatalf("Expected no errors, but got: %v", err)
 	}
@@ -33,3 +36,15 @@ func TestSetup(t *testing.T) {
 		t.Fatalf("Expected errors, but got: %v", err)
 	}
 }
+
+func TestSetupWithWrongDuration(t *testing.T) {
+	c := caddy.NewTestController("dns", `netbox { url example.org\n token foobar\n localCacheDuration Wrong }`)
+	_, err := newNetBox(c)
+	assert.Error(t, err, "Expected error")
+}
+
+func TestSetupWithDuration(t *testing.T) {
+	c := caddy.NewTestController("dns", `netbox { url example.org\n token foobar\n localCacheDuration 10s }`)
+	nb, _ := newNetBox(c)
+	assert.Equal(t, nb.CacheDuration, time.Second*10, "Duration not set properly")
+}