image: Implement incus image alias nested block

Signed-off-by: Ruihua Wen <[email protected]>

Author: SpiffyEight77

docs/resources/image_alias.md

@@ -42,6 +42,7 @@ type ImageModel struct {
 	SourceImage    types.Object `tfsdk:"source_image"`
 	SourceInstance types.Object `tfsdk:"source_instance"`
 	Aliases        types.Set    `tfsdk:"aliases"`
+	Alias          types.Set    `tfsdk:"alias"`
 	Project        types.String `tfsdk:"project"`
 	Remote         types.String `tfsdk:"remote"`
 
@@ -70,6 +71,11 @@ type SourceInstanceModel struct {
 	Snapshot types.String `tfsdk:"snapshot"`
 }
 
+type ImageAliasModel struct {
+	Name        types.String `tfsdk:"name"`
+	Description types.String `tfsdk:"description"`
+}
+
 // ImageResource represent Incus cached image resource.
 type ImageResource struct {
 	provider *provider_config.IncusProviderConfig
@@ -226,6 +232,36 @@ func (r ImageResource) Schema(_ context.Context, _ resource.SchemaRequest, resp
 				ElementType: types.StringType,
 			},
 		},
+
+		Blocks: map[string]schema.Block{
+			"alias": schema.SetNestedBlock{
+				Description: "Image alias",
+				NestedObject: schema.NestedBlockObject{
+					Attributes: map[string]schema.Attribute{
+						"name": schema.StringAttribute{
+							Required:    true,
+							Description: "Image alias name",
+							Validators: []validator.String{
+								stringvalidator.LengthAtLeast(1),
+							},
+						},
+						"description": schema.StringAttribute{
+							Optional:    true,
+							Description: "Image alias description",
+							PlanModifiers: []planmodifier.String{
+								stringplanmodifier.RequiresReplace(),
+							},
+							Validators: []validator.String{
+								stringvalidator.LengthAtLeast(1),
+							},
+						},
+					},
+					PlanModifiers: []planmodifier.Object{
+						objectplanmodifier.RequiresReplace(),
+					},
+				},
+			},
+		},
 	}
 }
 
