feat: add finalizers field

Finalizers are a valid field for projects, apps and appsets.

Fixes #391 and #404.

Signed-off-by: Blake Pettersson <[email protected]>

Author: blakepettersson

argocd/resource_argocd_application_set_test.go

@@ -950,6 +950,31 @@ func TestAccArgoCDApplicationSet_syncPolicy(t *testing.T) {
 	})
 }
 
+func TestAccArgoCDApplicationSet_finalizers(t *testing.T) {
+	resource.ParallelTest(t, resource.TestCase{
+		PreCheck:          func() { testAccPreCheck(t); testAccPreCheckFeatureSupported(t, features.ApplicationSet) },
+		ProviderFactories: testAccProviders,
+		Steps: []resource.TestStep{
+			{
+				Config: testAccArgoCDApplicationSet_finalizers(),
+				Check: resource.ComposeTestCheckFunc(
+					resource.TestCheckResourceAttr(
+						"argocd_application_set.finalizers",
+						"metadata.0.finalizers.0",
+						"argocd.argoproj.io/applicationset",
+					),
+				),
+			},
+			{
+				ResourceName:            "argocd_application_set.finalizers",
+				ImportState:             true,
+				ImportStateVerify:       true,
+				ImportStateVerifyIgnore: []string{"metadata.0.resource_version"},
+			},
+		},
+	})
+}
+
 func TestAccArgoCDApplicationSet_syncPolicyWithApplicationsSyncPolicy(t *testing.T) {
 	resource.ParallelTest(t, resource.TestCase{
 		PreCheck: func() {
@@ -3083,6 +3108,41 @@ resource "argocd_application_set" "sync_policy" {
 }`
 }
 
+func testAccArgoCDApplicationSet_finalizers() string {
+	return `
+resource "argocd_application_set" "finalizers" {
+	metadata {
+		name = "finalizers"
+		finalizers = ["argocd.argoproj.io/applicationset"]
+	}
+
+	spec {
+		generator {
+			clusters {} # Automatically use all clusters defined within Argo CD
+		}
+
+		template {
+			metadata {
+				name = "appset-finalizers-{{name}}"
+			}
+
+			spec {
+				source {
+					repo_url        = "https://github.com/argoproj/argocd-example-apps/"
+					target_revision = "HEAD"
+					path            = "guestbook"
+				}
+
+				destination {
+					server    = "{{server}}"
+					namespace = "default"
+				}
+			}
+		}
+	}
+}`
+}
+
 func testAccArgoCDApplicationSet_syncPolicyWithApplicationsSync() string {
 	return `
 resource "argocd_application_set" "applications_sync_policy" {

argocd/resource_argocd_application_test.go

@@ -760,6 +760,29 @@ func TestAccArgoCDApplication_EmptySyncPolicyBlock(t *testing.T) {
 	})
 }
 
+func TestAccArgoCDApplication_Finalizers(t *testing.T) {
+	resource.ParallelTest(t, resource.TestCase{
+		PreCheck:          func() { testAccPreCheck(t) },
+		ProviderFactories: testAccProviders,
+		Steps: []resource.TestStep{
+			{
+				Config: testAccArgoCDApplication_finalizers(),
+				Check: resource.ComposeTestCheckFunc(
+					resource.TestCheckResourceAttrSet(
+						"argocd_application.finalizers",
+						"metadata.0.uid",
+					),
+					resource.TestCheckResourceAttr(
+						"argocd_application.finalizers",
+						"metadata.0.finalizers.0",
+						"finalizer.argocd.argoproj.io",
+					),
+				),
+			},
+		},
+	})
+}
+
 func TestAccArgoCDApplication_NoAutomatedBlock(t *testing.T) {
 	resource.ParallelTest(t, resource.TestCase{
 		PreCheck:          func() { testAccPreCheck(t) },
@@ -2416,6 +2439,35 @@ resource "argocd_application" "multiple_sources" {
   }
 }`
 }
+func testAccArgoCDApplication_finalizers() string {
+	return `
+resource "argocd_application" "finalizers" {
+	metadata {
+		name      = "finalizers"
+		namespace = "argocd"
+		finalizers = ["finalizer.argocd.argoproj.io"]
+	}
+
+	spec {
+		project = "default" 
+
+		source {
+			repo_url        = "https://raw.githubusercontent.com/bitnami/charts/archive-full-index/bitnami"
+			chart           = "apache"
+			target_revision = "9.4.1"
+		}
+
+		destination {
+			server    = "https://kubernetes.default.svc"
+			namespace = "managed-namespace"
+		}
+
+		sync_policy {
+			sync_options = ["CreateNamespace=true"]
+		}
+	}
+}`
+}
 
 func testAccArgoCDApplication_ManagedNamespaceMetadata() string {
 	return `

argocd/resource_argocd_project_test.go

@@ -96,6 +96,25 @@ func TestAccArgoCDProject(t *testing.T) {
 					),
 				),
 			},
+			{
+				Config: testAccArgoCDProjectSimpleWithFinalizers(name),
+				Check: resource.ComposeTestCheckFunc(
+					resource.TestCheckResourceAttrSet(
+						"argocd_project.simple",
+						"metadata.0.uid",
+					),
+					resource.TestCheckResourceAttr(
+						"argocd_project.simple",
+						"metadata.0.finalizers.0",
+						"finalizer1",
+					),
+					resource.TestCheckResourceAttr(
+						"argocd_project.simple",
+						"metadata.0.finalizers.1",
+						"finalizer2",
+					),
+				),
+			},
 		},
 	})
 }
