integration-cli/docker_cli_start_volume_driver_unix_test.go
81fa9feb
 // +build !windows
 
 package main
 
 import (
 	"encoding/json"
 	"fmt"
9f19cbc2
 	"io"
81fa9feb
 	"io/ioutil"
 	"net/http"
 	"net/http/httptest"
 	"os"
0ef740a5
 	"os/exec"
81fa9feb
 	"path/filepath"
 	"strings"
0ef740a5
 	"time"
81fa9feb
 
a91a874f
 	"github.com/docker/docker/pkg/integration/checker"
81fa9feb
 	"github.com/go-check/check"
 )
 
 func init() {
d592778f
 	check.Suite(&DockerExternalVolumeSuite{
81fa9feb
 		ds: &DockerSuite{},
 	})
 }
 
d592778f
 type eventCounter struct {
 	activations int
 	creations   int
 	removals    int
 	mounts      int
 	unmounts    int
 	paths       int
d3eca445
 	lists       int
 	gets        int
d592778f
 }
 
 type DockerExternalVolumeSuite struct {
81fa9feb
 	server *httptest.Server
 	ds     *DockerSuite
d592778f
 	d      *Daemon
 	ec     *eventCounter
81fa9feb
 }
 
d592778f
 func (s *DockerExternalVolumeSuite) SetUpTest(c *check.C) {
 	s.d = NewDaemon(c)
 	s.ec = &eventCounter{}
81fa9feb
 }
 
d592778f
 func (s *DockerExternalVolumeSuite) TearDownTest(c *check.C) {
 	s.d.Stop()
81fa9feb
 	s.ds.TearDownTest(c)
 }
 
d592778f
 func (s *DockerExternalVolumeSuite) SetUpSuite(c *check.C) {
81fa9feb
 	mux := http.NewServeMux()
 	s.server = httptest.NewServer(mux)
 
 	type pluginRequest struct {
9f19cbc2
 		Name string
 	}
 
 	type pluginResp struct {
 		Mountpoint string `json:",omitempty"`
 		Err        string `json:",omitempty"`
 	}
 
d3eca445
 	type vol struct {
 		Name       string
 		Mountpoint string
 	}
 	var volList []vol
 
9f19cbc2
 	read := func(b io.ReadCloser) (pluginRequest, error) {
 		defer b.Close()
 		var pr pluginRequest
 		if err := json.NewDecoder(b).Decode(&pr); err != nil {
 			return pr, err
 		}
 		return pr, nil
 	}
 
 	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
 		}
 		volList = append(volList, vol{Name: pr.Name})
 		send(w, nil)
 	})
d592778f
 
d3eca445
 	mux.HandleFunc("/VolumeDriver.List", func(w http.ResponseWriter, r *http.Request) {
 		s.ec.lists++
 		send(w, map[string][]vol{"Volumes": volList})
 	})
 
 	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
 		}
 
d3eca445
 		for _, v := range volList {
 			if v.Name == pr.Name {
 				v.Mountpoint = hostVolumePath(pr.Name)
 				send(w, map[string]vol{"Volume": v})
 				return
 			}
 		}
 		send(w, `{"Err": "no such volume"}`)
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
 
9f19cbc2
 		if err := os.RemoveAll(hostVolumePath(pr.Name)); err != nil {
 			send(w, &pluginResp{Err: err.Error()})
 			return
 		}
 
d3eca445
 		for i, v := range volList {
 			if v.Name == pr.Name {
 				if err := os.RemoveAll(hostVolumePath(v.Name)); err != nil {
 					send(w, fmt.Sprintf(`{"Err": "%v"}`, err))
 					return
 				}
 				volList = append(volList[:i], volList[i+1:]...)
 				break
 			}
 		}
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
 		}
 
9f19cbc2
 		p := hostVolumePath(pr.Name)
81fa9feb
 		if err := os.MkdirAll(p, 0755); err != nil {
9f19cbc2
 			send(w, &pluginResp{Err: err.Error()})
 			return
81fa9feb
 		}
 
 		if err := ioutil.WriteFile(filepath.Join(p, "test"), []byte(s.server.URL), 0644); err != nil {
9f19cbc2
 			send(w, err)
 			return
81fa9feb
 		}
 
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
 	})
 
a91a874f
 	err := os.MkdirAll("/etc/docker/plugins", 0755)
 	c.Assert(err, checker.IsNil)
81fa9feb
 
a91a874f
 	err = ioutil.WriteFile("/etc/docker/plugins/test-external-volume-driver.spec", []byte(s.server.URL), 0644)
 	c.Assert(err, checker.IsNil)
81fa9feb
 }
 
d592778f
 func (s *DockerExternalVolumeSuite) TearDownSuite(c *check.C) {
81fa9feb
 	s.server.Close()
 
a91a874f
 	err := os.RemoveAll("/etc/docker/plugins")
 	c.Assert(err, checker.IsNil)
81fa9feb
 }
 
