Merge pull request #6551 from thaJeztah/remove_legacy_api_versions

remove API-version compatibility for API < v1.44

Author: thaJeztah

cli/command/builder/prune.go

@@ -12,7 +12,6 @@ import (
 	"github.com/docker/cli/internal/prompt"
 	"github.com/docker/cli/opts"
 	"github.com/docker/go-units"
-	"github.com/moby/moby/api/types/versions"
 	"github.com/moby/moby/client"
 	"github.com/spf13/cobra"
 )
@@ -112,17 +111,9 @@ type cancelledErr struct{ error }
 
 func (cancelledErr) Cancelled() {}
 
-type errNotImplemented struct{ error }
-
-func (errNotImplemented) NotImplemented() {}
-
 // pruneFn prunes the build cache for use in "docker system prune" and
 // returns the amount of space reclaimed and a detailed output string.
 func pruneFn(ctx context.Context, dockerCLI command.Cli, options pruner.PruneOptions) (uint64, string, error) {
-	if ver := dockerCLI.Client().ClientVersion(); ver != "" && versions.LessThan(ver, "1.31") {
-		// Not supported on older daemons.
-		return 0, "", errNotImplemented{errors.New("builder prune requires API version 1.31 or greater")}
-	}
 	if !options.Confirmed {
 		// Dry-run: perform validation and produce confirmation before pruning.
 		var confirmMsg string

cli/command/cli_test.go

@@ -164,7 +164,7 @@ func TestInitializeFromClient(t *testing.T) {
 		{
 			doc: "successful ping",
 			pingFunc: func() (types.Ping, error) {
-				return types.Ping{Experimental: true, OSType: "linux", APIVersion: "v1.30"}, nil
+				return types.Ping{Experimental: true, OSType: "linux", APIVersion: "v1.44"}, nil
 			},
 			expectedServer: ServerInfo{HasExperimental: true, OSType: "linux"},
 			negotiated:     true,
@@ -179,7 +179,7 @@ func TestInitializeFromClient(t *testing.T) {
 		{
 			doc: "failed ping, with API version",
 			pingFunc: func() (types.Ping, error) {
-				return types.Ping{APIVersion: "v1.33"}, errors.New("failed")
+				return types.Ping{APIVersion: "v1.44"}, errors.New("failed")
 			},
 			expectedServer: ServerInfo{HasExperimental: true},
 			negotiated:     true,

cli/command/container/create.go

@@ -25,7 +25,6 @@ import (
 	"github.com/docker/cli/internal/jsonstream"
 	"github.com/docker/cli/opts"
 	"github.com/moby/moby/api/types/mount"
-	"github.com/moby/moby/api/types/versions"
 	"github.com/moby/moby/client"
 	ocispec "github.com/opencontainers/image-spec/specs-go/v1"
 	"github.com/spf13/cobra"
@@ -85,7 +84,8 @@ func newCreateCommand(dockerCLI command.Cli) *cobra.Command {
 	flags.Bool("help", false, "Print usage")
 
 	// TODO(thaJeztah): consider adding platform as "image create option" on containerOptions
-	addPlatformFlag(flags, &options.platform)
+	flags.StringVar(&options.platform, "platform", os.Getenv("DOCKER_DEFAULT_PLATFORM"), "Set platform if server is multi-platform capable")
+	_ = flags.SetAnnotation("platform", "version", []string{"1.32"})
 	_ = cmd.RegisterFlagCompletionFunc("platform", completion.Platforms())
 
 	flags.BoolVar(&options.untrusted, "disable-content-trust", !trust.Enabled(), "Skip image verification")
@@ -306,11 +306,7 @@ func createContainer(ctx context.Context, dockerCli command.Cli, containerCfg *c
 	}
 
 	var platform *ocispec.Platform
-	// Engine API version 1.41 first introduced the option to specify platform on
-	// create. It will produce an error if you try to set a platform on older API
-	// versions, so check the API version here to maintain backwards
-	// compatibility for CLI users.
-	if options.platform != "" && versions.GreaterThanOrEqualTo(dockerCli.Client().ClientVersion(), "1.41") {
+	if options.platform != "" {
 		p, err := platforms.Parse(options.platform)
 		if err != nil {
 			return "", invalidParameter(fmt.Errorf("error parsing specified platform: %w", err))

cli/command/container/opts.go

@@ -141,16 +141,6 @@ type containerOptions struct {
 	Args  []string
 }
 
-// addPlatformFlag adds "--platform" to a set of flags for API version 1.32 and
-// later, using the value of "DOCKER_DEFAULT_PLATFORM" (if set) as a default.
-//
-// It should not be used for new uses, which may have a different API version
-// requirement.
-func addPlatformFlag(flags *pflag.FlagSet, target *string) {
-	flags.StringVar(target, "platform", os.Getenv("DOCKER_DEFAULT_PLATFORM"), "Set platform if server is multi-platform capable")
-	_ = flags.SetAnnotation("platform", "version", []string{"1.32"})
-}
-
 // addFlags adds all command line flags that will be used by parse to the FlagSet
 func addFlags(flags *pflag.FlagSet) *containerOptions {
 	copts := &containerOptions{
@@ -659,7 +649,6 @@ func parse(flags *pflag.FlagSet, copts *containerOptions, serverOS string) (*con
 		Cmd:          runCmd,
 		Image:        copts.Image,
 		Volumes:      volumes,
-		MacAddress:   copts.macAddress,
 		Entrypoint:   entrypoint,
 		WorkingDir:   copts.workingDir,
 		Labels:       opts.ConvertKVStringsToMap(labels),
@@ -730,25 +719,17 @@ func parse(flags *pflag.FlagSet, copts *containerOptions, serverOS string) (*con
 		config.StdinOnce = true
 	}
 
-	networkingConfig := &network.NetworkingConfig{
-		EndpointsConfig: make(map[string]*network.EndpointSettings),
-	}
-
-	networkingConfig.EndpointsConfig, err = parseNetworkOpts(copts)
+	epCfg, err := parseNetworkOpts(copts)
 	if err != nil {
 		return nil, err
 	}
 
-	// Put the endpoint-specific MacAddress of the "main" network attachment into the container Config for backward
-	// compatibility with older daemons.
-	if nw, ok := networkingConfig.EndpointsConfig[hostConfig.NetworkMode.NetworkName()]; ok {
-		config.MacAddress = nw.MacAddress //nolint:staticcheck // ignore SA1019: field is deprecated, but still used on API < v1.44.
-	}
-
 	return &containerConfig{
-		Config:           config,
-		HostConfig:       hostConfig,
-		NetworkingConfig: networkingConfig,
+		Config:     config,
+		HostConfig: hostConfig,
+		NetworkingConfig: &network.NetworkingConfig{
+			EndpointsConfig: epCfg,
+		},
 	}, nil
 }
 

cli/command/container/opts_test.go

@@ -351,11 +351,7 @@ func TestParseWithMacAddress(t *testing.T) {
 	if _, _, _, err := parseRun([]string{invalidMacAddress, "img", "cmd"}); err != nil && err.Error() != "invalidMacAddress is not a valid mac address" {
 		t.Fatalf("Expected an error with %v mac-address, got %v", invalidMacAddress, err)
 	}
-	config, hostConfig, nwConfig := mustParse(t, validMacAddress)
-	if config.MacAddress != "92:d0:c6:0a:29:33" { //nolint:staticcheck // ignore SA1019: field is deprecated, but still used on API < v1.44.
-		t.Fatalf("Expected the config to have '92:d0:c6:0a:29:33' as container-wide MacAddress, got '%v'",
-			config.MacAddress) //nolint:staticcheck // ignore SA1019: field is deprecated, but still used on API < v1.44.
-	}
+	_, hostConfig, nwConfig := mustParse(t, validMacAddress)
 	defaultNw := hostConfig.NetworkMode.NetworkName()
 	if nwConfig.EndpointsConfig[defaultNw].MacAddress != "92:d0:c6:0a:29:33" {
 		t.Fatalf("Expected the default endpoint to have the MacAddress '92:d0:c6:0a:29:33' set, got '%v'", nwConfig.EndpointsConfig[defaultNw].MacAddress)
@@ -576,7 +572,6 @@ func TestParseNetworkConfig(t *testing.T) {
 		name            string
 		flags           []string
 		expected        map[string]*networktypes.EndpointSettings
-		expectedCfg     container.Config
 		expectedHostCfg container.HostConfig
 		expectedErr     string
 	}{
@@ -680,7 +675,6 @@ func TestParseNetworkConfig(t *testing.T) {
 					MacAddress: "02:32:1c:23:00:04",
 				},
 			},
-			expectedCfg:     container.Config{MacAddress: "02:32:1c:23:00:04"},
 			expectedHostCfg: container.HostConfig{NetworkMode: "net1"},
 		},
 		{
@@ -698,7 +692,6 @@ func TestParseNetworkConfig(t *testing.T) {
 					MacAddress: "52:0f:f3:dc:50:10",
 				},
 			},
-			expectedCfg:     container.Config{MacAddress: "52:0f:f3:dc:50:10"},
 			expectedHostCfg: container.HostConfig{NetworkMode: "net1"},
 		},
 		{
@@ -745,15 +738,14 @@ func TestParseNetworkConfig(t *testing.T) {
 
 	for _, tc := range tests {
 		t.Run(tc.name, func(t *testing.T) {
-			config, hConfig, nwConfig, err := parseRun(tc.flags)
+			_, hConfig, nwConfig, err := parseRun(tc.flags)
 
 			if tc.expectedErr != "" {
 				assert.Error(t, err, tc.expectedErr)
 				return
 			}
 
 			assert.NilError(t, err)
-			assert.DeepEqual(t, config.MacAddress, tc.expectedCfg.MacAddress) //nolint:staticcheck // ignore SA1019: field is deprecated, but still used on API < v1.44.
 			assert.DeepEqual(t, hConfig.NetworkMode, tc.expectedHostCfg.NetworkMode)
 			assert.DeepEqual(t, nwConfig.EndpointsConfig, tc.expected, cmpopts.EquateComparable(netip.Addr{}))
 		})

cli/command/container/run.go

@@ -5,6 +5,7 @@ import (
 	"errors"
 	"fmt"
 	"io"
+	"os"
 	"strings"
 	"syscall"
 
@@ -70,7 +71,8 @@ func newRunCommand(dockerCLI command.Cli) *cobra.Command {
 	flags.Bool("help", false, "Print usage")
 
 	// TODO(thaJeztah): consider adding platform as "image create option" on containerOptions
-	addPlatformFlag(flags, &options.platform)
+	flags.StringVar(&options.platform, "platform", os.Getenv("DOCKER_DEFAULT_PLATFORM"), "Set platform if server is multi-platform capable")
+	_ = flags.SetAnnotation("platform", "version", []string{"1.32"})
 	flags.BoolVar(&options.untrusted, "disable-content-trust", !trust.Enabled(), "Skip image verification")
 	copts = addFlags(flags)
 

cli/command/container/run_test.go

@@ -61,7 +61,7 @@ func TestRunLabel(t *testing.T) {
 				ID: "id",
 			}, nil
 		},
-		Version: "1.36",
+		Version: client.MaxAPIVersion,
 	})
 	cmd := newRunCommand(fakeCLI)
 	cmd.SetArgs([]string{"--detach=true", "--label", "foo", "busybox"})
@@ -103,8 +103,8 @@ func TestRunAttach(t *testing.T) {
 			return responseChan, errChan
 		},
 		// use new (non-legacy) wait API
-		// see: 38591f20d07795aaef45d400df89ca12f29c603b
-		Version: "1.30",
+		// see: https://github.com/docker/cli/commit/38591f20d07795aaef45d400df89ca12f29c603b
+		Version: client.MaxAPIVersion,
 	}, func(fc *test.FakeCli) {
 		fc.SetOut(streams.NewOut(tty))
 		fc.SetIn(streams.NewIn(tty))
@@ -180,8 +180,8 @@ func TestRunAttachTermination(t *testing.T) {
 			return responseChan, errChan
 		},
 		// use new (non-legacy) wait API
-		// see: 38591f20d07795aaef45d400df89ca12f29c603b
-		Version: "1.30",
+		// see: https://github.com/docker/cli/commit/38591f20d07795aaef45d400df89ca12f29c603b
+		Version: client.MaxAPIVersion,
 	}, func(fc *test.FakeCli) {
 		fc.SetOut(streams.NewOut(tty))
 		fc.SetIn(streams.NewIn(tty))
@@ -262,7 +262,7 @@ func TestRunPullTermination(t *testing.T) {
 			attachCh <- struct{}{}
 			return respReader, nil
 		},
-		Version: "1.30",
+		Version: client.MaxAPIVersion,
 	})
 
 	cmd := newRunCommand(fakeCLI)

cli/command/formatter/buildcache.go

@@ -126,8 +126,6 @@ func (c *buildCacheContext) Parent() string {
 	var parent string
 	if len(c.v.Parents) > 0 {
 		parent = strings.Join(c.v.Parents, ", ")
-	} else {
-		parent = c.v.Parent //nolint:staticcheck // Ignore SA1019: Field was deprecated in API v1.42, but kept for backward compatibility
 	}
 	if c.trunc {
 		return TruncateID(parent)

cli/command/image/import.go

@@ -48,7 +48,8 @@ func newImportCommand(dockerCLI command.Cli) *cobra.Command {
 	options.changes = dockeropts.NewListOpts(nil)
 	flags.VarP(&options.changes, "change", "c", "Apply Dockerfile instruction to the created image")
 	flags.StringVarP(&options.message, "message", "m", "", "Set commit message for imported image")
-	addPlatformFlag(flags, &options.platform)
+	flags.StringVar(&options.platform, "platform", os.Getenv("DOCKER_DEFAULT_PLATFORM"), "Set platform if server is multi-platform capable")
+	_ = flags.SetAnnotation("platform", "version", []string{"1.32"})
 	_ = cmd.RegisterFlagCompletionFunc("platform", completion.Platforms())
 
 	return cmd