integration-cli/docker_cli_events_unix_test.go
f3ed4228
 // +build !windows
 
 package main
 
 import (
 	"bufio"
e372883f
 	"bytes"
f3ed4228
 	"fmt"
 	"io/ioutil"
 	"os"
 	"os/exec"
f05bacbe
 	"strings"
59e55dcd
 	"testing"
f05bacbe
 	"time"
f3ed4228
 	"unicode"
 
0595c017
 	"github.com/creack/pty"
50c4475d
 	"github.com/docker/docker/integration-cli/cli/build"
069fdc8a
 	"golang.org/x/sys/unix"
9f0b3f56
 	"gotest.tools/v3/assert"
 	is "gotest.tools/v3/assert/cmp"
f3ed4228
 )
 
 // #5979
1d92789b
 func (s *DockerSuite) TestEventsRedirectStdout(c *testing.T) {
55053d35
 	since := daemonUnixTime(c)
dc944ea7
 	dockerCmd(c, "run", "busybox", "true")
f3ed4228
 
 	file, err := ioutil.TempFile("", "")
6345208b
 	assert.NilError(c, err, "could not create temp file")
f3ed4228
 	defer os.Remove(file.Name())
 
55053d35
 	command := fmt.Sprintf("%s events --since=%s --until=%s > %s", dockerBinary, since, daemonUnixTime(c), file.Name())
f3ed4228
 	_, tty, err := pty.Open()
6345208b
 	assert.NilError(c, err, "Could not open pty")
f3ed4228
 	cmd := exec.Command("sh", "-c", command)
 	cmd.Stdin = tty
 	cmd.Stdout = tty
 	cmd.Stderr = tty
6345208b
 	assert.NilError(c, cmd.Run(), "run err for command %q", command)
f3ed4228
 
 	scanner := bufio.NewScanner(file)
 	for scanner.Scan() {
dc944ea7
 		for _, ch := range scanner.Text() {
6345208b
 			assert.Check(c, unicode.IsControl(ch) == false, "found control character %v", []byte(string(ch)))
f3ed4228
 		}
 	}
6345208b
 	assert.NilError(c, scanner.Err(), "Scan err for command %q", command)
f3ed4228
 }
f05bacbe
 
1d92789b
 func (s *DockerSuite) TestEventsOOMDisableFalse(c *testing.T) {
620ddc78
 	testRequires(c, DaemonIsLinux, oomControl, memoryLimitSupport, swapMemorySupport, NotPpc64le)
f05bacbe
 
c322af80
 	errChan := make(chan error, 1)
f05bacbe
 	go func() {
 		defer close(errChan)
 		out, exitCode, _ := dockerCmdWithError("run", "--name", "oomFalse", "-m", "10MB", "busybox", "sh", "-c", "x=a; while true; do x=$x$x$x$x; done")
 		if expected := 137; exitCode != expected {
 			errChan <- fmt.Errorf("wrong exit code for OOM container: expected %d, got %d (output: %q)", expected, exitCode, out)
 		}
 	}()
 	select {
 	case err := <-errChan:
6345208b
 		assert.NilError(c, err)
f05bacbe
 	case <-time.After(30 * time.Second):
 		c.Fatal("Timeout waiting for container to die on OOM")
 	}
 
55053d35
 	out, _ := dockerCmd(c, "events", "--since=0", "-f", "container=oomFalse", "--until", daemonUnixTime(c))
f05bacbe
 	events := strings.Split(strings.TrimSuffix(out, "\n"), "\n")
72f1881d
 	nEvents := len(events)
 
6345208b
 	assert.Assert(c, nEvents >= 5)
 	assert.Equal(c, parseEventAction(c, events[nEvents-5]), "create")
 	assert.Equal(c, parseEventAction(c, events[nEvents-4]), "attach")
 	assert.Equal(c, parseEventAction(c, events[nEvents-3]), "start")
 	assert.Equal(c, parseEventAction(c, events[nEvents-2]), "oom")
 	assert.Equal(c, parseEventAction(c, events[nEvents-1]), "die")
f05bacbe
 }
 
