integration-cli/docker_cli_external_volume_driver_test.go
81fa9feb
 package main
 
 import (
 	"encoding/json"
 	"fmt"
9f19cbc2
 	"io"
81fa9feb
 	"io/ioutil"
 	"net/http"
 	"net/http/httptest"
 	"os"
0ef740a5
 	"os/exec"
81fa9feb
 	"path/filepath"
 	"strings"
e25352a4
 	"testing"
0ef740a5
 	"time"
81fa9feb
 
91e197d6
 	"github.com/docker/docker/api/types"
48de91a3
 	"github.com/docker/docker/integration-cli/daemon"
239a8a51
 	testdaemon "github.com/docker/docker/internal/test/daemon"
6a0bdffc
 	"github.com/docker/docker/pkg/stringid"
2f40b1b2
 	"github.com/docker/docker/volume"
6345208b
 	"gotest.tools/assert"
81fa9feb
 )
 
6a0bdffc
 const volumePluginName = "test-external-volume-driver"
 
d592778f
 type eventCounter struct {
 	activations int
 	creations   int
 	removals    int
 	mounts      int
 	unmounts    int
 	paths       int
d3eca445
 	lists       int
 	gets        int
2f40b1b2
 	caps        int
d592778f
 }
 
 type DockerExternalVolumeSuite struct {
6a0bdffc
 	ds *DockerSuite
48de91a3
 	d  *daemon.Daemon
6a0bdffc
 	*volumePlugin
81fa9feb
 }
 
64a928a3
 func (s *DockerExternalVolumeSuite) SetUpTest(c *testing.T) {
43b15e92
 	testRequires(c, testEnv.IsLocalDaemon)
239a8a51
 	s.d = daemon.New(c, dockerBinary, dockerdBinary, testdaemon.WithEnvironment(testEnv.Execution))
d592778f
 	s.ec = &eventCounter{}
81fa9feb
 }
 
64a928a3
 func (s *DockerExternalVolumeSuite) TearDownTest(c *testing.T) {
5890091c
 	if s.d != nil {
c502fb49
 		s.d.Stop(c)
5890091c
 		s.ds.TearDownTest(c)
 	}
81fa9feb
 }
 
64a928a3
 func (s *DockerExternalVolumeSuite) SetUpSuite(c *testing.T) {
6a0bdffc
 	s.volumePlugin = newVolumePlugin(c, volumePluginName)
 }
 
 type volumePlugin struct {
 	ec *eventCounter
 	*httptest.Server
 	vols map[string]vol
 }
 
 type vol struct {
 	Name       string
 	Mountpoint string
 	Ninja      bool // hack used to trigger a null volume return on `Get`
 	Status     map[string]interface{}
9a2d0bc3
 	Options    map[string]string
6a0bdffc
 }
 
 func (p *volumePlugin) Close() {
 	p.Server.Close()
 }
 