@@ -338,14 +374,28 @@ func (r ImageResource) Update(ctx context.Context, req resource.UpdateRequest, r
 	diags = req.State.GetAttribute(ctx, path.Root("aliases"), &newAliases)
 	resp.Diagnostics.Append(diags...)
 
+	// Extract old and new nested alias blocks
+	oldAliasBlocks, diags := ToAliasList(ctx, plan.Alias)
+	resp.Diagnostics.Append(diags...)
+
+	newAliasBlocks := make([]string, 0, len(plan.Alias.Elements()))
+	diags = req.State.GetAttribute(ctx, path.Root("alias"), &newAliasBlocks)
+	resp.Diagnostics.Append(diags...)
+
 	if resp.Diagnostics.HasError() {
 		return
 	}
 
 	removed, added := utils.DiffSlices(oldAliases, newAliases)
 
+	// Calculate differences for nested alias blocks
+	removedAliasBlocks, addedAliasBlocks := utils.DiffSlices(oldAliasBlocks, newAliasBlocks)
+
+	// Combine all removals
+	allRemoved := append(removed, removedAliasBlocks...)
+
 	// Delete removed aliases.
-	for _, alias := range removed {
+	for _, alias := range allRemoved {
 		err := server.DeleteImageAlias(alias)
 		if err != nil {
 			resp.Diagnostics.AddError(fmt.Sprintf("Failed to delete alias %q for cached image with fingerprint %q", alias, imageFingerprint), err.Error())
@@ -366,6 +416,32 @@ func (r ImageResource) Update(ctx context.Context, req resource.UpdateRequest, r
 		}
 	}
 
+	// Add new nested alias blocks (with descriptions)
+	var planAliasBlocks []ImageAliasModel
+	if !plan.Alias.IsNull() {
+		diags = plan.Alias.ElementsAs(ctx, &planAliasBlocks, false)
+		resp.Diagnostics.Append(diags...)
+		if resp.Diagnostics.HasError() {
+			return
+		}
+	}
+
+	// Create new alias blocks
+	for _, aliasBlock := range planAliasBlocks {
+		if utils.ValueInSlice(aliasBlock.Name.ValueString(), addedAliasBlocks) {
+			req := api.ImageAliasesPost{}
+			req.Name = aliasBlock.Name.ValueString()
+			req.Description = aliasBlock.Description.ValueString()
+			req.Target = imageFingerprint
+
+			err := server.CreateImageAlias(req)
+			if err != nil {
+				resp.Diagnostics.AddError(fmt.Sprintf("Failed to create alias %q for cached image with fingerprint %q", aliasBlock.Name.ValueString(), imageFingerprint), err.Error())
+				return
+			}
+		}
+	}
+
 	// Update Terraform state.
 	diags = r.SyncState(ctx, &resp.State, server, plan)
 	resp.Diagnostics.Append(diags...)
@@ -422,8 +498,6 @@ func (r ImageResource) SyncState(ctx context.Context, tfState *tfsdk.State, serv
 		return respDiags
 	}
 
-	originalStateAliases := m.Aliases
-
 	if !m.SourceImage.IsNull() {
 		var sourceImageModel SourceImageModel
 		respDiags = m.SourceImage.As(ctx, &sourceImageModel, basetypes.ObjectAsOptions{})
@@ -453,22 +527,33 @@ func (r ImageResource) SyncState(ctx context.Context, tfState *tfsdk.State, serv
 	copiedAliases, diags := ToAliasList(ctx, m.CopiedAliases)
 	respDiags.Append(diags...)
 
+	configAliasBlocks, diags := ToAliasList(ctx, m.Alias)
+	respDiags.Append(diags...)
+
 	// Copy aliases from image state that are present in user defined
 	// config or are not copied.
 	var aliases []string
+	var aliasBlocks []api.ImageAlias
 	for _, a := range image.Aliases {
 		if utils.ValueInSlice(a.Name, configAliases) || !utils.ValueInSlice(a.Name, copiedAliases) {
+			if utils.ValueInSlice(a.Name, configAliasBlocks) {
+				aliasBlocks = append(aliasBlocks, a)
+			}
+
 			aliases = append(aliases, a.Name)
 		}
 	}
 
 	aliasSet, diags := ToAliasSetType(ctx, aliases)
 	respDiags.Append(diags...)
 
+	aliasBlocksSet, diags := ToAliasBlocksSetType(ctx, aliasBlocks)
+	respDiags.Append(diags...)
+
 	m.Fingerprint = types.StringValue(image.Fingerprint)
 	m.CreatedAt = types.Int64Value(image.CreatedAt.Unix())
 	m.Aliases = aliasSet
-	m.Aliases = originalStateAliases
+	m.Alias = aliasBlocksSet
 
 	if respDiags.HasError() {
 		return respDiags
@@ -571,7 +656,16 @@ func (r ImageResource) createImageFromSourceFile(ctx context.Context, resp *reso
 		return
 	}
 
-	imageAliases := make([]api.ImageAlias, 0, len(aliases))
+	var imageAliasBlocks []ImageAliasModel
+	if !plan.Alias.IsNull() {
+		diags = plan.Alias.ElementsAs(ctx, &imageAliasBlocks, false)
+		if diags.HasError() {
+			resp.Diagnostics.Append(diags...)
+			return
+		}
+	}
+
+	imageAliases := make([]api.ImageAlias, 0, len(aliases)+len(imageAliasBlocks))
 	for _, alias := range aliases {
 		// Ensure image alias does not already exist.
 		aliasTarget, _, _ := server.GetImageAlias(alias)
@@ -586,6 +680,26 @@ func (r ImageResource) createImageFromSourceFile(ctx context.Context, resp *reso
 
 		imageAliases = append(imageAliases, ia)
 	}
+
+	for _, imageAliasBlock := range imageAliasBlocks {
+		// Ensure image alias does not already exist.
+		name := imageAliasBlock.Name.ValueString()
+		description := imageAliasBlock.Description.ValueString()
+
+		aliasTarget, _, _ := server.GetImageAlias(name)
+		if aliasTarget != nil {
+			resp.Diagnostics.AddError(fmt.Sprintf("Image alias %q already exists", name), "")
+			return
+		}
+
+		ia := api.ImageAlias{
+			Name:        name,
+			Description: description,
+		}
+
+		imageAliases = append(imageAliases, ia)
+	}
+
 	image.Aliases = imageAliases
 
 	op, err := server.CreateImage(image, createArgs)
@@ -693,6 +807,15 @@ func (r ImageResource) createImageFromSourceImage(ctx context.Context, resp *res
 		return
 	}
 
+	var imageAliasBlocks []ImageAliasModel
+	if !plan.Alias.IsNull() {
+		diags = plan.Alias.ElementsAs(ctx, &imageAliasBlocks, false)
+		if diags.HasError() {
+			resp.Diagnostics.Append(diags...)
+			return
+		}
+	}
+
 	imageAliases := make([]api.ImageAlias, 0, len(aliases))
 	for _, alias := range aliases {
 		// Ensure image alias does not already exist.
@@ -709,6 +832,25 @@ func (r ImageResource) createImageFromSourceImage(ctx context.Context, resp *res
 		imageAliases = append(imageAliases, ia)
 	}
 
+	for _, imageAliasBlock := range imageAliasBlocks {
+		// Ensure image alias does not already exist.
+		name := imageAliasBlock.Name.ValueString()
+		description := imageAliasBlock.Description.ValueString()
+
+		aliasTarget, _, _ := server.GetImageAlias(name)
+		if aliasTarget != nil {
+			resp.Diagnostics.AddError(fmt.Sprintf("Image alias %q already exists", name), "")
+			return
+		}
+
+		ia := api.ImageAlias{
+			Name:        name,
+			Description: description,
+		}
+
+		imageAliases = append(imageAliases, ia)
+	}
+
 	// Get data about remote image (also checks if image exists).
 	imageInfo, _, err := imageServer.GetImage(image)
 	if err != nil {
@@ -807,6 +949,15 @@ func (r ImageResource) createImageFromSourceInstance(ctx context.Context, resp *
 		return
 	}
 
+	var imageAliasBlocks []ImageAliasModel
+	if !plan.Alias.IsNull() {
+		diags = plan.Alias.ElementsAs(ctx, &imageAliasBlocks, false)
+		if diags.HasError() {
+			resp.Diagnostics.Append(diags...)
+			return
+		}
+	}
+
 	imageAliases := make([]api.ImageAlias, 0, len(aliases))
 	for _, alias := range aliases {
 		// Ensure image alias does not already exist.
@@ -823,6 +974,25 @@ func (r ImageResource) createImageFromSourceInstance(ctx context.Context, resp *
 		imageAliases = append(imageAliases, ia)
 	}
 
+	for _, imageAliasBlock := range imageAliasBlocks {
+		// Ensure image alias does not already exist.
+		name := imageAliasBlock.Name.ValueString()
+		description := imageAliasBlock.Description.ValueString()
+
+		aliasTarget, _, _ := server.GetImageAlias(name)
+		if aliasTarget != nil {
+			resp.Diagnostics.AddError(fmt.Sprintf("Image alias %q already exists", name), "")
+			return
+		}
+
+		ia := api.ImageAlias{
+			Name:        name,
+			Description: description,
+		}
+
+		imageAliases = append(imageAliases, ia)
+	}
+
 	var source *api.ImagesPostSource
 	if !sourceInstanceModel.Snapshot.IsNull() {
 		snapsnotName := sourceInstanceModel.Snapshot.ValueString()
@@ -888,6 +1058,31 @@ func ToAliasSetType(ctx context.Context, aliases []string) (types.Set, diag.Diag
 	return types.SetValueFrom(ctx, types.StringType, aliases)
 }
 
+// ToAliasBlocksSetType converts slice of strings into aliases of type types.Set.
+func ToAliasBlocksSetType(ctx context.Context, aliases []api.ImageAlias) (types.Set, diag.Diagnostics) {
+	aliasType := map[string]attr.Type{
+		"name":        types.StringType,
+		"description": types.StringType,
+	}
+
+	aliasList := make([]ImageAliasModel, 0, len(aliases))
+	for _, a := range aliases {
+		alias := ImageAliasModel{
+			Name: types.StringValue(a.Name),
+		}
+
+		if a.Description != "" {
+			alias.Description = types.StringValue(a.Description)
+		} else {
+			alias.Description = types.StringNull()
+		}
+
+		aliasList = append(aliasList, alias)
+	}
+
+	return types.SetValueFrom(ctx, types.ObjectType{AttrTypes: aliasType}, aliasList)
+}
+
 // createImageResourceID creates new image ID by concatenating remote and
 // image fingerprint using colon.
 func createImageResourceID(remote string, fingerprint string) string {