Files
moby/client/container_list_test.go
Sebastiaan van Stijn 5819d10989 client: deprecate ContainerListOptions.Latest
The `--latest` option was implemented in [moby@b295239] as a CLI shortcut
for `--last=1`.

However, as part of a large refactor of the client in [moby@d05aa41], a
`ContainerListOptions` type was introduced, which contained a `Latest`
field.

This field was never used, as the `Latest` option was handled in the CLI,
and had no corresponding option for the API (other than `limit`).

This patch deprecates the field as it is non-functional.

[moby@b295239]: https://github.com/moby/moby/commit/b295239de20f15620ee4149fcc7c13ce461cdaac
[moby@d05aa41]: https://github.com/moby/moby/commit/d05aa418b0466553a24d42896f99176cfa29765f

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2026-01-23 14:49:59 +01:00

103 lines
2.6 KiB
Go

package client
import (
"net/http"
"net/url"
"testing"
cerrdefs "github.com/containerd/errdefs"
"github.com/moby/moby/api/types/container"
"gotest.tools/v3/assert"
is "gotest.tools/v3/assert/cmp"
)
func TestContainerListError(t *testing.T) {
client, err := New(
WithMockClient(errorMock(http.StatusInternalServerError, "Server error")),
)
assert.NilError(t, err)
_, err = client.ContainerList(t.Context(), ContainerListOptions{})
assert.Check(t, is.ErrorType(err, cerrdefs.IsInternal))
}
func TestContainerList(t *testing.T) {
const expectedURL = "/containers/json"
tests := []struct {
doc string
options ContainerListOptions
expected url.Values
}{
{
doc: "no options",
expected: url.Values{},
},
{
doc: "size",
options: ContainerListOptions{Size: true},
expected: url.Values{"size": []string{"1"}},
},
{
doc: "all",
options: ContainerListOptions{All: true},
expected: url.Values{"all": []string{"1"}},
},
{
doc: "latest",
options: ContainerListOptions{Latest: true}, //nolint:staticcheck // ignore SA1019: field is deprecated.
expected: url.Values{},
},
{
doc: "since",
options: ContainerListOptions{Since: "container"}, //nolint:staticcheck // ignore SA1019: field is deprecated.
expected: url.Values{},
},
{
doc: "before",
options: ContainerListOptions{Before: "container"}, //nolint:staticcheck // ignore SA1019: field is deprecated.
expected: url.Values{},
},
{
doc: "limit",
options: ContainerListOptions{Limit: 1},
expected: url.Values{"limit": []string{"1"}},
},
{
doc: "filters",
options: ContainerListOptions{
Filters: make(Filters).
Add("label", "label1").
Add("label", "label2").
Add("before", "container"),
},
expected: url.Values{"filters": []string{`{"before":{"container":true},"label":{"label1":true,"label2":true}}`}},
},
}
for _, tc := range tests {
t.Run(tc.doc, func(t *testing.T) {
var query url.Values
client, err := New(
WithMockClient(func(req *http.Request) (*http.Response, error) {
if err := assertRequest(req, http.MethodGet, expectedURL); err != nil {
return nil, err
}
query = req.URL.Query()
return mockJSONResponse(http.StatusOK, nil, []container.Summary{
{ID: "container_id1"},
{ID: "container_id2"},
})(req)
}),
)
assert.NilError(t, err)
list, err := client.ContainerList(t.Context(), tc.options)
assert.NilError(t, err)
assert.Check(t, is.Len(list.Items, 2))
assert.Check(t, is.DeepEqual(query, tc.expected))
})
}
}