From 2328745f92c5ab3122a7a6dcd56c1210ccfab4c1 Mon Sep 17 00:00:00 2001 From: Sebastiaan van Stijn Date: Mon, 31 Mar 2025 19:31:31 +0200 Subject: [PATCH] cli/command/image: deprecate RunPull and make internal This function was exported in 812f1136850f6c18bbe3f1b2a960a8ff8a8413f3 for use in other parts of the CLI, but it's now only used locally. Make it internal again, as it was never designed to be exported. There are no known external consumers of this function, but deprecating it first, in case there are. Signed-off-by: Sebastiaan van Stijn --- cli/command/image/pull.go | 14 +++++++++++--- cli/command/image/trust.go | 6 +++--- 2 files changed, 14 insertions(+), 6 deletions(-) diff --git a/cli/command/image/pull.go b/cli/command/image/pull.go index bc3ed55b8e..235e3a7a17 100644 --- a/cli/command/image/pull.go +++ b/cli/command/image/pull.go @@ -15,7 +15,10 @@ import ( ) // PullOptions defines what and how to pull -type PullOptions struct { +type PullOptions = pullOptions + +// pullOptions defines what and how to pull. +type pullOptions struct { remote string all bool platform string @@ -25,7 +28,7 @@ type PullOptions struct { // NewPullCommand creates a new `docker pull` command func NewPullCommand(dockerCli command.Cli) *cobra.Command { - var opts PullOptions + var opts pullOptions cmd := &cobra.Command{ Use: "pull [OPTIONS] NAME[:TAG|@DIGEST]", @@ -33,7 +36,7 @@ func NewPullCommand(dockerCli command.Cli) *cobra.Command { Args: cli.ExactArgs(1), RunE: func(cmd *cobra.Command, args []string) error { opts.remote = args[0] - return RunPull(cmd.Context(), dockerCli, opts) + return runPull(cmd.Context(), dockerCli, opts) }, Annotations: map[string]string{ "category-top": "5", @@ -57,6 +60,11 @@ func NewPullCommand(dockerCli command.Cli) *cobra.Command { // RunPull performs a pull against the engine based on the specified options func RunPull(ctx context.Context, dockerCLI command.Cli, opts PullOptions) error { + return runPull(ctx, dockerCLI, opts) +} + +// runPull performs a pull against the engine based on the specified options +func runPull(ctx context.Context, dockerCLI command.Cli, opts pullOptions) error { distributionRef, err := reference.ParseNormalizedNamed(opts.remote) switch { case err != nil: diff --git a/cli/command/image/trust.go b/cli/command/image/trust.go index 7e2e46b2ee..2c088c2088 100644 --- a/cli/command/image/trust.go +++ b/cli/command/image/trust.go @@ -47,7 +47,7 @@ func pushTrustedReference(ctx context.Context, ioStreams command.Streams, repoIn } // trustedPull handles content trust pulling of an image -func trustedPull(ctx context.Context, cli command.Cli, imgRefAndAuth trust.ImageRefAndAuth, opts PullOptions) error { +func trustedPull(ctx context.Context, cli command.Cli, imgRefAndAuth trust.ImageRefAndAuth, opts pullOptions) error { refs, err := getTrustedPullTargets(cli, imgRefAndAuth) if err != nil { return err @@ -69,7 +69,7 @@ func trustedPull(ctx context.Context, cli command.Cli, imgRefAndAuth trust.Image if err != nil { return err } - if err := imagePullPrivileged(ctx, cli, updatedImgRefAndAuth, PullOptions{ + if err := imagePullPrivileged(ctx, cli, updatedImgRefAndAuth, pullOptions{ all: false, platform: opts.platform, quiet: opts.quiet, @@ -144,7 +144,7 @@ func getTrustedPullTargets(cli command.Cli, imgRefAndAuth trust.ImageRefAndAuth) } // imagePullPrivileged pulls the image and displays it to the output -func imagePullPrivileged(ctx context.Context, cli command.Cli, imgRefAndAuth trust.ImageRefAndAuth, opts PullOptions) error { +func imagePullPrivileged(ctx context.Context, cli command.Cli, imgRefAndAuth trust.ImageRefAndAuth, opts pullOptions) error { encodedAuth, err := registrytypes.EncodeAuthConfig(*imgRefAndAuth.AuthConfig()) if err != nil { return err