integration-cli/docker_cli_health_test.go
b6c7becb
 package main
 
 import (
 	"encoding/json"
 	"strconv"
 	"strings"
 	"time"
1a149a0e
 
 	"github.com/docker/docker/api/types"
33968e6c
 	"github.com/docker/docker/integration-cli/checker"
50c4475d
 	"github.com/docker/docker/integration-cli/cli/build"
1a149a0e
 	"github.com/go-check/check"
b6c7becb
 )
 
 func waitForHealthStatus(c *check.C, name string, prev string, expected string) {
 	prev = prev + "\n"
 	expected = expected + "\n"
 	for {
 		out, _ := dockerCmd(c, "inspect", "--format={{.State.Health.Status}}", name)
 		if out == expected {
 			return
 		}
 		c.Check(out, checker.Equals, prev)
 		if out != prev {
 			return
 		}
 		time.Sleep(100 * time.Millisecond)
 	}
 }
 
 func getHealth(c *check.C, name string) *types.Health {
 	out, _ := dockerCmd(c, "inspect", "--format={{json .State.Health}}", name)
 	var health types.Health
 	err := json.Unmarshal([]byte(out), &health)
 	c.Check(err, checker.Equals, nil)
 	return &health
 }
 
 func (s *DockerSuite) TestHealth(c *check.C) {
 	testRequires(c, DaemonIsLinux) // busybox doesn't work on Windows
 
86f9eb4a
 	existingContainers := ExistingContainerIDs(c)
dc6ddfa8
 
b6c7becb
 	imageName := "testhealth"
50c4475d
 	buildImageSuccessfully(c, imageName, build.WithDockerfile(`FROM busybox
b6c7becb
 		RUN echo OK > /status
 		CMD ["/bin/sleep", "120"]
 		STOPSIGNAL SIGKILL
 		HEALTHCHECK --interval=1s --timeout=30s \
c10f6ef4
 		  CMD cat /status`))
b6c7becb
 
 	// No health status before starting
 	name := "test_health"
86f9eb4a
 	cid, _ := dockerCmd(c, "create", "--name", name, imageName)
 	out, _ := dockerCmd(c, "ps", "-a", "--format={{.ID}} {{.Status}}")
dc6ddfa8
 	out = RemoveOutputForExistingElements(out, existingContainers)
86f9eb4a
 	c.Check(out, checker.Equals, cid[:12]+" Created\n")
b6c7becb
 
 	// Inspect the options
 	out, _ = dockerCmd(c, "inspect",
50c4475d
 		"--format=timeout={{.Config.Healthcheck.Timeout}} interval={{.Config.Healthcheck.Interval}} retries={{.Config.Healthcheck.Retries}} test={{.Config.Healthcheck.Test}}", name)
b6c7becb
 	c.Check(out, checker.Equals, "timeout=30s interval=1s retries=0 test=[CMD-SHELL cat /status]\n")
 
 	// Start
 	dockerCmd(c, "start", name)
 	waitForHealthStatus(c, name, "starting", "healthy")
 
 	// Make it fail
 	dockerCmd(c, "exec", name, "rm", "/status")
 	waitForHealthStatus(c, name, "healthy", "unhealthy")
 
 	// Inspect the status
 	out, _ = dockerCmd(c, "inspect", "--format={{.State.Health.Status}}", name)
 	c.Check(out, checker.Equals, "unhealthy\n")
 
 	// Make it healthy again
 	dockerCmd(c, "exec", name, "touch", "/status")
 	waitForHealthStatus(c, name, "unhealthy", "healthy")
 
 	// Remove container
 	dockerCmd(c, "rm", "-f", name)
 
 	// Disable the check from the CLI
 	out, _ = dockerCmd(c, "create", "--name=noh", "--no-healthcheck", imageName)
 	out, _ = dockerCmd(c, "inspect", "--format={{.Config.Healthcheck.Test}}", "noh")
 	c.Check(out, checker.Equals, "[NONE]\n")
 	dockerCmd(c, "rm", "noh")
 
 	// Disable the check with a new build
50c4475d
 	buildImageSuccessfully(c, "no_healthcheck", build.WithDockerfile(`FROM testhealth
c10f6ef4
 		HEALTHCHECK NONE`))
b6c7becb
 
 	out, _ = dockerCmd(c, "inspect", "--format={{.ContainerConfig.Healthcheck.Test}}", "no_healthcheck")
 	c.Check(out, checker.Equals, "[NONE]\n")
 
 	// Enable the checks from the CLI
 	_, _ = dockerCmd(c, "run", "-d", "--name=fatal_healthcheck",
e399c558
 		"--health-interval=1s",
b6c7becb
 		"--health-retries=3",
 		"--health-cmd=cat /status",
 		"no_healthcheck")
 	waitForHealthStatus(c, "fatal_healthcheck", "starting", "healthy")
 	health := getHealth(c, "fatal_healthcheck")
 	c.Check(health.Status, checker.Equals, "healthy")
 	c.Check(health.FailingStreak, checker.Equals, 0)
 	last := health.Log[len(health.Log)-1]
 	c.Check(last.ExitCode, checker.Equals, 0)
 	c.Check(last.Output, checker.Equals, "OK\n")
 
18a59bb8
 	// Fail the check
b6c7becb
 	dockerCmd(c, "exec", "fatal_healthcheck", "rm", "/status")
18a59bb8
 	waitForHealthStatus(c, "fatal_healthcheck", "healthy", "unhealthy")
b6c7becb
 
 	failsStr, _ := dockerCmd(c, "inspect", "--format={{.State.Health.FailingStreak}}", "fatal_healthcheck")
 	fails, err := strconv.Atoi(strings.TrimSpace(failsStr))
 	c.Check(err, check.IsNil)
 	c.Check(fails >= 3, checker.Equals, true)
 	dockerCmd(c, "rm", "-f", "fatal_healthcheck")
 
 	// Check timeout
 	// Note: if the interval is too small, it seems that Docker spends all its time running health
 	// checks and never gets around to killing it.
 	_, _ = dockerCmd(c, "run", "-d", "--name=test",
e399c558
 		"--health-interval=1s", "--health-cmd=sleep 5m", "--health-timeout=1s", imageName)
b6c7becb
 	waitForHealthStatus(c, "test", "starting", "unhealthy")
 	health = getHealth(c, "test")
 	last = health.Log[len(health.Log)-1]
 	c.Check(health.Status, checker.Equals, "unhealthy")
 	c.Check(last.ExitCode, checker.Equals, -1)
e399c558
 	c.Check(last.Output, checker.Equals, "Health check exceeded timeout (1s)")
b6c7becb
 	dockerCmd(c, "rm", "-f", "test")
e95b6b51
 
 	// Check JSON-format
50c4475d
 	buildImageSuccessfully(c, imageName, build.WithDockerfile(`FROM busybox
e95b6b51
 		RUN echo OK > /status
 		CMD ["/bin/sleep", "120"]
 		STOPSIGNAL SIGKILL
 		HEALTHCHECK --interval=1s --timeout=30s \
c10f6ef4
 		  CMD ["cat", "/my status"]`))
e95b6b51
 	out, _ = dockerCmd(c, "inspect",
 		"--format={{.Config.Healthcheck.Test}}", imageName)
 	c.Check(out, checker.Equals, "[CMD cat /my status]\n")
 
b6c7becb
 }
5836d86a
 
b80472ce
 // GitHub #33021
5836d86a
 func (s *DockerSuite) TestUnsetEnvVarHealthCheck(c *check.C) {
 	testRequires(c, DaemonIsLinux) // busybox doesn't work on Windows
 
 	imageName := "testhealth"
 	buildImageSuccessfully(c, imageName, build.WithDockerfile(`FROM busybox
 HEALTHCHECK --interval=1s --timeout=5s --retries=5 CMD /bin/sh -c "sleep 1"
 ENTRYPOINT /bin/sh -c "sleep 600"`))
 
 	name := "env_test_health"
 	// No health status before starting
 	dockerCmd(c, "run", "-d", "--name", name, "-e", "FOO", imageName)
 	defer func() {
 		dockerCmd(c, "rm", "-f", name)
 		dockerCmd(c, "rmi", imageName)
 	}()
 
 	// Start
 	dockerCmd(c, "start", name)
 	waitForHealthStatus(c, name, "starting", "healthy")
 
 }