Merge pull request #297 from serturx/main

project: Add force_destroy attribute

Author: stgraber

docs/resources/project.md

@@ -34,6 +34,8 @@ resource "incus_instance" "instance" {
 * `remote` - *Optional* - The remote in which the resource will be created. If
   not provided, the provider's default remote will be used.
 
+* `force_destroy` - *Optional* - Whether to delete everything the project contains on destroy so that it can be destroyed without any error.
+
 ## Attribute Reference
 
 No attributes are exported.

internal/project/resource_project.go

@@ -9,6 +9,7 @@ import (
 	"github.com/hashicorp/terraform-plugin-framework/path"
 	"github.com/hashicorp/terraform-plugin-framework/resource"
 	"github.com/hashicorp/terraform-plugin-framework/resource/schema"
+	"github.com/hashicorp/terraform-plugin-framework/resource/schema/booldefault"
 	"github.com/hashicorp/terraform-plugin-framework/resource/schema/mapdefault"
 	"github.com/hashicorp/terraform-plugin-framework/resource/schema/planmodifier"
 	"github.com/hashicorp/terraform-plugin-framework/resource/schema/stringdefault"
@@ -25,10 +26,11 @@ import (
 
 // ProjectModel resource data model that matches the schema.
 type ProjectModel struct {
-	Name        types.String `tfsdk:"name"`
-	Description types.String `tfsdk:"description"`
-	Remote      types.String `tfsdk:"remote"`
-	Config      types.Map    `tfsdk:"config"`
+	Name         types.String `tfsdk:"name"`
+	Description  types.String `tfsdk:"description"`
+	Remote       types.String `tfsdk:"remote"`
+	Config       types.Map    `tfsdk:"config"`
+	ForceDestroy types.Bool   `tfsdk:"force_destroy"`
 }
 
 // ProjectResource represent Incus project resource.
@@ -76,6 +78,12 @@ func (r ProjectResource) Schema(_ context.Context, _ resource.SchemaRequest, res
 					stringplanmodifier.RequiresReplace(),
 				},
 			},
+
+			"force_destroy": schema.BoolAttribute{
+				Optional: true,
+				Computed: true,
+				Default:  booldefault.StaticBool(false),
+			},
 		},
 	}
 }
@@ -226,7 +234,12 @@ func (r ProjectResource) Delete(ctx context.Context, req resource.DeleteRequest,
 		return
 	}
 
-	err = server.DeleteProject(projectName)
+	if state.ForceDestroy.ValueBool() {
+		err = server.DeleteProjectForce(projectName)
+	} else {
+		err = server.DeleteProject(projectName)
+	}
+
 	if err != nil {
 		resp.Diagnostics.AddError(fmt.Sprintf("Failed to remove project %q", projectName), err.Error())
 	}
@@ -257,6 +270,10 @@ func (r *ProjectResource) ImportState(ctx context.Context, req resource.ImportSt
 
 		resp.Diagnostics.Append(resp.State.SetAttribute(ctx, path.Root(k), v)...)
 	}
+
+	// Force a change on import if set to `true` to make it clear in the plan
+	// that the resource has force_destroy set.
+	resp.Diagnostics.Append(resp.State.SetAttribute(ctx, path.Root("force_destroy"), types.BoolValue(false))...)
 }
 
 // SyncState fetches the server's current state for a project and updates

internal/project/resource_project_test.go