9f19cbc2
 func (s *DockerExternalVolumeSuite) TestExternalVolumeDriverNamed(c *check.C) {
a91a874f
 	err := s.d.StartWithBusybox()
 	c.Assert(err, checker.IsNil)
d592778f
 
 	out, err := s.d.Cmd("run", "--rm", "--name", "test-data", "-v", "external-volume-test:/tmp/external-volume-test", "--volume-driver", "test-external-volume-driver", "busybox:latest", "cat", "/tmp/external-volume-test/test")
9f19cbc2
 	c.Assert(err, checker.IsNil, check.Commentf(out))
a91a874f
 	c.Assert(out, checker.Contains, s.server.URL)
d592778f
 
be311fba
 	_, err = s.d.Cmd("volume", "rm", "external-volume-test")
 	c.Assert(err, checker.IsNil)
 
d592778f
 	p := hostVolumePath("external-volume-test")
 	_, err = os.Lstat(p)
a91a874f
 	c.Assert(err, checker.NotNil)
9f19cbc2
 	c.Assert(os.IsNotExist(err), checker.True, check.Commentf("Expected volume path in host to not exist: %s, %v\n", p, err))
d592778f
 
a91a874f
 	c.Assert(s.ec.activations, checker.Equals, 1)
 	c.Assert(s.ec.creations, checker.Equals, 1)
 	c.Assert(s.ec.removals, checker.Equals, 1)
 	c.Assert(s.ec.mounts, checker.Equals, 1)
 	c.Assert(s.ec.unmounts, checker.Equals, 1)
d592778f
 }
 
9f19cbc2
 func (s *DockerExternalVolumeSuite) TestExternalVolumeDriverUnnamed(c *check.C) {
a91a874f
 	err := s.d.StartWithBusybox()
 	c.Assert(err, checker.IsNil)
d592778f
 
 	out, err := s.d.Cmd("run", "--rm", "--name", "test-data", "-v", "/tmp/external-volume-test", "--volume-driver", "test-external-volume-driver", "busybox:latest", "cat", "/tmp/external-volume-test/test")
9f19cbc2
 	c.Assert(err, checker.IsNil, check.Commentf(out))
a91a874f
 	c.Assert(out, checker.Contains, s.server.URL)
d592778f
 
a91a874f
 	c.Assert(s.ec.activations, checker.Equals, 1)
 	c.Assert(s.ec.creations, checker.Equals, 1)
 	c.Assert(s.ec.removals, checker.Equals, 1)
 	c.Assert(s.ec.mounts, checker.Equals, 1)
 	c.Assert(s.ec.unmounts, checker.Equals, 1)
d592778f
 }
 
9f19cbc2
 func (s DockerExternalVolumeSuite) TestExternalVolumeDriverVolumesFrom(c *check.C) {
a91a874f
 	err := s.d.StartWithBusybox()
 	c.Assert(err, checker.IsNil)
d592778f
 
b3b7eb27
 	out, err := s.d.Cmd("run", "-d", "--name", "vol-test1", "-v", "/foo", "--volume-driver", "test-external-volume-driver", "busybox:latest")
a91a874f
 	c.Assert(err, checker.IsNil, check.Commentf(out))
d592778f
 
b3b7eb27
 	out, err = s.d.Cmd("run", "--rm", "--volumes-from", "vol-test1", "--name", "vol-test2", "busybox", "ls", "/tmp")
a91a874f
 	c.Assert(err, checker.IsNil, check.Commentf(out))
d592778f
 
b3b7eb27
 	out, err = s.d.Cmd("rm", "-fv", "vol-test1")
a91a874f
 	c.Assert(err, checker.IsNil, check.Commentf(out))
d592778f
 
a91a874f
 	c.Assert(s.ec.activations, checker.Equals, 1)
 	c.Assert(s.ec.creations, checker.Equals, 1)
 	c.Assert(s.ec.removals, checker.Equals, 1)
 	c.Assert(s.ec.mounts, checker.Equals, 2)
 	c.Assert(s.ec.unmounts, checker.Equals, 2)
d592778f
 }
 