64a928a3
 func newVolumePlugin(c *testing.T, name string) *volumePlugin {
81fa9feb
 	mux := http.NewServeMux()
6a0bdffc
 	s := &volumePlugin{Server: httptest.NewServer(mux), ec: &eventCounter{}, vols: make(map[string]vol)}
81fa9feb
 
 	type pluginRequest struct {
9f19cbc2
 		Name string
96c79a19
 		Opts map[string]string
2b6bc294
 		ID   string
9f19cbc2
 	}
 
 	type pluginResp struct {
 		Mountpoint string `json:",omitempty"`
 		Err        string `json:",omitempty"`
 	}
 
 	read := func(b io.ReadCloser) (pluginRequest, error) {
 		defer b.Close()
 		var pr pluginRequest
2c187a24
 		err := json.NewDecoder(b).Decode(&pr)
 		return pr, err
9f19cbc2
 	}
 
 	send := func(w http.ResponseWriter, data interface{}) {
 		switch t := data.(type) {
 		case error:
 			http.Error(w, t.Error(), 500)
 		case string:
 			w.Header().Set("Content-Type", "application/vnd.docker.plugins.v1+json")
 			fmt.Fprintln(w, t)
 		default:
 			w.Header().Set("Content-Type", "application/vnd.docker.plugins.v1+json")
 			json.NewEncoder(w).Encode(&data)
 		}
81fa9feb
 	}
 
 	mux.HandleFunc("/Plugin.Activate", func(w http.ResponseWriter, r *http.Request) {
d592778f
 		s.ec.activations++
9f19cbc2
 		send(w, `{"Implements": ["VolumeDriver"]}`)
81fa9feb
 	})
 
 	mux.HandleFunc("/VolumeDriver.Create", func(w http.ResponseWriter, r *http.Request) {
d592778f
 		s.ec.creations++
d3eca445
 		pr, err := read(r.Body)
 		if err != nil {
 			send(w, err)
 			return
 		}
96c79a19
 		_, isNinja := pr.Opts["ninja"]
36a1c56c
 		status := map[string]interface{}{"Hello": "world"}
9a2d0bc3
 		s.vols[pr.Name] = vol{Name: pr.Name, Ninja: isNinja, Status: status, Options: pr.Opts}
d3eca445
 		send(w, nil)
 	})
d592778f
 
d3eca445
 	mux.HandleFunc("/VolumeDriver.List", func(w http.ResponseWriter, r *http.Request) {
 		s.ec.lists++
6a0bdffc
 		vols := make([]vol, 0, len(s.vols))
 		for _, v := range s.vols {
928bfd07
 			if v.Ninja {
 				continue
 			}
 			vols = append(vols, v)
 		}
 		send(w, map[string][]vol{"Volumes": vols})
d3eca445
 	})
 
 	mux.HandleFunc("/VolumeDriver.Get", func(w http.ResponseWriter, r *http.Request) {
 		s.ec.gets++
 		pr, err := read(r.Body)
9f19cbc2
 		if err != nil {
 			send(w, err)
 			return
 		}
 
6a0bdffc
 		v, exists := s.vols[pr.Name]
 		if !exists {
 			send(w, `{"Err": "no such volume"}`)
 		}
36a1c56c
 
6a0bdffc
 		if v.Ninja {
 			send(w, map[string]vol{})
 			return
d3eca445
 		}
6a0bdffc
 
 		v.Mountpoint = hostVolumePath(pr.Name)
 		send(w, map[string]vol{"Volume": v})
 		return
81fa9feb
 	})
 
 	mux.HandleFunc("/VolumeDriver.Remove", func(w http.ResponseWriter, r *http.Request) {
d592778f
 		s.ec.removals++
9f19cbc2
 		pr, err := read(r.Body)
 		if err != nil {
 			send(w, err)
 			return
 		}
d3eca445
 
6a0bdffc
 		v, ok := s.vols[pr.Name]
 		if !ok {
 			send(w, nil)
 			return
 		}
 
 		if err := os.RemoveAll(hostVolumePath(v.Name)); err != nil {
 			send(w, &pluginResp{Err: err.Error()})
 			return
d3eca445
 		}
6a0bdffc
 		delete(s.vols, v.Name)
9f19cbc2
 		send(w, nil)
81fa9feb
 	})
 
 	mux.HandleFunc("/VolumeDriver.Path", func(w http.ResponseWriter, r *http.Request) {
d592778f
 		s.ec.paths++
 
9f19cbc2
 		pr, err := read(r.Body)
 		if err != nil {
 			send(w, err)
 			return
81fa9feb
 		}
9f19cbc2
 		p := hostVolumePath(pr.Name)
d3eca445
 		send(w, &pluginResp{Mountpoint: p})
81fa9feb
 	})
 
 	mux.HandleFunc("/VolumeDriver.Mount", func(w http.ResponseWriter, r *http.Request) {
d592778f
 		s.ec.mounts++
 
9f19cbc2
 		pr, err := read(r.Body)
 		if err != nil {
 			send(w, err)
 			return
81fa9feb
 		}
 
9a2d0bc3
 		if v, exists := s.vols[pr.Name]; exists {
 			// Use this to simulate a mount failure
 			if _, exists := v.Options["invalidOption"]; exists {
 				send(w, fmt.Errorf("invalid argument"))
 				return
 			}
 		}
 
9f19cbc2
 		p := hostVolumePath(pr.Name)
81fa9feb
 		if err := os.MkdirAll(p, 0755); err != nil {
9f19cbc2
 			send(w, &pluginResp{Err: err.Error()})
 			return
81fa9feb
 		}
 
6a0bdffc
 		if err := ioutil.WriteFile(filepath.Join(p, "test"), []byte(s.Server.URL), 0644); err != nil {
9f19cbc2
 			send(w, err)
 			return
81fa9feb
 		}
 
2b6bc294
 		if err := ioutil.WriteFile(filepath.Join(p, "mountID"), []byte(pr.ID), 0644); err != nil {
 			send(w, err)
 			return
 		}
 
9f19cbc2
 		send(w, &pluginResp{Mountpoint: p})
81fa9feb
 	})
 
d592778f
 	mux.HandleFunc("/VolumeDriver.Unmount", func(w http.ResponseWriter, r *http.Request) {
 		s.ec.unmounts++
 
9f19cbc2
 		_, err := read(r.Body)
 		if err != nil {
 			send(w, err)
 			return
81fa9feb
 		}
 
d3eca445
 		send(w, nil)
81fa9feb
 	})
 
2f40b1b2
 	mux.HandleFunc("/VolumeDriver.Capabilities", func(w http.ResponseWriter, r *http.Request) {
 		s.ec.caps++
 
 		_, err := read(r.Body)
 		if err != nil {
 			send(w, err)
 			return
 		}
 
 		send(w, `{"Capabilities": { "Scope": "global" }}`)
 	})
 
a91a874f
 	err := os.MkdirAll("/etc/docker/plugins", 0755)
6345208b
 	assert.NilError(c, err)
81fa9feb
 
6a0bdffc
 	err = ioutil.WriteFile("/etc/docker/plugins/"+name+".spec", []byte(s.Server.URL), 0644)
6345208b
 	assert.NilError(c, err)
6a0bdffc
 	return s
81fa9feb
 }
 