@@ -28,6 +28,7 @@ func TestAccProject_basic(t *testing.T) {
 				Check: resource.ComposeTestCheckFunc(
 					resource.TestCheckResourceAttr("incus_project.project0", "name", projectName),
 					resource.TestCheckResourceAttr("incus_project.project0", "description", "Terraform provider test project"),
+					resource.TestCheckResourceAttr("incus_project.project0", "force_destroy", "false"),
 					// Ensure state of computed keys is not tracked.
 					resource.TestCheckNoResourceAttr("incus_project.project0", "config.features.images"),
 					resource.TestCheckNoResourceAttr("incus_project.project0", "config.features.profiles"),
@@ -52,6 +53,7 @@ func TestAccProject_config(t *testing.T) {
 					resource.TestCheckResourceAttr("incus_project.project1", "name", projectName),
 					resource.TestCheckResourceAttr("incus_project.project1", "config.features.images", "true"),
 					resource.TestCheckResourceAttr("incus_project.project1", "config.features.profiles", "false"),
+					resource.TestCheckResourceAttr("incus_project.project1", "force_destroy", "false"),
 					// Ensure state of computed keys is not tracked.
 					resource.TestCheckNoResourceAttr("incus_project.project1", "config.features.storage.volumes"),
 					resource.TestCheckNoResourceAttr("incus_project.project1", "config.features.storage.buckets"),
@@ -75,6 +77,7 @@ func TestAccProject_updateConfig(t *testing.T) {
 					resource.TestCheckResourceAttr("incus_project.project1", "description", "Old description"),
 					resource.TestCheckResourceAttr("incus_project.project1", "config.features.images", "true"),
 					resource.TestCheckResourceAttr("incus_project.project1", "config.features.profiles", "false"),
+					resource.TestCheckResourceAttr("incus_project.project1", "force_destroy", "false"),
 					// Ensure state of computed keys is not tracked.
 					resource.TestCheckNoResourceAttr("incus_project.project1", "config.features.storage.volumes"),
 					resource.TestCheckNoResourceAttr("incus_project.project1", "config.features.storage.buckets"),
@@ -87,6 +90,20 @@ func TestAccProject_updateConfig(t *testing.T) {
 					resource.TestCheckResourceAttr("incus_project.project1", "description", "New description"),
 					resource.TestCheckResourceAttr("incus_project.project1", "config.features.images", "false"),
 					resource.TestCheckResourceAttr("incus_project.project1", "config.features.profiles", "true"),
+					resource.TestCheckResourceAttr("incus_project.project1", "force_destroy", "false"),
+					// Ensure state of computed keys is not tracked.
+					resource.TestCheckNoResourceAttr("incus_project.project1", "config.features.storage.volumes"),
+					resource.TestCheckNoResourceAttr("incus_project.project1", "config.features.storage.buckets"),
+				),
+			},
+			{
+				Config: testAccProject_updateConfig_3(projectName),
+				Check: resource.ComposeTestCheckFunc(
+					resource.TestCheckResourceAttr("incus_project.project1", "name", projectName),
+					resource.TestCheckResourceAttr("incus_project.project1", "description", "New description"),
+					resource.TestCheckResourceAttr("incus_project.project1", "force_destroy", "true"),
+					resource.TestCheckResourceAttr("incus_project.project1", "config.features.images", "false"),
+					resource.TestCheckResourceAttr("incus_project.project1", "config.features.profiles", "true"),
 					// Ensure state of computed keys is not tracked.
 					resource.TestCheckNoResourceAttr("incus_project.project1", "config.features.storage.volumes"),
 					resource.TestCheckNoResourceAttr("incus_project.project1", "config.features.storage.buckets"),
@@ -96,6 +113,36 @@ func TestAccProject_updateConfig(t *testing.T) {
 	})
 }
 
+// force_destroy is tested by creating a project containing an untracked instance
+// and letting CheckDestroy verify that the project can be destroyed.
+func TestAccProject_forceDestroy(t *testing.T) {
+	projectName := petname.Generate(2, "-")
+	instanceName := petname.Generate(2, "-")
+
+	resource.Test(t, resource.TestCase{
+		PreCheck:                 func() { acctest.PreCheck(t) },
+		ProtoV6ProviderFactories: acctest.ProtoV6ProviderFactories,
+		Steps: []resource.TestStep{
+			{
+				Config: testAccProject_forceDestroy_config(projectName, instanceName),
+				Check: resource.ComposeTestCheckFunc(
+					resource.TestCheckResourceAttr("incus_project.project1", "name", projectName),
+					resource.TestCheckResourceAttr("incus_project.project1", "force_destroy", "true"),
+					resource.TestCheckResourceAttr("incus_instance.instance1", "name", instanceName),
+					resource.TestCheckResourceAttr("incus_instance.instance1", "project", projectName),
+				),
+			},
+			{
+				Config: testAccProject_forceDestroy_danglingInstance(projectName),
+				Check: resource.ComposeTestCheckFunc(
+					resource.TestCheckResourceAttr("incus_project.project1", "name", projectName),
+					resource.TestCheckResourceAttr("incus_project.project1", "force_destroy", "true"),
+				),
+			},
+		},
+	})
+}
+
 func TestAccProject_importBasic(t *testing.T) {
 	resourceName := "incus_project.project0"
 
@@ -181,3 +228,58 @@ resource "incus_project" "project1" {
   }
 }`, name)
 }
+
+func testAccProject_updateConfig_3(name string) string {
+	return fmt.Sprintf(`
+resource "incus_project" "project1" {
+  name        = "%s"
+  description = "New description"
+  force_destroy = true
+  config = {
+	"features.images"   = false
+	"features.profiles" = true
+  }
+}`, name)
+}
+
+func testAccProject_forceDestroy_config(name string, instanceName string) string {
+	return fmt.Sprintf(`
+resource "incus_project" "project1" {
+  name          = "%s"
+  description   = "Terraform provider test project"
+  force_destroy = true
+  config = {
+	"features.images"   = true
+	"features.profiles" = false
+  }
+}
+
+resource "incus_instance" "instance1" {
+  name   = "%s"
+  project = incus_project.project1.name
+  type = "container"
+  image  = "%s"
+}
+`, name, instanceName, acctest.TestImage)
+}
+
+func testAccProject_forceDestroy_danglingInstance(name string) string {
+	return fmt.Sprintf(`
+resource "incus_project" "project1" {
+  name          = "%s"
+  description   = "Terraform provider test project"
+  force_destroy = true
+  config = {
+	"features.images"   = true
+	"features.profiles" = false
+  }
+}
+
+removed {
+  from = incus_instance.instance1
+  lifecycle {
+	destroy = false
+  }
+}
+`, name)
+}