9f19cbc2
 func (s DockerExternalVolumeSuite) TestExternalVolumeDriverDeleteContainer(c *check.C) {
a91a874f
 	err := s.d.StartWithBusybox()
 	c.Assert(err, checker.IsNil)
d592778f
 
a91a874f
 	out, err := s.d.Cmd("run", "-d", "--name", "vol-test1", "-v", "/foo", "--volume-driver", "test-external-volume-driver", "busybox:latest")
 	c.Assert(err, checker.IsNil, check.Commentf(out))
d592778f
 
a91a874f
 	out, err = s.d.Cmd("rm", "-fv", "vol-test1")
 	c.Assert(err, checker.IsNil, check.Commentf(out))
d592778f
 
a91a874f
 	c.Assert(s.ec.activations, checker.Equals, 1)
 	c.Assert(s.ec.creations, checker.Equals, 1)
 	c.Assert(s.ec.removals, checker.Equals, 1)
 	c.Assert(s.ec.mounts, checker.Equals, 1)
 	c.Assert(s.ec.unmounts, checker.Equals, 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
9f19cbc2
 func (s *DockerExternalVolumeSuite) TestExternalVolumeDriverLookupNotBlocked(c *check.C) {
0ef740a5
 	specPath := "/etc/docker/plugins/down-driver.spec"
d3eca445
 	err := ioutil.WriteFile(specPath, []byte("tcp://127.0.0.7:9999"), 0644)
 	c.Assert(err, check.IsNil)
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")
 
a91a874f
 	c.Assert(cmd1.Start(), checker.IsNil)
0ef740a5
 	defer cmd1.Process.Kill()
 	time.Sleep(100 * time.Millisecond) // ensure API has been called
a91a874f
 	c.Assert(cmd2.Start(), checker.IsNil)
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:
a91a874f
 		c.Assert(err, checker.IsNil)
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
 
9f19cbc2
 func (s *DockerExternalVolumeSuite) TestExternalVolumeDriverRetryNotImmediatelyExists(c *check.C) {
a91a874f
 	err := s.d.StartWithBusybox()
 	c.Assert(err, checker.IsNil)
45fdce8a
 
 	specPath := "/etc/docker/plugins/test-external-volume-driver-retry.spec"
 	os.RemoveAll(specPath)
 	defer os.RemoveAll(specPath)
 
 	errchan := make(chan error)
 	go func() {
 		if out, err := s.d.Cmd("run", "--rm", "--name", "test-data-retry", "-v", "external-volume-test:/tmp/external-volume-test", "--volume-driver", "test-external-volume-driver-retry", "busybox:latest"); err != nil {
 			errchan <- fmt.Errorf("%v:\n%s", err, out)
 		}
 		close(errchan)
 	}()
 	go func() {
 		// wait for a retry to occur, then create spec to allow plugin to register
 		time.Sleep(2000 * time.Millisecond)
9f19cbc2
 		// no need to check for an error here since it will get picked up by the timeout later
 		ioutil.WriteFile(specPath, []byte(s.server.URL), 0644)
45fdce8a
 	}()
 
 	select {
 	case err := <-errchan:
a91a874f
 		c.Assert(err, checker.IsNil)
45fdce8a
 	case <-time.After(8 * time.Second):
 		c.Fatal("volume creates fail when plugin not immediately available")
 	}
 
be311fba
 	_, err = s.d.Cmd("volume", "rm", "external-volume-test")
 	c.Assert(err, checker.IsNil)
 
a91a874f
 	c.Assert(s.ec.activations, checker.Equals, 1)
 	c.Assert(s.ec.creations, checker.Equals, 1)
 	c.Assert(s.ec.removals, checker.Equals, 1)
 	c.Assert(s.ec.mounts, checker.Equals, 1)
 	c.Assert(s.ec.unmounts, checker.Equals, 1)
45fdce8a
 }
39be3665
 
9f19cbc2
 func (s *DockerExternalVolumeSuite) TestExternalVolumeDriverBindExternalVolume(c *check.C) {
39be3665
 	dockerCmd(c, "volume", "create", "-d", "test-external-volume-driver", "--name", "foo")
 	dockerCmd(c, "run", "-d", "--name", "testing", "-v", "foo:/bar", "busybox", "top")
 
 	var mounts []struct {
 		Name   string
 		Driver string
 	}
 	out, err := inspectFieldJSON("testing", "Mounts")
a91a874f
 	c.Assert(err, checker.IsNil)
 	c.Assert(json.NewDecoder(strings.NewReader(out)).Decode(&mounts), checker.IsNil)
 	c.Assert(len(mounts), checker.Equals, 1, check.Commentf(out))
 	c.Assert(mounts[0].Name, checker.Equals, "foo")
 	c.Assert(mounts[0].Driver, checker.Equals, "test-external-volume-driver")
39be3665
 }
d3eca445
 
be311fba
 func (s *DockerExternalVolumeSuite) TesttExternalVolumeDriverList(c *check.C) {
d3eca445
 	dockerCmd(c, "volume", "create", "-d", "test-external-volume-driver", "--name", "abc")
 	out, _ := dockerCmd(c, "volume", "ls")
 	ls := strings.Split(strings.TrimSpace(out), "\n")
 	c.Assert(len(ls), check.Equals, 2, check.Commentf("\n%s", out))
 
 	vol := strings.Fields(ls[len(ls)-1])
 	c.Assert(len(vol), check.Equals, 2, check.Commentf("%v", vol))
 	c.Assert(vol[0], check.Equals, "test-external-volume-driver")
 	c.Assert(vol[1], check.Equals, "abc")
 
 	c.Assert(s.ec.lists, check.Equals, 1)
 }
 
be311fba
 func (s *DockerExternalVolumeSuite) TestExternalVolumeDriverGet(c *check.C) {
d3eca445
 	out, _, err := dockerCmdWithError("volume", "inspect", "dummy")
 	c.Assert(err, check.NotNil, check.Commentf(out))
 	c.Assert(s.ec.gets, check.Equals, 1)
 	c.Assert(out, checker.Contains, "No such volume")
 }