Skip to content

Commit 5bea0c3

Browse files
thaJeztahthaJeztah
committed
api/types: migrate NetworkInspectOptions to api/types/network
Signed-off-by: Sebastiaan van Stijn <[email protected]>
1 parent 245d121 commit 5bea0c3

13 files changed

Lines changed: 57 additions & 47 deletions

File tree

‎api/types/network/network.go‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,12 @@ const (
1717
NetworkNat = "nat"
1818
)
1919

20+
// InspectOptions holds parameters to inspect network.
21+
type InspectOptions struct {
22+
Scope string
23+
Verbose bool
24+
}
25+
2026
// ConnectOptions represents the data to be used to connect a container to the
2127
// network.
2228
type ConnectOptions struct {

‎api/types/types.go‎

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -477,12 +477,6 @@ type NetworkCreateRequest struct {
477477
Name string // Name is the requested name of the network.
478478
}
479479

480-
// NetworkInspectOptions holds parameters to inspect network
481-
type NetworkInspectOptions struct {
482-
Scope string
483-
Verbose bool
484-
}
485-
486480
// DiskUsageObject represents an object type used for disk usage query filtering.
487481
type DiskUsageObject string
488482

‎api/types/types_deprecated.go‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,11 @@ type ImageRemoveOptions = image.RemoveOptions
4040
// Deprecated: use [network.CreateResponse].
4141
type NetworkCreateResponse = network.CreateResponse
4242

43+
// NetworkInspectOptions holds parameters to inspect network.
44+
//
45+
// Deprecated: use [network.InspectOptions].
46+
type NetworkInspectOptions = network.InspectOptions
47+
4348
// NetworkConnect represents the data to be used to connect a container to the network
4449
//
4550
// Deprecated: use [network.ConnectOptions].

‎client/interface.go‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -110,8 +110,8 @@ type NetworkAPIClient interface {
110110
NetworkConnect(ctx context.Context, network, container string, config *network.EndpointSettings) error
111111
NetworkCreate(ctx context.Context, name string, options types.NetworkCreate) (network.CreateResponse, error)
112112
NetworkDisconnect(ctx context.Context, network, container string, force bool) error
113-
NetworkInspect(ctx context.Context, network string, options types.NetworkInspectOptions) (types.NetworkResource, error)
114-
NetworkInspectWithRaw(ctx context.Context, network string, options types.NetworkInspectOptions) (types.NetworkResource, []byte, error)
113+
NetworkInspect(ctx context.Context, network string, options network.InspectOptions) (types.NetworkResource, error)
114+
NetworkInspectWithRaw(ctx context.Context, network string, options network.InspectOptions) (types.NetworkResource, []byte, error)
115115
NetworkList(ctx context.Context, options types.NetworkListOptions) ([]types.NetworkResource, error)
116116
NetworkRemove(ctx context.Context, network string) error
117117
NetworksPrune(ctx context.Context, pruneFilter filters.Args) (types.NetworksPruneReport, error)

‎client/network_inspect.go‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,16 +8,17 @@ import (
88
"net/url"
99

1010
"github.com/docker/docker/api/types"
11+
"github.com/docker/docker/api/types/network"
1112
)
1213

1314
// NetworkInspect returns the information for a specific network configured in the docker host.
14-
func (cli *Client) NetworkInspect(ctx context.Context, networkID string, options types.NetworkInspectOptions) (types.NetworkResource, error) {
15+
func (cli *Client) NetworkInspect(ctx context.Context, networkID string, options network.InspectOptions) (types.NetworkResource, error) {
1516
networkResource, _, err := cli.NetworkInspectWithRaw(ctx, networkID, options)
1617
return networkResource, err
1718
}
1819

1920
// NetworkInspectWithRaw returns the information for a specific network configured in the docker host and its raw representation.
20-
func (cli *Client) NetworkInspectWithRaw(ctx context.Context, networkID string, options types.NetworkInspectOptions) (types.NetworkResource, []byte, error) {
21+
func (cli *Client) NetworkInspectWithRaw(ctx context.Context, networkID string, options network.InspectOptions) (types.NetworkResource, []byte, error) {
2122
if networkID == "" {
2223
return types.NetworkResource{}, nil, objectNotFoundError{object: "network", id: networkID}
2324
}

‎client/network_inspect_test.go‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -69,16 +69,16 @@ func TestNetworkInspect(t *testing.T) {
6969

7070
t.Run("empty ID", func(t *testing.T) {
7171
// verify that the client does not create a request if the network-ID/name is empty.
72-
_, err := client.NetworkInspect(context.Background(), "", types.NetworkInspectOptions{})
72+
_, err := client.NetworkInspect(context.Background(), "", network.InspectOptions{})
7373
assert.Check(t, is.ErrorType(err, errdefs.IsNotFound))
7474
})
7575
t.Run("no options", func(t *testing.T) {
76-
r, err := client.NetworkInspect(context.Background(), "network_id", types.NetworkInspectOptions{})
76+
r, err := client.NetworkInspect(context.Background(), "network_id", network.InspectOptions{})
7777
assert.NilError(t, err)
7878
assert.Equal(t, r.Name, "mynetwork")
7979
})
8080
t.Run("verbose", func(t *testing.T) {
81-
r, err := client.NetworkInspect(context.Background(), "network_id", types.NetworkInspectOptions{Verbose: true})
81+
r, err := client.NetworkInspect(context.Background(), "network_id", network.InspectOptions{Verbose: true})
8282
assert.NilError(t, err)
8383
assert.Equal(t, r.Name, "mynetwork")
8484
_, ok := r.Services["web"]
@@ -87,18 +87,18 @@ func TestNetworkInspect(t *testing.T) {
8787
}
8888
})
8989
t.Run("global scope", func(t *testing.T) {
90-
_, err := client.NetworkInspect(context.Background(), "network_id", types.NetworkInspectOptions{Scope: "global"})
90+
_, err := client.NetworkInspect(context.Background(), "network_id", network.InspectOptions{Scope: "global"})
9191
assert.Check(t, is.ErrorContains(err, "Error: No such network: network_id"))
9292
assert.Check(t, is.ErrorType(err, errdefs.IsNotFound))
9393
})
9494
t.Run("unknown network", func(t *testing.T) {
95-
_, err := client.NetworkInspect(context.Background(), "unknown", types.NetworkInspectOptions{})
95+
_, err := client.NetworkInspect(context.Background(), "unknown", network.InspectOptions{})
9696
assert.Check(t, is.ErrorContains(err, "Error: No such network: unknown"))
9797
assert.Check(t, is.ErrorType(err, errdefs.IsNotFound))
9898
})
9999
t.Run("server error", func(t *testing.T) {
100100
// Just testing that an internal server error is converted correctly by the client
101-
_, err := client.NetworkInspect(context.Background(), "test-500-response", types.NetworkInspectOptions{})
101+
_, err := client.NetworkInspect(context.Background(), "test-500-response", network.InspectOptions{})
102102
assert.Check(t, is.ErrorType(err, errdefs.IsSystem))
103103
})
104104
}

‎integration-cli/docker_api_swarm_test.go‎

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,7 @@ import (
2020
"github.com/cloudflare/cfssl/initca"
2121
"github.com/docker/docker/api/types"
2222
"github.com/docker/docker/api/types/container"
23+
"github.com/docker/docker/api/types/network"
2324
"github.com/docker/docker/api/types/swarm"
2425
"github.com/docker/docker/errdefs"
2526
"github.com/docker/docker/integration-cli/checker"
@@ -1026,11 +1027,11 @@ func (s *DockerSwarmSuite) TestAPINetworkInspectWithScope(c *testing.T) {
10261027
resp, err := apiclient.NetworkCreate(ctx, name, types.NetworkCreate{Driver: "overlay"})
10271028
assert.NilError(c, err)
10281029

1029-
network, err := apiclient.NetworkInspect(ctx, name, types.NetworkInspectOptions{})
1030+
nw, err := apiclient.NetworkInspect(ctx, name, network.InspectOptions{})
10301031
assert.NilError(c, err)
1031-
assert.Check(c, is.Equal("swarm", network.Scope))
1032-
assert.Check(c, is.Equal(resp.ID, network.ID))
1032+
assert.Check(c, is.Equal("swarm", nw.Scope))
1033+
assert.Check(c, is.Equal(resp.ID, nw.ID))
10331034

1034-
_, err = apiclient.NetworkInspect(ctx, name, types.NetworkInspectOptions{Scope: "local"})
1035+
_, err = apiclient.NetworkInspect(ctx, name, network.InspectOptions{Scope: "local"})
10351036
assert.Check(c, is.ErrorType(err, errdefs.IsNotFound))
10361037
}

‎integration/container/daemon_linux_test.go‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ import (
1111

1212
"github.com/docker/docker/api/types"
1313
containertypes "github.com/docker/docker/api/types/container"
14+
"github.com/docker/docker/api/types/network"
1415
realcontainer "github.com/docker/docker/container"
1516
"github.com/docker/docker/integration/internal/container"
1617
"github.com/docker/docker/testutil"
@@ -153,7 +154,7 @@ func TestDaemonHostGatewayIP(t *testing.T) {
153154
assert.NilError(t, err)
154155
assert.Assert(t, is.Len(res.Stderr(), 0))
155156
assert.Equal(t, 0, res.ExitCode)
156-
inspect, err := c.NetworkInspect(ctx, "bridge", types.NetworkInspectOptions{})
157+
inspect, err := c.NetworkInspect(ctx, "bridge", network.InspectOptions{})
157158
assert.NilError(t, err)
158159
assert.Check(t, is.Contains(res.Stdout(), inspect.IPAM.Config[0].Gateway))
159160
c.ContainerRemove(ctx, cID, containertypes.RemoveOptions{Force: true})

‎integration/internal/network/states.go‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,15 +3,15 @@ package network
33
import (
44
"context"
55

6-
"github.com/docker/docker/api/types"
6+
"github.com/docker/docker/api/types/network"
77
"github.com/docker/docker/client"
88
"gotest.tools/v3/poll"
99
)
1010

1111
// IsRemoved verifies the network is removed.
1212
func IsRemoved(ctx context.Context, client client.NetworkAPIClient, networkID string) func(log poll.LogT) poll.Result {
1313
return func(log poll.LogT) poll.Result {
14-
_, err := client.NetworkInspect(ctx, networkID, types.NetworkInspectOptions{})
14+
_, err := client.NetworkInspect(ctx, networkID, network.InspectOptions{})
1515
if err == nil {
1616
return poll.Continue("waiting for network %s to be removed", networkID)
1717
}

‎integration/network/inspect_test.go‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ package network // import "github.com/docker/docker/integration/network"
33
import (
44
"testing"
55

6-
"github.com/docker/docker/api/types"
6+
networktypes "github.com/docker/docker/api/types/network"
77
"github.com/docker/docker/integration/internal/network"
88
"github.com/docker/docker/integration/internal/swarm"
99
"github.com/docker/docker/testutil"
@@ -41,33 +41,33 @@ func TestInspectNetwork(t *testing.T) {
4141
tests := []struct {
4242
name string
4343
network string
44-
opts types.NetworkInspectOptions
44+
opts networktypes.InspectOptions
4545
}{
4646
{
4747
name: "full network id",
4848
network: overlayID,
49-
opts: types.NetworkInspectOptions{
49+
opts: networktypes.InspectOptions{
5050
Verbose: true,
5151
},
5252
},
5353
{
5454
name: "partial network id",
5555
network: overlayID[0:11],
56-
opts: types.NetworkInspectOptions{
56+
opts: networktypes.InspectOptions{
5757
Verbose: true,
5858
},
5959
},
6060
{
6161
name: "network name",
6262
network: networkName,
63-
opts: types.NetworkInspectOptions{
63+
opts: networktypes.InspectOptions{
6464
Verbose: true,
6565
},
6666
},
6767
{
6868
name: "network name and swarm scope",
6969
network: networkName,
70-
opts: types.NetworkInspectOptions{
70+
opts: networktypes.InspectOptions{
7171
Verbose: true,
7272
Scope: "swarm",
7373
},

0 commit comments

Comments
 (0)