From 2c5e0a008a9655ebbccaffbadb15bf938818f50a Mon Sep 17 00:00:00 2001 From: Sebastiaan van Stijn Date: Tue, 21 Oct 2025 20:41:46 +0200 Subject: [PATCH] client: rename ConfigListResult.Configs to ConfigListResult.Items Also consolidate the options with the method. Signed-off-by: Sebastiaan van Stijn --- client/config_list.go | 13 ++++++--- client/config_list_test.go | 2 +- client/config_remove.go | 8 ++++-- client/swarm_config_list_options.go | 6 ---- integration/config/config_test.go | 28 +++++++++---------- internal/testutil/daemon/config.go | 2 +- .../moby/moby/client/config_list.go | 13 ++++++--- .../moby/moby/client/config_remove.go | 8 ++++-- .../moby/client/swarm_config_list_options.go | 6 ---- 9 files changed, 46 insertions(+), 40 deletions(-) delete mode 100644 client/swarm_config_list_options.go delete mode 100644 vendor/github.com/moby/moby/client/swarm_config_list_options.go diff --git a/client/config_list.go b/client/config_list.go index b6752421b6..ee5e7fee7a 100644 --- a/client/config_list.go +++ b/client/config_list.go @@ -8,14 +8,18 @@ import ( "github.com/moby/moby/api/types/swarm" ) -// ConfigListResult holds the result from the ConfigList method. +// ConfigListOptions holds parameters to list configs +type ConfigListOptions struct { + Filters Filters +} + +// ConfigListResult holds the result from the [client.ConfigList] method. type ConfigListResult struct { - Configs []swarm.Config + Items []swarm.Config } // ConfigList returns the list of configs. func (cli *Client) ConfigList(ctx context.Context, options ConfigListOptions) (ConfigListResult, error) { - var out ConfigListResult query := url.Values{} options.Filters.updateURLValues(query) @@ -25,7 +29,8 @@ func (cli *Client) ConfigList(ctx context.Context, options ConfigListOptions) (C return ConfigListResult{}, err } - err = json.NewDecoder(resp.Body).Decode(&out.Configs) + var out ConfigListResult + err = json.NewDecoder(resp.Body).Decode(&out.Items) if err != nil { return ConfigListResult{}, err } diff --git a/client/config_list_test.go b/client/config_list_test.go index 19d9862ffa..86058fc808 100644 --- a/client/config_list_test.go +++ b/client/config_list_test.go @@ -83,6 +83,6 @@ func TestConfigList(t *testing.T) { result, err := client.ConfigList(context.Background(), listCase.options) assert.NilError(t, err) - assert.Check(t, is.Len(result.Configs, 2)) + assert.Check(t, is.Len(result.Items, 2)) } } diff --git a/client/config_remove.go b/client/config_remove.go index 8fc65b50a7..c77a4c3786 100644 --- a/client/config_remove.go +++ b/client/config_remove.go @@ -2,9 +2,13 @@ package client import "context" -type ConfigRemoveOptions struct{} +type ConfigRemoveOptions struct { + // Add future optional parameters here +} -type ConfigRemoveResult struct{} +type ConfigRemoveResult struct { + // Add future fields here +} // ConfigRemove removes a config. func (cli *Client) ConfigRemove(ctx context.Context, id string, options ConfigRemoveOptions) (ConfigRemoveResult, error) { diff --git a/client/swarm_config_list_options.go b/client/swarm_config_list_options.go deleted file mode 100644 index b66fb359fc..0000000000 --- a/client/swarm_config_list_options.go +++ /dev/null @@ -1,6 +0,0 @@ -package client - -// ConfigListOptions holds parameters to list configs -type ConfigListOptions struct { - Filters Filters -} diff --git a/integration/config/config_test.go b/integration/config/config_test.go index 90ffa53ca6..74d70fcb69 100644 --- a/integration/config/config_test.go +++ b/integration/config/config_test.go @@ -56,7 +56,7 @@ func TestConfigList(t *testing.T) { // This test case is ported from the original TestConfigsEmptyList result, err := c.ConfigList(ctx, client.ConfigListOptions{}) assert.NilError(t, err) - assert.Check(t, is.Equal(len(result.Configs), 0)) + assert.Check(t, is.Equal(len(result.Items), 0)) testName0 := "test0-" + t.Name() testName1 := "test1-" + t.Name() @@ -69,9 +69,9 @@ func TestConfigList(t *testing.T) { config1ID := createConfig(ctx, t, c, testName1, []byte("TESTINGDATA1"), map[string]string{"type": "production"}) // test by `config ls` - entries, err := c.ConfigList(ctx, client.ConfigListOptions{}) + res, err := c.ConfigList(ctx, client.ConfigListOptions{}) assert.NilError(t, err) - assert.Check(t, is.DeepEqual(configNamesFromList(entries.Configs), testNames)) + assert.Check(t, is.DeepEqual(configNamesFromList(res.Items), testNames)) testCases := []struct { desc string @@ -107,11 +107,11 @@ func TestConfigList(t *testing.T) { for _, tc := range testCases { t.Run(tc.desc, func(t *testing.T) { ctx := testutil.StartSpan(ctx, t) - entries, err = c.ConfigList(ctx, client.ConfigListOptions{ + res, err = c.ConfigList(ctx, client.ConfigListOptions{ Filters: tc.filters, }) assert.NilError(t, err) - assert.Check(t, is.DeepEqual(configNamesFromList(entries.Configs), tc.expected)) + assert.Check(t, is.DeepEqual(configNamesFromList(res.Items), tc.expected)) }) } } @@ -360,18 +360,18 @@ func TestConfigCreateResolve(t *testing.T) { fakeName := configID fakeID := createConfig(ctx, t, c, fakeName, []byte("fake foo"), nil) - entries, err := c.ConfigList(ctx, client.ConfigListOptions{}) + res, err := c.ConfigList(ctx, client.ConfigListOptions{}) assert.NilError(t, err) - assert.Assert(t, is.Contains(configNamesFromList(entries.Configs), configName)) - assert.Assert(t, is.Contains(configNamesFromList(entries.Configs), fakeName)) + assert.Assert(t, is.Contains(configNamesFromList(res.Items), configName)) + assert.Assert(t, is.Contains(configNamesFromList(res.Items), fakeName)) _, err = c.ConfigRemove(ctx, configID, client.ConfigRemoveOptions{}) assert.NilError(t, err) // Fake one will remain - entries, err = c.ConfigList(ctx, client.ConfigListOptions{}) + res, err = c.ConfigList(ctx, client.ConfigListOptions{}) assert.NilError(t, err) - assert.Assert(t, is.DeepEqual(configNamesFromList(entries.Configs), []string{fakeName})) + assert.Assert(t, is.DeepEqual(configNamesFromList(res.Items), []string{fakeName})) // Remove based on name prefix of the fake one // (which is the same as the ID of foo one) should not work @@ -381,16 +381,16 @@ func TestConfigCreateResolve(t *testing.T) { // - Partial ID (prefix) _, err = c.ConfigRemove(ctx, configID[:5], client.ConfigRemoveOptions{}) assert.Assert(t, err != nil) - entries, err = c.ConfigList(ctx, client.ConfigListOptions{}) + res, err = c.ConfigList(ctx, client.ConfigListOptions{}) assert.NilError(t, err) - assert.Assert(t, is.DeepEqual(configNamesFromList(entries.Configs), []string{fakeName})) + assert.Assert(t, is.DeepEqual(configNamesFromList(res.Items), []string{fakeName})) // Remove based on ID prefix of the fake one should succeed _, err = c.ConfigRemove(ctx, fakeID[:5], client.ConfigRemoveOptions{}) assert.NilError(t, err) - entries, err = c.ConfigList(ctx, client.ConfigListOptions{}) + res, err = c.ConfigList(ctx, client.ConfigListOptions{}) assert.NilError(t, err) - assert.Assert(t, is.Equal(0, len(entries.Configs))) + assert.Assert(t, is.Equal(0, len(res.Items))) } func configNamesFromList(entries []swarmtypes.Config) []string { diff --git a/internal/testutil/daemon/config.go b/internal/testutil/daemon/config.go index 6ef1a1510a..8d8145be03 100644 --- a/internal/testutil/daemon/config.go +++ b/internal/testutil/daemon/config.go @@ -33,7 +33,7 @@ func (d *Daemon) ListConfigs(t testing.TB) []swarm.Config { result, err := cli.ConfigList(context.Background(), client.ConfigListOptions{}) assert.NilError(t, err) - return result.Configs + return result.Items } // GetConfig returns a swarm config identified by the specified id diff --git a/vendor/github.com/moby/moby/client/config_list.go b/vendor/github.com/moby/moby/client/config_list.go index b6752421b6..ee5e7fee7a 100644 --- a/vendor/github.com/moby/moby/client/config_list.go +++ b/vendor/github.com/moby/moby/client/config_list.go @@ -8,14 +8,18 @@ import ( "github.com/moby/moby/api/types/swarm" ) -// ConfigListResult holds the result from the ConfigList method. +// ConfigListOptions holds parameters to list configs +type ConfigListOptions struct { + Filters Filters +} + +// ConfigListResult holds the result from the [client.ConfigList] method. type ConfigListResult struct { - Configs []swarm.Config + Items []swarm.Config } // ConfigList returns the list of configs. func (cli *Client) ConfigList(ctx context.Context, options ConfigListOptions) (ConfigListResult, error) { - var out ConfigListResult query := url.Values{} options.Filters.updateURLValues(query) @@ -25,7 +29,8 @@ func (cli *Client) ConfigList(ctx context.Context, options ConfigListOptions) (C return ConfigListResult{}, err } - err = json.NewDecoder(resp.Body).Decode(&out.Configs) + var out ConfigListResult + err = json.NewDecoder(resp.Body).Decode(&out.Items) if err != nil { return ConfigListResult{}, err } diff --git a/vendor/github.com/moby/moby/client/config_remove.go b/vendor/github.com/moby/moby/client/config_remove.go index 8fc65b50a7..c77a4c3786 100644 --- a/vendor/github.com/moby/moby/client/config_remove.go +++ b/vendor/github.com/moby/moby/client/config_remove.go @@ -2,9 +2,13 @@ package client import "context" -type ConfigRemoveOptions struct{} +type ConfigRemoveOptions struct { + // Add future optional parameters here +} -type ConfigRemoveResult struct{} +type ConfigRemoveResult struct { + // Add future fields here +} // ConfigRemove removes a config. func (cli *Client) ConfigRemove(ctx context.Context, id string, options ConfigRemoveOptions) (ConfigRemoveResult, error) { diff --git a/vendor/github.com/moby/moby/client/swarm_config_list_options.go b/vendor/github.com/moby/moby/client/swarm_config_list_options.go deleted file mode 100644 index b66fb359fc..0000000000 --- a/vendor/github.com/moby/moby/client/swarm_config_list_options.go +++ /dev/null @@ -1,6 +0,0 @@ -package client - -// ConfigListOptions holds parameters to list configs -type ConfigListOptions struct { - Filters Filters -}