Add support for "Helm value files from external Git repository" (#280)

* tests: run `TestAccArgoCDProjectToken_RenewAfter` in serial Since this test is time sensitive we don't want steps/checks running in parallel since this causes flakiness as the token may need to be renewed by the time Terraform checks that the apply results in a subsequent non-empty plan. * feat: add `ref` to `argocd_application.spec.source`
argoproj-labs · May 24, 2023 · 38a00f8 · 38a00f8
1 parent ac65e67
commit 38a00f8
Show file tree

Hide file tree

Showing 5 changed files with 147 additions and 0 deletions.
diff --git a/argocd/resource_argocd_application_test.go b/argocd/resource_argocd_application_test.go
@@ -1026,6 +1026,44 @@ func TestAccArgoCDApplication_MultipleSources(t *testing.T) {
 	})
 }
 
+func TestAccArgoCDApplication_HelmValuesFromExternalGitRepo(t *testing.T) {
+	resource.ParallelTest(t, resource.TestCase{
+		PreCheck:          func() { testAccPreCheck(t); testAccPreCheckFeatureSupported(t, featureMultipleApplicationSources) },
+		ProviderFactories: testAccProviders,
+		Steps: []resource.TestStep{
+			{
+				Config: testAccArgoCDApplicationHelmValuesFromExternalGitRepo(),
+				Check: resource.ComposeTestCheckFunc(
+					resource.TestCheckResourceAttrSet(
+						"argocd_application.helm_values_external",
+						"metadata.0.uid",
+					),
+					resource.TestCheckResourceAttr(
+						"argocd_application.helm_values_external",
+						"spec.0.source.0.chart",
+						"wordpress",
+					),
+					resource.TestCheckResourceAttrSet(
+						"argocd_application.helm_values_external",
+						"spec.0.source.0.helm.0.value_files.#",
+					),
+					resource.TestCheckResourceAttr(
+						"argocd_application.helm_values_external",
+						"spec.0.source.1.ref",
+						"values",
+					),
+				),
+			},
+			{
+				ResourceName:            "argocd_application.helm_values_external",
+				ImportState:             true,
+				ImportStateVerify:       true,
+				ImportStateVerifyIgnore: []string{"wait", "cascade", "metadata.0.generation", "metadata.0.resource_version"},
+			},
+		},
+	})
+}
+
 func TestAccArgoCDApplication_Wait(t *testing.T) {
 	chartRevision := "9.4.1"
 	name := acctest.RandomWithPrefix("test-acc")
@@ -2050,6 +2088,40 @@ resource "argocd_application" "multiple_sources" {
 }`
 }
 
+func testAccArgoCDApplicationHelmValuesFromExternalGitRepo() string {
+	return `
+resource "argocd_application" "helm_values_external" {
+  metadata {
+    name      = "helm-values-external"
+    namespace = "argocd"
+  }
+
+  spec {
+    project = "default" 
+  
+    source {
+      repo_url        = "https://charts.helm.sh/stable"
+      chart           = "wordpress"
+      target_revision = "9.0.3"
+      helm {
+        value_files = ["$values/helm-dependency/values.yaml"]
+      }
+    }
+
+    source {
+      repo_url        = "https://github.com/argoproj/argocd-example-apps.git"
+      target_revision = "HEAD"
+      ref             = "values"
+    }
+
+    destination {
+      server    = "https://kubernetes.default.svc"
+      namespace = "default"
+    }
+  }
+}`
+}
+
 func testAccSkipFeatureIgnoreDiffJQPathExpressions() (bool, error) {
 	ctx := context.Background()
 

diff --git a/argocd/schema_application.go b/argocd/schema_application.go
@@ -1290,6 +1290,11 @@ func applicationSpecSchemaV4() *schema.Schema {
 								Description: "Revision of the source to sync the application to. In case of Git, this can be commit, tag, or branch. If omitted, will equal to HEAD. In case of Helm, this is a semver tag for the Chart's version.",
 								Optional:    true,
 							},
+							"ref": {
+								Type:        schema.TypeString,
+								Description: "Reference to another `source` within defined sources. See associated documentation on [Helm value files from external Git repository](https://argo-cd.readthedocs.io/en/stable/user-guide/multiple_sources/#helm-value-files-from-external-git-repository) regarding combining `ref` with `path` and/or `chart`.",
+								Optional:    true,
+							},
 							"chart": {
 								Type:        schema.TypeString,
 								Description: "Helm chart name. Must be specified for applications sourced from a Helm repo.",

diff --git a/argocd/structure_application.go b/argocd/structure_application.go
@@ -80,6 +80,10 @@ func expandApplicationSource(_ass []interface{}) []application.ApplicationSource
 			s.Path = v.(string)
 		}
 
+		if v, ok := as["ref"]; ok {
+			s.Ref = v.(string)
+		}
+
 		if v, ok := as["target_revision"]; ok {
 			s.TargetRevision = v.(string)
 		}
@@ -639,6 +643,7 @@ func flattenApplicationSource(source []application.ApplicationSource) (
 			"plugin": flattenApplicationSourcePlugin(
 				[]*application.ApplicationSourcePlugin{s.Plugin},
 			),
+			"ref":             s.Ref,
 			"repo_url":        s.RepoURL,
 			"target_revision": s.TargetRevision,
 		})

diff --git a/docs/resources/application.md b/docs/resources/application.md
@@ -131,6 +131,38 @@ resource "argocd_application" "helm" {
     }
   }
 }
+
+# Multiple Application Sources with Helm value files from external Git repository
+resource "argocd_application" "multiple_sources" {
+  metadata {
+    name      = "helm-app-with-external-values"
+    namespace = "argocd"
+  }
+
+  spec {
+    project = "default"
+
+    source {
+      repo_url        = "https://charts.helm.sh/stable"
+      chart           = "wordpress"
+      target_revision = "9.0.3"
+      helm {
+        value_files = ["$values/helm-dependency/values.yaml"]
+      }
+    }
+
+    source {
+      repo_url        = "https://github.com/argoproj/argocd-example-apps.git"
+      target_revision = "HEAD"
+      ref             = "values"
+    }
+
+    destination {
+      server    = "https://kubernetes.default.svc"
+      namespace = "default"
+    }
+  }
+}
 ```
 
 <!-- schema generated by tfplugindocs -->
@@ -209,6 +241,7 @@ Optional:
 - `kustomize` (Block List, Max: 1) Kustomize specific options. (see [below for nested schema](#nestedblock--spec--source--kustomize))
 - `path` (String) Directory path within the repository. Only valid for applications sourced from Git.
 - `plugin` (Block List, Max: 1) Config management plugin specific options. (see [below for nested schema](#nestedblock--spec--source--plugin))
+- `ref` (String) Reference to another `source` within defined sources. See associated documentation on [Helm value files from external Git repository](https://argo-cd.readthedocs.io/en/stable/user-guide/multiple_sources/#helm-value-files-from-external-git-repository) regarding combining `ref` with `path` and/or `chart`.
 - `target_revision` (String) Revision of the source to sync the application to. In case of Git, this can be commit, tag, or branch. If omitted, will equal to HEAD. In case of Helm, this is a semver tag for the Chart's version.
 
 <a id="nestedblock--spec--source--directory"></a>

diff --git a/examples/resources/argocd_application/resource.tf b/examples/resources/argocd_application/resource.tf
@@ -116,3 +116,35 @@ resource "argocd_application" "helm" {
     }
   }
 }
+
+# Multiple Application Sources with Helm value files from external Git repository
+resource "argocd_application" "multiple_sources" {
+  metadata {
+    name      = "helm-app-with-external-values"
+    namespace = "argocd"
+  }
+
+  spec {
+    project = "default"
+
+    source {
+      repo_url        = "https://charts.helm.sh/stable"
+      chart           = "wordpress"
+      target_revision = "9.0.3"
+      helm {
+        value_files = ["$values/helm-dependency/values.yaml"]
+      }
+    }
+
+    source {
+      repo_url        = "https://github.com/argoproj/argocd-example-apps.git"
+      target_revision = "HEAD"
+      ref             = "values"
+    }
+
+    destination {
+      server    = "https://kubernetes.default.svc"
+      namespace = "default"
+    }
+  }
+}