64a928a3
 func (s *DockerExternalVolumeSuite) TearDownSuite(c *testing.T) {
6a0bdffc
 	s.volumePlugin.Close()
81fa9feb
 
a91a874f
 	err := os.RemoveAll("/etc/docker/plugins")
6345208b
 	assert.NilError(c, err)
81fa9feb
 }
 
64a928a3
 func (s *DockerExternalVolumeSuite) TestVolumeCLICreateOptionConflict(c *testing.T) {
53d447c5
 	dockerCmd(c, "volume", "create", "test")
 
 	out, _, err := dockerCmdWithError("volume", "create", "test", "--driver", volumePluginName)
2f069fa3
 	assert.Assert(c, err != nil, "volume create exception name already in use with another driver")
ed9449a4
 	assert.Assert(c, strings.Contains(out, "must be unique"))
53d447c5
 	out, _ = dockerCmd(c, "volume", "inspect", "--format={{ .Driver }}", "test")
 	_, _, err = dockerCmdWithError("volume", "create", "test", "--driver", strings.TrimSpace(out))
6345208b
 	assert.NilError(c, err)
53d447c5
 }
 
64a928a3
 func (s *DockerExternalVolumeSuite) TestExternalVolumeDriverNamed(c *testing.T) {
c502fb49
 	s.d.StartWithBusybox(c)
d592778f
 
6a0bdffc
 	out, err := s.d.Cmd("run", "--rm", "--name", "test-data", "-v", "external-volume-test:/tmp/external-volume-test", "--volume-driver", volumePluginName, "busybox:latest", "cat", "/tmp/external-volume-test/test")
6345208b
 	assert.NilError(c, err, out)
ed9449a4
 	assert.Assert(c, strings.Contains(out, s.Server.URL))
dd7d1c8a
 	_, err = s.d.Cmd("volume", "rm", "external-volume-test")
6345208b
 	assert.NilError(c, err)
dd7d1c8a
 
d592778f
 	p := hostVolumePath("external-volume-test")
 	_, err = os.Lstat(p)
6345208b
 	assert.ErrorContains(c, err, "")
4cf69b99
 	assert.Assert(c, os.IsNotExist(err), "Expected volume path in host to not exist: %s, %v\n", p, err)
d592778f
 
6dc7846d
 	assert.Equal(c, s.ec.activations, 1)
 	assert.Equal(c, s.ec.creations, 1)
 	assert.Equal(c, s.ec.removals, 1)
 	assert.Equal(c, s.ec.mounts, 1)
 	assert.Equal(c, s.ec.unmounts, 1)
d592778f
 }
 
