From f07d359043da46e15c7adb2ca36ec3bf8b79de27 Mon Sep 17 00:00:00 2001 From: Austin Vazquez Date: Wed, 20 Aug 2025 07:41:57 -0500 Subject: [PATCH] client: rename `ResizeOptions` type to `ContainerResizeOptions` Signed-off-by: Austin Vazquez --- client/client_interfaces.go | 4 ++-- client/container_resize.go | 8 +++---- client/container_resize_test.go | 24 +++++++++---------- integration-cli/docker_cli_events_test.go | 2 +- integration/container/exec_test.go | 6 ++--- integration/container/resize_test.go | 4 ++-- .../moby/moby/client/client_interfaces.go | 4 ++-- .../moby/moby/client/container_resize.go | 8 +++---- 8 files changed, 30 insertions(+), 30 deletions(-) diff --git a/client/client_interfaces.go b/client/client_interfaces.go index e8415916ff..82fdbe8baa 100644 --- a/client/client_interfaces.go +++ b/client/client_interfaces.go @@ -72,7 +72,7 @@ type ContainerAPIClient interface { ContainerExecAttach(ctx context.Context, execID string, options container.ExecAttachOptions) (HijackedResponse, error) ContainerExecCreate(ctx context.Context, container string, options container.ExecOptions) (container.ExecCreateResponse, error) ContainerExecInspect(ctx context.Context, execID string) (container.ExecInspect, error) - ContainerExecResize(ctx context.Context, execID string, options ResizeOptions) error + ContainerExecResize(ctx context.Context, execID string, options ContainerResizeOptions) error ContainerExecStart(ctx context.Context, execID string, options container.ExecStartOptions) error ContainerExport(ctx context.Context, container string) (io.ReadCloser, error) ContainerInspect(ctx context.Context, container string) (container.InspectResponse, error) @@ -83,7 +83,7 @@ type ContainerAPIClient interface { ContainerPause(ctx context.Context, container string) error ContainerRemove(ctx context.Context, container string, options container.RemoveOptions) error ContainerRename(ctx context.Context, container, newContainerName string) error - ContainerResize(ctx context.Context, container string, options ResizeOptions) error + ContainerResize(ctx context.Context, container string, options ContainerResizeOptions) error ContainerRestart(ctx context.Context, container string, options container.StopOptions) error ContainerStatPath(ctx context.Context, container, path string) (container.PathStat, error) ContainerStats(ctx context.Context, container string, stream bool) (StatsResponseReader, error) diff --git a/client/container_resize.go b/client/container_resize.go index 01197c442b..bba1b83354 100644 --- a/client/container_resize.go +++ b/client/container_resize.go @@ -6,16 +6,16 @@ import ( "strconv" ) -// ResizeOptions holds parameters to resize a TTY. +// ContainerResizeOptions holds parameters to resize a TTY. // It can be used to resize container TTYs and // exec process TTYs too. -type ResizeOptions struct { +type ContainerResizeOptions struct { Height uint Width uint } // ContainerResize changes the size of the pseudo-TTY for a container. -func (cli *Client) ContainerResize(ctx context.Context, containerID string, options ResizeOptions) error { +func (cli *Client) ContainerResize(ctx context.Context, containerID string, options ContainerResizeOptions) error { containerID, err := trimID("container", containerID) if err != nil { return err @@ -24,7 +24,7 @@ func (cli *Client) ContainerResize(ctx context.Context, containerID string, opti } // ContainerExecResize changes the size of the tty for an exec process running inside a container. -func (cli *Client) ContainerExecResize(ctx context.Context, execID string, options ResizeOptions) error { +func (cli *Client) ContainerExecResize(ctx context.Context, execID string, options ContainerResizeOptions) error { execID, err := trimID("exec", execID) if err != nil { return err diff --git a/client/container_resize_test.go b/client/container_resize_test.go index d23a19be70..cccfe70286 100644 --- a/client/container_resize_test.go +++ b/client/container_resize_test.go @@ -17,14 +17,14 @@ func TestContainerResizeError(t *testing.T) { client := &Client{ client: newMockClient(errorMock(http.StatusInternalServerError, "Server error")), } - err := client.ContainerResize(context.Background(), "container_id", ResizeOptions{}) + err := client.ContainerResize(context.Background(), "container_id", ContainerResizeOptions{}) assert.Check(t, is.ErrorType(err, cerrdefs.IsInternal)) - err = client.ContainerResize(context.Background(), "", ResizeOptions{}) + err = client.ContainerResize(context.Background(), "", ContainerResizeOptions{}) assert.Check(t, is.ErrorType(err, cerrdefs.IsInvalidArgument)) assert.Check(t, is.ErrorContains(err, "value is empty")) - err = client.ContainerResize(context.Background(), " ", ResizeOptions{}) + err = client.ContainerResize(context.Background(), " ", ContainerResizeOptions{}) assert.Check(t, is.ErrorType(err, cerrdefs.IsInvalidArgument)) assert.Check(t, is.ErrorContains(err, "value is empty")) } @@ -33,7 +33,7 @@ func TestContainerExecResizeError(t *testing.T) { client := &Client{ client: newMockClient(errorMock(http.StatusInternalServerError, "Server error")), } - err := client.ContainerExecResize(context.Background(), "exec_id", ResizeOptions{}) + err := client.ContainerExecResize(context.Background(), "exec_id", ContainerResizeOptions{}) assert.Check(t, is.ErrorType(err, cerrdefs.IsInternal)) } @@ -42,18 +42,18 @@ func TestContainerResize(t *testing.T) { tests := []struct { doc string - opts ResizeOptions + opts ContainerResizeOptions expectedHeight, expectedWidth string }{ { doc: "zero width height", // valid, but not very useful - opts: ResizeOptions{}, + opts: ContainerResizeOptions{}, expectedWidth: "0", expectedHeight: "0", }, { doc: "valid resize", - opts: ResizeOptions{ + opts: ContainerResizeOptions{ Height: 500, Width: 600, }, @@ -62,7 +62,7 @@ func TestContainerResize(t *testing.T) { }, { doc: "larger than maxint64", - opts: ResizeOptions{ + opts: ContainerResizeOptions{ Height: math.MaxInt64 + 1, Width: math.MaxInt64 + 2, }, @@ -85,18 +85,18 @@ func TestContainerExecResize(t *testing.T) { const expectedURL = "/exec/exec_id/resize" tests := []struct { doc string - opts ResizeOptions + opts ContainerResizeOptions expectedHeight, expectedWidth string }{ { doc: "zero width height", // valid, but not very useful - opts: ResizeOptions{}, + opts: ContainerResizeOptions{}, expectedWidth: "0", expectedHeight: "0", }, { doc: "valid resize", - opts: ResizeOptions{ + opts: ContainerResizeOptions{ Height: 500, Width: 600, }, @@ -105,7 +105,7 @@ func TestContainerExecResize(t *testing.T) { }, { doc: "larger than maxint64", - opts: ResizeOptions{ + opts: ContainerResizeOptions{ Height: math.MaxInt64 + 1, Width: math.MaxInt64 + 2, }, diff --git a/integration-cli/docker_cli_events_test.go b/integration-cli/docker_cli_events_test.go index 6396742ea6..3f02337f0d 100644 --- a/integration-cli/docker_cli_events_test.go +++ b/integration-cli/docker_cli_events_test.go @@ -453,7 +453,7 @@ func (s *DockerCLIEventSuite) TestEventsResize(c *testing.T) { assert.NilError(c, err) defer apiClient.Close() - options := client.ResizeOptions{ + options := client.ContainerResizeOptions{ Height: 80, Width: 24, } diff --git a/integration/container/exec_test.go b/integration/container/exec_test.go index 6d9b95728e..d456c9e474 100644 --- a/integration/container/exec_test.go +++ b/integration/container/exec_test.go @@ -138,7 +138,7 @@ func TestExecResize(t *testing.T) { assert.NilError(t, err) t.Run("success", func(t *testing.T) { - err := apiClient.ContainerExecResize(ctx, execID, client.ResizeOptions{ + err := apiClient.ContainerExecResize(ctx, execID, client.ContainerResizeOptions{ Height: 40, Width: 40, }) @@ -247,7 +247,7 @@ func TestExecResize(t *testing.T) { }) t.Run("unknown execID", func(t *testing.T) { - err = apiClient.ContainerExecResize(ctx, "no-such-exec-id", client.ResizeOptions{ + err = apiClient.ContainerExecResize(ctx, "no-such-exec-id", client.ContainerResizeOptions{ Height: 40, Width: 40, }) @@ -275,7 +275,7 @@ func TestExecResize(t *testing.T) { err := apiClient.ContainerKill(ctx, cID, "SIGKILL") assert.NilError(t, err) - err = apiClient.ContainerExecResize(ctx, execID, client.ResizeOptions{ + err = apiClient.ContainerExecResize(ctx, execID, client.ContainerResizeOptions{ Height: 40, Width: 40, }) diff --git a/integration/container/resize_test.go b/integration/container/resize_test.go index 98e87de801..5c9567e75f 100644 --- a/integration/container/resize_test.go +++ b/integration/container/resize_test.go @@ -23,7 +23,7 @@ func TestResize(t *testing.T) { t.Run("success", func(t *testing.T) { cID := container.Run(ctx, t, apiClient, container.WithTty(true)) defer container.Remove(ctx, t, apiClient, cID, containertypes.RemoveOptions{Force: true}) - err := apiClient.ContainerResize(ctx, cID, client.ResizeOptions{ + err := apiClient.ContainerResize(ctx, cID, client.ContainerResizeOptions{ Height: 40, Width: 40, }) @@ -130,7 +130,7 @@ func TestResize(t *testing.T) { t.Run("invalid state", func(t *testing.T) { cID := container.Create(ctx, t, apiClient, container.WithCmd("echo")) defer container.Remove(ctx, t, apiClient, cID, containertypes.RemoveOptions{Force: true}) - err := apiClient.ContainerResize(ctx, cID, client.ResizeOptions{ + err := apiClient.ContainerResize(ctx, cID, client.ContainerResizeOptions{ Height: 40, Width: 40, }) diff --git a/vendor/github.com/moby/moby/client/client_interfaces.go b/vendor/github.com/moby/moby/client/client_interfaces.go index e8415916ff..82fdbe8baa 100644 --- a/vendor/github.com/moby/moby/client/client_interfaces.go +++ b/vendor/github.com/moby/moby/client/client_interfaces.go @@ -72,7 +72,7 @@ type ContainerAPIClient interface { ContainerExecAttach(ctx context.Context, execID string, options container.ExecAttachOptions) (HijackedResponse, error) ContainerExecCreate(ctx context.Context, container string, options container.ExecOptions) (container.ExecCreateResponse, error) ContainerExecInspect(ctx context.Context, execID string) (container.ExecInspect, error) - ContainerExecResize(ctx context.Context, execID string, options ResizeOptions) error + ContainerExecResize(ctx context.Context, execID string, options ContainerResizeOptions) error ContainerExecStart(ctx context.Context, execID string, options container.ExecStartOptions) error ContainerExport(ctx context.Context, container string) (io.ReadCloser, error) ContainerInspect(ctx context.Context, container string) (container.InspectResponse, error) @@ -83,7 +83,7 @@ type ContainerAPIClient interface { ContainerPause(ctx context.Context, container string) error ContainerRemove(ctx context.Context, container string, options container.RemoveOptions) error ContainerRename(ctx context.Context, container, newContainerName string) error - ContainerResize(ctx context.Context, container string, options ResizeOptions) error + ContainerResize(ctx context.Context, container string, options ContainerResizeOptions) error ContainerRestart(ctx context.Context, container string, options container.StopOptions) error ContainerStatPath(ctx context.Context, container, path string) (container.PathStat, error) ContainerStats(ctx context.Context, container string, stream bool) (StatsResponseReader, error) diff --git a/vendor/github.com/moby/moby/client/container_resize.go b/vendor/github.com/moby/moby/client/container_resize.go index 01197c442b..bba1b83354 100644 --- a/vendor/github.com/moby/moby/client/container_resize.go +++ b/vendor/github.com/moby/moby/client/container_resize.go @@ -6,16 +6,16 @@ import ( "strconv" ) -// ResizeOptions holds parameters to resize a TTY. +// ContainerResizeOptions holds parameters to resize a TTY. // It can be used to resize container TTYs and // exec process TTYs too. -type ResizeOptions struct { +type ContainerResizeOptions struct { Height uint Width uint } // ContainerResize changes the size of the pseudo-TTY for a container. -func (cli *Client) ContainerResize(ctx context.Context, containerID string, options ResizeOptions) error { +func (cli *Client) ContainerResize(ctx context.Context, containerID string, options ContainerResizeOptions) error { containerID, err := trimID("container", containerID) if err != nil { return err @@ -24,7 +24,7 @@ func (cli *Client) ContainerResize(ctx context.Context, containerID string, opti } // ContainerExecResize changes the size of the tty for an exec process running inside a container. -func (cli *Client) ContainerExecResize(ctx context.Context, execID string, options ResizeOptions) error { +func (cli *Client) ContainerExecResize(ctx context.Context, execID string, options ContainerResizeOptions) error { execID, err := trimID("exec", execID) if err != nil { return err