Discovery cleanup to better separate local and remote discovery of plugins (#446)

David Chung · web-flow · commit 606cbb985057 · 2017-03-25T15:14:42.000-07:00
Signed-off-by: David Chung &lt;david.chung@docker.com&gt;
diff --git a/cmd/cli/event.go b/cmd/cli/event.go
@@ -6,6 +6,7 @@ import (
 
 	log "github.com/Sirupsen/logrus"
 	"github.com/docker/infrakit/pkg/discovery"
+	"github.com/docker/infrakit/pkg/discovery/local"
 	metadata_template "github.com/docker/infrakit/pkg/plugin/metadata/template"
 	"github.com/docker/infrakit/pkg/rpc/client"
 	event_rpc "github.com/docker/infrakit/pkg/rpc/event"
@@ -193,7 +194,7 @@ func eventCommand(plugins func() discovery.Plugins) *cobra.Command {
 
 			log.Infof("Using %v for rendering view.", templateURL)
 			engine, err := template.NewTemplate(templateURL, template.Options{
-				SocketDir: discovery.Dir(),
+				SocketDir: local.Dir(),
 			})
 			if err != nil {
 				return err
diff --git a/cmd/cli/main.go b/cmd/cli/main.go
@@ -8,6 +8,7 @@ import (
 
 	"github.com/docker/infrakit/pkg/cli"
 	"github.com/docker/infrakit/pkg/discovery"
+	"github.com/docker/infrakit/pkg/discovery/local"
 	"github.com/docker/infrakit/pkg/discovery/remote"
 	logutil "github.com/docker/infrakit/pkg/log"
 	"github.com/spf13/cobra"
@@ -58,7 +59,7 @@ func main() {
 	cmd.SilenceErrors = true
 	f := func() discovery.Plugins {
 		if len(ulist) == 0 {
-			d, err := discovery.NewPluginDiscovery()
+			d, err := local.NewPluginDiscovery()
 			if err != nil {
 				log.Crit("Failed to initialize plugin discovery", "err", err)
 				os.Exit(1)
diff --git a/cmd/cli/manager.go b/cmd/cli/manager.go
@@ -6,6 +6,7 @@ import (
 
 	log "github.com/Sirupsen/logrus"
 	"github.com/docker/infrakit/pkg/discovery"
+	"github.com/docker/infrakit/pkg/discovery/local"
 	"github.com/docker/infrakit/pkg/manager"
 	"github.com/docker/infrakit/pkg/plugin"
 	metadata_template "github.com/docker/infrakit/pkg/plugin/metadata/template"
@@ -87,7 +88,7 @@ func managerCommand(plugins func() discovery.Plugins) *cobra.Command {
 
 		log.Infof("Using %v for reading template\n", templateURL)
 		engine, err := template.NewTemplate(templateURL, template.Options{
-			SocketDir: discovery.Dir(),
+			SocketDir: local.Dir(),
 		})
 		if err != nil {
 			return err
diff --git a/cmd/cli/plugin.go b/cmd/cli/plugin.go
@@ -11,6 +11,7 @@ import (
 
 	log "github.com/Sirupsen/logrus"
 	"github.com/docker/infrakit/pkg/discovery"
+	"github.com/docker/infrakit/pkg/discovery/local"
 	"github.com/docker/infrakit/pkg/launch"
 	"github.com/docker/infrakit/pkg/launch/os"
 	"github.com/docker/infrakit/pkg/plugin"
@@ -59,7 +60,7 @@ func pluginCommand(plugins func() discovery.Plugins) *cobra.Command {
 	start.RunE = func(c *cobra.Command, args []string) error {
 
 		configTemplate, err := template.NewTemplate(*configURL, template.Options{
-			SocketDir: discovery.Dir(),
+			SocketDir: local.Dir(),
 		})
 		if err != nil {
 			return err
diff --git a/cmd/cli/resource.go b/cmd/cli/resource.go
@@ -6,6 +6,7 @@ import (
 
 	log "github.com/Sirupsen/logrus"
 	"github.com/docker/infrakit/pkg/discovery"
+	"github.com/docker/infrakit/pkg/discovery/local"
 	"github.com/docker/infrakit/pkg/plugin"
 	resource_plugin "github.com/docker/infrakit/pkg/rpc/resource"
 	"github.com/docker/infrakit/pkg/spi/resource"
@@ -139,7 +140,7 @@ func resourcePluginCommand(plugins func() discovery.Plugins) *cobra.Command {
 func readSpecFromTemplateURL(templateURL string) (*resource.Spec, error) {
 	log.Infof("Reading template from %v", templateURL)
 	engine, err := template.NewTemplate(templateURL, template.Options{
-		SocketDir: discovery.Dir(),
+		SocketDir: local.Dir(),
 	})
 	if err != nil {
 		return nil, err
diff --git a/cmd/cli/template.go b/cmd/cli/template.go
@@ -6,6 +6,7 @@ import (
 
 	log "github.com/Sirupsen/logrus"
 	"github.com/docker/infrakit/pkg/discovery"
+	"github.com/docker/infrakit/pkg/discovery/local"
 	metadata_template "github.com/docker/infrakit/pkg/plugin/metadata/template"
 	"github.com/docker/infrakit/pkg/template"
 	"github.com/spf13/cobra"
@@ -22,7 +23,7 @@ func templateCommand(plugins func() discovery.Plugins) *cobra.Command {
 
 			log.Infof("Using %v for reading template\n", templateURL)
 			engine, err := template.NewTemplate(templateURL, template.Options{
-				SocketDir: discovery.Dir(),
+				SocketDir: local.Dir(),
 			})
 			if err != nil {
 				return err
diff --git a/cmd/group/main.go b/cmd/group/main.go
@@ -6,7 +6,7 @@ import (
 
 	log "github.com/Sirupsen/logrus"
 	"github.com/docker/infrakit/pkg/cli"
-	"github.com/docker/infrakit/pkg/discovery"
+	"github.com/docker/infrakit/pkg/discovery/local"
 	"github.com/docker/infrakit/pkg/plugin"
 	"github.com/docker/infrakit/pkg/plugin/group"
 	metadata_plugin "github.com/docker/infrakit/pkg/plugin/metadata"
@@ -33,7 +33,7 @@ func main() {
 
 		cli.SetLogLevel(*logLevel)
 
-		plugins, err := discovery.NewPluginDiscovery()
+		plugins, err := local.NewPluginDiscovery()
 		if err != nil {
 			return err
 		}
diff --git a/cmd/manager/etcd.go b/cmd/manager/etcd.go
@@ -5,7 +5,7 @@ import (
 
 	"github.com/coreos/etcd/clientv3"
 	"github.com/docker/go-connections/tlsconfig"
-	"github.com/docker/infrakit/pkg/discovery"
+	"github.com/docker/infrakit/pkg/discovery/local"
 	etcd_leader "github.com/docker/infrakit/pkg/leader/etcd/v3"
 	etcd_store "github.com/docker/infrakit/pkg/store/etcd/v3"
 	etcd "github.com/docker/infrakit/pkg/util/etcd/v3"
@@ -66,7 +66,7 @@ func etcdEnvironment(getConfig func() config) *cobra.Command {
 			return err
 		}
 
-		plugins, err := discovery.NewPluginDiscovery()
+		plugins, err := local.NewPluginDiscovery()
 		if err != nil {
 			return err
 		}
diff --git a/cmd/manager/os.go b/cmd/manager/os.go
@@ -6,7 +6,7 @@ import (
 	"path/filepath"
 	"time"
 
-	"github.com/docker/infrakit/pkg/discovery"
+	"github.com/docker/infrakit/pkg/discovery/local"
 	file_leader "github.com/docker/infrakit/pkg/leader/file"
 	file_store "github.com/docker/infrakit/pkg/store/file"
 	"github.com/spf13/cobra"
@@ -52,7 +52,7 @@ func osEnvironment(getConfig func() config) *cobra.Command {
 	pollInterval := cmd.Flags().Duration("poll-interval", 5*time.Second, "Leader polling interval")
 	cmd.RunE = func(c *cobra.Command, args []string) error {
 
-		plugins, err := discovery.NewPluginDiscovery()
+		plugins, err := local.NewPluginDiscovery()
 		if err != nil {
 			return err
 		}
diff --git a/cmd/manager/swarm.go b/cmd/manager/swarm.go
@@ -5,7 +5,7 @@ import (
 
 	log "github.com/Sirupsen/logrus"
 	"github.com/docker/go-connections/tlsconfig"
-	"github.com/docker/infrakit/pkg/discovery"
+	"github.com/docker/infrakit/pkg/discovery/local"
 	swarm_leader "github.com/docker/infrakit/pkg/leader/swarm"
 	swarm_store "github.com/docker/infrakit/pkg/store/swarm"
 	"github.com/docker/infrakit/pkg/util/docker"
@@ -44,7 +44,7 @@ func swarmEnvironment(getConfig func() config) *cobra.Command {
 			return err
 		}
 
-		plugins, err := discovery.NewPluginDiscovery()
+		plugins, err := local.NewPluginDiscovery()
 		if err != nil {
 			return err
 		}
diff --git a/cmd/resource/main.go b/cmd/resource/main.go
@@ -5,7 +5,7 @@ import (
 
 	log "github.com/Sirupsen/logrus"
 	"github.com/docker/infrakit/pkg/cli"
-	"github.com/docker/infrakit/pkg/discovery"
+	"github.com/docker/infrakit/pkg/discovery/local"
 	"github.com/docker/infrakit/pkg/plugin"
 	"github.com/docker/infrakit/pkg/plugin/resource"
 	instance_client "github.com/docker/infrakit/pkg/rpc/instance"
@@ -27,7 +27,7 @@ func main() {
 
 		cli.SetLogLevel(*logLevel)
 
-		plugins, err := discovery.NewPluginDiscovery()
+		plugins, err := local.NewPluginDiscovery()
 		if err != nil {
 			return err
 		}
diff --git a/examples/flavor/combo/main.go b/examples/flavor/combo/main.go
@@ -5,7 +5,7 @@ import (
 
 	log "github.com/Sirupsen/logrus"
 	"github.com/docker/infrakit/pkg/cli"
-	"github.com/docker/infrakit/pkg/discovery"
+	"github.com/docker/infrakit/pkg/discovery/local"
 	"github.com/docker/infrakit/pkg/plugin"
 	flavor_rpc "github.com/docker/infrakit/pkg/rpc/flavor"
 	"github.com/docker/infrakit/pkg/spi/flavor"
@@ -22,7 +22,7 @@ func main() {
 	name := cmd.Flags().String("name", "flavor-combo", "Plugin name to advertise for discovery")
 	cmd.Run = func(c *cobra.Command, args []string) {
 
-		plugins, err := discovery.NewPluginDiscovery()
+		plugins, err := local.NewPluginDiscovery()
 		if err != nil {
 			log.Error(err)
 			os.Exit(1)
diff --git a/examples/flavor/swarm/flavor_test.go b/examples/flavor/swarm/flavor_test.go
@@ -8,6 +8,7 @@ import (
 	"github.com/docker/docker/api/types/filters"
 	"github.com/docker/docker/api/types/swarm"
 	"github.com/docker/infrakit/pkg/discovery"
+	"github.com/docker/infrakit/pkg/discovery/local"
 	mock_client "github.com/docker/infrakit/pkg/mock/docker/docker/client"
 	group_types "github.com/docker/infrakit/pkg/plugin/group/types"
 	"github.com/docker/infrakit/pkg/spi/flavor"
@@ -29,7 +30,7 @@ func templ(tpl string) *template.Template {
 }
 
 func plugins() discovery.Plugins {
-	d, err := discovery.NewPluginDiscovery()
+	d, err := local.NewPluginDiscovery()
 	if err != nil {
 		panic(err)
 	}
diff --git a/examples/flavor/swarm/main.go b/examples/flavor/swarm/main.go
@@ -6,6 +6,7 @@ import (
 	log "github.com/Sirupsen/logrus"
 	"github.com/docker/infrakit/pkg/cli"
 	"github.com/docker/infrakit/pkg/discovery"
+	"github.com/docker/infrakit/pkg/discovery/local"
 	"github.com/docker/infrakit/pkg/plugin/metadata"
 	flavor_plugin "github.com/docker/infrakit/pkg/rpc/flavor"
 	metadata_plugin "github.com/docker/infrakit/pkg/rpc/metadata"
@@ -24,13 +25,13 @@ func init() {
 }
 
 var defaultTemplateOptions = template.Options{
-	SocketDir: discovery.Dir(),
+	SocketDir: local.Dir(),
 }
 
 func main() {
 
 	plugins := func() discovery.Plugins {
-		d, err := discovery.NewPluginDiscovery()
+		d, err := local.NewPluginDiscovery()
 		if err != nil {
 			log.Fatalf("Failed to initialize plugin discovery: %s", err)
 			os.Exit(1)
diff --git a/examples/instance/vagrant/main.go b/examples/instance/vagrant/main.go
@@ -7,7 +7,7 @@ import (
 
 	log "github.com/Sirupsen/logrus"
 	"github.com/docker/infrakit/pkg/cli"
-	"github.com/docker/infrakit/pkg/discovery"
+	"github.com/docker/infrakit/pkg/discovery/local"
 	"github.com/docker/infrakit/pkg/plugin/metadata"
 	instance_plugin "github.com/docker/infrakit/pkg/rpc/instance"
 	metadata_plugin "github.com/docker/infrakit/pkg/rpc/metadata"
@@ -34,7 +34,7 @@ func main() {
 	cmd.RunE = func(c *cobra.Command, args []string) error {
 
 		opts := template.Options{
-			SocketDir: discovery.Dir(),
+			SocketDir: local.Dir(),
 		}
 
 		var templ *template.Template
diff --git a/pkg/cli/serverutil.go b/pkg/cli/serverutil.go
@@ -7,7 +7,7 @@ import (
 	"path"
 
 	log "github.com/Sirupsen/logrus"
-	"github.com/docker/infrakit/pkg/discovery"
+	"github.com/docker/infrakit/pkg/discovery/local"
 	"github.com/docker/infrakit/pkg/rpc/server"
 )
 
@@ -20,7 +20,7 @@ func EnsureDirExists(dir string) {
 // The plugin should conform to the rpc call convention as implemented in the rpc package.
 func RunPlugin(name string, plugin server.VersionedInterface, more ...server.VersionedInterface) {
 
-	dir := discovery.Dir()
+	dir := local.Dir()
 	EnsureDirExists(dir)
 
 	socketPath := path.Join(dir, name)
diff --git a/pkg/discovery/local/dir.go b/pkg/discovery/local/dir.go
@@ -1,4 +1,4 @@
-package discovery
+package local
 
 import (
 	"fmt"
@@ -10,12 +10,13 @@ import (
 	"sync"
 
 	log "github.com/Sirupsen/logrus"
+	"github.com/docker/infrakit/pkg/discovery"
 	"github.com/docker/infrakit/pkg/plugin"
 )
 
 // Dir returns the directory to use for plugin discovery, which may be customized by the environment.
 func Dir() string {
-	if pluginDir := os.Getenv(PluginDirEnvVar); pluginDir != "" {
+	if pluginDir := os.Getenv(discovery.PluginDirEnvVar); pluginDir != "" {
 		return pluginDir
 	}
 
@@ -27,12 +28,12 @@ func Dir() string {
 }
 
 // NewPluginDiscovery creates a plugin discovery based on the environment configuration.
-func NewPluginDiscovery() (Plugins, error) {
+func NewPluginDiscovery() (discovery.Plugins, error) {
 	return NewPluginDiscoveryWithDirectory(Dir())
 }
 
 // NewPluginDiscoveryWithDirectory creates a plugin discovery based on the directory given.
-func NewPluginDiscoveryWithDirectory(pluginDir string) (Plugins, error) {
+func NewPluginDiscoveryWithDirectory(pluginDir string) (discovery.Plugins, error) {
 	stat, err := os.Stat(pluginDir)
 	if err == nil {
 		if !stat.IsDir() {
@@ -66,7 +67,7 @@ func (r *dirPluginDiscovery) Find(name plugin.Name) (*plugin.Endpoint, error) {
 
 	p, exists := plugins[lookup]
 	if !exists {
-		return nil, ErrNotFound(string(name))
+		return nil, discovery.ErrNotFound(string(name))
 	}
 
 	return p, nil
@@ -91,7 +92,7 @@ func (r *dirPluginDiscovery) dirLookup(entry os.FileInfo) (*plugin.Endpoint, err
 		}, nil
 	}
 
-	return nil, ErrNotUnixSocket(socketPath)
+	return nil, discovery.ErrNotUnixSocket(socketPath)
 }
 
 // List returns a list of plugins known, keyed by the name
@@ -114,7 +115,7 @@ func (r *dirPluginDiscovery) List() (map[string]*plugin.Endpoint, error) {
 			instance, err := r.dirLookup(entry)
 
 			if err != nil {
-				if !IsErrNotUnixSocket(err) {
+				if !discovery.IsErrNotUnixSocket(err) {
 					log.Warningln("Loading plugin err=", err)
 				}
 				continue
diff --git a/pkg/discovery/local/dir_test.go b/pkg/discovery/local/dir_test.go
@@ -1,4 +1,4 @@
-package discovery
+package local
 
 import (
 	"io/ioutil"
@@ -13,12 +13,6 @@ import (
 	"github.com/stretchr/testify/require"
 )
 
-func TestErrNotUnixSocket(t *testing.T) {
-	err := ErrNotUnixSocket("no socket!")
-	require.Error(t, err)
-	require.True(t, IsErrNotUnixSocket(err))
-}
-
 func blockWhileFileExists(name string) {
 	for {
 		_, err := os.Stat(name)
diff --git a/pkg/manager/manager_test.go b/pkg/manager/manager_test.go
@@ -7,7 +7,7 @@ import (
 	"testing"
 	"time"
 
-	"github.com/docker/infrakit/pkg/discovery"
+	"github.com/docker/infrakit/pkg/discovery/local"
 	"github.com/docker/infrakit/pkg/leader"
 	group_mock "github.com/docker/infrakit/pkg/mock/spi/group"
 	store_mock "github.com/docker/infrakit/pkg/mock/store"
@@ -59,7 +59,7 @@ func testEnsemble(t *testing.T,
 	configStore func(*store_mock.MockSnapshot),
 	configureGroup func(*group_mock.MockPlugin)) (Backend, server.Stoppable) {
 
-	disc, err := discovery.NewPluginDiscoveryWithDirectory(dir)
+	disc, err := local.NewPluginDiscoveryWithDirectory(dir)
 	require.NoError(t, err)
 
 	detector := &testLeaderDetector{t: t, me: id, input: leader}
diff --git a/pkg/plugin/resource/plugin.go b/pkg/plugin/resource/plugin.go
diff --git a/pkg/plugin/resource/plugin_test.go b/pkg/plugin/resource/plugin_test.go
diff --git a/pkg/rpc/mux/reverse_proxy_test.go b/pkg/rpc/mux/reverse_proxy_test.go
diff --git a/pkg/rpc/mux/server_test.go b/pkg/rpc/mux/server_test.go