64a928a3
 func (s *DockerExternalVolumeSuite) TestExternalVolumeDriverUnnamed(c *testing.T) {
c502fb49
 	s.d.StartWithBusybox(c)
d592778f
 
6a0bdffc
 	out, err := s.d.Cmd("run", "--rm", "--name", "test-data", "-v", "/tmp/external-volume-test", "--volume-driver", volumePluginName, "busybox:latest", "cat", "/tmp/external-volume-test/test")
6345208b
 	assert.NilError(c, err, out)
ed9449a4
 	assert.Assert(c, strings.Contains(out, s.Server.URL))
6dc7846d
 	assert.Equal(c, s.ec.activations, 1)
 	assert.Equal(c, s.ec.creations, 1)
 	assert.Equal(c, s.ec.removals, 1)
 	assert.Equal(c, s.ec.mounts, 1)
 	assert.Equal(c, s.ec.unmounts, 1)
d592778f
 }
 
64a928a3
 func (s *DockerExternalVolumeSuite) TestExternalVolumeDriverVolumesFrom(c *testing.T) {
c502fb49
 	s.d.StartWithBusybox(c)
d592778f
 
6a0bdffc
 	out, err := s.d.Cmd("run", "--name", "vol-test1", "-v", "/foo", "--volume-driver", volumePluginName, "busybox:latest")
6345208b
 	assert.NilError(c, err, out)
d592778f
 
b3b7eb27
 	out, err = s.d.Cmd("run", "--rm", "--volumes-from", "vol-test1", "--name", "vol-test2", "busybox", "ls", "/tmp")
6345208b
 	assert.NilError(c, err, out)
d592778f
 
b3b7eb27
 	out, err = s.d.Cmd("rm", "-fv", "vol-test1")
6345208b
 	assert.NilError(c, err, out)
d592778f
 
6dc7846d
 	assert.Equal(c, s.ec.activations, 1)
 	assert.Equal(c, s.ec.creations, 1)
 	assert.Equal(c, s.ec.removals, 1)
 	assert.Equal(c, s.ec.mounts, 2)
 	assert.Equal(c, s.ec.unmounts, 2)
d592778f
 }
 
64a928a3
 func (s *DockerExternalVolumeSuite) TestExternalVolumeDriverDeleteContainer(c *testing.T) {
c502fb49
 	s.d.StartWithBusybox(c)
d592778f
 
6a0bdffc
 	out, err := s.d.Cmd("run", "--name", "vol-test1", "-v", "/foo", "--volume-driver", volumePluginName, "busybox:latest")
6345208b
 	assert.NilError(c, err, out)
d592778f
 
a91a874f
 	out, err = s.d.Cmd("rm", "-fv", "vol-test1")
6345208b
 	assert.NilError(c, err, out)
d592778f
 
6dc7846d
 	assert.Equal(c, s.ec.activations, 1)
 	assert.Equal(c, s.ec.creations, 1)
 	assert.Equal(c, s.ec.removals, 1)
 	assert.Equal(c, s.ec.mounts, 1)
 	assert.Equal(c, s.ec.unmounts, 1)
d592778f
 }
 
 func hostVolumePath(name string) string {
 	return fmt.Sprintf("/var/lib/docker/volumes/%s", name)
81fa9feb
 }
