mirror of
https://github.com/moby/moby.git
synced 2022-11-09 12:21:53 -05:00
22e7e107ad
add AutoRemove to HostConfig add -rm flag to docker run add TestRunAutoRemove to test -rm docs: add -rm to commandline/command/run add hostConfig to container monitor make monitor destroy the container via -rm This adds support for automatically removing a container after it exits. The removal of the container is handled on the server side.
581 lines
15 KiB
Go
581 lines
15 KiB
Go
package docker
|
||
|
||
import (
|
||
"bufio"
|
||
"fmt"
|
||
"github.com/dotcloud/docker/utils"
|
||
"io"
|
||
"io/ioutil"
|
||
"strings"
|
||
"testing"
|
||
"time"
|
||
)
|
||
|
||
func closeWrap(args ...io.Closer) error {
|
||
e := false
|
||
ret := fmt.Errorf("Error closing elements")
|
||
for _, c := range args {
|
||
if err := c.Close(); err != nil {
|
||
e = true
|
||
ret = fmt.Errorf("%s\n%s", ret, err)
|
||
}
|
||
}
|
||
if e {
|
||
return ret
|
||
}
|
||
return nil
|
||
}
|
||
|
||
func setTimeout(t *testing.T, msg string, d time.Duration, f func()) {
|
||
c := make(chan bool)
|
||
|
||
// Make sure we are not too long
|
||
go func() {
|
||
time.Sleep(d)
|
||
c <- true
|
||
}()
|
||
go func() {
|
||
f()
|
||
c <- false
|
||
}()
|
||
if <-c && msg != "" {
|
||
t.Fatal(msg)
|
||
}
|
||
}
|
||
|
||
func assertPipe(input, output string, r io.Reader, w io.Writer, count int) error {
|
||
for i := 0; i < count; i++ {
|
||
if _, err := w.Write([]byte(input)); err != nil {
|
||
return err
|
||
}
|
||
o, err := bufio.NewReader(r).ReadString('\n')
|
||
if err != nil {
|
||
return err
|
||
}
|
||
if strings.Trim(o, " \r\n") != output {
|
||
return fmt.Errorf("Unexpected output. Expected [%s], received [%s]", output, o)
|
||
}
|
||
}
|
||
return nil
|
||
}
|
||
|
||
// TestRunHostname checks that 'docker run -h' correctly sets a custom hostname
|
||
func TestRunHostname(t *testing.T) {
|
||
stdout, stdoutPipe := io.Pipe()
|
||
|
||
cli := NewDockerCli(nil, stdoutPipe, ioutil.Discard, testDaemonProto, testDaemonAddr)
|
||
defer cleanup(globalRuntime)
|
||
|
||
c := make(chan struct{})
|
||
go func() {
|
||
defer close(c)
|
||
if err := cli.CmdRun("-h", "foobar", unitTestImageID, "hostname"); err != nil {
|
||
t.Fatal(err)
|
||
}
|
||
}()
|
||
|
||
setTimeout(t, "Reading command output time out", 2*time.Second, func() {
|
||
cmdOutput, err := bufio.NewReader(stdout).ReadString('\n')
|
||
if err != nil {
|
||
t.Fatal(err)
|
||
}
|
||
if cmdOutput != "foobar\n" {
|
||
t.Fatalf("'hostname' should display '%s', not '%s'", "foobar\n", cmdOutput)
|
||
}
|
||
})
|
||
|
||
setTimeout(t, "CmdRun timed out", 5*time.Second, func() {
|
||
<-c
|
||
})
|
||
|
||
}
|
||
|
||
// TestRunWorkdir checks that 'docker run -w' correctly sets a custom working directory
|
||
func TestRunWorkdir(t *testing.T) {
|
||
stdout, stdoutPipe := io.Pipe()
|
||
|
||
cli := NewDockerCli(nil, stdoutPipe, ioutil.Discard, testDaemonProto, testDaemonAddr)
|
||
defer cleanup(globalRuntime)
|
||
|
||
c := make(chan struct{})
|
||
go func() {
|
||
defer close(c)
|
||
if err := cli.CmdRun("-w", "/foo/bar", unitTestImageID, "pwd"); err != nil {
|
||
t.Fatal(err)
|
||
}
|
||
}()
|
||
|
||
setTimeout(t, "Reading command output time out", 2*time.Second, func() {
|
||
cmdOutput, err := bufio.NewReader(stdout).ReadString('\n')
|
||
if err != nil {
|
||
t.Fatal(err)
|
||
}
|
||
if cmdOutput != "/foo/bar\n" {
|
||
t.Fatalf("'pwd' should display '%s', not '%s'", "/foo/bar\n", cmdOutput)
|
||
}
|
||
})
|
||
|
||
setTimeout(t, "CmdRun timed out", 5*time.Second, func() {
|
||
<-c
|
||
})
|
||
|
||
}
|
||
|
||
// TestRunWorkdirExists checks that 'docker run -w' correctly sets a custom working directory, even if it exists
|
||
func TestRunWorkdirExists(t *testing.T) {
|
||
stdout, stdoutPipe := io.Pipe()
|
||
|
||
cli := NewDockerCli(nil, stdoutPipe, ioutil.Discard, testDaemonProto, testDaemonAddr)
|
||
defer cleanup(globalRuntime)
|
||
|
||
c := make(chan struct{})
|
||
go func() {
|
||
defer close(c)
|
||
if err := cli.CmdRun("-w", "/proc", unitTestImageID, "pwd"); err != nil {
|
||
t.Fatal(err)
|
||
}
|
||
}()
|
||
|
||
setTimeout(t, "Reading command output time out", 2*time.Second, func() {
|
||
cmdOutput, err := bufio.NewReader(stdout).ReadString('\n')
|
||
if err != nil {
|
||
t.Fatal(err)
|
||
}
|
||
if cmdOutput != "/proc\n" {
|
||
t.Fatalf("'pwd' should display '%s', not '%s'", "/proc\n", cmdOutput)
|
||
}
|
||
})
|
||
|
||
setTimeout(t, "CmdRun timed out", 5*time.Second, func() {
|
||
<-c
|
||
})
|
||
|
||
}
|
||
|
||
func TestRunExit(t *testing.T) {
|
||
stdin, stdinPipe := io.Pipe()
|
||
stdout, stdoutPipe := io.Pipe()
|
||
|
||
cli := NewDockerCli(stdin, stdoutPipe, ioutil.Discard, testDaemonProto, testDaemonAddr)
|
||
defer cleanup(globalRuntime)
|
||
|
||
c1 := make(chan struct{})
|
||
go func() {
|
||
cli.CmdRun("-i", unitTestImageID, "/bin/cat")
|
||
close(c1)
|
||
}()
|
||
|
||
setTimeout(t, "Read/Write assertion timed out", 2*time.Second, func() {
|
||
if err := assertPipe("hello\n", "hello", stdout, stdinPipe, 15); err != nil {
|
||
t.Fatal(err)
|
||
}
|
||
})
|
||
|
||
container := globalRuntime.List()[0]
|
||
|
||
// Closing /bin/cat stdin, expect it to exit
|
||
if err := stdin.Close(); err != nil {
|
||
t.Fatal(err)
|
||
}
|
||
|
||
// as the process exited, CmdRun must finish and unblock. Wait for it
|
||
setTimeout(t, "Waiting for CmdRun timed out", 10*time.Second, func() {
|
||
<-c1
|
||
|
||
go func() {
|
||
cli.CmdWait(container.ID)
|
||
}()
|
||
|
||
if _, err := bufio.NewReader(stdout).ReadString('\n'); err != nil {
|
||
t.Fatal(err)
|
||
}
|
||
})
|
||
|
||
// Make sure that the client has been disconnected
|
||
setTimeout(t, "The client should have been disconnected once the remote process exited.", 2*time.Second, func() {
|
||
// Expecting pipe i/o error, just check that read does not block
|
||
stdin.Read([]byte{})
|
||
})
|
||
|
||
// Cleanup pipes
|
||
if err := closeWrap(stdin, stdinPipe, stdout, stdoutPipe); err != nil {
|
||
t.Fatal(err)
|
||
}
|
||
}
|
||
|
||
// Expected behaviour: the process dies when the client disconnects
|
||
func TestRunDisconnect(t *testing.T) {
|
||
|
||
stdin, stdinPipe := io.Pipe()
|
||
stdout, stdoutPipe := io.Pipe()
|
||
|
||
cli := NewDockerCli(stdin, stdoutPipe, ioutil.Discard, testDaemonProto, testDaemonAddr)
|
||
defer cleanup(globalRuntime)
|
||
|
||
c1 := make(chan struct{})
|
||
go func() {
|
||
// We're simulating a disconnect so the return value doesn't matter. What matters is the
|
||
// fact that CmdRun returns.
|
||
cli.CmdRun("-i", unitTestImageID, "/bin/cat")
|
||
close(c1)
|
||
}()
|
||
|
||
setTimeout(t, "Read/Write assertion timed out", 2*time.Second, func() {
|
||
if err := assertPipe("hello\n", "hello", stdout, stdinPipe, 15); err != nil {
|
||
t.Fatal(err)
|
||
}
|
||
})
|
||
|
||
// Close pipes (simulate disconnect)
|
||
if err := closeWrap(stdin, stdinPipe, stdout, stdoutPipe); err != nil {
|
||
t.Fatal(err)
|
||
}
|
||
|
||
// as the pipes are close, we expect the process to die,
|
||
// therefore CmdRun to unblock. Wait for CmdRun
|
||
setTimeout(t, "Waiting for CmdRun timed out", 2*time.Second, func() {
|
||
<-c1
|
||
})
|
||
|
||
// Client disconnect after run -i should cause stdin to be closed, which should
|
||
// cause /bin/cat to exit.
|
||
setTimeout(t, "Waiting for /bin/cat to exit timed out", 2*time.Second, func() {
|
||
container := globalRuntime.List()[0]
|
||
container.Wait()
|
||
if container.State.Running {
|
||
t.Fatalf("/bin/cat is still running after closing stdin")
|
||
}
|
||
})
|
||
}
|
||
|
||
// Expected behaviour: the process dies when the client disconnects
|
||
func TestRunDisconnectTty(t *testing.T) {
|
||
|
||
stdin, stdinPipe := io.Pipe()
|
||
stdout, stdoutPipe := io.Pipe()
|
||
|
||
cli := NewDockerCli(stdin, stdoutPipe, ioutil.Discard, testDaemonProto, testDaemonAddr)
|
||
defer cleanup(globalRuntime)
|
||
|
||
c1 := make(chan struct{})
|
||
go func() {
|
||
// We're simulating a disconnect so the return value doesn't matter. What matters is the
|
||
// fact that CmdRun returns.
|
||
if err := cli.CmdRun("-i", "-t", unitTestImageID, "/bin/cat"); err != nil {
|
||
utils.Debugf("Error CmdRun: %s\n", err)
|
||
}
|
||
|
||
close(c1)
|
||
}()
|
||
|
||
setTimeout(t, "Waiting for the container to be started timed out", 10*time.Second, func() {
|
||
for {
|
||
// Client disconnect after run -i should keep stdin out in TTY mode
|
||
l := globalRuntime.List()
|
||
if len(l) == 1 && l[0].State.Running {
|
||
break
|
||
}
|
||
time.Sleep(10 * time.Millisecond)
|
||
}
|
||
})
|
||
|
||
// Client disconnect after run -i should keep stdin out in TTY mode
|
||
container := globalRuntime.List()[0]
|
||
|
||
setTimeout(t, "Read/Write assertion timed out", 2000*time.Second, func() {
|
||
if err := assertPipe("hello\n", "hello", stdout, stdinPipe, 15); err != nil {
|
||
t.Fatal(err)
|
||
}
|
||
})
|
||
|
||
// Close pipes (simulate disconnect)
|
||
if err := closeWrap(stdin, stdinPipe, stdout, stdoutPipe); err != nil {
|
||
t.Fatal(err)
|
||
}
|
||
|
||
// In tty mode, we expect the process to stay alive even after client's stdin closes.
|
||
// Do not wait for run to finish
|
||
|
||
// Give some time to monitor to do his thing
|
||
container.WaitTimeout(500 * time.Millisecond)
|
||
if !container.State.Running {
|
||
t.Fatalf("/bin/cat should still be running after closing stdin (tty mode)")
|
||
}
|
||
}
|
||
|
||
// TestAttachStdin checks attaching to stdin without stdout and stderr.
|
||
// 'docker run -i -a stdin' should sends the client's stdin to the command,
|
||
// then detach from it and print the container id.
|
||
func TestRunAttachStdin(t *testing.T) {
|
||
|
||
stdin, stdinPipe := io.Pipe()
|
||
stdout, stdoutPipe := io.Pipe()
|
||
|
||
cli := NewDockerCli(stdin, stdoutPipe, ioutil.Discard, testDaemonProto, testDaemonAddr)
|
||
defer cleanup(globalRuntime)
|
||
|
||
ch := make(chan struct{})
|
||
go func() {
|
||
defer close(ch)
|
||
cli.CmdRun("-i", "-a", "stdin", unitTestImageID, "sh", "-c", "echo hello && cat && sleep 5")
|
||
}()
|
||
|
||
// Send input to the command, close stdin
|
||
setTimeout(t, "Write timed out", 10*time.Second, func() {
|
||
if _, err := stdinPipe.Write([]byte("hi there\n")); err != nil {
|
||
t.Fatal(err)
|
||
}
|
||
if err := stdinPipe.Close(); err != nil {
|
||
t.Fatal(err)
|
||
}
|
||
})
|
||
|
||
container := globalRuntime.List()[0]
|
||
|
||
// Check output
|
||
setTimeout(t, "Reading command output time out", 10*time.Second, func() {
|
||
cmdOutput, err := bufio.NewReader(stdout).ReadString('\n')
|
||
if err != nil {
|
||
t.Fatal(err)
|
||
}
|
||
if cmdOutput != container.ShortID()+"\n" {
|
||
t.Fatalf("Wrong output: should be '%s', not '%s'\n", container.ShortID()+"\n", cmdOutput)
|
||
}
|
||
})
|
||
|
||
// wait for CmdRun to return
|
||
setTimeout(t, "Waiting for CmdRun timed out", 5*time.Second, func() {
|
||
<-ch
|
||
})
|
||
|
||
setTimeout(t, "Waiting for command to exit timed out", 10*time.Second, func() {
|
||
container.Wait()
|
||
})
|
||
|
||
// Check logs
|
||
if cmdLogs, err := container.ReadLog("json"); err != nil {
|
||
t.Fatal(err)
|
||
} else {
|
||
if output, err := ioutil.ReadAll(cmdLogs); err != nil {
|
||
t.Fatal(err)
|
||
} else {
|
||
expectedLogs := []string{"{\"log\":\"hello\\n\",\"stream\":\"stdout\"", "{\"log\":\"hi there\\n\",\"stream\":\"stdout\""}
|
||
for _, expectedLog := range expectedLogs {
|
||
if !strings.Contains(string(output), expectedLog) {
|
||
t.Fatalf("Unexpected logs: should contains '%s', it is not '%s'\n", expectedLog, output)
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
|
||
// TestRunDetach checks attaching and detaching with the escape sequence.
|
||
func TestRunDetach(t *testing.T) {
|
||
|
||
stdin, stdinPipe := io.Pipe()
|
||
stdout, stdoutPipe := io.Pipe()
|
||
|
||
cli := NewDockerCli(stdin, stdoutPipe, ioutil.Discard, testDaemonProto, testDaemonAddr)
|
||
defer cleanup(globalRuntime)
|
||
|
||
ch := make(chan struct{})
|
||
go func() {
|
||
defer close(ch)
|
||
cli.CmdRun("-i", "-t", unitTestImageID, "cat")
|
||
}()
|
||
|
||
setTimeout(t, "First read/write assertion timed out", 2*time.Second, func() {
|
||
if err := assertPipe("hello\n", "hello", stdout, stdinPipe, 15); err != nil {
|
||
t.Fatal(err)
|
||
}
|
||
})
|
||
|
||
container := globalRuntime.List()[0]
|
||
|
||
setTimeout(t, "Escape sequence timeout", 5*time.Second, func() {
|
||
stdinPipe.Write([]byte{'', ''})
|
||
if err := stdinPipe.Close(); err != nil {
|
||
t.Fatal(err)
|
||
}
|
||
})
|
||
|
||
// wait for CmdRun to return
|
||
setTimeout(t, "Waiting for CmdRun timed out", 5*time.Second, func() {
|
||
<-ch
|
||
})
|
||
|
||
time.Sleep(500 * time.Millisecond)
|
||
if !container.State.Running {
|
||
t.Fatal("The detached container should be still running")
|
||
}
|
||
|
||
setTimeout(t, "Waiting for container to die timed out", 20*time.Second, func() {
|
||
container.Kill()
|
||
container.Wait()
|
||
})
|
||
}
|
||
|
||
// TestAttachDetach checks that attach in tty mode can be detached
|
||
func TestAttachDetach(t *testing.T) {
|
||
stdin, stdinPipe := io.Pipe()
|
||
stdout, stdoutPipe := io.Pipe()
|
||
|
||
cli := NewDockerCli(stdin, stdoutPipe, ioutil.Discard, testDaemonProto, testDaemonAddr)
|
||
defer cleanup(globalRuntime)
|
||
|
||
go stdout.Read(make([]byte, 1024))
|
||
setTimeout(t, "Starting container timed out", 2*time.Second, func() {
|
||
if err := cli.CmdRun("-i", "-t", "-d", unitTestImageID, "cat"); err != nil {
|
||
t.Fatal(err)
|
||
}
|
||
})
|
||
|
||
container := globalRuntime.List()[0]
|
||
|
||
stdin, stdinPipe = io.Pipe()
|
||
stdout, stdoutPipe = io.Pipe()
|
||
cli = NewDockerCli(stdin, stdoutPipe, ioutil.Discard, testDaemonProto, testDaemonAddr)
|
||
|
||
ch := make(chan struct{})
|
||
go func() {
|
||
defer close(ch)
|
||
if err := cli.CmdAttach(container.ShortID()); err != nil {
|
||
t.Fatal(err)
|
||
}
|
||
}()
|
||
|
||
setTimeout(t, "First read/write assertion timed out", 2*time.Second, func() {
|
||
if err := assertPipe("hello\n", "hello", stdout, stdinPipe, 15); err != nil {
|
||
t.Fatal(err)
|
||
}
|
||
})
|
||
|
||
setTimeout(t, "Escape sequence timeout", 5*time.Second, func() {
|
||
stdinPipe.Write([]byte{'', ''})
|
||
if err := stdinPipe.Close(); err != nil {
|
||
t.Fatal(err)
|
||
}
|
||
})
|
||
|
||
// wait for CmdRun to return
|
||
setTimeout(t, "Waiting for CmdAttach timed out", 5*time.Second, func() {
|
||
<-ch
|
||
})
|
||
|
||
time.Sleep(500 * time.Millisecond)
|
||
if !container.State.Running {
|
||
t.Fatal("The detached container should be still running")
|
||
}
|
||
|
||
setTimeout(t, "Waiting for container to die timedout", 5*time.Second, func() {
|
||
container.Kill()
|
||
container.Wait()
|
||
})
|
||
}
|
||
|
||
// Expected behaviour, the process stays alive when the client disconnects
|
||
func TestAttachDisconnect(t *testing.T) {
|
||
stdin, stdinPipe := io.Pipe()
|
||
stdout, stdoutPipe := io.Pipe()
|
||
|
||
cli := NewDockerCli(stdin, stdoutPipe, ioutil.Discard, testDaemonProto, testDaemonAddr)
|
||
defer cleanup(globalRuntime)
|
||
|
||
go func() {
|
||
// Start a process in daemon mode
|
||
if err := cli.CmdRun("-d", "-i", unitTestImageID, "/bin/cat"); err != nil {
|
||
utils.Debugf("Error CmdRun: %s\n", err)
|
||
}
|
||
}()
|
||
|
||
setTimeout(t, "Waiting for CmdRun timed out", 10*time.Second, func() {
|
||
if _, err := bufio.NewReader(stdout).ReadString('\n'); err != nil {
|
||
t.Fatal(err)
|
||
}
|
||
})
|
||
|
||
setTimeout(t, "Waiting for the container to be started timed out", 10*time.Second, func() {
|
||
for {
|
||
l := globalRuntime.List()
|
||
if len(l) == 1 && l[0].State.Running {
|
||
break
|
||
}
|
||
time.Sleep(10 * time.Millisecond)
|
||
}
|
||
})
|
||
|
||
container := globalRuntime.List()[0]
|
||
|
||
// Attach to it
|
||
c1 := make(chan struct{})
|
||
go func() {
|
||
// We're simulating a disconnect so the return value doesn't matter. What matters is the
|
||
// fact that CmdAttach returns.
|
||
cli.CmdAttach(container.ID)
|
||
close(c1)
|
||
}()
|
||
|
||
setTimeout(t, "First read/write assertion timed out", 2*time.Second, func() {
|
||
if err := assertPipe("hello\n", "hello", stdout, stdinPipe, 15); err != nil {
|
||
t.Fatal(err)
|
||
}
|
||
})
|
||
// Close pipes (client disconnects)
|
||
if err := closeWrap(stdin, stdinPipe, stdout, stdoutPipe); err != nil {
|
||
t.Fatal(err)
|
||
}
|
||
|
||
// Wait for attach to finish, the client disconnected, therefore, Attach finished his job
|
||
setTimeout(t, "Waiting for CmdAttach timed out", 2*time.Second, func() {
|
||
<-c1
|
||
})
|
||
|
||
// We closed stdin, expect /bin/cat to still be running
|
||
// Wait a little bit to make sure container.monitor() did his thing
|
||
err := container.WaitTimeout(500 * time.Millisecond)
|
||
if err == nil || !container.State.Running {
|
||
t.Fatalf("/bin/cat is not running after closing stdin")
|
||
}
|
||
|
||
// Try to avoid the timeout in destroy. Best effort, don't check error
|
||
cStdin, _ := container.StdinPipe()
|
||
cStdin.Close()
|
||
container.Wait()
|
||
}
|
||
|
||
// Expected behaviour: container gets deleted automatically after exit
|
||
func TestRunAutoRemove(t *testing.T) {
|
||
stdout, stdoutPipe := io.Pipe()
|
||
cli := NewDockerCli(nil, stdoutPipe, ioutil.Discard, testDaemonProto, testDaemonAddr)
|
||
defer cleanup(globalRuntime)
|
||
|
||
c := make(chan struct{})
|
||
go func() {
|
||
defer close(c)
|
||
if err := cli.CmdRun("-rm", unitTestImageID, "hostname"); err != nil {
|
||
t.Fatal(err)
|
||
}
|
||
}()
|
||
|
||
var temporaryContainerID string
|
||
setTimeout(t, "Reading command output time out", 2*time.Second, func() {
|
||
cmdOutput, err := bufio.NewReader(stdout).ReadString('\n')
|
||
if err != nil {
|
||
t.Fatal(err)
|
||
}
|
||
temporaryContainerID = cmdOutput
|
||
if err := closeWrap(stdout, stdoutPipe); err != nil {
|
||
t.Fatal(err)
|
||
}
|
||
})
|
||
|
||
setTimeout(t, "CmdRun timed out", 5*time.Second, func() {
|
||
<-c
|
||
})
|
||
|
||
time.Sleep(500 * time.Millisecond)
|
||
|
||
if len(globalRuntime.List()) > 0 {
|
||
t.Fatalf("failed to remove container automatically: container %s still exists", temporaryContainerID)
|
||
}
|
||
}
|