Add error suggestion message when package fails due to containerd

Author: Copilot

cli/azd/.vscode/cspell-azd-dictionary.txt

@@ -77,6 +77,7 @@ conditionalize
 consolesize
 containerapp
 containerapps
+containerd
 contoso
 createdby
 csharpapp

cli/azd/pkg/project/framework_service_docker.go

@@ -559,6 +559,20 @@ func (p *dockerProject) packBuild(
 			}
 		}
 
+		// Provide better error message for containerd-related issues
+		if strings.Contains(err.Error(), "failed to write image") && strings.Contains(err.Error(), "No such image") {
+			isContainerdEnabled, containerdErr := p.docker.IsContainerdEnabled(ctx)
+			if containerdErr != nil {
+				log.Printf("warning: failed to detect containerd status: %v", containerdErr)
+			} else if isContainerdEnabled {
+				return nil, &internal.ErrorWithSuggestion{
+					Err: err,
+					Suggestion: "Suggestion: disable containerd image store: " +
+						output.WithLinkFormat("https://docs.docker.com/desktop/features/containerd"),
+				}
+			}
+		}
+
 		return nil, err
 	}
 

cli/azd/pkg/tools/docker/docker.go

@@ -282,6 +282,19 @@ func (d *Cli) Name() string {
 	return "Docker"
 }
 
+// IsContainerdEnabled checks if Docker is using containerd as the image store
+func (d *Cli) IsContainerdEnabled(ctx context.Context) (bool, error) {
+	result, err := d.executeCommand(ctx, "", "system", "info", "--format", "{{.DriverStatus}}")
+	if err != nil {
+		return false, fmt.Errorf("checking docker driver status: %w", err)
+	}
+
+	driverStatus := strings.TrimSpace(result.Stdout)
+
+	// Check for containerd snapshotter which indicates containerd image store is enabled
+	return strings.Contains(driverStatus, "io.containerd.snapshotter.v1"), nil
+}
+
 func (d *Cli) executeCommand(ctx context.Context, cwd string, args ...string) (exec.RunResult, error) {
 	runArgs := exec.NewRunArgs("docker", args...).
 		WithCwd(cwd)

cli/azd/pkg/tools/docker/docker_test.go

@@ -596,3 +596,94 @@ func TestSplitDockerImage(t *testing.T) {
 		})
 	}
 }
+
+func TestIsContainerdEnabled(t *testing.T) {
+	tests := []struct {
+		name            string
+		systemInfoOut   string
+		systemInfoErr   error
+		expectedEnabled bool
+		expectError     bool
+	}{
+		{
+			name: "containerd enabled",
+			systemInfoOut: ` [
+				["driver", "overlay2"],
+				["snapshotter", "io.containerd.snapshotter.v1.overlayfs"]
+			]`,
+			expectedEnabled: true,
+			expectError:     false,
+		},
+		{
+			name: "containerd not enabled",
+			systemInfoOut: ` [
+				["driver", "overlay2"],
+				["backing filesystem", "extfs"]
+			]`,
+			expectedEnabled: false,
+			expectError:     false,
+		},
+		{
+			name:            "empty driver status",
+			systemInfoOut:   "",
+			expectedEnabled: false,
+			expectError:     false,
+		},
+		{
+			name:            "whitespace only output",
+			systemInfoOut:   "   \n\t  ",
+			expectedEnabled: false,
+			expectError:     false,
+		},
+		{
+			name: "containerd string present in other context",
+			systemInfoOut: ` [
+				["some unrelated field", "io.containerd.snapshotter.v1.something"],
+				["driver", "overlay2"]
+			]`,
+			expectedEnabled: true,
+			expectError:     false,
+		},
+		{
+			name:            "command execution error",
+			systemInfoErr:   errors.New("docker daemon not running"),
+			expectedEnabled: false,
+			expectError:     true,
+		},
+	}
+
+	for _, tt := range tests {
+		t.Run(tt.name, func(t *testing.T) {
+			mockContext := mocks.NewMockContext(context.Background())
+			docker := NewCli(mockContext.CommandRunner)
+
+			mockContext.CommandRunner.When(func(args exec.RunArgs, command string) bool {
+				return strings.Contains(command, "docker system info")
+			}).RespondFn(func(args exec.RunArgs) (exec.RunResult, error) {
+				require.Equal(t, "docker", args.Cmd)
+				require.Equal(t, []string{"system", "info", "--format", "{{.DriverStatus}}"}, args.Args)
+
+				if tt.systemInfoErr != nil {
+					return exec.RunResult{}, tt.systemInfoErr
+				}
+
+				return exec.RunResult{
+					Stdout:   tt.systemInfoOut,
+					Stderr:   "",
+					ExitCode: 0,
+				}, nil
+			})
+
+			enabled, err := docker.IsContainerdEnabled(context.Background())
+
+			if tt.expectError {
+				require.Error(t, err)
+				require.Contains(t, err.Error(), "checking docker driver status")
+			} else {
+				require.NoError(t, err)
+			}
+
+			require.Equal(t, tt.expectedEnabled, enabled)
+		})
+	}
+}