e6907243af
We try to perform API-version negotiation as lazy as possible (and only execute when we are about to make an API request). However, some code requires API-version dependent handling (to set options, or remove options based on the version of the API we're using). Currently this code depended on the caller code to perform API negotiation (or to configure the API version) first, which may not happen, and because of that we may be missing options (or set options that are not supported on older API versions). This patch: - splits the code that triggered API-version negotiation to a separate Client.checkVersion() function. - updates NewVersionError to accept a context - updates NewVersionError to perform API-version negotiation (if enabled) - updates various Client functions to manually trigger API-version negotiation Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
56 lines
1.6 KiB
Go
56 lines
1.6 KiB
Go
package client // import "github.com/docker/docker/client"
|
|
|
|
import (
|
|
"context"
|
|
"encoding/json"
|
|
"net/url"
|
|
|
|
"github.com/docker/docker/api/types"
|
|
"github.com/docker/docker/api/types/filters"
|
|
"github.com/docker/docker/api/types/versions"
|
|
)
|
|
|
|
// ImageList returns a list of images in the docker host.
|
|
func (cli *Client) ImageList(ctx context.Context, options types.ImageListOptions) ([]types.ImageSummary, error) {
|
|
// Make sure we negotiated (if the client is configured to do so),
|
|
// as code below contains API-version specific handling of options.
|
|
//
|
|
// Normally, version-negotiation (if enabled) would not happen until
|
|
// the API request is made.
|
|
cli.checkVersion(ctx)
|
|
|
|
var images []types.ImageSummary
|
|
query := url.Values{}
|
|
|
|
optionFilters := options.Filters
|
|
referenceFilters := optionFilters.Get("reference")
|
|
if versions.LessThan(cli.version, "1.25") && len(referenceFilters) > 0 {
|
|
query.Set("filter", referenceFilters[0])
|
|
for _, filterValue := range referenceFilters {
|
|
optionFilters.Del("reference", filterValue)
|
|
}
|
|
}
|
|
if optionFilters.Len() > 0 {
|
|
//nolint:staticcheck // ignore SA1019 for old code
|
|
filterJSON, err := filters.ToParamWithVersion(cli.version, optionFilters)
|
|
if err != nil {
|
|
return images, err
|
|
}
|
|
query.Set("filters", filterJSON)
|
|
}
|
|
if options.All {
|
|
query.Set("all", "1")
|
|
}
|
|
if options.SharedSize && versions.GreaterThanOrEqualTo(cli.version, "1.42") {
|
|
query.Set("shared-size", "1")
|
|
}
|
|
|
|
serverResp, err := cli.get(ctx, "/images/json", query, nil)
|
|
defer ensureReaderClosed(serverResp)
|
|
if err != nil {
|
|
return images, err
|
|
}
|
|
|
|
err = json.NewDecoder(serverResp.body).Decode(&images)
|
|
return images, err
|
|
}
|