1d92789b
 func (s *DockerSuite) TestEventsOOMDisableTrue(c *testing.T) {
620ddc78
 	testRequires(c, DaemonIsLinux, oomControl, memoryLimitSupport, NotArm, swapMemorySupport, NotPpc64le)
f05bacbe
 
c322af80
 	errChan := make(chan error, 1)
6bf5b3db
 	observer, err := newEventObserver(c)
6345208b
 	assert.NilError(c, err)
6bf5b3db
 	err = observer.Start()
6345208b
 	assert.NilError(c, err)
6bf5b3db
 	defer observer.Stop()
 
f05bacbe
 	go func() {
 		defer close(errChan)
 		out, exitCode, _ := dockerCmdWithError("run", "--oom-kill-disable=true", "--name", "oomTrue", "-m", "10MB", "busybox", "sh", "-c", "x=a; while true; do x=$x$x$x$x; done")
 		if expected := 137; exitCode != expected {
 			errChan <- fmt.Errorf("wrong exit code for OOM container: expected %d, got %d (output: %q)", expected, exitCode, out)
 		}
 	}()
 
6345208b
 	assert.NilError(c, waitRun("oomTrue"))
adf75503
 	defer dockerCmdWithResult("kill", "oomTrue")
62a856e9
 	containerID := inspectField(c, "oomTrue", "Id")
f05bacbe
 
6bf5b3db
 	testActions := map[string]chan bool{
 		"oom": make(chan bool),
 	}
f05bacbe
 
6bf5b3db
 	matcher := matchEventLine(containerID, "container", testActions)
 	processor := processEventMatch(testActions)
 	go observer.Match(matcher, processor)
 
 	select {
 	case <-time.After(20 * time.Second):
 		observer.CheckEventError(c, containerID, "oom", matcher)
 	case <-testActions["oom"]:
50c4475d
 	// ignore, done
6bf5b3db
 	case errRun := <-errChan:
 		if errRun != nil {
 			c.Fatalf("%v", errRun)
 		} else {
 			c.Fatalf("container should be still running but it's not")
 		}
f05bacbe
 	}
6bf5b3db
 
62a856e9
 	status := inspectField(c, "oomTrue", "State.Status")
6345208b
 	assert.Equal(c, strings.TrimSpace(status), "running", "container should be still running")
f05bacbe
 }
687ef005
 
 // #18453
1d92789b
 func (s *DockerSuite) TestEventsContainerFilterByName(c *testing.T) {
687ef005
 	testRequires(c, DaemonIsLinux)
72f1881d
 	cOut, _ := dockerCmd(c, "run", "--name=foo", "-d", "busybox", "top")
 	c1 := strings.TrimSpace(cOut)
 	waitRun("foo")
 	cOut, _ = dockerCmd(c, "run", "--name=bar", "-d", "busybox", "top")
 	c2 := strings.TrimSpace(cOut)
 	waitRun("bar")
55053d35
 	out, _ := dockerCmd(c, "events", "-f", "container=foo", "--since=0", "--until", daemonUnixTime(c))
6345208b
 	assert.Assert(c, strings.Contains(out, c1), out)
 	assert.Assert(c, !strings.Contains(out, c2), out)
687ef005
 }
 
 // #18453
1d92789b
 func (s *DockerSuite) TestEventsContainerFilterBeforeCreate(c *testing.T) {
687ef005
 	testRequires(c, DaemonIsLinux)
e372883f
 	buf := &bytes.Buffer{}
 	cmd := exec.Command(dockerBinary, "events", "-f", "container=foo", "--since=0")
 	cmd.Stdout = buf
6345208b
 	assert.NilError(c, cmd.Start())
e372883f
 	defer cmd.Wait()
 	defer cmd.Process.Kill()
 
 	// Sleep for a second to make sure we are testing the case where events are listened before container starts.
 	time.Sleep(time.Second)
 	id, _ := dockerCmd(c, "run", "--name=foo", "-d", "busybox", "top")
687ef005
 	cID := strings.TrimSpace(id)
e372883f
 	for i := 0; ; i++ {
 		out := buf.String()
 		if strings.Contains(out, cID) {
 			break
 		}
 		if i > 30 {
 			c.Fatalf("Missing event of container (foo, %v), got %q", cID, out)
 		}
 		time.Sleep(500 * time.Millisecond)
 	}
687ef005
 }