6b8129d1
 
0ef740a5
 // Make sure a request to use a down driver doesn't block other requests
64a928a3
 func (s *DockerExternalVolumeSuite) TestExternalVolumeDriverLookupNotBlocked(c *testing.T) {
0ef740a5
 	specPath := "/etc/docker/plugins/down-driver.spec"
d3eca445
 	err := ioutil.WriteFile(specPath, []byte("tcp://127.0.0.7:9999"), 0644)
6345208b
 	assert.NilError(c, err)
0ef740a5
 	defer os.RemoveAll(specPath)
 
 	chCmd1 := make(chan struct{})
 	chCmd2 := make(chan error)
 	cmd1 := exec.Command(dockerBinary, "volume", "create", "-d", "down-driver")
 	cmd2 := exec.Command(dockerBinary, "volume", "create")
 
ef4c63ac
 	assert.Assert(c, cmd1.Start() == nil)
0ef740a5
 	defer cmd1.Process.Kill()
 	time.Sleep(100 * time.Millisecond) // ensure API has been called
ef4c63ac
 	assert.Assert(c, cmd2.Start() == nil)
0ef740a5
 
 	go func() {
 		cmd1.Wait()
 		close(chCmd1)
 	}()
 	go func() {
 		chCmd2 <- cmd2.Wait()
 	}()
 
 	select {
 	case <-chCmd1:
 		cmd2.Process.Kill()
 		c.Fatalf("volume create with down driver finished unexpectedly")
 	case err := <-chCmd2:
6345208b
 		assert.NilError(c, err)
0ef740a5
 	case <-time.After(5 * time.Second):
 		cmd2.Process.Kill()
d3eca445
 		c.Fatal("volume creates are blocked by previous create requests when previous driver is down")
0ef740a5
 	}
 }
d3eca445
 
64a928a3
 func (s *DockerExternalVolumeSuite) TestExternalVolumeDriverRetryNotImmediatelyExists(c *testing.T) {
c502fb49
 	s.d.StartWithBusybox(c)
4bd4d18e
 	driverName := "test-external-volume-driver-retry"
45fdce8a
 
 	errchan := make(chan error)
4bd4d18e
 	started := make(chan struct{})
45fdce8a
 	go func() {
4bd4d18e
 		close(started)
 		if out, err := s.d.Cmd("run", "--rm", "--name", "test-data-retry", "-v", "external-volume-test:/tmp/external-volume-test", "--volume-driver", driverName, "busybox:latest"); err != nil {
45fdce8a
 			errchan <- fmt.Errorf("%v:\n%s", err, out)
 		}
 		close(errchan)
 	}()
4bd4d18e
 
 	<-started
 	// wait for a retry to occur, then create spec to allow plugin to register
cbf2f4d2
 	time.Sleep(2 * time.Second)
4bd4d18e
 	p := newVolumePlugin(c, driverName)
 	defer p.Close()
45fdce8a
 
 	select {
 	case err := <-errchan:
6345208b
 		assert.NilError(c, err)
45fdce8a
 	case <-time.After(8 * time.Second):
 		c.Fatal("volume creates fail when plugin not immediately available")
 	}
 
c502fb49
 	_, err := s.d.Cmd("volume", "rm", "external-volume-test")
6345208b
 	assert.NilError(c, err)
dd7d1c8a
 
6dc7846d
 	assert.Equal(c, p.ec.activations, 1)
 	assert.Equal(c, p.ec.creations, 1)
 	assert.Equal(c, p.ec.removals, 1)
 	assert.Equal(c, p.ec.mounts, 1)
 	assert.Equal(c, p.ec.unmounts, 1)
45fdce8a
 }
39be3665
 
