docker_cli_ps_test.go 36 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887
  1. package main
  2. import (
  3. "context"
  4. "fmt"
  5. "sort"
  6. "strconv"
  7. "strings"
  8. "testing"
  9. "time"
  10. "github.com/docker/docker/api/types/versions"
  11. "github.com/docker/docker/integration-cli/cli"
  12. "github.com/docker/docker/integration-cli/cli/build"
  13. "github.com/docker/docker/pkg/stringid"
  14. "gotest.tools/v3/assert"
  15. is "gotest.tools/v3/assert/cmp"
  16. "gotest.tools/v3/icmd"
  17. "gotest.tools/v3/skip"
  18. )
  19. type DockerCLIPsSuite struct {
  20. ds *DockerSuite
  21. }
  22. func (s *DockerCLIPsSuite) TearDownTest(ctx context.Context, c *testing.T) {
  23. s.ds.TearDownTest(ctx, c)
  24. }
  25. func (s *DockerCLIPsSuite) OnTimeout(c *testing.T) {
  26. s.ds.OnTimeout(c)
  27. }
  28. func (s *DockerCLIPsSuite) TestPsListContainersBase(c *testing.T) {
  29. existingContainers := ExistingContainerIDs(c)
  30. out := runSleepingContainer(c, "-d")
  31. firstID := strings.TrimSpace(out)
  32. out = runSleepingContainer(c, "-d")
  33. secondID := strings.TrimSpace(out)
  34. // not long running
  35. out, _ = dockerCmd(c, "run", "-d", "busybox", "true")
  36. thirdID := strings.TrimSpace(out)
  37. out = runSleepingContainer(c, "-d")
  38. fourthID := strings.TrimSpace(out)
  39. // make sure the second is running
  40. assert.Assert(c, waitRun(secondID) == nil)
  41. // make sure third one is not running
  42. dockerCmd(c, "wait", thirdID)
  43. // make sure the forth is running
  44. assert.Assert(c, waitRun(fourthID) == nil)
  45. // all
  46. out, _ = dockerCmd(c, "ps", "-a")
  47. assert.Equal(c, assertContainerList(RemoveOutputForExistingElements(out, existingContainers), []string{fourthID, thirdID, secondID, firstID}), true, fmt.Sprintf("ALL: Container list is not in the correct order: \n%s", out))
  48. // running
  49. out, _ = dockerCmd(c, "ps")
  50. assert.Equal(c, assertContainerList(RemoveOutputForExistingElements(out, existingContainers), []string{fourthID, secondID, firstID}), true, fmt.Sprintf("RUNNING: Container list is not in the correct order: \n%s", out))
  51. // limit
  52. out, _ = dockerCmd(c, "ps", "-n=2", "-a")
  53. expected := []string{fourthID, thirdID}
  54. assert.Equal(c, assertContainerList(RemoveOutputForExistingElements(out, existingContainers), expected), true, fmt.Sprintf("LIMIT & ALL: Container list is not in the correct order: \n%s", out))
  55. out, _ = dockerCmd(c, "ps", "-n=2")
  56. assert.Equal(c, assertContainerList(RemoveOutputForExistingElements(out, existingContainers), expected), true, fmt.Sprintf("LIMIT: Container list is not in the correct order: \n%s", out))
  57. // filter since
  58. out, _ = dockerCmd(c, "ps", "-f", "since="+firstID, "-a")
  59. expected = []string{fourthID, thirdID, secondID}
  60. assert.Equal(c, assertContainerList(RemoveOutputForExistingElements(out, existingContainers), expected), true, fmt.Sprintf("SINCE filter & ALL: Container list is not in the correct order: \n%s", out))
  61. out, _ = dockerCmd(c, "ps", "-f", "since="+firstID)
  62. expected = []string{fourthID, secondID}
  63. assert.Equal(c, assertContainerList(RemoveOutputForExistingElements(out, existingContainers), expected), true, fmt.Sprintf("SINCE filter: Container list is not in the correct order: \n%s", out))
  64. out, _ = dockerCmd(c, "ps", "-f", "since="+thirdID)
  65. expected = []string{fourthID}
  66. assert.Equal(c, assertContainerList(RemoveOutputForExistingElements(out, existingContainers), expected), true, fmt.Sprintf("SINCE filter: Container list is not in the correct order: \n%s", out))
  67. // filter before
  68. out, _ = dockerCmd(c, "ps", "-f", "before="+fourthID, "-a")
  69. expected = []string{thirdID, secondID, firstID}
  70. assert.Equal(c, assertContainerList(RemoveOutputForExistingElements(out, existingContainers), expected), true, fmt.Sprintf("BEFORE filter & ALL: Container list is not in the correct order: \n%s", out))
  71. out, _ = dockerCmd(c, "ps", "-f", "before="+fourthID)
  72. expected = []string{secondID, firstID}
  73. assert.Equal(c, assertContainerList(RemoveOutputForExistingElements(out, existingContainers), expected), true, fmt.Sprintf("BEFORE filter: Container list is not in the correct order: \n%s", out))
  74. out, _ = dockerCmd(c, "ps", "-f", "before="+thirdID)
  75. expected = []string{secondID, firstID}
  76. assert.Equal(c, assertContainerList(RemoveOutputForExistingElements(out, existingContainers), expected), true, fmt.Sprintf("SINCE filter: Container list is not in the correct order: \n%s", out))
  77. // filter since & before
  78. out, _ = dockerCmd(c, "ps", "-f", "since="+firstID, "-f", "before="+fourthID, "-a")
  79. expected = []string{thirdID, secondID}
  80. assert.Equal(c, assertContainerList(RemoveOutputForExistingElements(out, existingContainers), expected), true, fmt.Sprintf("SINCE filter, BEFORE filter & ALL: Container list is not in the correct order: \n%s", out))
  81. out, _ = dockerCmd(c, "ps", "-f", "since="+firstID, "-f", "before="+fourthID)
  82. expected = []string{secondID}
  83. assert.Equal(c, assertContainerList(RemoveOutputForExistingElements(out, existingContainers), expected), true, fmt.Sprintf("SINCE filter, BEFORE filter: Container list is not in the correct order: \n%s", out))
  84. // filter since & limit
  85. out, _ = dockerCmd(c, "ps", "-f", "since="+firstID, "-n=2", "-a")
  86. expected = []string{fourthID, thirdID}
  87. assert.Equal(c, assertContainerList(RemoveOutputForExistingElements(out, existingContainers), expected), true, fmt.Sprintf("SINCE filter, LIMIT & ALL: Container list is not in the correct order: \n%s", out))
  88. out, _ = dockerCmd(c, "ps", "-f", "since="+firstID, "-n=2")
  89. assert.Equal(c, assertContainerList(RemoveOutputForExistingElements(out, existingContainers), expected), true, fmt.Sprintf("SINCE filter, LIMIT: Container list is not in the correct order: \n%s", out))
  90. // filter before & limit
  91. out, _ = dockerCmd(c, "ps", "-f", "before="+fourthID, "-n=1", "-a")
  92. expected = []string{thirdID}
  93. assert.Equal(c, assertContainerList(RemoveOutputForExistingElements(out, existingContainers), expected), true, fmt.Sprintf("BEFORE filter, LIMIT & ALL: Container list is not in the correct order: \n%s", out))
  94. out, _ = dockerCmd(c, "ps", "-f", "before="+fourthID, "-n=1")
  95. assert.Equal(c, assertContainerList(RemoveOutputForExistingElements(out, existingContainers), expected), true, fmt.Sprintf("BEFORE filter, LIMIT: Container list is not in the correct order: \n%s", out))
  96. // filter since & filter before & limit
  97. out, _ = dockerCmd(c, "ps", "-f", "since="+firstID, "-f", "before="+fourthID, "-n=1", "-a")
  98. expected = []string{thirdID}
  99. assert.Equal(c, assertContainerList(RemoveOutputForExistingElements(out, existingContainers), expected), true, fmt.Sprintf("SINCE filter, BEFORE filter, LIMIT & ALL: Container list is not in the correct order: \n%s", out))
  100. out, _ = dockerCmd(c, "ps", "-f", "since="+firstID, "-f", "before="+fourthID, "-n=1")
  101. assert.Equal(c, assertContainerList(RemoveOutputForExistingElements(out, existingContainers), expected), true, fmt.Sprintf("SINCE filter, BEFORE filter, LIMIT: Container list is not in the correct order: \n%s", out))
  102. }
  103. func assertContainerList(out string, expected []string) bool {
  104. lines := strings.Split(strings.Trim(out, "\n "), "\n")
  105. if len(lines)-1 != len(expected) {
  106. return false
  107. }
  108. containerIDIndex := strings.Index(lines[0], "CONTAINER ID")
  109. for i := 0; i < len(expected); i++ {
  110. foundID := lines[i+1][containerIDIndex : containerIDIndex+12]
  111. if foundID != expected[i][:12] {
  112. return false
  113. }
  114. }
  115. return true
  116. }
  117. func (s *DockerCLIPsSuite) TestPsListContainersSize(c *testing.T) {
  118. // Problematic on Windows as it doesn't report the size correctly @swernli
  119. testRequires(c, DaemonIsLinux)
  120. dockerCmd(c, "run", "-d", "busybox")
  121. baseOut, _ := dockerCmd(c, "ps", "-s", "-n=1")
  122. baseLines := strings.Split(strings.Trim(baseOut, "\n "), "\n")
  123. baseSizeIndex := strings.Index(baseLines[0], "SIZE")
  124. baseFoundsize := baseLines[1][baseSizeIndex:]
  125. baseBytes, err := strconv.Atoi(strings.Split(baseFoundsize, "B")[0])
  126. assert.NilError(c, err)
  127. name := "test_size"
  128. dockerCmd(c, "run", "--name", name, "busybox", "sh", "-c", "echo 1 > test")
  129. id := getIDByName(c, name)
  130. var result *icmd.Result
  131. wait := make(chan struct{})
  132. go func() {
  133. result = icmd.RunCommand(dockerBinary, "ps", "-s", "-n=1")
  134. close(wait)
  135. }()
  136. select {
  137. case <-wait:
  138. case <-time.After(3 * time.Second):
  139. c.Fatalf(`Calling "docker ps -s" timed out!`)
  140. }
  141. result.Assert(c, icmd.Success)
  142. lines := strings.Split(strings.Trim(result.Combined(), "\n "), "\n")
  143. assert.Equal(c, len(lines), 2, "Expected 2 lines for 'ps -s -n=1' output, got %d", len(lines))
  144. sizeIndex := strings.Index(lines[0], "SIZE")
  145. idIndex := strings.Index(lines[0], "CONTAINER ID")
  146. foundID := lines[1][idIndex : idIndex+12]
  147. assert.Equal(c, foundID, id[:12], fmt.Sprintf("Expected id %s, got %s", id[:12], foundID))
  148. expectedSize := fmt.Sprintf("%dB", 2+baseBytes)
  149. foundSize := lines[1][sizeIndex:]
  150. assert.Assert(c, strings.Contains(foundSize, expectedSize), "Expected size %q, got %q", expectedSize, foundSize)
  151. }
  152. func (s *DockerCLIPsSuite) TestPsListContainersFilterStatus(c *testing.T) {
  153. existingContainers := ExistingContainerIDs(c)
  154. // start exited container
  155. out := cli.DockerCmd(c, "run", "-d", "busybox").Combined()
  156. firstID := strings.TrimSpace(out)
  157. // make sure the exited container is not running
  158. cli.DockerCmd(c, "wait", firstID)
  159. // start running container
  160. out = cli.DockerCmd(c, "run", "-itd", "busybox").Combined()
  161. secondID := strings.TrimSpace(out)
  162. // filter containers by exited
  163. out = cli.DockerCmd(c, "ps", "--no-trunc", "-q", "--filter=status=exited").Combined()
  164. containerOut := strings.TrimSpace(out)
  165. assert.Equal(c, RemoveOutputForExistingElements(containerOut, existingContainers), firstID)
  166. out = cli.DockerCmd(c, "ps", "-a", "--no-trunc", "-q", "--filter=status=running").Combined()
  167. containerOut = strings.TrimSpace(out)
  168. assert.Equal(c, RemoveOutputForExistingElements(containerOut, existingContainers), secondID)
  169. result := cli.Docker(cli.Args("ps", "-a", "-q", "--filter=status=rubbish"), cli.WithTimeout(time.Second*60))
  170. err := "invalid filter 'status=rubbish'"
  171. if versions.LessThan(testEnv.DaemonAPIVersion(), "1.32") {
  172. err = "Unrecognised filter value for status: rubbish"
  173. }
  174. result.Assert(c, icmd.Expected{
  175. ExitCode: 1,
  176. Err: err,
  177. })
  178. // Windows doesn't support pausing of containers
  179. if testEnv.DaemonInfo.OSType != "windows" {
  180. // pause running container
  181. out = cli.DockerCmd(c, "run", "-itd", "busybox").Combined()
  182. pausedID := strings.TrimSpace(out)
  183. cli.DockerCmd(c, "pause", pausedID)
  184. // make sure the container is unpaused to let the daemon stop it properly
  185. defer func() { cli.DockerCmd(c, "unpause", pausedID) }()
  186. out = cli.DockerCmd(c, "ps", "--no-trunc", "-q", "--filter=status=paused").Combined()
  187. containerOut = strings.TrimSpace(out)
  188. assert.Equal(c, RemoveOutputForExistingElements(containerOut, existingContainers), pausedID)
  189. }
  190. }
  191. func (s *DockerCLIPsSuite) TestPsListContainersFilterHealth(c *testing.T) {
  192. skip.If(c, RuntimeIsWindowsContainerd(), "FIXME. Hang on Windows + containerd combination")
  193. existingContainers := ExistingContainerIDs(c)
  194. // Test legacy no health check
  195. out := runSleepingContainer(c, "--name=none_legacy")
  196. containerID := strings.TrimSpace(out)
  197. cli.WaitRun(c, containerID)
  198. out = cli.DockerCmd(c, "ps", "-q", "-l", "--no-trunc", "--filter=health=none").Combined()
  199. containerOut := strings.TrimSpace(out)
  200. assert.Equal(c, containerOut, containerID, fmt.Sprintf("Expected id %s, got %s for legacy none filter, output: %q", containerID, containerOut, out))
  201. // Test no health check specified explicitly
  202. out = runSleepingContainer(c, "--name=none", "--no-healthcheck")
  203. containerID = strings.TrimSpace(out)
  204. cli.WaitRun(c, containerID)
  205. out = cli.DockerCmd(c, "ps", "-q", "-l", "--no-trunc", "--filter=health=none").Combined()
  206. containerOut = strings.TrimSpace(out)
  207. assert.Equal(c, containerOut, containerID, fmt.Sprintf("Expected id %s, got %s for none filter, output: %q", containerID, containerOut, out))
  208. // Test failing health check
  209. out = runSleepingContainer(c, "--name=failing_container", "--health-cmd=exit 1", "--health-interval=1s")
  210. containerID = strings.TrimSpace(out)
  211. waitForHealthStatus(c, "failing_container", "starting", "unhealthy")
  212. out = cli.DockerCmd(c, "ps", "-q", "--no-trunc", "--filter=health=unhealthy").Combined()
  213. containerOut = strings.TrimSpace(out)
  214. assert.Equal(c, containerOut, containerID, fmt.Sprintf("Expected containerID %s, got %s for unhealthy filter, output: %q", containerID, containerOut, out))
  215. // Check passing healthcheck
  216. out = runSleepingContainer(c, "--name=passing_container", "--health-cmd=exit 0", "--health-interval=1s")
  217. containerID = strings.TrimSpace(out)
  218. waitForHealthStatus(c, "passing_container", "starting", "healthy")
  219. out = cli.DockerCmd(c, "ps", "-q", "--no-trunc", "--filter=health=healthy").Combined()
  220. containerOut = strings.TrimSpace(RemoveOutputForExistingElements(out, existingContainers))
  221. assert.Equal(c, containerOut, containerID, fmt.Sprintf("Expected containerID %s, got %s for healthy filter, output: %q", containerID, containerOut, out))
  222. }
  223. func (s *DockerCLIPsSuite) TestPsListContainersFilterID(c *testing.T) {
  224. // start container
  225. out, _ := dockerCmd(c, "run", "-d", "busybox")
  226. firstID := strings.TrimSpace(out)
  227. // start another container
  228. runSleepingContainer(c)
  229. // filter containers by id
  230. out, _ = dockerCmd(c, "ps", "-a", "-q", "--filter=id="+firstID)
  231. containerOut := strings.TrimSpace(out)
  232. assert.Equal(c, containerOut, firstID[:12], fmt.Sprintf("Expected id %s, got %s for exited filter, output: %q", firstID[:12], containerOut, out))
  233. }
  234. func (s *DockerCLIPsSuite) TestPsListContainersFilterName(c *testing.T) {
  235. // start container
  236. dockerCmd(c, "run", "--name=a_name_to_match", "busybox")
  237. id := getIDByName(c, "a_name_to_match")
  238. // start another container
  239. runSleepingContainer(c, "--name=b_name_to_match")
  240. // filter containers by name
  241. out, _ := dockerCmd(c, "ps", "-a", "-q", "--filter=name=a_name_to_match")
  242. containerOut := strings.TrimSpace(out)
  243. assert.Equal(c, containerOut, id[:12], fmt.Sprintf("Expected id %s, got %s for exited filter, output: %q", id[:12], containerOut, out))
  244. }
  245. // Test for the ancestor filter for ps.
  246. // There is also the same test but with image:tag@digest in docker_cli_by_digest_test.go
  247. //
  248. // What the test setups :
  249. // - Create 2 image based on busybox using the same repository but different tags
  250. // - Create an image based on the previous image (images_ps_filter_test2)
  251. // - Run containers for each of those image (busybox, images_ps_filter_test1, images_ps_filter_test2)
  252. // - Filter them out :P
  253. func (s *DockerCLIPsSuite) TestPsListContainersFilterAncestorImage(c *testing.T) {
  254. existingContainers := ExistingContainerIDs(c)
  255. // Build images
  256. imageName1 := "images_ps_filter_test1"
  257. buildImageSuccessfully(c, imageName1, build.WithDockerfile(`FROM busybox
  258. LABEL match me 1`))
  259. imageID1 := getIDByName(c, imageName1)
  260. imageName1Tagged := "images_ps_filter_test1:tag"
  261. buildImageSuccessfully(c, imageName1Tagged, build.WithDockerfile(`FROM busybox
  262. LABEL match me 1 tagged`))
  263. imageID1Tagged := getIDByName(c, imageName1Tagged)
  264. imageName2 := "images_ps_filter_test2"
  265. buildImageSuccessfully(c, imageName2, build.WithDockerfile(fmt.Sprintf(`FROM %s
  266. LABEL match me 2`, imageName1)))
  267. imageID2 := getIDByName(c, imageName2)
  268. // start containers
  269. dockerCmd(c, "run", "--name=first", "busybox", "echo", "hello")
  270. firstID := getIDByName(c, "first")
  271. // start another container
  272. dockerCmd(c, "run", "--name=second", "busybox", "echo", "hello")
  273. secondID := getIDByName(c, "second")
  274. // start third container
  275. dockerCmd(c, "run", "--name=third", imageName1, "echo", "hello")
  276. thirdID := getIDByName(c, "third")
  277. // start fourth container
  278. dockerCmd(c, "run", "--name=fourth", imageName1Tagged, "echo", "hello")
  279. fourthID := getIDByName(c, "fourth")
  280. // start fifth container
  281. dockerCmd(c, "run", "--name=fifth", imageName2, "echo", "hello")
  282. fifthID := getIDByName(c, "fifth")
  283. filterTestSuite := []struct {
  284. filterName string
  285. expectedIDs []string
  286. }{
  287. // non existent stuff
  288. {"nonexistent", []string{}},
  289. {"nonexistent:tag", []string{}},
  290. // image
  291. {"busybox", []string{firstID, secondID, thirdID, fourthID, fifthID}},
  292. {imageName1, []string{thirdID, fifthID}},
  293. {imageName2, []string{fifthID}},
  294. // image:tag
  295. {fmt.Sprintf("%s:latest", imageName1), []string{thirdID, fifthID}},
  296. {imageName1Tagged, []string{fourthID}},
  297. // short-id
  298. {stringid.TruncateID(imageID1), []string{thirdID, fifthID}},
  299. {stringid.TruncateID(imageID2), []string{fifthID}},
  300. // full-id
  301. {imageID1, []string{thirdID, fifthID}},
  302. {imageID1Tagged, []string{fourthID}},
  303. {imageID2, []string{fifthID}},
  304. }
  305. var out string
  306. for _, filter := range filterTestSuite {
  307. out, _ = dockerCmd(c, "ps", "-a", "-q", "--no-trunc", "--filter=ancestor="+filter.filterName)
  308. checkPsAncestorFilterOutput(c, RemoveOutputForExistingElements(out, existingContainers), filter.filterName, filter.expectedIDs)
  309. }
  310. // Multiple ancestor filter
  311. out, _ = dockerCmd(c, "ps", "-a", "-q", "--no-trunc", "--filter=ancestor="+imageName2, "--filter=ancestor="+imageName1Tagged)
  312. checkPsAncestorFilterOutput(c, RemoveOutputForExistingElements(out, existingContainers), imageName2+","+imageName1Tagged, []string{fourthID, fifthID})
  313. }
  314. func checkPsAncestorFilterOutput(c *testing.T, out string, filterName string, expectedIDs []string) {
  315. var actualIDs []string
  316. if out != "" {
  317. actualIDs = strings.Split(out[:len(out)-1], "\n")
  318. }
  319. sort.Strings(actualIDs)
  320. sort.Strings(expectedIDs)
  321. assert.Equal(c, len(actualIDs), len(expectedIDs), fmt.Sprintf("Expected filtered container(s) for %s ancestor filter to be %v:%v, got %v:%v", filterName, len(expectedIDs), expectedIDs, len(actualIDs), actualIDs))
  322. if len(expectedIDs) > 0 {
  323. same := true
  324. for i := range expectedIDs {
  325. if actualIDs[i] != expectedIDs[i] {
  326. c.Logf("%s, %s", actualIDs[i], expectedIDs[i])
  327. same = false
  328. break
  329. }
  330. }
  331. assert.Equal(c, same, true, fmt.Sprintf("Expected filtered container(s) for %s ancestor filter to be %v, got %v", filterName, expectedIDs, actualIDs))
  332. }
  333. }
  334. func (s *DockerCLIPsSuite) TestPsListContainersFilterLabel(c *testing.T) {
  335. // start container
  336. dockerCmd(c, "run", "--name=first", "-l", "match=me", "-l", "second=tag", "busybox")
  337. firstID := getIDByName(c, "first")
  338. // start another container
  339. dockerCmd(c, "run", "--name=second", "-l", "match=me too", "busybox")
  340. secondID := getIDByName(c, "second")
  341. // start third container
  342. dockerCmd(c, "run", "--name=third", "-l", "nomatch=me", "busybox")
  343. thirdID := getIDByName(c, "third")
  344. // filter containers by exact match
  345. out, _ := dockerCmd(c, "ps", "-a", "-q", "--no-trunc", "--filter=label=match=me")
  346. containerOut := strings.TrimSpace(out)
  347. assert.Equal(c, containerOut, firstID, fmt.Sprintf("Expected id %s, got %s for exited filter, output: %q", firstID, containerOut, out))
  348. // filter containers by two labels
  349. out, _ = dockerCmd(c, "ps", "-a", "-q", "--no-trunc", "--filter=label=match=me", "--filter=label=second=tag")
  350. containerOut = strings.TrimSpace(out)
  351. assert.Equal(c, containerOut, firstID, fmt.Sprintf("Expected id %s, got %s for exited filter, output: %q", firstID, containerOut, out))
  352. // filter containers by two labels, but expect not found because of AND behavior
  353. out, _ = dockerCmd(c, "ps", "-a", "-q", "--no-trunc", "--filter=label=match=me", "--filter=label=second=tag-no")
  354. containerOut = strings.TrimSpace(out)
  355. assert.Equal(c, containerOut, "", fmt.Sprintf("Expected nothing, got %s for exited filter, output: %q", containerOut, out))
  356. // filter containers by exact key
  357. out, _ = dockerCmd(c, "ps", "-a", "-q", "--no-trunc", "--filter=label=match")
  358. containerOut = strings.TrimSpace(out)
  359. assert.Assert(c, strings.Contains(containerOut, firstID))
  360. assert.Assert(c, strings.Contains(containerOut, secondID))
  361. assert.Assert(c, !strings.Contains(containerOut, thirdID))
  362. }
  363. func (s *DockerCLIPsSuite) TestPsListContainersFilterExited(c *testing.T) {
  364. // TODO Flaky on Windows CI [both RS1 and RS5]
  365. // On slower machines the container may not have exited
  366. // yet when we filter below by exit status/exit value.
  367. skip.If(c, DaemonIsWindows(), "FLAKY on Windows, see #20819")
  368. runSleepingContainer(c, "--name=sleep")
  369. firstZero, _ := dockerCmd(c, "run", "-d", "busybox", "true")
  370. secondZero, _ := dockerCmd(c, "run", "-d", "busybox", "true")
  371. out, _, err := dockerCmdWithError("run", "--name", "nonzero1", "busybox", "false")
  372. assert.Assert(c, err != nil, "Should fail. out: %s", out)
  373. firstNonZero := getIDByName(c, "nonzero1")
  374. out, _, err = dockerCmdWithError("run", "--name", "nonzero2", "busybox", "false")
  375. assert.Assert(c, err != nil, "Should fail. out: %s", out)
  376. secondNonZero := getIDByName(c, "nonzero2")
  377. // filter containers by exited=0
  378. out, _ = dockerCmd(c, "ps", "-a", "-q", "--no-trunc", "--filter=exited=0")
  379. assert.Assert(c, strings.Contains(out, strings.TrimSpace(firstZero)))
  380. assert.Assert(c, strings.Contains(out, strings.TrimSpace(secondZero)))
  381. assert.Assert(c, !strings.Contains(out, strings.TrimSpace(firstNonZero)))
  382. assert.Assert(c, !strings.Contains(out, strings.TrimSpace(secondNonZero)))
  383. out, _ = dockerCmd(c, "ps", "-a", "-q", "--no-trunc", "--filter=exited=1")
  384. assert.Assert(c, strings.Contains(out, strings.TrimSpace(firstNonZero)))
  385. assert.Assert(c, strings.Contains(out, strings.TrimSpace(secondNonZero)))
  386. assert.Assert(c, !strings.Contains(out, strings.TrimSpace(firstZero)))
  387. assert.Assert(c, !strings.Contains(out, strings.TrimSpace(secondZero)))
  388. }
  389. func (s *DockerCLIPsSuite) TestPsRightTagName(c *testing.T) {
  390. // TODO Investigate further why this fails on Windows to Windows CI
  391. testRequires(c, DaemonIsLinux)
  392. existingContainers := ExistingContainerNames(c)
  393. tag := "asybox:shmatest"
  394. dockerCmd(c, "tag", "busybox", tag)
  395. var id1 string
  396. out := runSleepingContainer(c)
  397. id1 = strings.TrimSpace(out)
  398. var id2 string
  399. out = runSleepingContainerInImage(c, tag)
  400. id2 = strings.TrimSpace(out)
  401. var imageID string
  402. out = inspectField(c, "busybox", "Id")
  403. imageID = strings.TrimSpace(out)
  404. var id3 string
  405. out = runSleepingContainerInImage(c, imageID)
  406. id3 = strings.TrimSpace(out)
  407. out, _ = dockerCmd(c, "ps", "--no-trunc")
  408. lines := strings.Split(strings.TrimSpace(out), "\n")
  409. lines = RemoveLinesForExistingElements(lines, existingContainers)
  410. // skip header
  411. lines = lines[1:]
  412. assert.Equal(c, len(lines), 3, "There should be 3 running container, got %d", len(lines))
  413. for _, line := range lines {
  414. f := strings.Fields(line)
  415. switch f[0] {
  416. case id1:
  417. assert.Equal(c, f[1], "busybox", fmt.Sprintf("Expected %s tag for id %s, got %s", "busybox", id1, f[1]))
  418. case id2:
  419. assert.Equal(c, f[1], tag, fmt.Sprintf("Expected %s tag for id %s, got %s", tag, id2, f[1]))
  420. case id3:
  421. assert.Equal(c, f[1], imageID, fmt.Sprintf("Expected %s imageID for id %s, got %s", tag, id3, f[1]))
  422. default:
  423. c.Fatalf("Unexpected id %s, expected %s and %s and %s", f[0], id1, id2, id3)
  424. }
  425. }
  426. }
  427. func (s *DockerCLIPsSuite) TestPsListContainersFilterCreated(c *testing.T) {
  428. // create a container
  429. out, _ := dockerCmd(c, "create", "busybox")
  430. cID := strings.TrimSpace(out)
  431. shortCID := cID[:12]
  432. // Make sure it DOESN'T show up w/o a '-a' for normal 'ps'
  433. out, _ = dockerCmd(c, "ps", "-q")
  434. assert.Assert(c, !strings.Contains(out, shortCID), "Should have not seen '%s' in ps output:\n%s", shortCID, out)
  435. // Make sure it DOES show up as 'Created' for 'ps -a'
  436. out, _ = dockerCmd(c, "ps", "-a")
  437. hits := 0
  438. for _, line := range strings.Split(out, "\n") {
  439. if !strings.Contains(line, shortCID) {
  440. continue
  441. }
  442. hits++
  443. assert.Assert(c, strings.Contains(line, "Created"), "Missing 'Created' on '%s'", line)
  444. }
  445. assert.Equal(c, hits, 1, fmt.Sprintf("Should have seen '%s' in ps -a output once:%d\n%s", shortCID, hits, out))
  446. // filter containers by 'create' - note, no -a needed
  447. out, _ = dockerCmd(c, "ps", "-q", "-f", "status=created")
  448. containerOut := strings.TrimSpace(out)
  449. assert.Assert(c, strings.Contains(containerOut, shortCID), "Should have seen '%s' in ps output:\n%s", shortCID, out)
  450. }
  451. // Test for GitHub issue #12595
  452. func (s *DockerCLIPsSuite) TestPsImageIDAfterUpdate(c *testing.T) {
  453. // TODO: Investigate why this fails on Windows to Windows CI further.
  454. testRequires(c, DaemonIsLinux)
  455. originalImageName := "busybox:TestPsImageIDAfterUpdate-original"
  456. updatedImageName := "busybox:TestPsImageIDAfterUpdate-updated"
  457. existingContainers := ExistingContainerIDs(c)
  458. icmd.RunCommand(dockerBinary, "tag", "busybox:latest", originalImageName).Assert(c, icmd.Success)
  459. originalImageID := getIDByName(c, originalImageName)
  460. result := icmd.RunCommand(dockerBinary, append([]string{"run", "-d", originalImageName}, sleepCommandForDaemonPlatform()...)...)
  461. result.Assert(c, icmd.Success)
  462. containerID := strings.TrimSpace(result.Combined())
  463. result = icmd.RunCommand(dockerBinary, "ps", "--no-trunc")
  464. result.Assert(c, icmd.Success)
  465. lines := strings.Split(strings.TrimSpace(result.Combined()), "\n")
  466. lines = RemoveLinesForExistingElements(lines, existingContainers)
  467. // skip header
  468. lines = lines[1:]
  469. assert.Equal(c, len(lines), 1)
  470. for _, line := range lines {
  471. f := strings.Fields(line)
  472. assert.Equal(c, f[1], originalImageName)
  473. }
  474. icmd.RunCommand(dockerBinary, "commit", containerID, updatedImageName).Assert(c, icmd.Success)
  475. icmd.RunCommand(dockerBinary, "tag", updatedImageName, originalImageName).Assert(c, icmd.Success)
  476. result = icmd.RunCommand(dockerBinary, "ps", "--no-trunc")
  477. result.Assert(c, icmd.Success)
  478. lines = strings.Split(strings.TrimSpace(result.Combined()), "\n")
  479. lines = RemoveLinesForExistingElements(lines, existingContainers)
  480. // skip header
  481. lines = lines[1:]
  482. assert.Equal(c, len(lines), 1)
  483. for _, line := range lines {
  484. f := strings.Fields(line)
  485. assert.Equal(c, f[1], originalImageID)
  486. }
  487. }
  488. func (s *DockerCLIPsSuite) TestPsNotShowPortsOfStoppedContainer(c *testing.T) {
  489. testRequires(c, DaemonIsLinux)
  490. dockerCmd(c, "run", "--name=foo", "-d", "-p", "6000:5000", "busybox", "top")
  491. assert.Assert(c, waitRun("foo") == nil)
  492. ports, _ := dockerCmd(c, "ps", "--format", "{{ .Ports }}", "--filter", "name=foo")
  493. expected := ":6000->5000/tcp"
  494. assert.Assert(c, is.Contains(ports, expected), "Expected: %v, got: %v", expected, ports)
  495. dockerCmd(c, "kill", "foo")
  496. dockerCmd(c, "wait", "foo")
  497. ports, _ = dockerCmd(c, "ps", "--format", "{{ .Ports }}", "--filter", "name=foo")
  498. assert.Equal(c, ports, "", "Should not got %v", expected)
  499. }
  500. func (s *DockerCLIPsSuite) TestPsShowMounts(c *testing.T) {
  501. existingContainers := ExistingContainerNames(c)
  502. prefix, slash := getPrefixAndSlashFromDaemonPlatform()
  503. mp := prefix + slash + "test"
  504. dockerCmd(c, "volume", "create", "ps-volume-test")
  505. // volume mount containers
  506. runSleepingContainer(c, "--name=volume-test-1", "--volume", "ps-volume-test:"+mp)
  507. assert.Assert(c, waitRun("volume-test-1") == nil)
  508. runSleepingContainer(c, "--name=volume-test-2", "--volume", mp)
  509. assert.Assert(c, waitRun("volume-test-2") == nil)
  510. // bind mount container
  511. var bindMountSource string
  512. var bindMountDestination string
  513. if DaemonIsWindows() {
  514. bindMountSource = `c:\`
  515. bindMountDestination = `c:\t`
  516. } else {
  517. bindMountSource = "/tmp"
  518. bindMountDestination = "/t"
  519. }
  520. runSleepingContainer(c, "--name=bind-mount-test", "-v", bindMountSource+":"+bindMountDestination)
  521. assert.Assert(c, waitRun("bind-mount-test") == nil)
  522. out, _ := dockerCmd(c, "ps", "--format", "{{.Names}} {{.Mounts}}")
  523. lines := strings.Split(strings.TrimSpace(out), "\n")
  524. lines = RemoveLinesForExistingElements(lines, existingContainers)
  525. assert.Equal(c, len(lines), 3)
  526. fields := strings.Fields(lines[0])
  527. assert.Equal(c, len(fields), 2)
  528. assert.Equal(c, fields[0], "bind-mount-test")
  529. assert.Equal(c, fields[1], bindMountSource)
  530. fields = strings.Fields(lines[1])
  531. assert.Equal(c, len(fields), 2)
  532. anonymousVolumeID := fields[1]
  533. fields = strings.Fields(lines[2])
  534. assert.Equal(c, fields[1], "ps-volume-test")
  535. // filter by volume name
  536. out, _ = dockerCmd(c, "ps", "--format", "{{.Names}} {{.Mounts}}", "--filter", "volume=ps-volume-test")
  537. lines = strings.Split(strings.TrimSpace(out), "\n")
  538. lines = RemoveLinesForExistingElements(lines, existingContainers)
  539. assert.Equal(c, len(lines), 1)
  540. fields = strings.Fields(lines[0])
  541. assert.Equal(c, fields[1], "ps-volume-test")
  542. // empty results filtering by unknown volume
  543. out, _ = dockerCmd(c, "ps", "--format", "{{.Names}} {{.Mounts}}", "--filter", "volume=this-volume-should-not-exist")
  544. assert.Equal(c, len(strings.TrimSpace(out)), 0)
  545. // filter by mount destination
  546. out, _ = dockerCmd(c, "ps", "--format", "{{.Names}} {{.Mounts}}", "--filter", "volume="+mp)
  547. lines = strings.Split(strings.TrimSpace(out), "\n")
  548. lines = RemoveLinesForExistingElements(lines, existingContainers)
  549. assert.Equal(c, len(lines), 2)
  550. fields = strings.Fields(lines[0])
  551. assert.Equal(c, fields[1], anonymousVolumeID)
  552. fields = strings.Fields(lines[1])
  553. assert.Equal(c, fields[1], "ps-volume-test")
  554. // filter by bind mount source
  555. out, _ = dockerCmd(c, "ps", "--format", "{{.Names}} {{.Mounts}}", "--filter", "volume="+bindMountSource)
  556. lines = strings.Split(strings.TrimSpace(out), "\n")
  557. lines = RemoveLinesForExistingElements(lines, existingContainers)
  558. assert.Equal(c, len(lines), 1)
  559. fields = strings.Fields(lines[0])
  560. assert.Equal(c, len(fields), 2)
  561. assert.Equal(c, fields[0], "bind-mount-test")
  562. assert.Equal(c, fields[1], bindMountSource)
  563. // filter by bind mount destination
  564. out, _ = dockerCmd(c, "ps", "--format", "{{.Names}} {{.Mounts}}", "--filter", "volume="+bindMountDestination)
  565. lines = strings.Split(strings.TrimSpace(out), "\n")
  566. lines = RemoveLinesForExistingElements(lines, existingContainers)
  567. assert.Equal(c, len(lines), 1)
  568. fields = strings.Fields(lines[0])
  569. assert.Equal(c, len(fields), 2)
  570. assert.Equal(c, fields[0], "bind-mount-test")
  571. assert.Equal(c, fields[1], bindMountSource)
  572. // empty results filtering by unknown mount point
  573. out, _ = dockerCmd(c, "ps", "--format", "{{.Names}} {{.Mounts}}", "--filter", "volume="+prefix+slash+"this-path-was-never-mounted")
  574. assert.Equal(c, len(strings.TrimSpace(out)), 0)
  575. }
  576. func (s *DockerCLIPsSuite) TestPsListContainersFilterNetwork(c *testing.T) {
  577. existing := ExistingContainerIDs(c)
  578. // TODO default network on Windows is not called "bridge", and creating a
  579. // custom network fails on Windows fails with "Error response from daemon: plugin not found")
  580. testRequires(c, DaemonIsLinux)
  581. // create some containers
  582. runSleepingContainer(c, "--net=bridge", "--name=onbridgenetwork")
  583. runSleepingContainer(c, "--net=none", "--name=onnonenetwork")
  584. // Filter docker ps on non existing network
  585. out, _ := dockerCmd(c, "ps", "--filter", "network=doesnotexist")
  586. containerOut := strings.TrimSpace(out)
  587. lines := strings.Split(containerOut, "\n")
  588. // skip header
  589. lines = lines[1:]
  590. // ps output should have no containers
  591. assert.Equal(c, len(RemoveLinesForExistingElements(lines, existing)), 0)
  592. // Filter docker ps on network bridge
  593. out, _ = dockerCmd(c, "ps", "--filter", "network=bridge")
  594. containerOut = strings.TrimSpace(out)
  595. lines = strings.Split(containerOut, "\n")
  596. // skip header
  597. lines = lines[1:]
  598. // ps output should have only one container
  599. assert.Equal(c, len(RemoveLinesForExistingElements(lines, existing)), 1)
  600. // Making sure onbridgenetwork is on the output
  601. assert.Assert(c, strings.Contains(containerOut, "onbridgenetwork"), "Missing the container on network\n")
  602. // Filter docker ps on networks bridge and none
  603. out, _ = dockerCmd(c, "ps", "--filter", "network=bridge", "--filter", "network=none")
  604. containerOut = strings.TrimSpace(out)
  605. lines = strings.Split(containerOut, "\n")
  606. // skip header
  607. lines = lines[1:]
  608. // ps output should have both the containers
  609. assert.Equal(c, len(RemoveLinesForExistingElements(lines, existing)), 2)
  610. // Making sure onbridgenetwork and onnonenetwork is on the output
  611. assert.Assert(c, strings.Contains(containerOut, "onnonenetwork"), "Missing the container on none network\n")
  612. assert.Assert(c, strings.Contains(containerOut, "onbridgenetwork"), "Missing the container on bridge network\n")
  613. nwID, _ := dockerCmd(c, "network", "inspect", "--format", "{{.ID}}", "bridge")
  614. // Filter by network ID
  615. out, _ = dockerCmd(c, "ps", "--filter", "network="+nwID)
  616. containerOut = strings.TrimSpace(out)
  617. assert.Assert(c, is.Contains(containerOut, "onbridgenetwork"))
  618. // Filter by partial network ID
  619. partialnwID := nwID[0:4]
  620. out, _ = dockerCmd(c, "ps", "--filter", "network="+partialnwID)
  621. containerOut = strings.TrimSpace(out)
  622. lines = strings.Split(containerOut, "\n")
  623. // skip header
  624. lines = lines[1:]
  625. // ps output should have only one container
  626. assert.Equal(c, len(RemoveLinesForExistingElements(lines, existing)), 1)
  627. // Making sure onbridgenetwork is on the output
  628. assert.Assert(c, strings.Contains(containerOut, "onbridgenetwork"), "Missing the container on network\n")
  629. }
  630. func (s *DockerCLIPsSuite) TestPsByOrder(c *testing.T) {
  631. out := runSleepingContainer(c, "--name", "xyz-abc")
  632. container1 := strings.TrimSpace(out)
  633. out = runSleepingContainer(c, "--name", "xyz-123")
  634. container2 := strings.TrimSpace(out)
  635. runSleepingContainer(c, "--name", "789-abc")
  636. runSleepingContainer(c, "--name", "789-123")
  637. // Run multiple time should have the same result
  638. out = cli.DockerCmd(c, "ps", "--no-trunc", "-q", "-f", "name=xyz").Combined()
  639. assert.Equal(c, strings.TrimSpace(out), fmt.Sprintf("%s\n%s", container2, container1))
  640. // Run multiple time should have the same result
  641. out = cli.DockerCmd(c, "ps", "--no-trunc", "-q", "-f", "name=xyz").Combined()
  642. assert.Equal(c, strings.TrimSpace(out), fmt.Sprintf("%s\n%s", container2, container1))
  643. }
  644. func (s *DockerCLIPsSuite) TestPsListContainersFilterPorts(c *testing.T) {
  645. testRequires(c, DaemonIsLinux)
  646. existingContainers := ExistingContainerIDs(c)
  647. out, _ := dockerCmd(c, "run", "-d", "--publish=80", "busybox", "top")
  648. id1 := strings.TrimSpace(out)
  649. out, _ = dockerCmd(c, "run", "-d", "--expose=8080", "busybox", "top")
  650. id2 := strings.TrimSpace(out)
  651. out, _ = dockerCmd(c, "run", "-d", "-p", "1090:90", "busybox", "top")
  652. id3 := strings.TrimSpace(out)
  653. out, _ = dockerCmd(c, "ps", "--no-trunc", "-q")
  654. assert.Assert(c, strings.Contains(strings.TrimSpace(out), id1))
  655. assert.Assert(c, strings.Contains(strings.TrimSpace(out), id2))
  656. assert.Assert(c, strings.Contains(strings.TrimSpace(out), id3))
  657. out, _ = dockerCmd(c, "ps", "--no-trunc", "-q", "--filter", "publish=80-8080/udp")
  658. assert.Assert(c, strings.TrimSpace(out) != id1)
  659. assert.Assert(c, strings.TrimSpace(out) != id2)
  660. assert.Assert(c, strings.TrimSpace(out) != id3)
  661. out, _ = dockerCmd(c, "ps", "--no-trunc", "-q", "--filter", "expose=8081")
  662. assert.Assert(c, strings.TrimSpace(out) != id1)
  663. assert.Assert(c, strings.TrimSpace(out) != id2)
  664. assert.Assert(c, strings.TrimSpace(out) != id3)
  665. out, _ = dockerCmd(c, "ps", "--no-trunc", "-q", "--filter", "publish=80-81")
  666. assert.Assert(c, strings.TrimSpace(out) != id1)
  667. assert.Assert(c, strings.TrimSpace(out) != id2)
  668. assert.Assert(c, strings.TrimSpace(out) != id3)
  669. out, _ = dockerCmd(c, "ps", "--no-trunc", "-q", "--filter", "expose=80/tcp")
  670. assert.Equal(c, strings.TrimSpace(out), id1)
  671. assert.Assert(c, strings.TrimSpace(out) != id2)
  672. assert.Assert(c, strings.TrimSpace(out) != id3)
  673. out, _ = dockerCmd(c, "ps", "--no-trunc", "-q", "--filter", "publish=1090")
  674. assert.Assert(c, strings.TrimSpace(out) != id1)
  675. assert.Assert(c, strings.TrimSpace(out) != id2)
  676. assert.Equal(c, strings.TrimSpace(out), id3)
  677. out, _ = dockerCmd(c, "ps", "--no-trunc", "-q", "--filter", "expose=8080/tcp")
  678. out = RemoveOutputForExistingElements(out, existingContainers)
  679. assert.Assert(c, strings.TrimSpace(out) != id1)
  680. assert.Equal(c, strings.TrimSpace(out), id2)
  681. assert.Assert(c, strings.TrimSpace(out) != id3)
  682. }
  683. func (s *DockerCLIPsSuite) TestPsNotShowLinknamesOfDeletedContainer(c *testing.T) {
  684. testRequires(c, DaemonIsLinux, MinimumAPIVersion("1.31"))
  685. existingContainers := ExistingContainerNames(c)
  686. dockerCmd(c, "create", "--name=aaa", "busybox", "top")
  687. dockerCmd(c, "create", "--name=bbb", "--link=aaa", "busybox", "top")
  688. out, _ := dockerCmd(c, "ps", "--no-trunc", "-a", "--format", "{{.Names}}")
  689. lines := strings.Split(strings.TrimSpace(out), "\n")
  690. lines = RemoveLinesForExistingElements(lines, existingContainers)
  691. expected := []string{"bbb", "aaa,bbb/aaa"}
  692. var names []string
  693. names = append(names, lines...)
  694. assert.Assert(c, is.DeepEqual(names, expected), "Expected array with non-truncated names: %v, got: %v", expected, names)
  695. dockerCmd(c, "rm", "bbb")
  696. out, _ = dockerCmd(c, "ps", "--no-trunc", "-a", "--format", "{{.Names}}")
  697. out = RemoveOutputForExistingElements(out, existingContainers)
  698. assert.Equal(c, strings.TrimSpace(out), "aaa")
  699. }