9d12d093
 
1d92789b
 func (s *DockerSuite) TestVolumeEvents(c *testing.T) {
9d12d093
 	testRequires(c, DaemonIsLinux)
 
55053d35
 	since := daemonUnixTime(c)
9d12d093
 
 	// Observe create/mount volume actions
ba3f0bf0
 	dockerCmd(c, "volume", "create", "test-event-volume-local")
9d12d093
 	dockerCmd(c, "run", "--name", "test-volume-container", "--volume", "test-event-volume-local:/foo", "-d", "busybox", "true")
 	waitRun("test-volume-container")
 
 	// Observe unmount/destroy volume actions
 	dockerCmd(c, "rm", "-f", "test-volume-container")
 	dockerCmd(c, "volume", "rm", "test-event-volume-local")
 
55053d35
 	until := daemonUnixTime(c)
 	out, _ := dockerCmd(c, "events", "--since", since, "--until", until)
9d12d093
 	events := strings.Split(strings.TrimSpace(out), "\n")
6345208b
 	assert.Assert(c, len(events) > 4)
9d12d093
 
 	volumeEvents := eventActionsByIDAndType(c, events, "test-event-volume-local", "volume")
6345208b
 	assert.Equal(c, len(volumeEvents), 5)
 	assert.Equal(c, volumeEvents[0], "create")
 	assert.Equal(c, volumeEvents[1], "create")
 	assert.Equal(c, volumeEvents[2], "mount")
 	assert.Equal(c, volumeEvents[3], "unmount")
 	assert.Equal(c, volumeEvents[4], "destroy")
9d12d093
 }
f15af1ef
 
1d92789b
 func (s *DockerSuite) TestNetworkEvents(c *testing.T) {
f15af1ef
 	testRequires(c, DaemonIsLinux)
 
55053d35
 	since := daemonUnixTime(c)
f15af1ef
 
 	// Observe create/connect network actions
 	dockerCmd(c, "network", "create", "test-event-network-local")
 	dockerCmd(c, "run", "--name", "test-network-container", "--net", "test-event-network-local", "-d", "busybox", "true")
 	waitRun("test-network-container")
 
 	// Observe disconnect/destroy network actions
 	dockerCmd(c, "rm", "-f", "test-network-container")
 	dockerCmd(c, "network", "rm", "test-event-network-local")
 
55053d35
 	until := daemonUnixTime(c)
 	out, _ := dockerCmd(c, "events", "--since", since, "--until", until)
f15af1ef
 	events := strings.Split(strings.TrimSpace(out), "\n")
6345208b
 	assert.Assert(c, len(events) > 4)
f15af1ef
 
 	netEvents := eventActionsByIDAndType(c, events, "test-event-network-local", "network")
6345208b
 	assert.Equal(c, len(netEvents), 4)
 	assert.Equal(c, netEvents[0], "create")
 	assert.Equal(c, netEvents[1], "connect")
 	assert.Equal(c, netEvents[2], "disconnect")
 	assert.Equal(c, netEvents[3], "destroy")
f15af1ef
 }
851fe00c
 
