docker_cli_volume_test.go 25 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614
  1. package main
  2. import (
  3. "context"
  4. "fmt"
  5. "os"
  6. "os/exec"
  7. "path/filepath"
  8. "strings"
  9. "testing"
  10. "github.com/docker/docker/api/types/container"
  11. "github.com/docker/docker/api/types/mount"
  12. "github.com/docker/docker/api/types/network"
  13. "github.com/docker/docker/client"
  14. "github.com/docker/docker/integration-cli/cli"
  15. "github.com/docker/docker/integration-cli/cli/build"
  16. "github.com/docker/docker/testutil"
  17. "gotest.tools/v3/assert"
  18. "gotest.tools/v3/icmd"
  19. )
  20. type DockerCLIVolumeSuite struct {
  21. ds *DockerSuite
  22. }
  23. func (s *DockerCLIVolumeSuite) TearDownTest(ctx context.Context, c *testing.T) {
  24. s.ds.TearDownTest(ctx, c)
  25. }
  26. func (s *DockerCLIVolumeSuite) OnTimeout(c *testing.T) {
  27. s.ds.OnTimeout(c)
  28. }
  29. func (s *DockerCLIVolumeSuite) TestVolumeCLICreate(c *testing.T) {
  30. cli.DockerCmd(c, "volume", "create")
  31. _, _, err := dockerCmdWithError("volume", "create", "-d", "nosuchdriver")
  32. assert.ErrorContains(c, err, "")
  33. // test using hidden --name option
  34. name := cli.DockerCmd(c, "volume", "create", "--name=test").Stdout()
  35. name = strings.TrimSpace(name)
  36. assert.Equal(c, name, "test")
  37. name = cli.DockerCmd(c, "volume", "create", "test2").Stdout()
  38. name = strings.TrimSpace(name)
  39. assert.Equal(c, name, "test2")
  40. }
  41. func (s *DockerCLIVolumeSuite) TestVolumeCLIInspect(c *testing.T) {
  42. assert.Assert(c, exec.Command(dockerBinary, "volume", "inspect", "doesnotexist").Run() != nil, "volume inspect should error on non-existent volume")
  43. name := cli.DockerCmd(c, "volume", "create").Stdout()
  44. name = strings.TrimSpace(name)
  45. out := cli.DockerCmd(c, "volume", "inspect", "--format={{ .Name }}", name).Stdout()
  46. assert.Equal(c, strings.TrimSpace(out), name)
  47. cli.DockerCmd(c, "volume", "create", "test")
  48. out = cli.DockerCmd(c, "volume", "inspect", "--format={{ .Name }}", "test").Stdout()
  49. assert.Equal(c, strings.TrimSpace(out), "test")
  50. }
  51. func (s *DockerCLIVolumeSuite) TestVolumeCLIInspectMulti(c *testing.T) {
  52. cli.DockerCmd(c, "volume", "create", "test1")
  53. cli.DockerCmd(c, "volume", "create", "test2")
  54. cli.DockerCmd(c, "volume", "create", "test3")
  55. result := dockerCmdWithResult("volume", "inspect", "--format={{ .Name }}", "test1", "test2", "doesnotexist", "test3")
  56. result.Assert(c, icmd.Expected{
  57. ExitCode: 1,
  58. Err: "No such volume: doesnotexist",
  59. })
  60. out := result.Stdout()
  61. assert.Assert(c, strings.Contains(out, "test1"))
  62. assert.Assert(c, strings.Contains(out, "test2"))
  63. assert.Assert(c, strings.Contains(out, "test3"))
  64. }
  65. func (s *DockerCLIVolumeSuite) TestVolumeCLILs(c *testing.T) {
  66. prefix, _ := getPrefixAndSlashFromDaemonPlatform()
  67. cli.DockerCmd(c, "volume", "create", "aaa")
  68. cli.DockerCmd(c, "volume", "create", "test")
  69. cli.DockerCmd(c, "volume", "create", "soo")
  70. cli.DockerCmd(c, "run", "-v", "soo:"+prefix+"/foo", "busybox", "ls", "/")
  71. out := cli.DockerCmd(c, "volume", "ls", "-q").Stdout()
  72. assertVolumesInList(c, out, []string{"aaa", "soo", "test"})
  73. }
  74. func (s *DockerCLIVolumeSuite) TestVolumeLsFormat(c *testing.T) {
  75. cli.DockerCmd(c, "volume", "create", "aaa")
  76. cli.DockerCmd(c, "volume", "create", "test")
  77. cli.DockerCmd(c, "volume", "create", "soo")
  78. out := cli.DockerCmd(c, "volume", "ls", "--format", "{{.Name}}").Stdout()
  79. assertVolumesInList(c, out, []string{"aaa", "soo", "test"})
  80. }
  81. func (s *DockerCLIVolumeSuite) TestVolumeLsFormatDefaultFormat(c *testing.T) {
  82. cli.DockerCmd(c, "volume", "create", "aaa")
  83. cli.DockerCmd(c, "volume", "create", "test")
  84. cli.DockerCmd(c, "volume", "create", "soo")
  85. const config = `{
  86. "volumesFormat": "{{ .Name }} default"
  87. }`
  88. d, err := os.MkdirTemp("", "integration-cli-")
  89. assert.NilError(c, err)
  90. defer os.RemoveAll(d)
  91. err = os.WriteFile(filepath.Join(d, "config.json"), []byte(config), 0o644)
  92. assert.NilError(c, err)
  93. out := cli.DockerCmd(c, "--config", d, "volume", "ls").Stdout()
  94. assertVolumesInList(c, out, []string{"aaa default", "soo default", "test default"})
  95. }
  96. func assertVolumesInList(c *testing.T, out string, expected []string) {
  97. lines := strings.Split(strings.TrimSpace(out), "\n")
  98. for _, expect := range expected {
  99. found := false
  100. for _, v := range lines {
  101. found = v == expect
  102. if found {
  103. break
  104. }
  105. }
  106. assert.Assert(c, found, "Expected volume not found: %v, got: %v", expect, lines)
  107. }
  108. }
  109. func (s *DockerCLIVolumeSuite) TestVolumeCLILsFilterDangling(c *testing.T) {
  110. prefix, _ := getPrefixAndSlashFromDaemonPlatform()
  111. cli.DockerCmd(c, "volume", "create", "testnotinuse1")
  112. cli.DockerCmd(c, "volume", "create", "testisinuse1")
  113. cli.DockerCmd(c, "volume", "create", "testisinuse2")
  114. // Make sure both "created" (but not started), and started
  115. // containers are included in reference counting
  116. cli.DockerCmd(c, "run", "--name", "volume-test1", "-v", "testisinuse1:"+prefix+"/foo", "busybox", "true")
  117. cli.DockerCmd(c, "create", "--name", "volume-test2", "-v", "testisinuse2:"+prefix+"/foo", "busybox", "true")
  118. // No filter, all volumes should show
  119. out := cli.DockerCmd(c, "volume", "ls").Stdout()
  120. assert.Assert(c, strings.Contains(out, "testnotinuse1\n"), "expected volume 'testnotinuse1' in output")
  121. assert.Assert(c, strings.Contains(out, "testisinuse1\n"), "expected volume 'testisinuse1' in output")
  122. assert.Assert(c, strings.Contains(out, "testisinuse2\n"), "expected volume 'testisinuse2' in output")
  123. // Explicitly disabling dangling
  124. out = cli.DockerCmd(c, "volume", "ls", "--filter", "dangling=false").Stdout()
  125. assert.Assert(c, !strings.Contains(out, "testnotinuse1\n"), "expected volume 'testnotinuse1' in output")
  126. assert.Assert(c, strings.Contains(out, "testisinuse1\n"), "expected volume 'testisinuse1' in output")
  127. assert.Assert(c, strings.Contains(out, "testisinuse2\n"), "expected volume 'testisinuse2' in output")
  128. // Filter "dangling" volumes; only "dangling" (unused) volumes should be in the output
  129. out = cli.DockerCmd(c, "volume", "ls", "--filter", "dangling=true").Stdout()
  130. assert.Assert(c, strings.Contains(out, "testnotinuse1\n"), "expected volume 'testnotinuse1' in output")
  131. assert.Assert(c, !strings.Contains(out, "testisinuse1\n"), "volume 'testisinuse1' in output, but not expected")
  132. assert.Assert(c, !strings.Contains(out, "testisinuse2\n"), "volume 'testisinuse2' in output, but not expected")
  133. // Filter "dangling" volumes; only "dangling" (unused) volumes should be in the output, dangling also accept 1
  134. out = cli.DockerCmd(c, "volume", "ls", "--filter", "dangling=1").Stdout()
  135. assert.Assert(c, strings.Contains(out, "testnotinuse1\n"), "expected volume 'testnotinuse1' in output")
  136. assert.Assert(c, !strings.Contains(out, "testisinuse1\n"), "volume 'testisinuse1' in output, but not expected")
  137. assert.Assert(c, !strings.Contains(out, "testisinuse2\n"), "volume 'testisinuse2' in output, but not expected")
  138. // dangling=0 is same as dangling=false case
  139. out = cli.DockerCmd(c, "volume", "ls", "--filter", "dangling=0").Stdout()
  140. assert.Assert(c, !strings.Contains(out, "testnotinuse1\n"), "expected volume 'testnotinuse1' in output")
  141. assert.Assert(c, strings.Contains(out, "testisinuse1\n"), "expected volume 'testisinuse1' in output")
  142. assert.Assert(c, strings.Contains(out, "testisinuse2\n"), "expected volume 'testisinuse2' in output")
  143. out = cli.DockerCmd(c, "volume", "ls", "--filter", "name=testisin").Stdout()
  144. assert.Assert(c, !strings.Contains(out, "testnotinuse1\n"), "expected volume 'testnotinuse1' in output")
  145. assert.Assert(c, strings.Contains(out, "testisinuse1\n"), "expected volume 'testisinuse1' in output")
  146. assert.Assert(c, strings.Contains(out, "testisinuse2\n"), "expected volume 'testisinuse2' in output")
  147. }
  148. func (s *DockerCLIVolumeSuite) TestVolumeCLILsErrorWithInvalidFilterName(c *testing.T) {
  149. out, _, err := dockerCmdWithError("volume", "ls", "-f", "FOO=123")
  150. assert.ErrorContains(c, err, "")
  151. assert.Assert(c, strings.Contains(out, "invalid filter"))
  152. }
  153. func (s *DockerCLIVolumeSuite) TestVolumeCLILsWithIncorrectFilterValue(c *testing.T) {
  154. out, _, err := dockerCmdWithError("volume", "ls", "-f", "dangling=invalid")
  155. assert.ErrorContains(c, err, "")
  156. assert.Assert(c, strings.Contains(out, "invalid filter"))
  157. }
  158. func (s *DockerCLIVolumeSuite) TestVolumeCLIRm(c *testing.T) {
  159. prefix, _ := getPrefixAndSlashFromDaemonPlatform()
  160. id := cli.DockerCmd(c, "volume", "create").Stdout()
  161. id = strings.TrimSpace(id)
  162. cli.DockerCmd(c, "volume", "create", "test")
  163. cli.DockerCmd(c, "volume", "rm", id)
  164. cli.DockerCmd(c, "volume", "rm", "test")
  165. volumeID := "testing"
  166. cli.DockerCmd(c, "run", "-v", volumeID+":"+prefix+"/foo", "--name=test", "busybox", "sh", "-c", "echo hello > /foo/bar")
  167. icmd.RunCommand(dockerBinary, "volume", "rm", "testing").Assert(c, icmd.Expected{
  168. ExitCode: 1,
  169. Error: "exit status 1",
  170. })
  171. out := cli.DockerCmd(c, "run", "--volumes-from=test", "--name=test2", "busybox", "sh", "-c", "cat /foo/bar").Combined()
  172. assert.Equal(c, strings.TrimSpace(out), "hello")
  173. cli.DockerCmd(c, "rm", "-fv", "test2")
  174. cli.DockerCmd(c, "volume", "inspect", volumeID)
  175. cli.DockerCmd(c, "rm", "-f", "test")
  176. out = cli.DockerCmd(c, "run", "--name=test2", "-v", volumeID+":"+prefix+"/foo", "busybox", "sh", "-c", "cat /foo/bar").Combined()
  177. assert.Equal(c, strings.TrimSpace(out), "hello", "volume data was removed")
  178. cli.DockerCmd(c, "rm", "test2")
  179. cli.DockerCmd(c, "volume", "rm", volumeID)
  180. assert.Assert(c, exec.Command("volume", "rm", "doesnotexist").Run() != nil, "volume rm should fail with non-existent volume")
  181. }
  182. // FIXME(vdemeester) should be a unit test in cli/command/volume package
  183. func (s *DockerCLIVolumeSuite) TestVolumeCLINoArgs(c *testing.T) {
  184. out := cli.DockerCmd(c, "volume").Combined()
  185. // no args should produce the cmd usage output
  186. usage := "Usage: docker volume COMMAND"
  187. assert.Assert(c, strings.Contains(out, usage))
  188. // invalid arg should error and show the command usage on stderr
  189. icmd.RunCommand(dockerBinary, "volume", "somearg").Assert(c, icmd.Expected{
  190. ExitCode: 1,
  191. Error: "exit status 1",
  192. Err: usage,
  193. })
  194. // invalid flag should error and show the flag error and cmd usage
  195. result := icmd.RunCommand(dockerBinary, "volume", "--no-such-flag")
  196. result.Assert(c, icmd.Expected{
  197. ExitCode: 125,
  198. Error: "exit status 125",
  199. Err: usage,
  200. })
  201. assert.Assert(c, strings.Contains(result.Stderr(), "unknown flag: --no-such-flag"))
  202. }
  203. func (s *DockerCLIVolumeSuite) TestVolumeCLIInspectTmplError(c *testing.T) {
  204. name := cli.DockerCmd(c, "volume", "create").Stdout()
  205. name = strings.TrimSpace(name)
  206. out, exitCode, err := dockerCmdWithError("volume", "inspect", "--format='{{ .FooBar }}'", name)
  207. assert.Assert(c, err != nil, "Output: %s", out)
  208. assert.Equal(c, exitCode, 1, fmt.Sprintf("Output: %s", out))
  209. assert.Assert(c, strings.Contains(out, "Template parsing error"))
  210. }
  211. func (s *DockerCLIVolumeSuite) TestVolumeCLICreateWithOpts(c *testing.T) {
  212. testRequires(c, DaemonIsLinux)
  213. cli.DockerCmd(c, "volume", "create", "-d", "local", "test", "--opt=type=tmpfs", "--opt=device=tmpfs", "--opt=o=size=1m,uid=1000")
  214. out := cli.DockerCmd(c, "run", "-v", "test:/foo", "busybox", "mount").Stdout()
  215. mounts := strings.Split(out, "\n")
  216. var found bool
  217. for _, m := range mounts {
  218. if strings.Contains(m, "/foo") {
  219. found = true
  220. info := strings.Fields(m)
  221. // tmpfs on <path> type tmpfs (rw,relatime,size=1024k,uid=1000)
  222. assert.Equal(c, info[0], "tmpfs")
  223. assert.Equal(c, info[2], "/foo")
  224. assert.Equal(c, info[4], "tmpfs")
  225. assert.Assert(c, strings.Contains(info[5], "uid=1000"))
  226. assert.Assert(c, strings.Contains(info[5], "size=1024k"))
  227. break
  228. }
  229. }
  230. assert.Equal(c, found, true)
  231. }
  232. func (s *DockerCLIVolumeSuite) TestVolumeCLICreateLabel(c *testing.T) {
  233. const testVol = "testvolcreatelabel"
  234. const testLabel = "foo"
  235. const testValue = "bar"
  236. _, _, err := dockerCmdWithError("volume", "create", "--label", testLabel+"="+testValue, testVol)
  237. assert.NilError(c, err)
  238. out := cli.DockerCmd(c, "volume", "inspect", "--format={{ .Labels."+testLabel+" }}", testVol).Stdout()
  239. assert.Equal(c, strings.TrimSpace(out), testValue)
  240. }
  241. func (s *DockerCLIVolumeSuite) TestVolumeCLICreateLabelMultiple(c *testing.T) {
  242. const testVol = "testvolcreatelabel"
  243. testLabels := map[string]string{
  244. "foo": "bar",
  245. "baz": "foo",
  246. }
  247. args := []string{
  248. "volume",
  249. "create",
  250. testVol,
  251. }
  252. for k, v := range testLabels {
  253. args = append(args, "--label", k+"="+v)
  254. }
  255. _, _, err := dockerCmdWithError(args...)
  256. assert.NilError(c, err)
  257. for k, v := range testLabels {
  258. out := cli.DockerCmd(c, "volume", "inspect", "--format={{ .Labels."+k+" }}", testVol).Stdout()
  259. assert.Equal(c, strings.TrimSpace(out), v)
  260. }
  261. }
  262. func (s *DockerCLIVolumeSuite) TestVolumeCLILsFilterLabels(c *testing.T) {
  263. testVol1 := "testvolcreatelabel-1"
  264. _, _, err := dockerCmdWithError("volume", "create", "--label", "foo=bar1", testVol1)
  265. assert.NilError(c, err)
  266. testVol2 := "testvolcreatelabel-2"
  267. _, _, err = dockerCmdWithError("volume", "create", "--label", "foo=bar2", testVol2)
  268. assert.NilError(c, err)
  269. // filter with label=key
  270. out := cli.DockerCmd(c, "volume", "ls", "--filter", "label=foo").Stdout()
  271. assert.Assert(c, strings.Contains(out, "testvolcreatelabel-1\n"), "expected volume 'testvolcreatelabel-1' in output")
  272. assert.Assert(c, strings.Contains(out, "testvolcreatelabel-2\n"), "expected volume 'testvolcreatelabel-2' in output")
  273. // filter with label=key=value
  274. out = cli.DockerCmd(c, "volume", "ls", "--filter", "label=foo=bar1").Stdout()
  275. assert.Assert(c, strings.Contains(out, "testvolcreatelabel-1\n"), "expected volume 'testvolcreatelabel-1' in output")
  276. assert.Assert(c, !strings.Contains(out, "testvolcreatelabel-2\n"), "expected volume 'testvolcreatelabel-2 in output")
  277. out = cli.DockerCmd(c, "volume", "ls", "--filter", "label=non-exist").Stdout()
  278. outArr := strings.Split(strings.TrimSpace(out), "\n")
  279. assert.Equal(c, len(outArr), 1, fmt.Sprintf("\n%s", out))
  280. out = cli.DockerCmd(c, "volume", "ls", "--filter", "label=foo=non-exist").Stdout()
  281. outArr = strings.Split(strings.TrimSpace(out), "\n")
  282. assert.Equal(c, len(outArr), 1, fmt.Sprintf("\n%s", out))
  283. }
  284. func (s *DockerCLIVolumeSuite) TestVolumeCLILsFilterDrivers(c *testing.T) {
  285. // using default volume driver local to create volumes
  286. testVol1 := "testvol-1"
  287. _, _, err := dockerCmdWithError("volume", "create", testVol1)
  288. assert.NilError(c, err)
  289. testVol2 := "testvol-2"
  290. _, _, err = dockerCmdWithError("volume", "create", testVol2)
  291. assert.NilError(c, err)
  292. // filter with driver=local
  293. out := cli.DockerCmd(c, "volume", "ls", "--filter", "driver=local").Stdout()
  294. assert.Assert(c, strings.Contains(out, "testvol-1\n"), "expected volume 'testvol-1' in output")
  295. assert.Assert(c, strings.Contains(out, "testvol-2\n"), "expected volume 'testvol-2' in output")
  296. // filter with driver=invaliddriver
  297. out = cli.DockerCmd(c, "volume", "ls", "--filter", "driver=invaliddriver").Stdout()
  298. outArr := strings.Split(strings.TrimSpace(out), "\n")
  299. assert.Equal(c, len(outArr), 1, fmt.Sprintf("\n%s", out))
  300. // filter with driver=loca
  301. out = cli.DockerCmd(c, "volume", "ls", "--filter", "driver=loca").Stdout()
  302. outArr = strings.Split(strings.TrimSpace(out), "\n")
  303. assert.Equal(c, len(outArr), 1, fmt.Sprintf("\n%s", out))
  304. // filter with driver=
  305. out = cli.DockerCmd(c, "volume", "ls", "--filter", "driver=").Stdout()
  306. outArr = strings.Split(strings.TrimSpace(out), "\n")
  307. assert.Equal(c, len(outArr), 1, fmt.Sprintf("\n%s", out))
  308. }
  309. func (s *DockerCLIVolumeSuite) TestVolumeCLIRmForceUsage(c *testing.T) {
  310. id := cli.DockerCmd(c, "volume", "create").Stdout()
  311. id = strings.TrimSpace(id)
  312. cli.DockerCmd(c, "volume", "rm", "-f", id)
  313. cli.DockerCmd(c, "volume", "rm", "--force", "nonexist")
  314. }
  315. func (s *DockerCLIVolumeSuite) TestVolumeCLIRmForce(c *testing.T) {
  316. testRequires(c, testEnv.IsLocalDaemon, DaemonIsLinux)
  317. const name = "test"
  318. id := cli.DockerCmd(c, "volume", "create", name).Stdout()
  319. id = strings.TrimSpace(id)
  320. assert.Equal(c, id, name)
  321. out := cli.DockerCmd(c, "volume", "inspect", "--format", "{{.Mountpoint}}", name).Stdout()
  322. assert.Assert(c, strings.TrimSpace(out) != "")
  323. // Mountpoint is in the form of "/var/lib/docker/volumes/.../_data", removing `/_data`
  324. path := strings.TrimSuffix(strings.TrimSpace(out), "/_data")
  325. icmd.RunCommand("rm", "-rf", path).Assert(c, icmd.Success)
  326. cli.DockerCmd(c, "volume", "rm", "-f", name)
  327. out = cli.DockerCmd(c, "volume", "ls").Stdout()
  328. assert.Assert(c, !strings.Contains(out, name))
  329. cli.DockerCmd(c, "volume", "create", name)
  330. out = cli.DockerCmd(c, "volume", "ls").Stdout()
  331. assert.Assert(c, strings.Contains(out, name))
  332. }
  333. // TestVolumeCLIRmForceInUse verifies that repeated `docker volume rm -f` calls does not remove a volume
  334. // if it is in use. Test case for https://github.com/docker/docker/issues/31446
  335. func (s *DockerCLIVolumeSuite) TestVolumeCLIRmForceInUse(c *testing.T) {
  336. const name = "testvolume"
  337. id := cli.DockerCmd(c, "volume", "create", name).Stdout()
  338. id = strings.TrimSpace(id)
  339. assert.Equal(c, id, name)
  340. prefix, slash := getPrefixAndSlashFromDaemonPlatform()
  341. cid := cli.DockerCmd(c, "create", "-v", "testvolume:"+prefix+slash+"foo", "busybox").Stdout()
  342. cid = strings.TrimSpace(cid)
  343. _, _, err := dockerCmdWithError("volume", "rm", "-f", name)
  344. assert.ErrorContains(c, err, "")
  345. assert.ErrorContains(c, err, "volume is in use")
  346. out := cli.DockerCmd(c, "volume", "ls").Stdout()
  347. assert.Assert(c, strings.Contains(out, name))
  348. // The original issue did not _remove_ the volume from the list
  349. // the first time. But a second call to `volume rm` removed it.
  350. // Calling `volume rm` a second time to confirm it's not removed
  351. // when calling twice.
  352. _, _, err = dockerCmdWithError("volume", "rm", "-f", name)
  353. assert.ErrorContains(c, err, "")
  354. assert.ErrorContains(c, err, "volume is in use")
  355. out = cli.DockerCmd(c, "volume", "ls").Stdout()
  356. assert.Assert(c, strings.Contains(out, name))
  357. // Verify removing the volume after the container is removed works
  358. e := cli.DockerCmd(c, "rm", cid).ExitCode
  359. assert.Equal(c, e, 0)
  360. e = cli.DockerCmd(c, "volume", "rm", "-f", name).ExitCode
  361. assert.Equal(c, e, 0)
  362. result := cli.DockerCmd(c, "volume", "ls")
  363. assert.Equal(c, result.ExitCode, 0)
  364. assert.Assert(c, !strings.Contains(result.Stdout(), name))
  365. }
  366. func (s *DockerCLIVolumeSuite) TestVolumeCliInspectWithVolumeOpts(c *testing.T) {
  367. testRequires(c, DaemonIsLinux)
  368. // Without options
  369. name := "test1"
  370. cli.DockerCmd(c, "volume", "create", "-d", "local", name)
  371. out := cli.DockerCmd(c, "volume", "inspect", "--format={{ .Options }}", name).Stdout()
  372. assert.Assert(c, strings.Contains(strings.TrimSpace(out), "map[]"))
  373. // With options
  374. name = "test2"
  375. k1, v1 := "type", "tmpfs"
  376. k2, v2 := "device", "tmpfs"
  377. k3, v3 := "o", "size=1m,uid=1000"
  378. cli.DockerCmd(c, "volume", "create", "-d", "local", name, "--opt", fmt.Sprintf("%s=%s", k1, v1), "--opt", fmt.Sprintf("%s=%s", k2, v2), "--opt", fmt.Sprintf("%s=%s", k3, v3))
  379. out = cli.DockerCmd(c, "volume", "inspect", "--format={{ .Options }}", name).Stdout()
  380. assert.Assert(c, strings.Contains(strings.TrimSpace(out), fmt.Sprintf("%s:%s", k1, v1)))
  381. assert.Assert(c, strings.Contains(strings.TrimSpace(out), fmt.Sprintf("%s:%s", k2, v2)))
  382. assert.Assert(c, strings.Contains(strings.TrimSpace(out), fmt.Sprintf("%s:%s", k3, v3)))
  383. }
  384. // Test case (1) for 21845: duplicate targets for --volumes-from
  385. func (s *DockerCLIVolumeSuite) TestDuplicateMountpointsForVolumesFrom(c *testing.T) {
  386. testRequires(c, DaemonIsLinux)
  387. const image = "vimage"
  388. buildImageSuccessfully(c, image, build.WithDockerfile(`
  389. FROM busybox
  390. VOLUME ["/tmp/data"]`))
  391. cli.DockerCmd(c, "run", "--name=data1", image, "true")
  392. cli.DockerCmd(c, "run", "--name=data2", image, "true")
  393. data1 := cli.DockerCmd(c, "inspect", "--format", "{{(index .Mounts 0).Name}}", "data1").Stdout()
  394. data1 = strings.TrimSpace(data1)
  395. assert.Assert(c, data1 != "")
  396. data2 := cli.DockerCmd(c, "inspect", "--format", "{{(index .Mounts 0).Name}}", "data2").Stdout()
  397. data2 = strings.TrimSpace(data2)
  398. assert.Assert(c, data2 != "")
  399. // Both volume should exist
  400. out := cli.DockerCmd(c, "volume", "ls", "-q").Stdout()
  401. assert.Assert(c, strings.Contains(strings.TrimSpace(out), data1))
  402. assert.Assert(c, strings.Contains(strings.TrimSpace(out), data2))
  403. out, _, err := dockerCmdWithError("run", "--name=app", "--volumes-from=data1", "--volumes-from=data2", "-d", "busybox", "top")
  404. assert.Assert(c, err == nil, "Out: %s", out)
  405. // Only the second volume will be referenced, this is backward compatible
  406. out = cli.DockerCmd(c, "inspect", "--format", "{{(index .Mounts 0).Name}}", "app").Stdout()
  407. assert.Equal(c, strings.TrimSpace(out), data2)
  408. cli.DockerCmd(c, "rm", "-f", "-v", "app")
  409. cli.DockerCmd(c, "rm", "-f", "-v", "data1")
  410. cli.DockerCmd(c, "rm", "-f", "-v", "data2")
  411. // Both volume should not exist
  412. out = cli.DockerCmd(c, "volume", "ls", "-q").Stdout()
  413. assert.Assert(c, !strings.Contains(strings.TrimSpace(out), data1))
  414. assert.Assert(c, !strings.Contains(strings.TrimSpace(out), data2))
  415. }
  416. // Test case (2) for 21845: duplicate targets for --volumes-from and -v (bind)
  417. func (s *DockerCLIVolumeSuite) TestDuplicateMountpointsForVolumesFromAndBind(c *testing.T) {
  418. testRequires(c, DaemonIsLinux)
  419. const image = "vimage"
  420. buildImageSuccessfully(c, image, build.WithDockerfile(`
  421. FROM busybox
  422. VOLUME ["/tmp/data"]`))
  423. cli.DockerCmd(c, "run", "--name=data1", image, "true")
  424. cli.DockerCmd(c, "run", "--name=data2", image, "true")
  425. data1 := cli.DockerCmd(c, "inspect", "--format", "{{(index .Mounts 0).Name}}", "data1").Stdout()
  426. data1 = strings.TrimSpace(data1)
  427. assert.Assert(c, data1 != "")
  428. data2 := cli.DockerCmd(c, "inspect", "--format", "{{(index .Mounts 0).Name}}", "data2").Stdout()
  429. data2 = strings.TrimSpace(data2)
  430. assert.Assert(c, data2 != "")
  431. // Both volume should exist
  432. out := cli.DockerCmd(c, "volume", "ls", "-q").Stdout()
  433. assert.Assert(c, strings.Contains(strings.TrimSpace(out), data1))
  434. assert.Assert(c, strings.Contains(strings.TrimSpace(out), data2))
  435. // /tmp/data is automatically created, because we are not using the modern mount API here
  436. out, _, err := dockerCmdWithError("run", "--name=app", "--volumes-from=data1", "--volumes-from=data2", "-v", "/tmp/data:/tmp/data", "-d", "busybox", "top")
  437. assert.Assert(c, err == nil, "Out: %s", out)
  438. // No volume will be referenced (mount is /tmp/data), this is backward compatible
  439. out = cli.DockerCmd(c, "inspect", "--format", "{{(index .Mounts 0).Name}}", "app").Stdout()
  440. assert.Assert(c, !strings.Contains(strings.TrimSpace(out), data1))
  441. assert.Assert(c, !strings.Contains(strings.TrimSpace(out), data2))
  442. cli.DockerCmd(c, "rm", "-f", "-v", "app")
  443. cli.DockerCmd(c, "rm", "-f", "-v", "data1")
  444. cli.DockerCmd(c, "rm", "-f", "-v", "data2")
  445. // Both volume should not exist
  446. out = cli.DockerCmd(c, "volume", "ls", "-q").Stdout()
  447. assert.Assert(c, !strings.Contains(strings.TrimSpace(out), data1))
  448. assert.Assert(c, !strings.Contains(strings.TrimSpace(out), data2))
  449. }
  450. // Test case (3) for 21845: duplicate targets for --volumes-from and `Mounts` (API only)
  451. func (s *DockerCLIVolumeSuite) TestDuplicateMountpointsForVolumesFromAndMounts(c *testing.T) {
  452. testRequires(c, testEnv.IsLocalDaemon, DaemonIsLinux)
  453. const image = "vimage"
  454. buildImageSuccessfully(c, image, build.WithDockerfile(`
  455. FROM busybox
  456. VOLUME ["/tmp/data"]`))
  457. cli.DockerCmd(c, "run", "--name=data1", image, "true")
  458. cli.DockerCmd(c, "run", "--name=data2", image, "true")
  459. data1 := cli.DockerCmd(c, "inspect", "--format", "{{(index .Mounts 0).Name}}", "data1").Stdout()
  460. data1 = strings.TrimSpace(data1)
  461. assert.Assert(c, data1 != "")
  462. data2 := cli.DockerCmd(c, "inspect", "--format", "{{(index .Mounts 0).Name}}", "data2").Stdout()
  463. data2 = strings.TrimSpace(data2)
  464. assert.Assert(c, data2 != "")
  465. // Both volume should exist
  466. out := cli.DockerCmd(c, "volume", "ls", "-q").Stdout()
  467. assert.Assert(c, strings.Contains(strings.TrimSpace(out), data1))
  468. assert.Assert(c, strings.Contains(strings.TrimSpace(out), data2))
  469. err := os.MkdirAll("/tmp/data", 0o755)
  470. assert.NilError(c, err)
  471. // Mounts is available in API
  472. apiClient, err := client.NewClientWithOpts(client.FromEnv)
  473. assert.NilError(c, err)
  474. defer apiClient.Close()
  475. config := container.Config{
  476. Cmd: []string{"top"},
  477. Image: "busybox",
  478. }
  479. hostConfig := container.HostConfig{
  480. VolumesFrom: []string{"data1", "data2"},
  481. Mounts: []mount.Mount{
  482. {
  483. Type: "bind",
  484. Source: "/tmp/data",
  485. Target: "/tmp/data",
  486. },
  487. },
  488. }
  489. _, err = apiClient.ContainerCreate(testutil.GetContext(c), &config, &hostConfig, &network.NetworkingConfig{}, nil, "app")
  490. assert.NilError(c, err)
  491. // No volume will be referenced (mount is /tmp/data), this is backward compatible
  492. out = cli.DockerCmd(c, "inspect", "--format", "{{(index .Mounts 0).Name}}", "app").Stdout()
  493. assert.Assert(c, !strings.Contains(strings.TrimSpace(out), data1))
  494. assert.Assert(c, !strings.Contains(strings.TrimSpace(out), data2))
  495. cli.DockerCmd(c, "rm", "-f", "-v", "app")
  496. cli.DockerCmd(c, "rm", "-f", "-v", "data1")
  497. cli.DockerCmd(c, "rm", "-f", "-v", "data2")
  498. // Both volume should not exist
  499. out = cli.DockerCmd(c, "volume", "ls", "-q").Stdout()
  500. assert.Assert(c, !strings.Contains(strings.TrimSpace(out), data1))
  501. assert.Assert(c, !strings.Contains(strings.TrimSpace(out), data2))
  502. }