package main import ( "bytes" "context" "encoding/json" "fmt" "io" "net/http" "os" "strings" "testing" "time" "github.com/docker/docker/api/types" "github.com/docker/docker/api/types/versions" "github.com/docker/docker/client" "github.com/docker/docker/integration-cli/checker" "github.com/docker/docker/testutil/request" "gotest.tools/v3/assert" is "gotest.tools/v3/assert/cmp" "gotest.tools/v3/poll" ) // Regression test for #9414 func (s *DockerAPISuite) TestExecAPICreateNoCmd(c *testing.T) { name := "exec_test" dockerCmd(c, "run", "-d", "-t", "--name", name, "busybox", "/bin/sh") res, body, err := request.Post(fmt.Sprintf("/containers/%s/exec", name), request.JSONBody(map[string]interface{}{"Cmd": nil})) assert.NilError(c, err) if versions.LessThan(testEnv.DaemonAPIVersion(), "1.32") { assert.Equal(c, res.StatusCode, http.StatusInternalServerError) } else { assert.Equal(c, res.StatusCode, http.StatusBadRequest) } b, err := request.ReadBody(body) assert.NilError(c, err) assert.Assert(c, strings.Contains(getErrorMessage(c, b), "No exec command specified"), "Expected message when creating exec command with no Cmd specified") } func (s *DockerAPISuite) TestExecAPICreateNoValidContentType(c *testing.T) { name := "exec_test" dockerCmd(c, "run", "-d", "-t", "--name", name, "busybox", "/bin/sh") jsonData := bytes.NewBuffer(nil) if err := json.NewEncoder(jsonData).Encode(map[string]interface{}{"Cmd": nil}); err != nil { c.Fatalf("Can not encode data to json %s", err) } res, body, err := request.Post(fmt.Sprintf("/containers/%s/exec", name), request.RawContent(io.NopCloser(jsonData)), request.ContentType("test/plain")) assert.NilError(c, err) if versions.LessThan(testEnv.DaemonAPIVersion(), "1.32") { assert.Equal(c, res.StatusCode, http.StatusInternalServerError) } else { assert.Equal(c, res.StatusCode, http.StatusBadRequest) } b, err := request.ReadBody(body) assert.NilError(c, err) assert.Assert(c, is.Contains(getErrorMessage(c, b), "unsupported Content-Type header (test/plain): must be 'application/json'")) } func (s *DockerAPISuite) TestExecAPICreateContainerPaused(c *testing.T) { // Not relevant on Windows as Windows containers cannot be paused testRequires(c, DaemonIsLinux) name := "exec_create_test" dockerCmd(c, "run", "-d", "-t", "--name", name, "busybox", "/bin/sh") dockerCmd(c, "pause", name) cli, err := client.NewClientWithOpts(client.FromEnv) assert.NilError(c, err) defer cli.Close() config := types.ExecConfig{ Cmd: []string{"true"}, } _, err = cli.ContainerExecCreate(context.Background(), name, config) assert.ErrorContains(c, err, "Container "+name+" is paused, unpause the container before exec", "Expected message when creating exec command with Container %s is paused", name) } func (s *DockerAPISuite) TestExecAPIStart(c *testing.T) { testRequires(c, DaemonIsLinux) // Uses pause/unpause but bits may be salvageable to Windows to Windows CI dockerCmd(c, "run", "-d", "--name", "test", "busybox", "top") id := createExec(c, "test") startExec(c, id, http.StatusOK) var execJSON struct{ PID int } inspectExec(c, id, &execJSON) assert.Assert(c, execJSON.PID > 1) id = createExec(c, "test") dockerCmd(c, "stop", "test") startExec(c, id, http.StatusNotFound) dockerCmd(c, "start", "test") startExec(c, id, http.StatusNotFound) // make sure exec is created before pausing id = createExec(c, "test") dockerCmd(c, "pause", "test") startExec(c, id, http.StatusConflict) dockerCmd(c, "unpause", "test") startExec(c, id, http.StatusOK) } func (s *DockerAPISuite) TestExecAPIStartEnsureHeaders(c *testing.T) { testRequires(c, DaemonIsLinux) dockerCmd(c, "run", "-d", "--name", "test", "busybox", "top") id := createExec(c, "test") resp, _, err := request.Post(fmt.Sprintf("/exec/%s/start", id), request.RawString(`{"Detach": true}`), request.JSON) assert.NilError(c, err) assert.Assert(c, resp.Header.Get("Server") != "") } func (s *DockerAPISuite) TestExecAPIStartBackwardsCompatible(c *testing.T) { testRequires(c, DaemonIsLinux) // Windows only supports 1.25 or later runSleepingContainer(c, "-d", "--name", "test") id := createExec(c, "test") resp, body, err := request.Post(fmt.Sprintf("/v1.20/exec/%s/start", id), request.RawString(`{"Detach": true}`), request.ContentType("text/plain")) assert.NilError(c, err) b, err := request.ReadBody(body) comment := fmt.Sprintf("response body: %s", b) assert.NilError(c, err, comment) assert.Equal(c, resp.StatusCode, http.StatusOK, comment) } // #19362 func (s *DockerAPISuite) TestExecAPIStartMultipleTimesError(c *testing.T) { runSleepingContainer(c, "-d", "--name", "test") execID := createExec(c, "test") startExec(c, execID, http.StatusOK) waitForExec(c, execID) startExec(c, execID, http.StatusConflict) } // #20638 func (s *DockerAPISuite) TestExecAPIStartWithDetach(c *testing.T) { name := "foo" runSleepingContainer(c, "-d", "-t", "--name", name) config := types.ExecConfig{ Cmd: []string{"true"}, AttachStderr: true, } cli, err := client.NewClientWithOpts(client.FromEnv) assert.NilError(c, err) defer cli.Close() createResp, err := cli.ContainerExecCreate(context.Background(), name, config) assert.NilError(c, err) _, body, err := request.Post(fmt.Sprintf("/exec/%s/start", createResp.ID), request.RawString(`{"Detach": true}`), request.JSON) assert.NilError(c, err) b, err := request.ReadBody(body) comment := fmt.Sprintf("response body: %s", b) assert.NilError(c, err, comment) resp, _, err := request.Get("/_ping") assert.NilError(c, err) if resp.StatusCode != http.StatusOK { c.Fatal("daemon is down, it should alive") } } // #30311 func (s *DockerAPISuite) TestExecAPIStartValidCommand(c *testing.T) { name := "exec_test" dockerCmd(c, "run", "-d", "-t", "--name", name, "busybox", "/bin/sh") id := createExecCmd(c, name, "true") startExec(c, id, http.StatusOK) waitForExec(c, id) var inspectJSON struct{ ExecIDs []string } inspectContainer(c, name, &inspectJSON) assert.Assert(c, inspectJSON.ExecIDs == nil) } // #30311 func (s *DockerAPISuite) TestExecAPIStartInvalidCommand(c *testing.T) { name := "exec_test" dockerCmd(c, "run", "-d", "-t", "--name", name, "busybox", "/bin/sh") id := createExecCmd(c, name, "invalid") if versions.LessThan(testEnv.DaemonAPIVersion(), "1.32") { startExec(c, id, http.StatusNotFound) } else { startExec(c, id, http.StatusBadRequest) } waitForExec(c, id) var inspectJSON struct{ ExecIDs []string } inspectContainer(c, name, &inspectJSON) assert.Assert(c, inspectJSON.ExecIDs == nil) } func (s *DockerAPISuite) TestExecStateCleanup(c *testing.T) { testRequires(c, DaemonIsLinux, testEnv.IsLocalDaemon) // This test checks accidental regressions. Not part of stable API. name := "exec_cleanup" cid, _ := dockerCmd(c, "run", "-d", "-t", "--name", name, "busybox", "/bin/sh") cid = strings.TrimSpace(cid) stateDir := "/var/run/docker/containerd/" + cid checkReadDir := func(c *testing.T) (interface{}, string) { fi, err := os.ReadDir(stateDir) assert.NilError(c, err) return len(fi), "" } fi, err := os.ReadDir(stateDir) assert.NilError(c, err) assert.Assert(c, len(fi) > 1) id := createExecCmd(c, name, "ls") startExec(c, id, http.StatusOK) waitForExec(c, id) poll.WaitOn(c, pollCheck(c, checkReadDir, checker.Equals(len(fi))), poll.WithTimeout(5*time.Second)) id = createExecCmd(c, name, "invalid") startExec(c, id, http.StatusBadRequest) waitForExec(c, id) poll.WaitOn(c, pollCheck(c, checkReadDir, checker.Equals(len(fi))), poll.WithTimeout(5*time.Second)) dockerCmd(c, "stop", name) _, err = os.Stat(stateDir) assert.ErrorContains(c, err, "") assert.Assert(c, os.IsNotExist(err)) } func createExec(c *testing.T, name string) string { return createExecCmd(c, name, "true") } func createExecCmd(c *testing.T, name string, cmd string) string { _, reader, err := request.Post(fmt.Sprintf("/containers/%s/exec", name), request.JSONBody(map[string]interface{}{"Cmd": []string{cmd}})) assert.NilError(c, err) b, err := io.ReadAll(reader) assert.NilError(c, err) defer reader.Close() createResp := struct { ID string `json:"Id"` }{} assert.NilError(c, json.Unmarshal(b, &createResp), string(b)) return createResp.ID } func startExec(c *testing.T, id string, code int) { resp, body, err := request.Post(fmt.Sprintf("/exec/%s/start", id), request.RawString(`{"Detach": true}`), request.JSON) assert.NilError(c, err) b, err := request.ReadBody(body) assert.NilError(c, err, "response body: %s", b) assert.Equal(c, resp.StatusCode, code, "response body: %s", b) } func inspectExec(c *testing.T, id string, out interface{}) { resp, body, err := request.Get(fmt.Sprintf("/exec/%s/json", id)) assert.NilError(c, err) defer body.Close() assert.Equal(c, resp.StatusCode, http.StatusOK) err = json.NewDecoder(body).Decode(out) assert.NilError(c, err) } func waitForExec(c *testing.T, id string) { timeout := time.After(60 * time.Second) var execJSON struct{ Running bool } for { select { case <-timeout: c.Fatal("timeout waiting for exec to start") default: } inspectExec(c, id, &execJSON) if !execJSON.Running { break } } } func inspectContainer(c *testing.T, id string, out interface{}) { resp, body, err := request.Get("/containers/" + id + "/json") assert.NilError(c, err) defer body.Close() assert.Equal(c, resp.StatusCode, http.StatusOK) err = json.NewDecoder(body).Decode(out) assert.NilError(c, err) }