github.com/flavio/docker@v0.1.3-0.20170117145210-f63d1a6eec47/integration-cli/docker_cli_inspect_test.go (about) 1 package main 2 3 import ( 4 "encoding/json" 5 "fmt" 6 "os" 7 "strconv" 8 "strings" 9 "time" 10 11 "github.com/docker/docker/api/types" 12 "github.com/docker/docker/api/types/container" 13 "github.com/docker/docker/integration-cli/checker" 14 icmd "github.com/docker/docker/pkg/testutil/cmd" 15 "github.com/go-check/check" 16 ) 17 18 func checkValidGraphDriver(c *check.C, name string) { 19 if name != "devicemapper" && name != "overlay" && name != "vfs" && name != "zfs" && name != "btrfs" && name != "aufs" { 20 c.Fatalf("%v is not a valid graph driver name", name) 21 } 22 } 23 24 func (s *DockerSuite) TestInspectImage(c *check.C) { 25 testRequires(c, DaemonIsLinux) 26 imageTest := "emptyfs" 27 // It is important that this ID remain stable. If a code change causes 28 // it to be different, this is equivalent to a cache bust when pulling 29 // a legacy-format manifest. If the check at the end of this function 30 // fails, fix the difference in the image serialization instead of 31 // updating this hash. 32 imageTestID := "sha256:11f64303f0f7ffdc71f001788132bca5346831939a956e3e975c93267d89a16d" 33 id := inspectField(c, imageTest, "Id") 34 35 c.Assert(id, checker.Equals, imageTestID) 36 } 37 38 func (s *DockerSuite) TestInspectInt64(c *check.C) { 39 dockerCmd(c, "run", "-d", "-m=300M", "--name", "inspectTest", "busybox", "true") 40 inspectOut := inspectField(c, "inspectTest", "HostConfig.Memory") 41 c.Assert(inspectOut, checker.Equals, "314572800") 42 } 43 44 func (s *DockerSuite) TestInspectDefault(c *check.C) { 45 //Both the container and image are named busybox. docker inspect will fetch the container JSON. 46 //If the container JSON is not available, it will go for the image JSON. 47 48 out, _ := dockerCmd(c, "run", "--name=busybox", "-d", "busybox", "true") 49 containerID := strings.TrimSpace(out) 50 51 inspectOut := inspectField(c, "busybox", "Id") 52 c.Assert(strings.TrimSpace(inspectOut), checker.Equals, containerID) 53 } 54 55 func (s *DockerSuite) TestInspectStatus(c *check.C) { 56 if testEnv.DaemonPlatform() != "windows" { 57 defer unpauseAllContainers(c) 58 } 59 out, _ := runSleepingContainer(c, "-d") 60 out = strings.TrimSpace(out) 61 62 inspectOut := inspectField(c, out, "State.Status") 63 c.Assert(inspectOut, checker.Equals, "running") 64 65 // Windows does not support pause/unpause on Windows Server Containers. 66 // (RS1 does for Hyper-V Containers, but production CI is not setup for that) 67 if testEnv.DaemonPlatform() != "windows" { 68 dockerCmd(c, "pause", out) 69 inspectOut = inspectField(c, out, "State.Status") 70 c.Assert(inspectOut, checker.Equals, "paused") 71 72 dockerCmd(c, "unpause", out) 73 inspectOut = inspectField(c, out, "State.Status") 74 c.Assert(inspectOut, checker.Equals, "running") 75 } 76 77 dockerCmd(c, "stop", out) 78 inspectOut = inspectField(c, out, "State.Status") 79 c.Assert(inspectOut, checker.Equals, "exited") 80 81 } 82 83 func (s *DockerSuite) TestInspectTypeFlagContainer(c *check.C) { 84 //Both the container and image are named busybox. docker inspect will fetch container 85 //JSON State.Running field. If the field is true, it's a container. 86 runSleepingContainer(c, "--name=busybox", "-d") 87 88 formatStr := "--format={{.State.Running}}" 89 out, _ := dockerCmd(c, "inspect", "--type=container", formatStr, "busybox") 90 c.Assert(out, checker.Equals, "true\n") // not a container JSON 91 } 92 93 func (s *DockerSuite) TestInspectTypeFlagWithNoContainer(c *check.C) { 94 //Run this test on an image named busybox. docker inspect will try to fetch container 95 //JSON. Since there is no container named busybox and --type=container, docker inspect will 96 //not try to get the image JSON. It will throw an error. 97 98 dockerCmd(c, "run", "-d", "busybox", "true") 99 100 _, _, err := dockerCmdWithError("inspect", "--type=container", "busybox") 101 // docker inspect should fail, as there is no container named busybox 102 c.Assert(err, checker.NotNil) 103 } 104 105 func (s *DockerSuite) TestInspectTypeFlagWithImage(c *check.C) { 106 //Both the container and image are named busybox. docker inspect will fetch image 107 //JSON as --type=image. if there is no image with name busybox, docker inspect 108 //will throw an error. 109 110 dockerCmd(c, "run", "--name=busybox", "-d", "busybox", "true") 111 112 out, _ := dockerCmd(c, "inspect", "--type=image", "busybox") 113 c.Assert(out, checker.Not(checker.Contains), "State") // not an image JSON 114 } 115 116 func (s *DockerSuite) TestInspectTypeFlagWithInvalidValue(c *check.C) { 117 //Both the container and image are named busybox. docker inspect will fail 118 //as --type=foobar is not a valid value for the flag. 119 120 dockerCmd(c, "run", "--name=busybox", "-d", "busybox", "true") 121 122 out, exitCode, err := dockerCmdWithError("inspect", "--type=foobar", "busybox") 123 c.Assert(err, checker.NotNil, check.Commentf("%s", exitCode)) 124 c.Assert(exitCode, checker.Equals, 1, check.Commentf("%s", err)) 125 c.Assert(out, checker.Contains, "not a valid value for --type") 126 } 127 128 func (s *DockerSuite) TestInspectImageFilterInt(c *check.C) { 129 testRequires(c, DaemonIsLinux) 130 imageTest := "emptyfs" 131 out := inspectField(c, imageTest, "Size") 132 133 size, err := strconv.Atoi(out) 134 c.Assert(err, checker.IsNil, check.Commentf("failed to inspect size of the image: %s, %v", out, err)) 135 136 //now see if the size turns out to be the same 137 formatStr := fmt.Sprintf("--format={{eq .Size %d}}", size) 138 out, _ = dockerCmd(c, "inspect", formatStr, imageTest) 139 result, err := strconv.ParseBool(strings.TrimSuffix(out, "\n")) 140 c.Assert(err, checker.IsNil) 141 c.Assert(result, checker.Equals, true) 142 } 143 144 func (s *DockerSuite) TestInspectContainerFilterInt(c *check.C) { 145 result := icmd.RunCmd(icmd.Cmd{ 146 Command: []string{dockerBinary, "run", "-i", "-a", "stdin", "busybox", "cat"}, 147 Stdin: strings.NewReader("blahblah"), 148 }) 149 result.Assert(c, icmd.Success) 150 out := result.Stdout() 151 id := strings.TrimSpace(out) 152 153 out = inspectField(c, id, "State.ExitCode") 154 155 exitCode, err := strconv.Atoi(out) 156 c.Assert(err, checker.IsNil, check.Commentf("failed to inspect exitcode of the container: %s, %v", out, err)) 157 158 //now get the exit code to verify 159 formatStr := fmt.Sprintf("--format={{eq .State.ExitCode %d}}", exitCode) 160 out, _ = dockerCmd(c, "inspect", formatStr, id) 161 inspectResult, err := strconv.ParseBool(strings.TrimSuffix(out, "\n")) 162 c.Assert(err, checker.IsNil) 163 c.Assert(inspectResult, checker.Equals, true) 164 } 165 166 func (s *DockerSuite) TestInspectImageGraphDriver(c *check.C) { 167 testRequires(c, DaemonIsLinux, Devicemapper) 168 imageTest := "emptyfs" 169 name := inspectField(c, imageTest, "GraphDriver.Name") 170 171 checkValidGraphDriver(c, name) 172 173 deviceID := inspectField(c, imageTest, "GraphDriver.Data.DeviceId") 174 175 _, err := strconv.Atoi(deviceID) 176 c.Assert(err, checker.IsNil, check.Commentf("failed to inspect DeviceId of the image: %s, %v", deviceID, err)) 177 178 deviceSize := inspectField(c, imageTest, "GraphDriver.Data.DeviceSize") 179 180 _, err = strconv.ParseUint(deviceSize, 10, 64) 181 c.Assert(err, checker.IsNil, check.Commentf("failed to inspect DeviceSize of the image: %s, %v", deviceSize, err)) 182 } 183 184 func (s *DockerSuite) TestInspectContainerGraphDriver(c *check.C) { 185 testRequires(c, DaemonIsLinux, Devicemapper) 186 187 out, _ := dockerCmd(c, "run", "-d", "busybox", "true") 188 out = strings.TrimSpace(out) 189 190 name := inspectField(c, out, "GraphDriver.Name") 191 192 checkValidGraphDriver(c, name) 193 194 imageDeviceID := inspectField(c, "busybox", "GraphDriver.Data.DeviceId") 195 196 deviceID := inspectField(c, out, "GraphDriver.Data.DeviceId") 197 198 c.Assert(imageDeviceID, checker.Not(checker.Equals), deviceID) 199 200 _, err := strconv.Atoi(deviceID) 201 c.Assert(err, checker.IsNil, check.Commentf("failed to inspect DeviceId of the image: %s, %v", deviceID, err)) 202 203 deviceSize := inspectField(c, out, "GraphDriver.Data.DeviceSize") 204 205 _, err = strconv.ParseUint(deviceSize, 10, 64) 206 c.Assert(err, checker.IsNil, check.Commentf("failed to inspect DeviceSize of the image: %s, %v", deviceSize, err)) 207 } 208 209 func (s *DockerSuite) TestInspectBindMountPoint(c *check.C) { 210 modifier := ",z" 211 prefix, slash := getPrefixAndSlashFromDaemonPlatform() 212 if testEnv.DaemonPlatform() == "windows" { 213 modifier = "" 214 // Linux creates the host directory if it doesn't exist. Windows does not. 215 os.Mkdir(`c:\data`, os.ModeDir) 216 } 217 218 dockerCmd(c, "run", "-d", "--name", "test", "-v", prefix+slash+"data:"+prefix+slash+"data:ro"+modifier, "busybox", "cat") 219 220 vol := inspectFieldJSON(c, "test", "Mounts") 221 222 var mp []types.MountPoint 223 err := json.Unmarshal([]byte(vol), &mp) 224 c.Assert(err, checker.IsNil) 225 226 // check that there is only one mountpoint 227 c.Assert(mp, check.HasLen, 1) 228 229 m := mp[0] 230 231 c.Assert(m.Name, checker.Equals, "") 232 c.Assert(m.Driver, checker.Equals, "") 233 c.Assert(m.Source, checker.Equals, prefix+slash+"data") 234 c.Assert(m.Destination, checker.Equals, prefix+slash+"data") 235 if testEnv.DaemonPlatform() != "windows" { // Windows does not set mode 236 c.Assert(m.Mode, checker.Equals, "ro"+modifier) 237 } 238 c.Assert(m.RW, checker.Equals, false) 239 } 240 241 func (s *DockerSuite) TestInspectNamedMountPoint(c *check.C) { 242 prefix, slash := getPrefixAndSlashFromDaemonPlatform() 243 244 dockerCmd(c, "run", "-d", "--name", "test", "-v", "data:"+prefix+slash+"data", "busybox", "cat") 245 246 vol := inspectFieldJSON(c, "test", "Mounts") 247 248 var mp []types.MountPoint 249 err := json.Unmarshal([]byte(vol), &mp) 250 c.Assert(err, checker.IsNil) 251 252 // check that there is only one mountpoint 253 c.Assert(mp, checker.HasLen, 1) 254 255 m := mp[0] 256 257 c.Assert(m.Name, checker.Equals, "data") 258 c.Assert(m.Driver, checker.Equals, "local") 259 c.Assert(m.Source, checker.Not(checker.Equals), "") 260 c.Assert(m.Destination, checker.Equals, prefix+slash+"data") 261 c.Assert(m.RW, checker.Equals, true) 262 } 263 264 // #14947 265 func (s *DockerSuite) TestInspectTimesAsRFC3339Nano(c *check.C) { 266 out, _ := dockerCmd(c, "run", "-d", "busybox", "true") 267 id := strings.TrimSpace(out) 268 startedAt := inspectField(c, id, "State.StartedAt") 269 finishedAt := inspectField(c, id, "State.FinishedAt") 270 created := inspectField(c, id, "Created") 271 272 _, err := time.Parse(time.RFC3339Nano, startedAt) 273 c.Assert(err, checker.IsNil) 274 _, err = time.Parse(time.RFC3339Nano, finishedAt) 275 c.Assert(err, checker.IsNil) 276 _, err = time.Parse(time.RFC3339Nano, created) 277 c.Assert(err, checker.IsNil) 278 279 created = inspectField(c, "busybox", "Created") 280 281 _, err = time.Parse(time.RFC3339Nano, created) 282 c.Assert(err, checker.IsNil) 283 } 284 285 // #15633 286 func (s *DockerSuite) TestInspectLogConfigNoType(c *check.C) { 287 dockerCmd(c, "create", "--name=test", "--log-opt", "max-file=42", "busybox") 288 var logConfig container.LogConfig 289 290 out := inspectFieldJSON(c, "test", "HostConfig.LogConfig") 291 292 err := json.NewDecoder(strings.NewReader(out)).Decode(&logConfig) 293 c.Assert(err, checker.IsNil, check.Commentf("%v", out)) 294 295 c.Assert(logConfig.Type, checker.Equals, "json-file") 296 c.Assert(logConfig.Config["max-file"], checker.Equals, "42", check.Commentf("%v", logConfig)) 297 } 298 299 func (s *DockerSuite) TestInspectNoSizeFlagContainer(c *check.C) { 300 301 //Both the container and image are named busybox. docker inspect will fetch container 302 //JSON SizeRw and SizeRootFs field. If there is no flag --size/-s, there are no size fields. 303 304 runSleepingContainer(c, "--name=busybox", "-d") 305 306 formatStr := "--format={{.SizeRw}},{{.SizeRootFs}}" 307 out, _ := dockerCmd(c, "inspect", "--type=container", formatStr, "busybox") 308 c.Assert(strings.TrimSpace(out), check.Equals, "<nil>,<nil>", check.Commentf("Exepcted not to display size info: %s", out)) 309 } 310 311 func (s *DockerSuite) TestInspectSizeFlagContainer(c *check.C) { 312 runSleepingContainer(c, "--name=busybox", "-d") 313 314 formatStr := "--format='{{.SizeRw}},{{.SizeRootFs}}'" 315 out, _ := dockerCmd(c, "inspect", "-s", "--type=container", formatStr, "busybox") 316 sz := strings.Split(out, ",") 317 318 c.Assert(strings.TrimSpace(sz[0]), check.Not(check.Equals), "<nil>") 319 c.Assert(strings.TrimSpace(sz[1]), check.Not(check.Equals), "<nil>") 320 } 321 322 func (s *DockerSuite) TestInspectTemplateError(c *check.C) { 323 // Template parsing error for both the container and image. 324 325 runSleepingContainer(c, "--name=container1", "-d") 326 327 out, _, err := dockerCmdWithError("inspect", "--type=container", "--format='Format container: {{.ThisDoesNotExist}}'", "container1") 328 c.Assert(err, check.Not(check.IsNil)) 329 c.Assert(out, checker.Contains, "Template parsing error") 330 331 out, _, err = dockerCmdWithError("inspect", "--type=image", "--format='Format container: {{.ThisDoesNotExist}}'", "busybox") 332 c.Assert(err, check.Not(check.IsNil)) 333 c.Assert(out, checker.Contains, "Template parsing error") 334 } 335 336 func (s *DockerSuite) TestInspectJSONFields(c *check.C) { 337 runSleepingContainer(c, "--name=busybox", "-d") 338 out, _, err := dockerCmdWithError("inspect", "--type=container", "--format={{.HostConfig.Dns}}", "busybox") 339 340 c.Assert(err, check.IsNil) 341 c.Assert(out, checker.Equals, "[]\n") 342 } 343 344 func (s *DockerSuite) TestInspectByPrefix(c *check.C) { 345 id := inspectField(c, "busybox", "Id") 346 c.Assert(id, checker.HasPrefix, "sha256:") 347 348 id2 := inspectField(c, id[:12], "Id") 349 c.Assert(id, checker.Equals, id2) 350 351 id3 := inspectField(c, strings.TrimPrefix(id, "sha256:")[:12], "Id") 352 c.Assert(id, checker.Equals, id3) 353 } 354 355 func (s *DockerSuite) TestInspectStopWhenNotFound(c *check.C) { 356 runSleepingContainer(c, "--name=busybox", "-d") 357 runSleepingContainer(c, "--name=not-shown", "-d") 358 out, _, err := dockerCmdWithError("inspect", "--type=container", "--format='{{.Name}}'", "busybox", "missing", "not-shown") 359 360 c.Assert(err, checker.Not(check.IsNil)) 361 c.Assert(out, checker.Contains, "busybox") 362 c.Assert(out, checker.Not(checker.Contains), "not-shown") 363 c.Assert(out, checker.Contains, "Error: No such container: missing") 364 } 365 366 func (s *DockerSuite) TestInspectHistory(c *check.C) { 367 dockerCmd(c, "run", "--name=testcont", "busybox", "echo", "hello") 368 dockerCmd(c, "commit", "-m", "test comment", "testcont", "testimg") 369 out, _, err := dockerCmdWithError("inspect", "--format='{{.Comment}}'", "testimg") 370 c.Assert(err, check.IsNil) 371 c.Assert(out, checker.Contains, "test comment") 372 } 373 374 func (s *DockerSuite) TestInspectContainerNetworkDefault(c *check.C) { 375 testRequires(c, DaemonIsLinux) 376 377 contName := "test1" 378 dockerCmd(c, "run", "--name", contName, "-d", "busybox", "top") 379 netOut, _ := dockerCmd(c, "network", "inspect", "--format={{.ID}}", "bridge") 380 out := inspectField(c, contName, "NetworkSettings.Networks") 381 c.Assert(out, checker.Contains, "bridge") 382 out = inspectField(c, contName, "NetworkSettings.Networks.bridge.NetworkID") 383 c.Assert(strings.TrimSpace(out), checker.Equals, strings.TrimSpace(netOut)) 384 } 385 386 func (s *DockerSuite) TestInspectContainerNetworkCustom(c *check.C) { 387 testRequires(c, DaemonIsLinux) 388 389 netOut, _ := dockerCmd(c, "network", "create", "net1") 390 dockerCmd(c, "run", "--name=container1", "--net=net1", "-d", "busybox", "top") 391 out := inspectField(c, "container1", "NetworkSettings.Networks") 392 c.Assert(out, checker.Contains, "net1") 393 out = inspectField(c, "container1", "NetworkSettings.Networks.net1.NetworkID") 394 c.Assert(strings.TrimSpace(out), checker.Equals, strings.TrimSpace(netOut)) 395 } 396 397 func (s *DockerSuite) TestInspectRootFS(c *check.C) { 398 out, _, err := dockerCmdWithError("inspect", "busybox") 399 c.Assert(err, check.IsNil) 400 401 var imageJSON []types.ImageInspect 402 err = json.Unmarshal([]byte(out), &imageJSON) 403 c.Assert(err, checker.IsNil) 404 405 c.Assert(len(imageJSON[0].RootFS.Layers), checker.GreaterOrEqualThan, 1) 406 } 407 408 func (s *DockerSuite) TestInspectAmpersand(c *check.C) { 409 testRequires(c, DaemonIsLinux) 410 411 name := "test" 412 out, _ := dockerCmd(c, "run", "--name", name, "--env", `TEST_ENV="soanni&rtr"`, "busybox", "env") 413 c.Assert(out, checker.Contains, `soanni&rtr`) 414 out, _ = dockerCmd(c, "inspect", name) 415 c.Assert(out, checker.Contains, `soanni&rtr`) 416 } 417 418 func (s *DockerSuite) TestInspectPlugin(c *check.C) { 419 testRequires(c, DaemonIsLinux, IsAmd64, Network) 420 _, _, err := dockerCmdWithError("plugin", "install", "--grant-all-permissions", pNameWithTag) 421 c.Assert(err, checker.IsNil) 422 423 out, _, err := dockerCmdWithError("inspect", "--type", "plugin", "--format", "{{.Name}}", pNameWithTag) 424 c.Assert(err, checker.IsNil) 425 c.Assert(strings.TrimSpace(out), checker.Equals, pNameWithTag) 426 427 out, _, err = dockerCmdWithError("inspect", "--format", "{{.Name}}", pNameWithTag) 428 c.Assert(err, checker.IsNil) 429 c.Assert(strings.TrimSpace(out), checker.Equals, pNameWithTag) 430 431 // Even without tag the inspect still work 432 out, _, err = dockerCmdWithError("inspect", "--type", "plugin", "--format", "{{.Name}}", pNameWithTag) 433 c.Assert(err, checker.IsNil) 434 c.Assert(strings.TrimSpace(out), checker.Equals, pNameWithTag) 435 436 out, _, err = dockerCmdWithError("inspect", "--format", "{{.Name}}", pNameWithTag) 437 c.Assert(err, checker.IsNil) 438 c.Assert(strings.TrimSpace(out), checker.Equals, pNameWithTag) 439 440 _, _, err = dockerCmdWithError("plugin", "disable", pNameWithTag) 441 c.Assert(err, checker.IsNil) 442 443 out, _, err = dockerCmdWithError("plugin", "remove", pNameWithTag) 444 c.Assert(err, checker.IsNil) 445 c.Assert(out, checker.Contains, pNameWithTag) 446 } 447 448 // Test case for 29185 449 func (s *DockerSuite) TestInspectUnknownObject(c *check.C) { 450 // This test should work on both Windows and Linux 451 out, _, err := dockerCmdWithError("inspect", "foobar") 452 c.Assert(err, checker.NotNil) 453 c.Assert(out, checker.Contains, "Error: No such object: foobar") 454 c.Assert(err.Error(), checker.Contains, "Error: No such object: foobar") 455 } 456 457 func (s *DockerSuite) TestInpectInvalidReference(c *check.C) { 458 // This test should work on both Windows and Linux 459 out, _, err := dockerCmdWithError("inspect", "FooBar") 460 c.Assert(err, checker.NotNil) 461 c.Assert(out, checker.Contains, "Error: No such object: FooBar") 462 c.Assert(err.Error(), checker.Contains, "Error: No such object: FooBar") 463 }