Merge pull request #3171 from corhere/plugin-interface

agent,manager,node: define our own plugin ifaces

agent/csi/plugin/manager.go

@@ -5,9 +5,8 @@ import (
 	"fmt"
 	"sync"
 
-	"github.com/docker/docker/pkg/plugingetter"
-
 	"github.com/moby/swarmkit/v2/api"
+	"github.com/moby/swarmkit/v2/node/plugin"
 )
 
 const (
@@ -35,15 +34,15 @@ type pluginManager struct {
 	// newNodePluginFunc usually points to NewNodePlugin. However, for testing,
 	// NewNodePlugin can be swapped out with a function that creates fake node
 	// plugins
-	newNodePluginFunc func(string, plugingetter.CompatPlugin, plugingetter.PluginAddr, SecretGetter) NodePlugin
+	newNodePluginFunc func(string, plugin.AddrPlugin, SecretGetter) NodePlugin
 
 	// secrets is a SecretGetter for use by node plugins.
 	secrets SecretGetter
 
-	pg plugingetter.PluginGetter
+	pg plugin.Getter
 }
 
-func NewManager(pg plugingetter.PluginGetter, secrets SecretGetter) Manager {
+func NewManager(pg plugin.Getter, secrets SecretGetter) Manager {
 	return &pluginManager{
 		plugins:           map[string]NodePlugin{},
 		newNodePluginFunc: NewNodePlugin,
@@ -104,17 +103,17 @@ func (pm *pluginManager) getPlugin(name string) (NodePlugin, error) {
 		return p, nil
 	}
 
-	pc, err := pm.pg.Get(name, DockerCSIPluginCap, plugingetter.Lookup)
+	pc, err := pm.pg.Get(name, DockerCSIPluginCap)
 	if err != nil {
 		return nil, err
 	}
 
-	pa, ok := pc.(plugingetter.PluginAddr)
+	pa, ok := pc.(plugin.AddrPlugin)
 	if !ok {
 		return nil, fmt.Errorf("plugin does not implement PluginAddr interface")
 	}
 
-	p := pm.newNodePluginFunc(name, pc, pa, pm.secrets)
+	p := pm.newNodePluginFunc(name, pa, pm.secrets)
 	pm.plugins[name] = p
 	return p, nil
 }

agent/csi/plugin/manager_test.go

@@ -18,7 +18,7 @@ var _ = Describe("Manager", func() {
 
 	BeforeEach(func() {
 		pg = &testutils.FakePluginGetter{
-			Plugins: map[string]*testutils.FakeCompatPlugin{},
+			Plugins: map[string]*testutils.FakePlugin{},
 		}
 
 		pm = &pluginManager{
@@ -27,21 +27,21 @@ var _ = Describe("Manager", func() {
 			pg:                pg,
 		}
 
-		pg.Plugins["plug1"] = &testutils.FakeCompatPlugin{
+		pg.Plugins["plug1"] = &testutils.FakePlugin{
 			PluginName: "plug1",
 			PluginAddr: &net.UnixAddr{
 				Net:  "unix",
 				Name: "",
 			},
 		}
-		pg.Plugins["plug2"] = &testutils.FakeCompatPlugin{
+		pg.Plugins["plug2"] = &testutils.FakePlugin{
 			PluginName: "plug2",
 			PluginAddr: &net.UnixAddr{
 				Net:  "unix",
 				Name: "fail",
 			},
 		}
-		pg.Plugins["plug3"] = &testutils.FakeCompatPlugin{
+		pg.Plugins["plug3"] = &testutils.FakePlugin{
 			PluginName: "plug3",
 			PluginAddr: &net.UnixAddr{
 				Net:  "unix",

agent/csi/plugin/plugin.go

@@ -11,10 +11,10 @@ import (
 	"google.golang.org/grpc/status"
 
 	"github.com/container-storage-interface/spec/lib/go/csi"
-	"github.com/docker/docker/pkg/plugingetter"
 	"github.com/moby/swarmkit/v2/api"
 	"github.com/moby/swarmkit/v2/internal/csi/capability"
 	"github.com/moby/swarmkit/v2/log"
+	"github.com/moby/swarmkit/v2/node/plugin"
 )
 
 // SecretGetter is a reimplementation of the exec.SecretGetter interface in the
@@ -88,17 +88,17 @@ const (
 	TargetPublishPath string = "/data/published"
 )
 
-func NewNodePlugin(name string, pc plugingetter.CompatPlugin, pa plugingetter.PluginAddr, secrets SecretGetter) NodePlugin {
-	return newNodePlugin(name, pc, pa, secrets)
+func NewNodePlugin(name string, p plugin.AddrPlugin, secrets SecretGetter) NodePlugin {
+	return newNodePlugin(name, p, secrets)
 }
 
 // newNodePlugin returns a raw nodePlugin object, not behind an interface. this
 // is useful for testing.
-func newNodePlugin(name string, pc plugingetter.CompatPlugin, pa plugingetter.PluginAddr, secrets SecretGetter) *nodePlugin {
+func newNodePlugin(name string, p plugin.AddrPlugin, secrets SecretGetter) *nodePlugin {
 	return &nodePlugin{
 		name:      name,
-		socket:    fmt.Sprintf("%s://%s", pa.Addr().Network(), pa.Addr().String()),
-		scopePath: pc.ScopedPath,
+		socket:    fmt.Sprintf("%s://%s", p.Addr().Network(), p.Addr().String()),
+		scopePath: p.ScopedPath,
 		secrets:   secrets,
 		volumeMap: map[string]*volumePublishStatus{},
 	}

agent/csi/plugin/plugin_fake_test.go

@@ -4,9 +4,8 @@ import (
 	"context"
 	"fmt"
 
-	"github.com/docker/docker/pkg/plugingetter"
-
 	"github.com/moby/swarmkit/v2/api"
+	mobyplugin "github.com/moby/swarmkit/v2/node/plugin"
 )
 
 // plugin_fake_test.go contains code for faking node plugins in the context of
@@ -20,7 +19,7 @@ type fakeNodePlugin struct {
 
 // newFakeNodePlugin has the same signature as NewNodePlugin, allowing it to be
 // substituted in testing.
-func newFakeNodePlugin(name string, pc plugingetter.CompatPlugin, pa plugingetter.PluginAddr, secrets SecretGetter) NodePlugin {
+func newFakeNodePlugin(name string, pa mobyplugin.AddrPlugin, secrets SecretGetter) NodePlugin {
 	return &fakeNodePlugin{
 		name:   name,
 		socket: pa.Addr().String(),

agent/csi/plugin/plugin_test.go

@@ -15,11 +15,11 @@ import (
 )
 
 func newVolumeClient(name string, nodeID string) *nodePlugin {
-	p := &testutils.FakeCompatPlugin{
+	p := &testutils.FakePlugin{
 		PluginName: name,
 		PluginAddr: &net.UnixAddr{},
 	}
-	n := newNodePlugin(name, p, p, nil)
+	n := newNodePlugin(name, p, nil)
 	n.staging = true
 
 	fakeNodeClient := newFakeNodeClient(true, nodeID)

agent/csi/volumes.go

@@ -6,12 +6,11 @@ import (
 	"sync"
 	"time"
 
-	"github.com/docker/docker/pkg/plugingetter"
-
 	"github.com/moby/swarmkit/v2/agent/csi/plugin"
 	"github.com/moby/swarmkit/v2/agent/exec"
 	"github.com/moby/swarmkit/v2/api"
 	"github.com/moby/swarmkit/v2/log"
+	mobyplugin "github.com/moby/swarmkit/v2/node/plugin"
 	"github.com/moby/swarmkit/v2/volumequeue"
 )
 
@@ -46,7 +45,7 @@ type volumes struct {
 }
 
 // NewManager returns a place to store volumes.
-func NewManager(pg plugingetter.PluginGetter, secrets exec.SecretGetter) exec.VolumesManager {
+func NewManager(pg mobyplugin.Getter, secrets exec.SecretGetter) exec.VolumesManager {
 	r := &volumes{
 		volumes:        map[string]volumeState{},
 		plugins:        plugin.NewManager(pg, secrets),

agent/dependency.go

@@ -1,13 +1,12 @@
 package agent
 
 import (
-	"github.com/docker/docker/pkg/plugingetter"
-
 	"github.com/moby/swarmkit/v2/agent/configs"
 	"github.com/moby/swarmkit/v2/agent/csi"
 	"github.com/moby/swarmkit/v2/agent/exec"
 	"github.com/moby/swarmkit/v2/agent/secrets"
 	"github.com/moby/swarmkit/v2/api"
+	"github.com/moby/swarmkit/v2/node/plugin"
 )
 
 type dependencyManager struct {
@@ -18,7 +17,7 @@ type dependencyManager struct {
 
 // NewDependencyManager creates a dependency manager object that wraps
 // objects which provide access to various dependency types.
-func NewDependencyManager(pg plugingetter.PluginGetter) exec.DependencyManager {
+func NewDependencyManager(pg plugin.Getter) exec.DependencyManager {
 	d := &dependencyManager{
 		secrets: secrets.NewManager(),
 		configs: configs.NewManager(),

agent/worker_test.go

@@ -42,7 +42,7 @@ func TestWorkerAssign(t *testing.T) {
 	defer cleanup()
 
 	pg := &testutils.FakePluginGetter{
-		Plugins: map[string]*testutils.FakeCompatPlugin{
+		Plugins: map[string]*testutils.FakePlugin{
 			"plugin-1": {
 				PluginName: "plugin-1",
 				PluginAddr: &net.UnixAddr{},
@@ -268,7 +268,7 @@ func TestWorkerWait(t *testing.T) {
 	ctx := context.Background()
 
 	pg := &testutils.FakePluginGetter{
-		Plugins: map[string]*testutils.FakeCompatPlugin{
+		Plugins: map[string]*testutils.FakePlugin{
 			"plugin-1": {
 				PluginName: "plugin-1",
 				PluginAddr: &net.UnixAddr{},
@@ -416,7 +416,7 @@ func TestWorkerUpdate(t *testing.T) {
 	ctx := context.Background()
 
 	pg := &testutils.FakePluginGetter{
-		Plugins: map[string]*testutils.FakeCompatPlugin{
+		Plugins: map[string]*testutils.FakePlugin{
 			"plugin-1": {
 				PluginName: "plugin-1",
 				PluginAddr: &net.UnixAddr{},

manager/csi/fakes_test.go

@@ -10,8 +10,8 @@ import (
 	"github.com/golang/protobuf/ptypes/wrappers"
 	"google.golang.org/grpc"
 
-	"github.com/docker/docker/pkg/plugingetter"
 	"github.com/moby/swarmkit/v2/api"
+	mobyplugin "github.com/moby/swarmkit/v2/node/plugin"
 )
 
 const (
@@ -203,11 +203,11 @@ type fakePluginMaker struct {
 	plugins map[string]*fakePlugin
 }
 
-func (fpm *fakePluginMaker) newFakePlugin(pc plugingetter.CompatPlugin, pa plugingetter.PluginAddr, provider SecretProvider) Plugin {
+func (fpm *fakePluginMaker) newFakePlugin(pa mobyplugin.AddrPlugin, provider SecretProvider) Plugin {
 	fpm.Lock()
 	defer fpm.Unlock()
 	p := &fakePlugin{
-		name:               pc.Name(),
+		name:               pa.Name(),
 		socket:             pa.Addr().String(),
 		swarmToCSI:         map[string]string{},
 		volumesCreated:     map[string]*api.Volume{},
@@ -216,7 +216,7 @@ func (fpm *fakePluginMaker) newFakePlugin(pc plugingetter.CompatPlugin, pa plugi
 		volumesUnpublished: map[string][]string{},
 		removedIDs:         map[string]struct{}{},
 	}
-	fpm.plugins[pc.Name()] = p
+	fpm.plugins[pa.Name()] = p
 	return p
 }
 

manager/csi/manager.go

@@ -7,12 +7,12 @@ import (
 	"sync"
 	"time"
 
-	"github.com/docker/docker/pkg/plugingetter"
 	"github.com/docker/go-events"
 
 	"github.com/moby/swarmkit/v2/api"
 	"github.com/moby/swarmkit/v2/log"
 	"github.com/moby/swarmkit/v2/manager/state/store"
+	mobyplugin "github.com/moby/swarmkit/v2/node/plugin"
 	"github.com/moby/swarmkit/v2/volumequeue"
 )
 
@@ -36,12 +36,12 @@ type Manager struct {
 
 	// pg is the plugingetter, which allows us to access the Docker Engine's
 	// plugin store.
-	pg plugingetter.PluginGetter
+	pg mobyplugin.Getter
 
 	// newPlugin is a function which returns an object implementing the Plugin
 	// interface. It allows us to swap out the implementation of plugins while
 	// unit-testing the Manager
-	newPlugin func(pc plugingetter.CompatPlugin, pa plugingetter.PluginAddr, provider SecretProvider) Plugin
+	newPlugin func(p mobyplugin.AddrPlugin, provider SecretProvider) Plugin
 
 	// synchronization for starting and stopping the Manager
 	startOnce sync.Once
@@ -55,7 +55,7 @@ type Manager struct {
 	pendingVolumes *volumequeue.VolumeQueue
 }
 
-func NewManager(s *store.MemoryStore, pg plugingetter.PluginGetter) *Manager {
+func NewManager(s *store.MemoryStore, pg mobyplugin.Getter) *Manager {
 	return &Manager{
 		store:          s,
 		stopChan:       make(chan struct{}),
@@ -469,7 +469,7 @@ func (vm *Manager) getPlugin(name string) (Plugin, error) {
 	}
 
 	// otherwise, we need to load the plugin.
-	pc, err := vm.pg.Get(name, DockerCSIPluginCap, plugingetter.Lookup)
+	pc, err := vm.pg.Get(name, DockerCSIPluginCap)
 	if err != nil {
 		return nil, err
 	}
@@ -478,12 +478,12 @@ func (vm *Manager) getPlugin(name string) (Plugin, error) {
 		return nil, errors.New("driver \"" + name + "\" not found")
 	}
 
-	pa, ok := pc.(plugingetter.PluginAddr)
+	pa, ok := pc.(mobyplugin.AddrPlugin)
 	if !ok {
 		return nil, errors.New("plugin for driver \"" + name + "\" does not implement PluginAddr")
 	}
 
-	p := vm.newPlugin(pc, pa, vm.provider)
+	p := vm.newPlugin(pa, vm.provider)
 	vm.plugins[name] = p
 
 	return p, nil