api/types: move ContainerExecInspect to api/types/container

thaJeztah · thaJeztah · commit 5b27e715213a · 2024-06-10T10:19:46.000+02:00
Signed-off-by: Sebastiaan van Stijn &lt;github@gone.nl&gt;
diff --git a/api/types/client.go b/api/types/client.go
@@ -12,15 +12,6 @@ import (
 	units "github.com/docker/go-units"
 )
 
-// ContainerExecInspect holds information returned by exec inspect.
-type ContainerExecInspect struct {
-	ExecID      string `json:"ID"`
-	ContainerID string
-	Running     bool
-	ExitCode    int
-	Pid         int
-}
-
 // CopyToContainerOptions holds information
 // about files to copy into a container
 type CopyToContainerOptions struct {
diff --git a/api/types/container/exec.go b/api/types/container/exec.go
@@ -32,3 +32,12 @@ type ExecStartOptions struct {
 //
 // TODO(thaJeztah): make this a separate type; ContainerExecAttach does not use the Detach option, and cannot run detached.
 type ExecAttachOptions = ExecStartOptions
+
+// ExecInspect holds information returned by exec inspect.
+type ExecInspect struct {
+	ExecID      string `json:"ID"`
+	ContainerID string
+	Running     bool
+	ExitCode    int
+	Pid         int
+}
diff --git a/api/types/types_deprecated.go b/api/types/types_deprecated.go
@@ -67,3 +67,8 @@ type ExecConfig = container.ExecOptions
 //
 // Deprecated: use [container.ExecStartOptions] or [container.ExecAttachOptions].
 type ExecStartCheck = container.ExecStartOptions
+
+// ContainerExecInspect holds information returned by exec inspect.
+//
+// Deprecated: use [container.ExecInspect].
+type ContainerExecInspect = container.ExecInspect
diff --git a/client/container_exec.go b/client/container_exec.go
@@ -63,8 +63,8 @@ func (cli *Client) ContainerExecAttach(ctx context.Context, execID string, confi
 }
 
 // ContainerExecInspect returns information about a specific exec process on the docker host.
-func (cli *Client) ContainerExecInspect(ctx context.Context, execID string) (types.ContainerExecInspect, error) {
-	var response types.ContainerExecInspect
+func (cli *Client) ContainerExecInspect(ctx context.Context, execID string) (container.ExecInspect, error) {
+	var response container.ExecInspect
 	resp, err := cli.get(ctx, "/exec/"+execID+"/json", nil, nil)
 	if err != nil {
 		return response, err
diff --git a/client/container_exec_test.go b/client/container_exec_test.go
@@ -139,7 +139,7 @@ func TestContainerExecInspect(t *testing.T) {
 			if !strings.HasPrefix(req.URL.Path, expectedURL) {
 				return nil, fmt.Errorf("Expected URL '%s', got '%s'", expectedURL, req.URL)
 			}
-			b, err := json.Marshal(types.ContainerExecInspect{
+			b, err := json.Marshal(container.ExecInspect{
 				ExecID:      "exec_id",
 				ContainerID: "container_id",
 			})
diff --git a/client/interface.go b/client/interface.go
@@ -52,7 +52,7 @@ type ContainerAPIClient interface {
 	ContainerDiff(ctx context.Context, container string) ([]container.FilesystemChange, error)
 	ContainerExecAttach(ctx context.Context, execID string, options container.ExecAttachOptions) (types.HijackedResponse, error)
 	ContainerExecCreate(ctx context.Context, container string, options container.ExecOptions) (types.IDResponse, error)
-	ContainerExecInspect(ctx context.Context, execID string) (types.ContainerExecInspect, error)
+	ContainerExecInspect(ctx context.Context, execID string) (container.ExecInspect, error)
 	ContainerExecResize(ctx context.Context, execID string, options container.ResizeOptions) error
 	ContainerExecStart(ctx context.Context, execID string, options container.ExecStartOptions) error
 	ContainerExport(ctx context.Context, container string) (io.ReadCloser, error)

Original file line number	Diff line number	Diff line change
`@@ -139,7 +139,7 @@ func TestContainerExecInspect(t *testing.T) {`
`139`	`139`	`if !strings.HasPrefix(req.URL.Path, expectedURL) {`
`140`	`140`	`return nil, fmt.Errorf("Expected URL '%s', got '%s'", expectedURL, req.URL)`
`141`	`141`	`}`
`142`		`- b, err := json.Marshal(types.ContainerExecInspect{`
	`142`	`+ b, err := json.Marshal(container.ExecInspect{`
`143`	`143`	`ExecID: "exec_id",`
`144`	`144`	`ContainerID: "container_id",`
`145`	`145`	`})`