64a928a3
 func (s *DockerExternalVolumeSuite) TestExternalVolumeDriverBindExternalVolume(c *testing.T) {
6a0bdffc
 	dockerCmd(c, "volume", "create", "-d", volumePluginName, "foo")
39be3665
 	dockerCmd(c, "run", "-d", "--name", "testing", "-v", "foo:/bar", "busybox", "top")
 
 	var mounts []struct {
 		Name   string
 		Driver string
 	}
62a856e9
 	out := inspectFieldJSON(c, "testing", "Mounts")
ef4c63ac
 	assert.Assert(c, json.NewDecoder(strings.NewReader(out)).Decode(&mounts) == nil)
673cf751
 	assert.Equal(c, len(mounts), 1, fmt.Sprintf("%s", out))
6dc7846d
 	assert.Equal(c, mounts[0].Name, "foo")
 	assert.Equal(c, mounts[0].Driver, volumePluginName)
39be3665
 }
d3eca445
 
64a928a3
 func (s *DockerExternalVolumeSuite) TestExternalVolumeDriverList(c *testing.T) {
6a0bdffc
 	dockerCmd(c, "volume", "create", "-d", volumePluginName, "abc3")
d3eca445
 	out, _ := dockerCmd(c, "volume", "ls")
 	ls := strings.Split(strings.TrimSpace(out), "\n")
673cf751
 	assert.Equal(c, len(ls), 2, fmt.Sprintf("\n%s", out))
d3eca445
 
 	vol := strings.Fields(ls[len(ls)-1])
673cf751
 	assert.Equal(c, len(vol), 2, fmt.Sprintf("%v", vol))
6dc7846d
 	assert.Equal(c, vol[0], volumePluginName)
 	assert.Equal(c, vol[1], "abc3")
d3eca445
 
6dc7846d
 	assert.Equal(c, s.ec.lists, 1)
d3eca445
 }
 
64a928a3
 func (s *DockerExternalVolumeSuite) TestExternalVolumeDriverGet(c *testing.T) {
d3eca445
 	out, _, err := dockerCmdWithError("volume", "inspect", "dummy")
6345208b
 	assert.ErrorContains(c, err, "", out)
ed9449a4
 	assert.Assert(c, strings.Contains(out, "No such volume"))
6dc7846d
 	assert.Equal(c, s.ec.gets, 1)
36a1c56c
 
6a0bdffc
 	dockerCmd(c, "volume", "create", "test", "-d", volumePluginName)
36a1c56c
 	out, _ = dockerCmd(c, "volume", "inspect", "test")
 
 	type vol struct {
 		Status map[string]string
 	}
 	var st []vol
 
ef4c63ac
 	assert.Assert(c, json.Unmarshal([]byte(out), &st) == nil)
7b91af80
 	assert.Equal(c, len(st), 1)
673cf751
 	assert.Equal(c, len(st[0].Status), 1, fmt.Sprintf("%v", st[0]))
 	assert.Equal(c, st[0].Status["Hello"], "world", fmt.Sprintf("%v", st[0].Status))
d3eca445
 }
00ec6102
 
64a928a3
 func (s *DockerExternalVolumeSuite) TestExternalVolumeDriverWithDaemonRestart(c *testing.T) {
6a0bdffc
 	dockerCmd(c, "volume", "create", "-d", volumePluginName, "abc1")
c502fb49
 	s.d.Restart(c)
00ec6102
 
928bfd07
 	dockerCmd(c, "run", "--name=test", "-v", "abc1:/foo", "busybox", "true")
00ec6102
 	var mounts []types.MountPoint
c778f4b9
 	inspectFieldAndUnmarshall(c, "test", "Mounts", &mounts)
7b91af80
 	assert.Equal(c, len(mounts), 1)
6dc7846d
 	assert.Equal(c, mounts[0].Driver, volumePluginName)
00ec6102
 }
96c79a19
 
 // Ensures that the daemon handles when the plugin responds to a `Get` request with a null volume and a null error.
 // Prior the daemon would panic in this scenario.