@@ -401,6 +420,34 @@ func testAccArgoCDProjectSimpleWithoutOrphaned(name string) string {
 	`, name)
 }
 
+func testAccArgoCDProjectSimpleWithFinalizers(name string) string {
+	return fmt.Sprintf(`
+  resource "argocd_project" "simple" {
+    metadata {
+      name      = "%s"
+      namespace = "argocd"
+      labels = {
+        acceptance = "true"
+      }
+      annotations = {
+        "this.is.a.really.long.nested.key" = "yes, really!"
+      }
+      finalizers = ["finalizer1", "finalizer2"]
+    }
+  
+    spec {
+      description  = "simple project"
+      source_repos = ["*"]
+  
+      destination {
+        name      = "anothercluster"
+        namespace = "bar"
+      }
+    }
+  }
+	`, name)
+}
+
 func testAccArgoCDProjectSimpleWithEmptyOrphaned(name string) string {
 	return fmt.Sprintf(`
   resource "argocd_project" "simple" {

argocd/schema_metadata.go

@@ -65,5 +65,11 @@ func metadataFields(objectName string) map[string]*schema.Schema {
 			Description: fmt.Sprintf("The unique in time and space value for this %s. More info: http://kubernetes.io/docs/user-guide/identifiers#uids", objectName),
 			Computed:    true,
 		},
+		"finalizers": {
+			Type:        schema.TypeList,
+			Description: "List of finalizers for the resource.",
+			Optional:    true,
+			Elem:        &schema.Schema{Type: schema.TypeString},
+		},
 	}
 }

argocd/structure_metadata.go

@@ -20,6 +20,10 @@ func expandMetadata(d *schema.ResourceData) (meta meta.ObjectMeta) {
 		meta.Labels = expandStringMap(m["labels"].(map[string]interface{}))
 	}
 
+	if v, ok := m["finalizers"].([]interface{}); ok && len(v) > 0 {
+		meta.Finalizers = expandStringList(v)
+	}
+
 	if v, ok := m["name"]; ok {
 		meta.Name = v.(string)
 	}
@@ -37,6 +41,7 @@ func flattenMetadata(meta meta.ObjectMeta, d *schema.ResourceData) []interface{}
 		"name":             meta.Name,
 		"namespace":        meta.Namespace,
 		"resource_version": meta.ResourceVersion,
+		"finalizers":       meta.Finalizers,
 		"uid":              fmt.Sprintf("%v", meta.UID),
 	}
 

docs/resources/application.md

@@ -193,6 +193,7 @@ resource "argocd_application" "multiple_sources" {
 Optional:
 
 - `annotations` (Map of String) An unstructured key value map stored with the applications.argoproj.io that may be used to store arbitrary metadata. More info: http://kubernetes.io/docs/user-guide/annotations
+- `finalizers` (List of String) List of finalizers for the resource.
 - `labels` (Map of String) Map of string keys and values that can be used to organize and categorize (scope and select) the applications.argoproj.io. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels
 - `name` (String) Name of the applications.argoproj.io, must be unique. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/identifiers#names
 - `namespace` (String) Namespace of the applications.argoproj.io, must be unique. Cannot be updated. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/

docs/resources/application_set.md

@@ -578,6 +578,7 @@ resource "argocd_application_set" "progressive_sync" {
 Optional:
 
 - `annotations` (Map of String) An unstructured key value map stored with the applicationsets.argoproj.io that may be used to store arbitrary metadata. More info: http://kubernetes.io/docs/user-guide/annotations
+- `finalizers` (List of String) List of finalizers for the resource.
 - `labels` (Map of String) Map of string keys and values that can be used to organize and categorize (scope and select) the applicationsets.argoproj.io. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels
 - `name` (String) Name of the applicationsets.argoproj.io, must be unique. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/identifiers#names
 - `namespace` (String) Namespace of the applicationsets.argoproj.io, must be unique. Cannot be updated. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/

docs/resources/project.md

@@ -151,6 +151,7 @@ resource "argocd_project" "myproject" {
 Optional:
 
 - `annotations` (Map of String) An unstructured key value map stored with the appprojects.argoproj.io that may be used to store arbitrary metadata. More info: http://kubernetes.io/docs/user-guide/annotations
+- `finalizers` (List of String) List of finalizers for the resource.
 - `labels` (Map of String) Map of string keys and values that can be used to organize and categorize (scope and select) the appprojects.argoproj.io. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels
 - `name` (String) Name of the appprojects.argoproj.io, must be unique. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/identifiers#names
 - `namespace` (String) Namespace of the appprojects.argoproj.io, must be unique. Cannot be updated. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/