1d92789b
 func (s *DockerSuite) TestEventsContainerWithMultiNetwork(c *testing.T) {
1cac7e6c
 	testRequires(c, DaemonIsLinux)
 
 	// Observe create/connect network actions
 	dockerCmd(c, "network", "create", "test-event-network-local-1")
 	dockerCmd(c, "network", "create", "test-event-network-local-2")
 	dockerCmd(c, "run", "--name", "test-network-container", "--net", "test-event-network-local-1", "-td", "busybox", "sh")
 	waitRun("test-network-container")
 	dockerCmd(c, "network", "connect", "test-event-network-local-2", "test-network-container")
 
 	since := daemonUnixTime(c)
 
 	dockerCmd(c, "stop", "-t", "1", "test-network-container")
 
 	until := daemonUnixTime(c)
 	out, _ := dockerCmd(c, "events", "--since", since, "--until", until, "-f", "type=network")
 	netEvents := strings.Split(strings.TrimSpace(out), "\n")
 
e0de1718
 	// received two network disconnect events
6345208b
 	assert.Equal(c, len(netEvents), 2)
 	assert.Assert(c, strings.Contains(netEvents[0], "disconnect"))
 	assert.Assert(c, strings.Contains(netEvents[1], "disconnect"))
e0de1718
 
580d3677
 	// both networks appeared in the network event output
6345208b
 	assert.Assert(c, strings.Contains(out, "test-event-network-local-1"))
 	assert.Assert(c, strings.Contains(out, "test-event-network-local-2"))
1cac7e6c
 }
 
1d92789b
 func (s *DockerSuite) TestEventsStreaming(c *testing.T) {
851fe00c
 	testRequires(c, DaemonIsLinux)
 
 	observer, err := newEventObserver(c)
6345208b
 	assert.NilError(c, err)
851fe00c
 	err = observer.Start()
6345208b
 	assert.NilError(c, err)
851fe00c
 	defer observer.Stop()
 
 	out, _ := dockerCmd(c, "run", "-d", "busybox:latest", "true")
 	containerID := strings.TrimSpace(out)
 
 	testActions := map[string]chan bool{
abbf2aa6
 		"create":  make(chan bool, 1),
 		"start":   make(chan bool, 1),
 		"die":     make(chan bool, 1),
 		"destroy": make(chan bool, 1),
851fe00c
 	}
 
 	matcher := matchEventLine(containerID, "container", testActions)
27b06049
 	processor := processEventMatch(testActions)
 	go observer.Match(matcher, processor)
851fe00c
 
 	select {
 	case <-time.After(5 * time.Second):
 		observer.CheckEventError(c, containerID, "create", matcher)
 	case <-testActions["create"]:
 		// ignore, done
 	}
 
 	select {
 	case <-time.After(5 * time.Second):
 		observer.CheckEventError(c, containerID, "start", matcher)
 	case <-testActions["start"]:
 		// ignore, done
 	}
 
 	select {
 	case <-time.After(5 * time.Second):
 		observer.CheckEventError(c, containerID, "die", matcher)
 	case <-testActions["die"]:
 		// ignore, done
 	}
 
 	dockerCmd(c, "rm", containerID)
 
 	select {
 	case <-time.After(5 * time.Second):
 		observer.CheckEventError(c, containerID, "destroy", matcher)
 	case <-testActions["destroy"]:
 		// ignore, done
 	}
 }
 
1d92789b
 func (s *DockerSuite) TestEventsImageUntagDelete(c *testing.T) {
851fe00c
 	testRequires(c, DaemonIsLinux)
 
 	observer, err := newEventObserver(c)
6345208b
 	assert.NilError(c, err)
851fe00c
 	err = observer.Start()
6345208b
 	assert.NilError(c, err)
851fe00c
 	defer observer.Stop()
 
 	name := "testimageevents"
50c4475d
 	buildImageSuccessfully(c, name, build.WithDockerfile(`FROM scratch
c10f6ef4
 		MAINTAINER "docker"`))
 	imageID := getIDByName(c, name)
6345208b
 	assert.NilError(c, deleteImages(name))
851fe00c
 
 	testActions := map[string]chan bool{
abbf2aa6
 		"untag":  make(chan bool, 1),
 		"delete": make(chan bool, 1),
851fe00c
 	}
 
 	matcher := matchEventLine(imageID, "image", testActions)
27b06049
 	processor := processEventMatch(testActions)
 	go observer.Match(matcher, processor)
851fe00c
 
 	select {
 	case <-time.After(10 * time.Second):
 		observer.CheckEventError(c, imageID, "untag", matcher)
 	case <-testActions["untag"]:
 		// ignore, done
 	}
 
 	select {
 	case <-time.After(10 * time.Second):
 		observer.CheckEventError(c, imageID, "delete", matcher)
 	case <-testActions["delete"]:
 		// ignore, done
 	}
 }
 