64a928a3
 func (s *DockerExternalVolumeSuite) TestExternalVolumeDriverGetEmptyResponse(c *testing.T) {
c502fb49
 	s.d.Start(c)
88ea43d2
 
6a0bdffc
 	out, err := s.d.Cmd("volume", "create", "-d", volumePluginName, "abc2", "--opt", "ninja=1")
6345208b
 	assert.NilError(c, err, out)
88ea43d2
 
 	out, err = s.d.Cmd("volume", "inspect", "abc2")
6345208b
 	assert.ErrorContains(c, err, "", out)
ed9449a4
 	assert.Assert(c, strings.Contains(out, "No such volume"))
96c79a19
 }
9e6b1852
 
 // Ensure only cached paths are used in volume list to prevent N+1 calls to `VolumeDriver.Path`
e4b6adc8
 //
 // TODO(@cpuguy83): This test is testing internal implementation. In all the cases here, there may not even be a path
 // 	available because the volume is not even mounted. Consider removing this test.
64a928a3
 func (s *DockerExternalVolumeSuite) TestExternalVolumeDriverPathCalls(c *testing.T) {
c502fb49
 	s.d.Start(c)
6dc7846d
 	assert.Equal(c, s.ec.paths, 0)
9e6b1852
 
ba3f0bf0
 	out, err := s.d.Cmd("volume", "create", "test", "--driver=test-external-volume-driver")
6345208b
 	assert.NilError(c, err, out)
6dc7846d
 	assert.Equal(c, s.ec.paths, 0)
9e6b1852
 
 	out, err = s.d.Cmd("volume", "ls")
6345208b
 	assert.NilError(c, err, out)
6dc7846d
 	assert.Equal(c, s.ec.paths, 0)
9e6b1852
 }
2b6bc294
 
64a928a3
 func (s *DockerExternalVolumeSuite) TestExternalVolumeDriverMountID(c *testing.T) {
c502fb49
 	s.d.StartWithBusybox(c)
2b6bc294
 
6a0bdffc
 	out, err := s.d.Cmd("run", "--rm", "-v", "external-volume-test:/tmp/external-volume-test", "--volume-driver", volumePluginName, "busybox:latest", "cat", "/tmp/external-volume-test/test")
6345208b
 	assert.NilError(c, err, out)
 	assert.Assert(c, strings.TrimSpace(out) != "")
2b6bc294
 }
2f40b1b2
 
 // Check that VolumeDriver.Capabilities gets called, and only called once
64a928a3
 func (s *DockerExternalVolumeSuite) TestExternalVolumeDriverCapabilities(c *testing.T) {
c502fb49
 	s.d.Start(c)
6dc7846d
 	assert.Equal(c, s.ec.caps, 0)
2f40b1b2
 
 	for i := 0; i < 3; i++ {
6a0bdffc
 		out, err := s.d.Cmd("volume", "create", "-d", volumePluginName, fmt.Sprintf("test%d", i))
6345208b
 		assert.NilError(c, err, out)
6dc7846d
 		assert.Equal(c, s.ec.caps, 1)
2f40b1b2
 		out, err = s.d.Cmd("volume", "inspect", "--format={{.Scope}}", fmt.Sprintf("test%d", i))
6345208b
 		assert.NilError(c, err)
 		assert.Equal(c, strings.TrimSpace(out), volume.GlobalScope)
2f40b1b2
 	}
 }
6a0bdffc
 
