all: simply registering plugins (#3287)

Abstract the caddy call and make it simpler.

See #3261 for some part of the discussion.

Go from:

~~~ go
func init() {
       caddy.RegisterPlugin("any", caddy.Plugin{
               ServerType: "dns",
               Action:     setup,
       })
}
~~~

To:

~~~ go
func init() { plugin.Register("any", setup) }
~~~

This requires some external documents in coredns.io to be updated as
well; the old way still works, so it's backwards compatible.

Signed-off-by: Miek Gieben <miek@miek.nl>

plugin/acl/setup.go

@@ -13,12 +13,7 @@ import (
 	"github.com/miekg/dns"
 )
 
-func init() {
+func init() { plugin.Register("acl", setup) }
-	caddy.RegisterPlugin("acl", caddy.Plugin{
-		ServerType: "dns",
-		Action:     setup,
-	})
-}
 
 func newDefaultFilter() *iptree.Tree {
 	defaultFilter := iptree.NewTree()

plugin/any/setup.go

@@ -7,12 +7,7 @@ import (
 	"github.com/caddyserver/caddy"
 )
 
-func init() {
+func init() { plugin.Register("any", setup) }
-	caddy.RegisterPlugin("any", caddy.Plugin{
-		ServerType: "dns",
-		Action:     setup,
-	})
-}
 
 func setup(c *caddy.Controller) error {
 	a := Any{}

plugin/auto/setup.go

@@ -18,12 +18,7 @@ import (
 
 var log = clog.NewWithPlugin("auto")
 
-func init() {
+func init() { plugin.Register("auto", setup) }
-	caddy.RegisterPlugin("auto", caddy.Plugin{
-		ServerType: "dns",
-		Action:     setup,
-	})
-}
 
 func setup(c *caddy.Controller) error {
 	a, err := autoParse(c)

plugin/autopath/setup.go

@@ -11,13 +11,7 @@ import (
 	"github.com/miekg/dns"
 )
 
-func init() {
+func init() { plugin.Register("autopath", setup) }
-	caddy.RegisterPlugin("autopath", caddy.Plugin{
-		ServerType: "dns",
-		Action:     setup,
-	})
-
-}
 
 func setup(c *caddy.Controller) error {
 	ap, mw, err := autoPathParse(c)

plugin/azure/setup.go

@@ -17,12 +17,7 @@ import (
 
 var log = clog.NewWithPlugin("azure")
 
-func init() {
+func init() { plugin.Register("azure", setup) }
-	caddy.RegisterPlugin("azure", caddy.Plugin{
-		ServerType: "dns",
-		Action:     setup,
-	})
-}
 
 func setup(c *caddy.Controller) error {
 	env, keys, fall, err := parse(c)

plugin/cache/setup.go

@@ -16,12 +16,7 @@ import (
 
 var log = clog.NewWithPlugin("cache")
 
-func init() {
+func init() { plugin.Register("cache", setup) }
-	caddy.RegisterPlugin("cache", caddy.Plugin{
-		ServerType: "dns",
-		Action:     setup,
-	})
-}
 
 func setup(c *caddy.Controller) error {
 	ca, err := cacheParse(c)

plugin/chaos/setup.go

@@ -11,13 +11,7 @@ import (
 	"github.com/caddyserver/caddy"
 )
 
-func init() {
+func init() { plugin.Register("chaos", setup) }
-	caddy.RegisterPlugin("chaos", caddy.Plugin{
-		ServerType: "dns",
-		Action:     setup,
-	})
-
-}
 
 func setup(c *caddy.Controller) error {
 	version, authors, err := parse(c)

plugin/clouddns/setup.go

@@ -18,9 +18,8 @@ import (
 var log = clog.NewWithPlugin("clouddns")
 
 func init() {
-	caddy.RegisterPlugin("clouddns", caddy.Plugin{
+	plugin.Register("clouddns",
-		ServerType: "dns",
+		func(c *caddy.Controller) error {
-		Action: func(c *caddy.Controller) error {
 			f := func(ctx context.Context, opt option.ClientOption) (gcpDNS, error) {
 				var err error
 				var client *gcp.Service
@@ -35,7 +34,7 @@ func init() {
 			}
 			return setup(c, f)
 		},
-	})
+	)
 }
 
 func setup(c *caddy.Controller, f func(ctx context.Context, opt option.ClientOption) (gcpDNS, error)) error {

plugin/deprecated/setup.go

@@ -20,7 +20,7 @@ import (
 )
 
 // removed has the names of the plugins that need to error on startup.
-var removed = []string{"reverse"}
+var removed = []string{""}
 
 func setup(c *caddy.Controller) error {
 	c.Next()
@@ -29,10 +29,7 @@ func setup(c *caddy.Controller) error {
 }
 
 func init() {
-	for _, plugin := range removed {
+	for _, plug := range removed {
-		caddy.RegisterPlugin(plugin, caddy.Plugin{
+		plugin.Register(plug, setup)
-			ServerType: "dns",
-			Action:     setup,
-		})
 	}
 }

plugin/dnssec/setup.go

@@ -17,12 +17,7 @@ import (
 
 var log = clog.NewWithPlugin("dnssec")
 
-func init() {
+func init() { plugin.Register("dnssec", setup) }
-	caddy.RegisterPlugin("dnssec", caddy.Plugin{
-		ServerType: "dns",
-		Action:     setup,
-	})
-}
 
 func setup(c *caddy.Controller) error {
 	zones, keys, capacity, splitkeys, err := dnssecParse(c)

plugin/dnstap/setup.go

@@ -15,12 +15,7 @@ import (
 
 var log = clog.NewWithPlugin("dnstap")
 
-func init() {
+func init() { plugin.Register("dnstap", wrapSetup) }
-	caddy.RegisterPlugin("dnstap", caddy.Plugin{
-		ServerType: "dns",
-		Action:     wrapSetup,
-	})
-}
 
 func wrapSetup(c *caddy.Controller) error {
 	if err := setup(c); err != nil {

plugin/erratic/setup.go

@@ -11,12 +11,7 @@ import (
 	"github.com/caddyserver/caddy"
 )
 
-func init() {
+func init() { plugin.Register("erratic", setup) }
-	caddy.RegisterPlugin("erratic", caddy.Plugin{
-		ServerType: "dns",
-		Action:     setup,
-	})
-}
 
 func setup(c *caddy.Controller) error {
 	e, err := parseErratic(c)

plugin/errors/setup.go

@@ -10,12 +10,7 @@ import (
 	"github.com/caddyserver/caddy"
 )
 
-func init() {
+func init() { plugin.Register("errors", setup) }
-	caddy.RegisterPlugin("errors", caddy.Plugin{
-		ServerType: "dns",
-		Action:     setup,
-	})
-}
 
 func setup(c *caddy.Controller) error {
 	handler, err := errorsParse(c)

plugin/etcd/setup.go

@@ -15,12 +15,7 @@ import (
 
 var log = clog.NewWithPlugin("etcd")
 
-func init() {
+func init() { plugin.Register("etcd", setup) }
-	caddy.RegisterPlugin("etcd", caddy.Plugin{
-		ServerType: "dns",
-		Action:     setup,
-	})
-}
 
 func setup(c *caddy.Controller) error {
 	e, err := etcdParse(c)

plugin/file/setup.go

@@ -13,12 +13,7 @@ import (
 	"github.com/caddyserver/caddy"
 )
 
-func init() {
+func init() { plugin.Register("file", setup) }
-	caddy.RegisterPlugin("file", caddy.Plugin{
-		ServerType: "dns",
-		Action:     setup,
-	})
-}
 
 func setup(c *caddy.Controller) error {
 	zones, err := fileParse(c)

plugin/forward/setup.go

@@ -16,12 +16,7 @@ import (
 	"github.com/caddyserver/caddy/caddyfile"
 )
 
-func init() {
+func init() { plugin.Register("forward", setup) }
-	caddy.RegisterPlugin("forward", caddy.Plugin{
-		ServerType: "dns",
-		Action:     setup,
-	})
-}
 
 func setup(c *caddy.Controller) error {
 	f, err := parseForward(c)

plugin/grpc/setup.go

@@ -14,12 +14,7 @@ import (
 	"github.com/caddyserver/caddy/caddyfile"
 )
 
-func init() {
+func init() { plugin.Register("grpc", setup) }
-	caddy.RegisterPlugin("grpc", caddy.Plugin{
-		ServerType: "dns",
-		Action:     setup,
-	})
-}
 
 func setup(c *caddy.Controller) error {
 	g, err := parseGRPC(c)

plugin/health/setup.go

@@ -11,12 +11,7 @@ import (
 	"github.com/caddyserver/caddy"
 )
 
-func init() {
+func init() { plugin.Register("health", setup) }
-	caddy.RegisterPlugin("health", caddy.Plugin{
-		ServerType: "dns",
-		Action:     setup,
-	})
-}
 
 func setup(c *caddy.Controller) error {
 	addr, lame, err := parse(c)

plugin/hosts/setup.go

@@ -17,12 +17,7 @@ import (
 
 var log = clog.NewWithPlugin("hosts")
 
-func init() {
+func init() { plugin.Register("hosts", setup) }
-	caddy.RegisterPlugin("hosts", caddy.Plugin{
-		ServerType: "dns",
-		Action:     setup,
-	})
-}
 
 func periodicHostsUpdate(h *Hosts) chan bool {
 	parseChan := make(chan bool)

plugin/k8s_external/setup.go

@@ -9,12 +9,7 @@ import (
 	"github.com/caddyserver/caddy"
 )
 
-func init() {
+func init() { plugin.Register("k8s_external", setup) }
-	caddy.RegisterPlugin("k8s_external", caddy.Plugin{
-		ServerType: "dns",
-		Action:     setup,
-	})
-}
 
 func setup(c *caddy.Controller) error {
 	e, err := parse(c)

plugin/kubernetes/setup.go

@@ -34,12 +34,7 @@ import (
 
 var log = clog.NewWithPlugin("kubernetes")
 
-func init() {
+func init() { plugin.Register("kubernetes", setup) }
-	caddy.RegisterPlugin("kubernetes", caddy.Plugin{
-		ServerType: "dns",
-		Action:     setup,
-	})
-}
 
 func setup(c *caddy.Controller) error {
 	klog.SetOutput(os.Stdout)

plugin/loadbalance/setup.go

@@ -12,12 +12,7 @@ import (
 
 var log = clog.NewWithPlugin("loadbalance")
 
-func init() {
+func init() { plugin.Register("loadbalance", setup) }
-	caddy.RegisterPlugin("loadbalance", caddy.Plugin{
-		ServerType: "dns",
-		Action:     setup,
-	})
-}
 
 func setup(c *caddy.Controller) error {
 	err := parse(c)

plugin/log/setup.go

@@ -12,12 +12,7 @@ import (
 	"github.com/miekg/dns"
 )
 
-func init() {
+func init() { plugin.Register("log", setup) }
-	caddy.RegisterPlugin("log", caddy.Plugin{
-		ServerType: "dns",
-		Action:     setup,
-	})
-}
 
 func setup(c *caddy.Controller) error {
 	rules, err := logParse(c)

plugin/loop/setup.go

@@ -13,12 +13,7 @@ import (
 	"github.com/caddyserver/caddy"
 )
 
-func init() {
+func init() { plugin.Register("loop", setup) }
-	caddy.RegisterPlugin("loop", caddy.Plugin{
-		ServerType: "dns",
-		Action:     setup,
-	})
-}
 
 func setup(c *caddy.Controller) error {
 	l, err := parse(c)

plugin/metadata/setup.go

@@ -7,12 +7,7 @@ import (
 	"github.com/caddyserver/caddy"
 )
 
-func init() {
+func init() { plugin.Register("metadata", setup) }
-	caddy.RegisterPlugin("metadata", caddy.Plugin{
-		ServerType: "dns",
-		Action:     setup,
-	})
-}
 
 func setup(c *caddy.Controller) error {
 	m, err := metadataParse(c)

plugin/metrics/setup.go

@@ -20,12 +20,7 @@ var (
 	registry = newReg()
 )
 
-func init() {
+func init() { plugin.Register("prometheus", setup) }
-	caddy.RegisterPlugin("prometheus", caddy.Plugin{
-		ServerType: "dns",
-		Action:     setup,
-	})
-}
 
 func setup(c *caddy.Controller) error {
 	m, err := parse(c)

plugin/nsid/setup.go

@@ -10,12 +10,7 @@ import (
 	"github.com/caddyserver/caddy"
 )
 
-func init() {
+func init() { plugin.Register("nsid", setup) }
-	caddy.RegisterPlugin("nsid", caddy.Plugin{
-		ServerType: "dns",
-		Action:     setup,
-	})
-}
 
 func setup(c *caddy.Controller) error {
 	nsid, err := nsidParse(c)

plugin/pprof/setup.go

@@ -15,12 +15,7 @@ var log = clog.NewWithPlugin("pprof")
 
 const defaultAddr = "localhost:6053"
 
-func init() {
+func init() { plugin.Register("pprof", setup) }
-	caddy.RegisterPlugin("pprof", caddy.Plugin{
-		ServerType: "dns",
-		Action:     setup,
-	})
-}
 
 func setup(c *caddy.Controller) error {
 	h := &handler{addr: defaultAddr}

plugin/ready/setup.go

@@ -9,12 +9,7 @@ import (
 	"github.com/caddyserver/caddy"
 )
 
-func init() {
+func init() { plugin.Register("ready", setup) }
-	caddy.RegisterPlugin("ready", caddy.Plugin{
-		ServerType: "dns",
-		Action:     setup,
-	})
-}
 
 func setup(c *caddy.Controller) error {
 	addr, err := parse(c)

plugin/register.go

@@ -0,0 +1,11 @@
+package plugin
+
+import "github.com/caddyserver/caddy"
+
+// Register registers your plugin with CoreDNS and allows it to be called when the server is running.
+func Register(name string, action caddy.SetupFunc) {
+	caddy.RegisterPlugin(name, caddy.Plugin{
+		ServerType: "dns",
+		Action:     action,
+	})
+}

plugin/reload/setup.go

@@ -14,12 +14,7 @@ import (
 
 var log = clog.NewWithPlugin("reload")
 
-func init() {
+func init() { plugin.Register("reload", setup) }
-	caddy.RegisterPlugin("reload", caddy.Plugin{
-		ServerType: "dns",
-		Action:     setup,
-	})
-}
 
 // the info reload is global to all application, whatever number of reloads.
 // it is used to transmit data between Setup and start of the hook called 'onInstanceStartup'

plugin/rewrite/setup.go

@@ -10,12 +10,7 @@ import (
 
 var log = clog.NewWithPlugin("rewrite")
 
-func init() {
+func init() { plugin.Register("rewrite", setup) }
-	caddy.RegisterPlugin("rewrite", caddy.Plugin{
-		ServerType: "dns",
-		Action:     setup,
-	})
-}
 
 func setup(c *caddy.Controller) error {
 	rewrites, err := rewriteParse(c)

plugin/route53/setup.go

@@ -25,9 +25,8 @@ import (
 var log = clog.NewWithPlugin("route53")
 
 func init() {
-	caddy.RegisterPlugin("route53", caddy.Plugin{
+	plugin.Register("route53",
-		ServerType: "dns",
+		func(c *caddy.Controller) error {
-		Action: func(c *caddy.Controller) error {
 			f := func(credential *credentials.Credentials) route53iface.Route53API {
 				return route53.New(session.Must(session.NewSession(&aws.Config{
 					Credentials: credential,
@@ -35,7 +34,7 @@ func init() {
 			}
 			return setup(c, f)
 		},
-	})
+	)
 }
 
 func setup(c *caddy.Controller, f func(*credentials.Credentials) route53iface.Route53API) error {

plugin/secondary/setup.go

@@ -10,12 +10,7 @@ import (
 	"github.com/caddyserver/caddy"
 )
 
-func init() {
+func init() { plugin.Register("secondary", setup) }
-	caddy.RegisterPlugin("secondary", caddy.Plugin{
-		ServerType: "dns",
-		Action:     setup,
-	})
-}
 
 func setup(c *caddy.Controller) error {
 	zones, err := secondaryParse(c)

plugin/sign/setup.go

@@ -12,12 +12,7 @@ import (
 	"github.com/caddyserver/caddy"
 )
 
-func init() {
+func init() { plugin.Register("sign", setup) }
-	caddy.RegisterPlugin("sign", caddy.Plugin{
-		ServerType: "dns",
-		Action:     setup,
-	})
-}
 
 func setup(c *caddy.Controller) error {
 	sign, err := parse(c)

plugin/template/setup.go

@@ -12,12 +12,7 @@ import (
 	"github.com/miekg/dns"
 )
 
-func init() {
+func init() { plugin.Register("template", setupTemplate) }
-	caddy.RegisterPlugin("template", caddy.Plugin{
-		ServerType: "dns",
-		Action:     setupTemplate,
-	})
-}
 
 func setupTemplate(c *caddy.Controller) error {
 	handler, err := templateParse(c)

plugin/trace/setup.go

@@ -11,12 +11,7 @@ import (
 	"github.com/caddyserver/caddy"
 )
 
-func init() {
+func init() { plugin.Register("trace", setup) }
-	caddy.RegisterPlugin("trace", caddy.Plugin{
-		ServerType: "dns",
-		Action:     setup,
-	})
-}
 
 func setup(c *caddy.Controller) error {
 	t, err := traceParse(c)

plugin/whoami/setup.go

@@ -7,12 +7,7 @@ import (
 	"github.com/caddyserver/caddy"
 )
 
-func init() {
+func init() { plugin.Register("whoami", setup) }
-	caddy.RegisterPlugin("whoami", caddy.Plugin{
-		ServerType: "dns",
-		Action:     setup,
-	})
-}
 
 func setup(c *caddy.Controller) error {
 	c.Next() // 'whoami'