1d92789b
 func (s *DockerSuite) TestEventsFilterVolumeAndNetworkType(c *testing.T) {
851fe00c
 	testRequires(c, DaemonIsLinux)
 
55053d35
 	since := daemonUnixTime(c)
851fe00c
 
 	dockerCmd(c, "network", "create", "test-event-network-type")
ba3f0bf0
 	dockerCmd(c, "volume", "create", "test-event-volume-type")
851fe00c
 
55053d35
 	out, _ := dockerCmd(c, "events", "--filter", "type=volume", "--filter", "type=network", "--since", since, "--until", daemonUnixTime(c))
851fe00c
 	events := strings.Split(strings.TrimSpace(out), "\n")
6345208b
 	assert.Assert(c, len(events) >= 2, out)
851fe00c
 
 	networkActions := eventActionsByIDAndType(c, events, "test-event-network-type", "network")
 	volumeActions := eventActionsByIDAndType(c, events, "test-event-volume-type", "volume")
 
6345208b
 	assert.Equal(c, volumeActions[0], "create")
 	assert.Equal(c, networkActions[0], "create")
851fe00c
 }
 
1d92789b
 func (s *DockerSuite) TestEventsFilterVolumeID(c *testing.T) {
851fe00c
 	testRequires(c, DaemonIsLinux)
 
55053d35
 	since := daemonUnixTime(c)
851fe00c
 
ba3f0bf0
 	dockerCmd(c, "volume", "create", "test-event-volume-id")
55053d35
 	out, _ := dockerCmd(c, "events", "--filter", "volume=test-event-volume-id", "--since", since, "--until", daemonUnixTime(c))
851fe00c
 	events := strings.Split(strings.TrimSpace(out), "\n")
6345208b
 	assert.Equal(c, len(events), 1)
851fe00c
 
6345208b
 	assert.Equal(c, len(events), 1)
 	assert.Assert(c, strings.Contains(events[0], "test-event-volume-id"))
 	assert.Assert(c, strings.Contains(events[0], "driver=local"))
851fe00c
 }
 
1d92789b
 func (s *DockerSuite) TestEventsFilterNetworkID(c *testing.T) {
851fe00c
 	testRequires(c, DaemonIsLinux)
 
55053d35
 	since := daemonUnixTime(c)
851fe00c
 
 	dockerCmd(c, "network", "create", "test-event-network-local")
55053d35
 	out, _ := dockerCmd(c, "events", "--filter", "network=test-event-network-local", "--since", since, "--until", daemonUnixTime(c))
851fe00c
 	events := strings.Split(strings.TrimSpace(out), "\n")
6345208b
 	assert.Equal(c, len(events), 1)
 	assert.Assert(c, strings.Contains(events[0], "test-event-network-local"))
 	assert.Assert(c, strings.Contains(events[0], "type=bridge"))
851fe00c
 }
382c152a
 
