Skip to content

Commit 95b92b1

Browse files
thaJeztahthaJeztah
committed
api/types: move ResizeOptions to api/types/container
Signed-off-by: Sebastiaan van Stijn <[email protected]>
1 parent ec69501 commit 95b92b1

8 files changed

Lines changed: 32 additions & 23 deletions

File tree

‎api/types/client.go‎

Lines changed: 0 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -289,14 +289,6 @@ type ImageSearchOptions struct {
289289
Limit int
290290
}
291291

292-
// ResizeOptions holds parameters to resize a tty.
293-
// It can be used to resize container ttys and
294-
// exec process ttys too.
295-
type ResizeOptions struct {
296-
Height uint
297-
Width uint
298-
}
299-
300292
// NodeListOptions holds parameters to list nodes with.
301293
type NodeListOptions struct {
302294
Filters filters.Args

‎api/types/container/options.go‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
package container
2+
3+
// ResizeOptions holds parameters to resize a TTY.
4+
// It can be used to resize container TTYs and
5+
// exec process TTYs too.
6+
type ResizeOptions struct {
7+
Height uint
8+
Width uint
9+
}

‎api/types/types_deprecated.go‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@ package types
22

33
import (
44
"github.com/docker/docker/api/types/checkpoint"
5+
"github.com/docker/docker/api/types/container"
56
"github.com/docker/docker/api/types/image"
67
"github.com/docker/docker/api/types/swarm"
78
"github.com/docker/docker/api/types/system"
@@ -91,6 +92,13 @@ type ServiceCreateResponse = swarm.ServiceCreateResponse
9192
// Deprecated: use [swarm.ServiceUpdateResponse].
9293
type ServiceUpdateResponse = swarm.ServiceUpdateResponse
9394

95+
// ResizeOptions holds parameters to resize a TTY.
96+
// It can be used to resize container TTYs and
97+
// exec process TTYs too.
98+
//
99+
// Deprecated: use [container.ResizeOptions].
100+
type ResizeOptions = container.ResizeOptions
101+
94102
// DecodeSecurityOptions decodes a security options string slice to a type safe
95103
// [system.SecurityOpt].
96104
//

‎client/container_resize.go‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,16 +5,16 @@ import (
55
"net/url"
66
"strconv"
77

8-
"github.com/docker/docker/api/types"
8+
"github.com/docker/docker/api/types/container"
99
)
1010

1111
// ContainerResize changes the size of the tty for a container.
12-
func (cli *Client) ContainerResize(ctx context.Context, containerID string, options types.ResizeOptions) error {
12+
func (cli *Client) ContainerResize(ctx context.Context, containerID string, options container.ResizeOptions) error {
1313
return cli.resize(ctx, "/containers/"+containerID, options.Height, options.Width)
1414
}
1515

1616
// ContainerExecResize changes the size of the tty for an exec process running inside a container.
17-
func (cli *Client) ContainerExecResize(ctx context.Context, execID string, options types.ResizeOptions) error {
17+
func (cli *Client) ContainerExecResize(ctx context.Context, execID string, options container.ResizeOptions) error {
1818
return cli.resize(ctx, "/exec/"+execID, options.Height, options.Width)
1919
}
2020

‎client/container_resize_test.go‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ import (
99
"strings"
1010
"testing"
1111

12-
"github.com/docker/docker/api/types"
12+
"github.com/docker/docker/api/types/container"
1313
"github.com/docker/docker/errdefs"
1414
"gotest.tools/v3/assert"
1515
is "gotest.tools/v3/assert/cmp"
@@ -19,15 +19,15 @@ func TestContainerResizeError(t *testing.T) {
1919
client := &Client{
2020
client: newMockClient(errorMock(http.StatusInternalServerError, "Server error")),
2121
}
22-
err := client.ContainerResize(context.Background(), "container_id", types.ResizeOptions{})
22+
err := client.ContainerResize(context.Background(), "container_id", container.ResizeOptions{})
2323
assert.Check(t, is.ErrorType(err, errdefs.IsSystem))
2424
}
2525

2626
func TestContainerExecResizeError(t *testing.T) {
2727
client := &Client{
2828
client: newMockClient(errorMock(http.StatusInternalServerError, "Server error")),
2929
}
30-
err := client.ContainerExecResize(context.Background(), "exec_id", types.ResizeOptions{})
30+
err := client.ContainerExecResize(context.Background(), "exec_id", container.ResizeOptions{})
3131
assert.Check(t, is.ErrorType(err, errdefs.IsSystem))
3232
}
3333

@@ -36,7 +36,7 @@ func TestContainerResize(t *testing.T) {
3636
client: newMockClient(resizeTransport("/containers/container_id/resize")),
3737
}
3838

39-
err := client.ContainerResize(context.Background(), "container_id", types.ResizeOptions{
39+
err := client.ContainerResize(context.Background(), "container_id", container.ResizeOptions{
4040
Height: 500,
4141
Width: 600,
4242
})
@@ -50,7 +50,7 @@ func TestContainerExecResize(t *testing.T) {
5050
client: newMockClient(resizeTransport("/exec/exec_id/resize")),
5151
}
5252

53-
err := client.ContainerExecResize(context.Background(), "exec_id", types.ResizeOptions{
53+
err := client.ContainerExecResize(context.Background(), "exec_id", container.ResizeOptions{
5454
Height: 500,
5555
Width: 600,
5656
})

‎client/interface.go‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ type ContainerAPIClient interface {
5353
ContainerExecAttach(ctx context.Context, execID string, config types.ExecStartCheck) (types.HijackedResponse, error)
5454
ContainerExecCreate(ctx context.Context, container string, config types.ExecConfig) (types.IDResponse, error)
5555
ContainerExecInspect(ctx context.Context, execID string) (types.ContainerExecInspect, error)
56-
ContainerExecResize(ctx context.Context, execID string, options types.ResizeOptions) error
56+
ContainerExecResize(ctx context.Context, execID string, options container.ResizeOptions) error
5757
ContainerExecStart(ctx context.Context, execID string, config types.ExecStartCheck) error
5858
ContainerExport(ctx context.Context, container string) (io.ReadCloser, error)
5959
ContainerInspect(ctx context.Context, container string) (types.ContainerJSON, error)
@@ -64,7 +64,7 @@ type ContainerAPIClient interface {
6464
ContainerPause(ctx context.Context, container string) error
6565
ContainerRemove(ctx context.Context, container string, options types.ContainerRemoveOptions) error
6666
ContainerRename(ctx context.Context, container, newContainerName string) error
67-
ContainerResize(ctx context.Context, container string, options types.ResizeOptions) error
67+
ContainerResize(ctx context.Context, container string, options container.ResizeOptions) error
6868
ContainerRestart(ctx context.Context, container string, options container.StopOptions) error
6969
ContainerStatPath(ctx context.Context, container, path string) (types.ContainerPathStat, error)
7070
ContainerStats(ctx context.Context, container string, stream bool) (types.ContainerStats, error)

‎integration-cli/docker_cli_events_test.go‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ import (
1313
"testing"
1414
"time"
1515

16-
"github.com/docker/docker/api/types"
16+
"github.com/docker/docker/api/types/container"
1717
eventtypes "github.com/docker/docker/api/types/events"
1818
"github.com/docker/docker/client"
1919
eventstestutils "github.com/docker/docker/daemon/events/testutils"
@@ -459,7 +459,7 @@ func (s *DockerCLIEventSuite) TestEventsResize(c *testing.T) {
459459
assert.NilError(c, err)
460460
defer apiClient.Close()
461461

462-
options := types.ResizeOptions{
462+
options := container.ResizeOptions{
463463
Height: 80,
464464
Width: 24,
465465
}

‎integration/container/resize_test.go‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ import (
44
"net/http"
55
"testing"
66

7-
"github.com/docker/docker/api/types"
7+
containertypes "github.com/docker/docker/api/types/container"
88
"github.com/docker/docker/api/types/versions"
99
"github.com/docker/docker/errdefs"
1010
"github.com/docker/docker/integration/internal/container"
@@ -20,7 +20,7 @@ func TestResize(t *testing.T) {
2020

2121
t.Run("success", func(t *testing.T) {
2222
cID := container.Run(ctx, t, apiClient, container.WithTty(true))
23-
err := apiClient.ContainerResize(ctx, cID, types.ResizeOptions{
23+
err := apiClient.ContainerResize(ctx, cID, containertypes.ResizeOptions{
2424
Height: 40,
2525
Width: 40,
2626
})
@@ -46,7 +46,7 @@ func TestResize(t *testing.T) {
4646

4747
t.Run("invalid state", func(t *testing.T) {
4848
cID := container.Create(ctx, t, apiClient, container.WithCmd("echo"))
49-
err := apiClient.ContainerResize(ctx, cID, types.ResizeOptions{
49+
err := apiClient.ContainerResize(ctx, cID, containertypes.ResizeOptions{
5050
Height: 40,
5151
Width: 40,
5252
})

0 commit comments

Comments
 (0)