64a928a3
 func (s *DockerExternalVolumeSuite) TestExternalVolumeDriverOutOfBandDelete(c *testing.T) {
510e79eb
 	driverName := stringid.GenerateRandomID()
6a0bdffc
 	p := newVolumePlugin(c, driverName)
 	defer p.Close()
 
c502fb49
 	s.d.StartWithBusybox(c)
6a0bdffc
 
 	out, err := s.d.Cmd("volume", "create", "-d", driverName, "--name", "test")
6345208b
 	assert.NilError(c, err, out)
6a0bdffc
 
 	out, err = s.d.Cmd("volume", "create", "-d", "local", "--name", "test")
6345208b
 	assert.ErrorContains(c, err, "", out)
ed9449a4
 	assert.Assert(c, strings.Contains(out, "must be unique"))
6a0bdffc
 	// simulate out of band volume deletion on plugin level
 	delete(p.vols, "test")
 
d8ce4a6e
 	// test re-create with same driver
 	out, err = s.d.Cmd("volume", "create", "-d", driverName, "--opt", "foo=bar", "--name", "test")
6345208b
 	assert.NilError(c, err, out)
d8ce4a6e
 	out, err = s.d.Cmd("volume", "inspect", "test")
6345208b
 	assert.NilError(c, err, out)
d8ce4a6e
 
 	var vs []types.Volume
 	err = json.Unmarshal([]byte(out), &vs)
6345208b
 	assert.NilError(c, err)
7b91af80
 	assert.Equal(c, len(vs), 1)
6dc7846d
 	assert.Equal(c, vs[0].Driver, driverName)
e49237dc
 	assert.Assert(c, vs[0].Options != nil)
6dc7846d
 	assert.Equal(c, vs[0].Options["foo"], "bar")
 	assert.Equal(c, vs[0].Driver, driverName)
d8ce4a6e
 
 	// simulate out of band volume deletion on plugin level
 	delete(p.vols, "test")
 
 	// test create with different driver
6a0bdffc
 	out, err = s.d.Cmd("volume", "create", "-d", "local", "--name", "test")
6345208b
 	assert.NilError(c, err, out)
d8ce4a6e
 
 	out, err = s.d.Cmd("volume", "inspect", "test")
6345208b
 	assert.NilError(c, err, out)
d8ce4a6e
 	vs = nil
 	err = json.Unmarshal([]byte(out), &vs)
6345208b
 	assert.NilError(c, err)
7b91af80
 	assert.Equal(c, len(vs), 1)
 	assert.Equal(c, len(vs[0].Options), 0)
6dc7846d
 	assert.Equal(c, vs[0].Driver, "local")
6a0bdffc
 }
9a2d0bc3
 
64a928a3
 func (s *DockerExternalVolumeSuite) TestExternalVolumeDriverUnmountOnMountFail(c *testing.T) {
c502fb49
 	s.d.StartWithBusybox(c)
9a2d0bc3
 	s.d.Cmd("volume", "create", "-d", "test-external-volume-driver", "--opt=invalidOption=1", "--name=testumount")
 
 	out, _ := s.d.Cmd("run", "-v", "testumount:/foo", "busybox", "true")
673cf751
 	assert.Equal(c, s.ec.unmounts, 0, fmt.Sprintf("%s", out))
9a2d0bc3
 	out, _ = s.d.Cmd("run", "-w", "/foo", "-v", "testumount:/foo", "busybox", "true")
673cf751
 	assert.Equal(c, s.ec.unmounts, 0, fmt.Sprintf("%s", out))
9a2d0bc3
 }
df0d317a
 
64a928a3
 func (s *DockerExternalVolumeSuite) TestExternalVolumeDriverUnmountOnCp(c *testing.T) {
df0d317a
 	s.d.StartWithBusybox(c)
 	s.d.Cmd("volume", "create", "-d", "test-external-volume-driver", "--name=test")
 
 	out, _ := s.d.Cmd("run", "-d", "--name=test", "-v", "test:/foo", "busybox", "/bin/sh", "-c", "touch /test && top")
673cf751
 	assert.Equal(c, s.ec.mounts, 1, fmt.Sprintf("%s", out))
df0d317a
 
 	out, _ = s.d.Cmd("cp", "test:/test", "/tmp/test")
673cf751
 	assert.Equal(c, s.ec.mounts, 2, fmt.Sprintf("%s", out))
 	assert.Equal(c, s.ec.unmounts, 1, fmt.Sprintf("%s", out))
df0d317a
 
 	out, _ = s.d.Cmd("kill", "test")
673cf751
 	assert.Equal(c, s.ec.unmounts, 2, fmt.Sprintf("%s", out))
df0d317a
 }