1d92789b
 func (s *DockerDaemonSuite) TestDaemonEvents(c *testing.T) {
382c152a
 
 	// daemon config file
 	configFilePath := "test.json"
 	defer os.Remove(configFilePath)
 
 	daemonConfig := `{"labels":["foo=bar"]}`
0e0ab58a
 	err := ioutil.WriteFile(configFilePath, []byte(daemonConfig), 0644)
6345208b
 	assert.NilError(c, err)
24a41922
 	s.d.Start(c, "--config-file="+configFilePath)
 
 	info := s.d.Info(c)
382c152a
 
d7be6b2d
 	daemonConfig = `{"max-concurrent-downloads":1,"labels":["bar=foo"], "shutdown-timeout": 10}`
0e0ab58a
 	err = ioutil.WriteFile(configFilePath, []byte(daemonConfig), 0644)
24a41922
 	assert.NilError(c, err)
382c152a
 
6345208b
 	assert.NilError(c, s.d.Signal(unix.SIGHUP))
382c152a
 	time.Sleep(3 * time.Second)
 
24a41922
 	out, err := s.d.Cmd("events", "--since=0", "--until", daemonUnixTime(c))
6345208b
 	assert.NilError(c, err)
7b2e5216
 
9a60e1cc
 	// only check for values known (daemon ID/name) or explicitly set above,
 	// otherwise just check for names being present.
 	expectedSubstrings := []string{
24a41922
 		" daemon reload " + info.ID + " ",
9a60e1cc
 		"(allow-nondistributable-artifacts=[",
 		" cluster-advertise=, ",
 		" cluster-store=, ",
f929f15d
 		" cluster-store-opts=",
9a60e1cc
 		" debug=true, ",
 		" default-ipc-mode=",
 		" default-runtime=",
 		" default-shm-size=",
 		" insecure-registries=[",
 		" labels=[\"bar=foo\"], ",
 		" live-restore=",
 		" max-concurrent-downloads=1, ",
 		" max-concurrent-uploads=5, ",
24a41922
 		" name=" + info.Name,
9a60e1cc
 		" registry-mirrors=[",
 		" runtimes=",
 		" shutdown-timeout=10)",
 	}
 
 	for _, s := range expectedSubstrings {
8a3e8ac0
 		assert.Check(c, is.Contains(out, s))
9a60e1cc
 	}
62014aaf
 }
 
1d92789b
 func (s *DockerDaemonSuite) TestDaemonEventsWithFilters(c *testing.T) {
62014aaf
 
 	// daemon config file
 	configFilePath := "test.json"
 	defer os.Remove(configFilePath)
 
 	daemonConfig := `{"labels":["foo=bar"]}`
0e0ab58a
 	err := ioutil.WriteFile(configFilePath, []byte(daemonConfig), 0644)
6345208b
 	assert.NilError(c, err)
24a41922
 	s.d.Start(c, "--config-file="+configFilePath)
 
 	info := s.d.Info(c)
62014aaf
 
24a41922
 	assert.NilError(c, s.d.Signal(unix.SIGHUP))
62014aaf
 	time.Sleep(3 * time.Second)
 
24a41922
 	out, err := s.d.Cmd("events", "--since=0", "--until", daemonUnixTime(c), "--filter", fmt.Sprintf("daemon=%s", info.ID))
6345208b
 	assert.NilError(c, err)
24a41922
 	assert.Assert(c, strings.Contains(out, fmt.Sprintf("daemon reload %s", info.ID)))
62014aaf
 
24a41922
 	out, err = s.d.Cmd("events", "--since=0", "--until", daemonUnixTime(c), "--filter", fmt.Sprintf("daemon=%s", info.ID))
6345208b
 	assert.NilError(c, err)
24a41922
 	assert.Assert(c, strings.Contains(out, fmt.Sprintf("daemon reload %s", info.ID)))
62014aaf
 
 	out, err = s.d.Cmd("events", "--since=0", "--until", daemonUnixTime(c), "--filter", "daemon=foo")
6345208b
 	assert.NilError(c, err)
24a41922
 	assert.Assert(c, !strings.Contains(out, fmt.Sprintf("daemon reload %s", info.ID)))
62014aaf
 
 	out, err = s.d.Cmd("events", "--since=0", "--until", daemonUnixTime(c), "--filter", "type=daemon")
6345208b
 	assert.NilError(c, err)
24a41922
 	assert.Assert(c, strings.Contains(out, fmt.Sprintf("daemon reload %s", info.ID)))
62014aaf
 
 	out, err = s.d.Cmd("events", "--since=0", "--until", daemonUnixTime(c), "--filter", "type=container")
6345208b
 	assert.NilError(c, err)
24a41922
 	assert.Assert(c, !strings.Contains(out, fmt.Sprintf("daemon reload %s", info.ID)))
382c152a
 }