cagent pull --force

Signed-off-by: David Gageot <david.gageot@docker.com>

Author: dgageot

cmd/root/api.go

@@ -126,7 +126,7 @@ func (f *apiFlags) runAPICommand(cmd *cobra.Command, args []string) error {
 					return
 				case <-ticker.C:
 					slog.Info("Auto-pulling OCI reference", "reference", agentsPath)
-					if _, err := remote.Pull(ctx, agentsPath); err != nil {
+					if _, err := remote.Pull(ctx, agentsPath, false); err != nil {
 						slog.Error("Failed to auto-pull OCI reference", "reference", agentsPath, "error", err)
 						continue
 					}

cmd/root/pull.go

@@ -15,18 +15,28 @@ import (
 	"github.com/docker/cagent/pkg/telemetry"
 )
 
+type pullFlags struct {
+	force bool
+}
+
 func newPullCmd() *cobra.Command {
-	return &cobra.Command{
+	var flags pullFlags
+
+	cmd := &cobra.Command{
 		Use:     "pull <registry-ref>",
 		Short:   "Pull an agent from an OCI registry",
 		Long:    "Pull an agent configuration file from an OCI registry",
 		GroupID: "core",
 		Args:    cobra.ExactArgs(1),
-		RunE:    runPullCommand,
+		RunE:    flags.runPullCommand,
 	}
+
+	cmd.PersistentFlags().BoolVar(&flags.force, "force", false, "Force pull even if the configuration already exists locally")
+
+	return cmd
 }
 
-func runPullCommand(cmd *cobra.Command, args []string) error {
+func (f *pullFlags) runPullCommand(cmd *cobra.Command, args []string) error {
 	telemetry.TrackCommand("pull", args)
 
 	ctx := cmd.Context()
@@ -37,7 +47,7 @@ func runPullCommand(cmd *cobra.Command, args []string) error {
 	out.Println("Pulling agent", registryRef)
 
 	var opts []crane.Option
-	_, err := remote.Pull(ctx, registryRef, opts...)
+	_, err := remote.Pull(ctx, registryRef, f.force, opts...)
 	if err != nil {
 		return fmt.Errorf("failed to pull artifact: %w", err)
 	}

pkg/agentfile/resolver.go

@@ -105,7 +105,7 @@ func Resolve(ctx context.Context, out *cli.Printer, agentFilename string) (strin
 	a, err := FromStore(agentFilename)
 	if err != nil {
 		out.Println("Pulling agent", agentFilename)
-		if _, pullErr := remote.Pull(ctx, agentFilename); pullErr != nil {
+		if _, pullErr := remote.Pull(ctx, agentFilename, false); pullErr != nil {
 			return "", fmt.Errorf("failed to pull OCI image %s: %w", agentFilename, pullErr)
 		}
 		// Retry after pull

pkg/remote/pull.go

@@ -11,7 +11,7 @@ import (
 )
 
 // Pull pulls an artifact from a registry and stores it in the content store
-func Pull(ctx context.Context, registryRef string, opts ...crane.Option) (string, error) {
+func Pull(ctx context.Context, registryRef string, force bool, opts ...crane.Option) (string, error) {
 	opts = append(opts, crane.WithContext(ctx))
 
 	ref, err := name.ParseReference(registryRef)
@@ -30,12 +30,14 @@ func Pull(ctx context.Context, registryRef string, opts ...crane.Option) (string
 	}
 
 	localRef := ref.Context().RepositoryStr() + ":" + ref.Identifier()
-	if meta, metaErr := store.GetArtifactMetadata(localRef); metaErr == nil {
-		if meta.Digest == remoteDigest {
-			if !hasCagentAnnotation(meta.Annotations) {
-				return "", fmt.Errorf("artifact %s found in store wasn't created by cagent", localRef)
+	if !force {
+		if meta, metaErr := store.GetArtifactMetadata(localRef); metaErr == nil {
+			if meta.Digest == remoteDigest {
+				if !hasCagentAnnotation(meta.Annotations) {
+					return "", fmt.Errorf("artifact %s found in store wasn't created by cagent", localRef)
+				}
+				return meta.Digest, nil
 			}
-			return meta.Digest, nil
 		}
 	}
 
@@ -49,7 +51,7 @@ func Pull(ctx context.Context, registryRef string, opts ...crane.Option) (string
 		return "", fmt.Errorf("getting manifest from pulled image: %w", err)
 	}
 	if !hasCagentAnnotation(manifest.Annotations) {
-		return "", fmt.Errorf("artifact %s found in store wasn't created by cagent", localRef)
+		return "", fmt.Errorf("artifact %s wasn't created by cagent", localRef)
 	}
 
 	digest, err := store.StoreArtifact(img, localRef)

pkg/remote/pull_test.go

@@ -15,12 +15,12 @@ import (
 )
 
 func TestPullNonExistentRegistry(t *testing.T) {
-	_, err := Pull(t.Context(), "registry.example.com/non-existent:latest")
+	_, err := Pull(t.Context(), "registry.example.com/non-existent:latest", false)
 	require.Error(t, err)
 }
 
 func TestPullWithOptions(t *testing.T) {
-	_, err := Pull(t.Context(), "registry.example.com/test:latest", crane.Insecure)
+	_, err := Pull(t.Context(), "registry.example.com/test:latest", false, crane.Insecure)
 	require.Error(t, err)
 }
 

pkg/server/server.go

@@ -695,7 +695,7 @@ func (s *Server) pullAgent(c echo.Context) error {
 	}
 
 	slog.Info("Pulling agent", "name", req.Name)
-	_, err := remote.Pull(c.Request().Context(), req.Name)
+	_, err := remote.Pull(c.Request().Context(), req.Name, false)
 	if err != nil {
 		slog.Error("Failed to pull agent", "name", req.Name, "error", err)
 		return echo.NewHTTPError(http.StatusInternalServerError, "failed to pull agent")