f4c0ec8ffc
- TestServiceLogsCompleteness runs service with command to write 6 log lines but as command exits immediately, service is restarted and 6 more lines are printed in logs, which confuses the checker.Equals(6) check. - TestServiceLogsSince runs service with command to write 3 log lines, and service restart can also affect it's checks. Let's change from `tail` which exits immediately to `tail -f` which hangs forever, this way we would not confuse checks with more log lines when expected. Signed-off-by: Pavel Tikhomirov <ptikhomirov@virtuozzo.com>
393 lines
14 KiB
Go
393 lines
14 KiB
Go
//go:build !windows
|
|
// +build !windows
|
|
|
|
package main
|
|
|
|
import (
|
|
"bufio"
|
|
"fmt"
|
|
"io"
|
|
"os/exec"
|
|
"strings"
|
|
"testing"
|
|
"time"
|
|
|
|
"github.com/docker/docker/integration-cli/checker"
|
|
"github.com/docker/docker/integration-cli/daemon"
|
|
"gotest.tools/v3/assert"
|
|
"gotest.tools/v3/icmd"
|
|
"gotest.tools/v3/poll"
|
|
)
|
|
|
|
type logMessage struct {
|
|
err error
|
|
data []byte
|
|
}
|
|
|
|
func (s *DockerSwarmSuite) TestServiceLogs(c *testing.T) {
|
|
d := s.AddDaemon(c, true, true)
|
|
|
|
// we have multiple services here for detecting the goroutine issue #28915
|
|
services := map[string]string{
|
|
"TestServiceLogs1": "hello1",
|
|
"TestServiceLogs2": "hello2",
|
|
}
|
|
|
|
for name, message := range services {
|
|
out, err := d.Cmd("service", "create", "--detach", "--no-resolve-image", "--name", name, "busybox",
|
|
"sh", "-c", fmt.Sprintf("echo %s; exec tail -f /dev/null", message))
|
|
assert.NilError(c, err)
|
|
assert.Assert(c, strings.TrimSpace(out) != "")
|
|
}
|
|
|
|
// make sure task has been deployed.
|
|
poll.WaitOn(c, pollCheck(c,
|
|
d.CheckRunningTaskImages, checker.DeepEquals(map[string]int{"busybox:latest": len(services)})), poll.WithTimeout(defaultReconciliationTimeout))
|
|
|
|
for name, message := range services {
|
|
out, err := d.Cmd("service", "logs", name)
|
|
assert.NilError(c, err)
|
|
assert.Assert(c, strings.Contains(out, message), "log for %q: %q", name, out)
|
|
}
|
|
}
|
|
|
|
// countLogLines returns a closure that can be used with poll.WaitOn() to
|
|
// verify that a minimum number of expected container log messages have been
|
|
// output.
|
|
func countLogLines(d *daemon.Daemon, name string) func(*testing.T) (interface{}, string) {
|
|
return func(c *testing.T) (interface{}, string) {
|
|
result := icmd.RunCmd(d.Command("service", "logs", "-t", "--raw", name))
|
|
result.Assert(c, icmd.Expected{})
|
|
// if this returns an emptystring, trying to split it later will return
|
|
// an array containing emptystring. a valid log line will NEVER be
|
|
// emptystring because we ask for the timestamp.
|
|
if result.Stdout() == "" {
|
|
return 0, "Empty stdout"
|
|
}
|
|
lines := strings.Split(strings.TrimSpace(result.Stdout()), "\n")
|
|
return len(lines), fmt.Sprintf("output, %q", result.Stdout())
|
|
}
|
|
}
|
|
|
|
func (s *DockerSwarmSuite) TestServiceLogsCompleteness(c *testing.T) {
|
|
d := s.AddDaemon(c, true, true)
|
|
|
|
name := "TestServiceLogsCompleteness"
|
|
|
|
// make a service that prints 6 lines
|
|
out, err := d.Cmd("service", "create", "--detach", "--no-resolve-image", "--name", name, "busybox", "sh", "-c", "for line in $(seq 0 5); do echo log test $line; done; exec tail -f /dev/null")
|
|
assert.NilError(c, err)
|
|
assert.Assert(c, strings.TrimSpace(out) != "")
|
|
|
|
// make sure task has been deployed.
|
|
poll.WaitOn(c, pollCheck(c, d.CheckActiveContainerCount, checker.Equals(1)), poll.WithTimeout(defaultReconciliationTimeout))
|
|
// and make sure we have all the log lines
|
|
poll.WaitOn(c, pollCheck(c, countLogLines(d, name), checker.Equals(6)), poll.WithTimeout(defaultReconciliationTimeout))
|
|
|
|
out, err = d.Cmd("service", "logs", name)
|
|
assert.NilError(c, err)
|
|
lines := strings.Split(strings.TrimSpace(out), "\n")
|
|
|
|
// i have heard anecdotal reports that logs may come back from the engine
|
|
// mis-ordered. if this tests fails, consider the possibility that that
|
|
// might be occurring
|
|
for i, line := range lines {
|
|
assert.Assert(c, strings.Contains(line, fmt.Sprintf("log test %v", i)))
|
|
}
|
|
}
|
|
|
|
func (s *DockerSwarmSuite) TestServiceLogsTail(c *testing.T) {
|
|
d := s.AddDaemon(c, true, true)
|
|
|
|
name := "TestServiceLogsTail"
|
|
|
|
// make a service that prints 6 lines
|
|
out, err := d.Cmd("service", "create", "--detach", "--no-resolve-image", "--name", name, "busybox", "sh", "-c", "for line in $(seq 1 6); do echo log test $line; done; sleep 100000")
|
|
assert.NilError(c, err)
|
|
assert.Assert(c, strings.TrimSpace(out) != "")
|
|
|
|
// make sure task has been deployed.
|
|
poll.WaitOn(c, pollCheck(c, d.CheckActiveContainerCount, checker.Equals(1)), poll.WithTimeout(defaultReconciliationTimeout))
|
|
poll.WaitOn(c, pollCheck(c, countLogLines(d, name), checker.Equals(6)), poll.WithTimeout(defaultReconciliationTimeout))
|
|
|
|
out, err = d.Cmd("service", "logs", "--tail=2", name)
|
|
assert.NilError(c, err)
|
|
lines := strings.Split(strings.TrimSpace(out), "\n")
|
|
|
|
for i, line := range lines {
|
|
// doing i+5 is hacky but not too fragile, it's good enough. if it flakes something else is wrong
|
|
assert.Assert(c, strings.Contains(line, fmt.Sprintf("log test %v", i+5)))
|
|
}
|
|
}
|
|
|
|
func (s *DockerSwarmSuite) TestServiceLogsSince(c *testing.T) {
|
|
// See DockerSuite.TestLogsSince, which is where this comes from
|
|
d := s.AddDaemon(c, true, true)
|
|
|
|
name := "TestServiceLogsSince"
|
|
|
|
out, err := d.Cmd("service", "create", "--detach", "--no-resolve-image", "--name", name, "busybox", "sh", "-c", "for i in $(seq 1 3); do usleep 100000; echo log$i; done; exec tail -f /dev/null")
|
|
assert.NilError(c, err)
|
|
assert.Assert(c, strings.TrimSpace(out) != "")
|
|
poll.WaitOn(c, pollCheck(c, d.CheckActiveContainerCount, checker.Equals(1)), poll.WithTimeout(defaultReconciliationTimeout))
|
|
// wait a sec for the logs to come in
|
|
poll.WaitOn(c, pollCheck(c, countLogLines(d, name), checker.Equals(3)), poll.WithTimeout(defaultReconciliationTimeout))
|
|
|
|
out, err = d.Cmd("service", "logs", "-t", name)
|
|
assert.NilError(c, err)
|
|
|
|
log2Line := strings.Split(strings.Split(out, "\n")[1], " ")
|
|
t, err := time.Parse(time.RFC3339Nano, log2Line[0]) // timestamp log2 is written
|
|
assert.NilError(c, err)
|
|
u := t.Add(50 * time.Millisecond) // add .05s so log1 & log2 don't show up
|
|
since := u.Format(time.RFC3339Nano)
|
|
|
|
out, err = d.Cmd("service", "logs", "-t", fmt.Sprintf("--since=%v", since), name)
|
|
assert.NilError(c, err)
|
|
|
|
unexpected := []string{"log1", "log2"}
|
|
expected := []string{"log3"}
|
|
for _, v := range unexpected {
|
|
assert.Assert(c, !strings.Contains(out, v), "unexpected log message returned, since=%v", u)
|
|
}
|
|
for _, v := range expected {
|
|
assert.Assert(c, strings.Contains(out, v), "expected log message %v, was not present, since=%v", u)
|
|
}
|
|
}
|
|
|
|
func (s *DockerSwarmSuite) TestServiceLogsFollow(c *testing.T) {
|
|
d := s.AddDaemon(c, true, true)
|
|
|
|
name := "TestServiceLogsFollow"
|
|
|
|
out, err := d.Cmd("service", "create", "--detach", "--no-resolve-image", "--name", name, "busybox", "sh", "-c", "trap 'exit 0' TERM; while true; do echo log test; usleep 100000; done")
|
|
assert.NilError(c, err)
|
|
assert.Assert(c, strings.TrimSpace(out) != "")
|
|
|
|
// make sure task has been deployed.
|
|
poll.WaitOn(c, pollCheck(c, d.CheckActiveContainerCount, checker.Equals(1)), poll.WithTimeout(defaultReconciliationTimeout))
|
|
|
|
args := []string{"service", "logs", "-f", name}
|
|
cmd := exec.Command(dockerBinary, d.PrependHostArg(args)...)
|
|
r, w := io.Pipe()
|
|
defer r.Close()
|
|
defer w.Close()
|
|
cmd.Stdout = w
|
|
cmd.Stderr = w
|
|
assert.NilError(c, cmd.Start())
|
|
go cmd.Wait()
|
|
|
|
// Make sure pipe is written to
|
|
ch := make(chan *logMessage)
|
|
done := make(chan struct{})
|
|
stop := make(chan struct{})
|
|
defer close(stop)
|
|
go func() {
|
|
reader := bufio.NewReader(r)
|
|
for {
|
|
msg := &logMessage{}
|
|
msg.data, _, msg.err = reader.ReadLine()
|
|
select {
|
|
case ch <- msg:
|
|
case <-stop:
|
|
return
|
|
case <-done:
|
|
return
|
|
}
|
|
}
|
|
}()
|
|
|
|
for i := 0; i < 3; i++ {
|
|
msg := <-ch
|
|
assert.NilError(c, msg.err)
|
|
assert.Assert(c, strings.Contains(string(msg.data), "log test"))
|
|
}
|
|
close(done)
|
|
|
|
assert.NilError(c, cmd.Process.Kill())
|
|
}
|
|
|
|
func (s *DockerSwarmSuite) TestServiceLogsTaskLogs(c *testing.T) {
|
|
d := s.AddDaemon(c, true, true)
|
|
|
|
name := "TestServicelogsTaskLogs"
|
|
replicas := 2
|
|
|
|
result := icmd.RunCmd(d.Command(
|
|
// create a service with the name
|
|
"service", "create", "--detach", "--no-resolve-image", "--name", name,
|
|
// which has some number of replicas
|
|
fmt.Sprintf("--replicas=%v", replicas),
|
|
// which has this the task id as an environment variable templated in
|
|
"--env", "TASK={{.Task.ID}}",
|
|
// and runs this command to print exactly 6 logs lines
|
|
"busybox", "sh", "-c", "trap 'exit 0' TERM; for line in $(seq 0 5); do echo $TASK log test $line; done; sleep 100000",
|
|
))
|
|
result.Assert(c, icmd.Expected{})
|
|
// ^^ verify that we get no error
|
|
// then verify that we have an id in stdout
|
|
id := strings.TrimSpace(result.Stdout())
|
|
assert.Assert(c, id != "")
|
|
// so, right here, we're basically inspecting by id and returning only
|
|
// the ID. if they don't match, the service doesn't exist.
|
|
result = icmd.RunCmd(d.Command("service", "inspect", "--format=\"{{.ID}}\"", id))
|
|
result.Assert(c, icmd.Expected{Out: id})
|
|
|
|
// make sure task has been deployed.
|
|
poll.WaitOn(c, pollCheck(c, d.CheckActiveContainerCount, checker.Equals(replicas)), poll.WithTimeout(defaultReconciliationTimeout))
|
|
poll.WaitOn(c, pollCheck(c, countLogLines(d, name), checker.Equals(6*replicas)), poll.WithTimeout(defaultReconciliationTimeout))
|
|
|
|
// get the task ids
|
|
result = icmd.RunCmd(d.Command("service", "ps", "-q", name))
|
|
result.Assert(c, icmd.Expected{})
|
|
// make sure we have two tasks
|
|
taskIDs := strings.Split(strings.TrimSpace(result.Stdout()), "\n")
|
|
assert.Equal(c, len(taskIDs), replicas)
|
|
|
|
for _, taskID := range taskIDs {
|
|
c.Logf("checking task %v", taskID)
|
|
result := icmd.RunCmd(d.Command("service", "logs", taskID))
|
|
result.Assert(c, icmd.Expected{})
|
|
lines := strings.Split(strings.TrimSpace(result.Stdout()), "\n")
|
|
|
|
c.Logf("checking messages for %v", taskID)
|
|
for i, line := range lines {
|
|
// make sure the message is in order
|
|
assert.Assert(c, strings.Contains(line, fmt.Sprintf("log test %v", i)))
|
|
// make sure it contains the task id
|
|
assert.Assert(c, strings.Contains(line, taskID))
|
|
}
|
|
}
|
|
}
|
|
|
|
func (s *DockerSwarmSuite) TestServiceLogsTTY(c *testing.T) {
|
|
d := s.AddDaemon(c, true, true)
|
|
|
|
name := "TestServiceLogsTTY"
|
|
|
|
result := icmd.RunCmd(d.Command(
|
|
// create a service
|
|
"service", "create", "--detach", "--no-resolve-image",
|
|
// name it $name
|
|
"--name", name,
|
|
// use a TTY
|
|
"-t",
|
|
// busybox image, shell string
|
|
"busybox", "sh", "-c",
|
|
// echo to stdout and stderr
|
|
"echo out; (echo err 1>&2); sleep 10000",
|
|
))
|
|
|
|
result.Assert(c, icmd.Expected{})
|
|
id := strings.TrimSpace(result.Stdout())
|
|
assert.Assert(c, id != "")
|
|
// so, right here, we're basically inspecting by id and returning only
|
|
// the ID. if they don't match, the service doesn't exist.
|
|
result = icmd.RunCmd(d.Command("service", "inspect", "--format=\"{{.ID}}\"", id))
|
|
result.Assert(c, icmd.Expected{Out: id})
|
|
|
|
// make sure task has been deployed.
|
|
poll.WaitOn(c, pollCheck(c, d.CheckActiveContainerCount, checker.Equals(1)), poll.WithTimeout(defaultReconciliationTimeout))
|
|
// and make sure we have all the log lines
|
|
poll.WaitOn(c, pollCheck(c, countLogLines(d, name), checker.Equals(2)), poll.WithTimeout(defaultReconciliationTimeout))
|
|
|
|
cmd := d.Command("service", "logs", "--raw", name)
|
|
result = icmd.RunCmd(cmd)
|
|
// for some reason there is carriage return in the output. i think this is
|
|
// just expected.
|
|
result.Assert(c, icmd.Expected{Out: "out\r\nerr\r\n"})
|
|
}
|
|
|
|
func (s *DockerSwarmSuite) TestServiceLogsNoHangDeletedContainer(c *testing.T) {
|
|
d := s.AddDaemon(c, true, true)
|
|
|
|
name := "TestServiceLogsNoHangDeletedContainer"
|
|
|
|
result := icmd.RunCmd(d.Command(
|
|
// create a service
|
|
"service", "create", "--detach", "--no-resolve-image",
|
|
// name it $name
|
|
"--name", name,
|
|
// busybox image, shell string
|
|
"busybox", "sh", "-c",
|
|
// echo to stdout and stderr
|
|
"while true; do echo line; sleep 2; done",
|
|
))
|
|
|
|
// confirm that the command succeeded
|
|
result.Assert(c, icmd.Expected{})
|
|
// get the service id
|
|
id := strings.TrimSpace(result.Stdout())
|
|
assert.Assert(c, id != "")
|
|
|
|
// make sure task has been deployed.
|
|
poll.WaitOn(c, pollCheck(c, d.CheckActiveContainerCount, checker.Equals(1)), poll.WithTimeout(defaultReconciliationTimeout))
|
|
// and make sure we have all the log lines
|
|
poll.WaitOn(c, pollCheck(c, countLogLines(d, name), checker.Equals(2)), poll.WithTimeout(defaultReconciliationTimeout))
|
|
|
|
// now find and nuke the container
|
|
result = icmd.RunCmd(d.Command("ps", "-q"))
|
|
containerID := strings.TrimSpace(result.Stdout())
|
|
assert.Assert(c, containerID != "")
|
|
result = icmd.RunCmd(d.Command("rm", "-f", containerID))
|
|
result.Assert(c, icmd.Expected{Out: containerID})
|
|
|
|
// run logs. use tail 2 to make sure we don't try to get a bunch of logs
|
|
// somehow and slow down execution time
|
|
cmd := d.Command("service", "logs", "--tail", "2", id)
|
|
// start the command and then wait for it to finish with a 3 second timeout
|
|
result = icmd.StartCmd(cmd)
|
|
result = icmd.WaitOnCmd(3*time.Second, result)
|
|
|
|
// then, assert that the result matches expected. if the command timed out,
|
|
// if the command is timed out, result.Timeout will be true, but the
|
|
// Expected defaults to false
|
|
result.Assert(c, icmd.Expected{})
|
|
}
|
|
|
|
func (s *DockerSwarmSuite) TestServiceLogsDetails(c *testing.T) {
|
|
d := s.AddDaemon(c, true, true)
|
|
|
|
name := "TestServiceLogsDetails"
|
|
|
|
result := icmd.RunCmd(d.Command(
|
|
// create a service
|
|
"service", "create", "--detach", "--no-resolve-image",
|
|
// name it $name
|
|
"--name", name,
|
|
// add an environment variable
|
|
"--env", "asdf=test1",
|
|
// add a log driver (without explicitly setting a driver, log-opt doesn't work)
|
|
"--log-driver", "json-file",
|
|
// add a log option to print the environment variable
|
|
"--log-opt", "env=asdf",
|
|
// busybox image, shell string
|
|
"busybox", "sh", "-c",
|
|
// make a log line
|
|
"trap 'exit 0' TERM; echo LogLine; while true; do sleep 1; done;",
|
|
))
|
|
|
|
result.Assert(c, icmd.Expected{})
|
|
id := strings.TrimSpace(result.Stdout())
|
|
assert.Assert(c, id != "")
|
|
|
|
// make sure task has been deployed
|
|
poll.WaitOn(c, pollCheck(c, d.CheckActiveContainerCount, checker.Equals(1)), poll.WithTimeout(defaultReconciliationTimeout))
|
|
// and make sure we have all the log lines
|
|
poll.WaitOn(c, pollCheck(c, countLogLines(d, name), checker.Equals(1)), poll.WithTimeout(defaultReconciliationTimeout))
|
|
|
|
// First, test without pretty printing
|
|
// call service logs with details. set raw to skip pretty printing
|
|
result = icmd.RunCmd(d.Command("service", "logs", "--raw", "--details", name))
|
|
// in this case, we should get details and we should get log message, but
|
|
// there will also be context as details (which will fall after the detail
|
|
// we inserted in alphabetical order
|
|
result.Assert(c, icmd.Expected{Out: "asdf=test1"})
|
|
result.Assert(c, icmd.Expected{Out: "LogLine"})
|
|
|
|
// call service logs with details. this time, don't pass raw
|
|
result = icmd.RunCmd(d.Command("service", "logs", "--details", id))
|
|
// in this case, we should get details space logmessage as well. the context
|
|
// is part of the pretty part of the logline
|
|
result.Assert(c, icmd.Expected{Out: "asdf=test1 LogLine"})
|
|
}
|