feat: add support for appset plugin generators (#624)

* feat: add support for appset plugin generators

This has one caveat, which likely cannot be fixed until #615 is merged;
we're limited to simple string maps for `parameters`, which is only a
subset of what the plugin generator supports. In reality pretty much
anything can go in as a parameter from the perspective of the plugin
generator, but `terraform-plugin-sdk` needs an explicit type.

With `terraform-plugin-framework` we can use any as a type, then we can
handle the marshaling/unmarshaling appropriately. I don't believe this
will be a breaking change in the future since we will be widening the
types `parameters` will accept at a later stage.

Fixes #620.

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

* chore: wait for crds to be fully installed

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

---------

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

Author: blakepettersson

GNUmakefile

@@ -51,8 +51,16 @@ testacc_prepare_env:
 	echo "\n--- Fetch ArgoCD installation manifests\n"
 	curl https://raw.githubusercontent.com/argoproj/argo-cd/${ARGOCD_VERSION}/manifests/install.yaml > manifests/install/argocd.yml
 
+
 	echo "\n--- Install ArgoCD ${ARGOCD_VERSION}\n"
-	kustomize build manifests/install | kubectl apply -f - && \
+	kustomize build manifests/install | kubectl apply -f -
+
+	echo "\n--- Wait until CRDs are established\n"
+	kubectl wait --for=condition=Established crd/applications.argoproj.io --timeout=60s
+	kubectl wait --for=condition=Established crd/applicationsets.argoproj.io --timeout=60s
+	kubectl wait --for=condition=Established crd/appprojects.argoproj.io --timeout=60s
+
+	echo "\n--- Install ArgoCD test data\n"
 	kubectl apply -f manifests/testdata/
 
 	echo "\n--- Wait for ArgoCD components to be ready...\n"

argocd/resource_argocd_application_set_test.go

@@ -163,6 +163,42 @@ func TestAccArgoCDApplicationSet_gitFiles(t *testing.T) {
 	})
 }
 
+func TestAccArgoCDApplicationSet_plugin(t *testing.T) {
+	resource.ParallelTest(t, resource.TestCase{
+		PreCheck:          func() { testAccPreCheck(t); testAccPreCheckFeatureSupported(t, features.ApplicationSet) },
+		ProviderFactories: testAccProviders,
+		Steps: []resource.TestStep{
+			{
+				Config: testAccArgoCDApplicationSet_plugin(),
+				Check: resource.ComposeTestCheckFunc(
+					resource.TestCheckResourceAttrSet(
+						"argocd_application_set.plugin",
+						"metadata.0.uid",
+					),
+					resource.TestCheckResourceAttrSet(
+						"argocd_application_set.plugin",
+						"spec.0.generator.0.plugin.0.requeue_after_seconds",
+					),
+					resource.TestCheckResourceAttrSet(
+						"argocd_application_set.plugin",
+						"spec.0.generator.0.plugin.0.config_map_ref",
+					),
+					resource.TestCheckResourceAttrSet(
+						"argocd_application_set.plugin",
+						"spec.0.generator.0.plugin.0.input.0.parameters.key1",
+					),
+				),
+			},
+			{
+				ResourceName:            "argocd_application_set.plugin",
+				ImportState:             true,
+				ImportStateVerify:       true,
+				ImportStateVerifyIgnore: []string{"metadata.0.resource_version"},
+			},
+		},
+	})
+}
+
 func TestAccArgoCDApplicationSet_list(t *testing.T) {
 	resource.ParallelTest(t, resource.TestCase{
 		PreCheck:          func() { testAccPreCheck(t); testAccPreCheckFeatureSupported(t, features.ApplicationSet) },
@@ -1183,6 +1219,52 @@ resource "argocd_application_set" "git_files" {
 }`
 }
 
+func testAccArgoCDApplicationSet_plugin() string {
+	return `
+resource "argocd_application_set" "plugin" {
+	metadata {
+		name = "plugin"
+	}
+
+	spec {
+		generator {
+			plugin {
+				config_map_ref = "plugin"
+
+				input {
+					parameters = {
+						key1 = "value1"
+					}
+				}
+
+				requeue_after_seconds = 30
+			}
+		}
+
+		template {
+			metadata {
+				name = "{{cluster}}-guestbook"
+			}
+
+			spec {
+				project = "default"
+
+				source {
+					repo_url        = "https://github.com/argoproj/argo-cd.git"
+					target_revision = "HEAD"
+					path            = "applicationset/examples/list-generator/guestbook/{{cluster}}"
+				}
+
+				destination {
+					server    = "{{url}}"
+					namespace = "guestbook"
+				}
+			}
+		}
+	}
+}`
+}
+
 func testAccArgoCDApplicationSet_list() string {
 	return `
 resource "argocd_application_set" "list" {

argocd/schema_application_set.go

@@ -156,6 +156,7 @@ func generatorResourceV0(level int) *schema.Resource {
 				"list":                      applicationSetListGeneratorSchemaV0(),
 				"matrix":                    applicationSetMatrixGeneratorSchemaV0(level),
 				"merge":                     applicationSetMergeGeneratorSchemaV0(level),
+				"plugin":                    applicationSetPluginGeneratorSchemaV0(),
 				"pull_request":              applicationSetPullRequestGeneratorSchemaV0(),
 				"scm_provider":              applicationSetSCMProviderGeneratorSchemaV0(),
 				"selector": {
@@ -173,6 +174,7 @@ func generatorResourceV0(level int) *schema.Resource {
 
 	return &schema.Resource{
 		Schema: map[string]*schema.Schema{
+			"plugin":                    applicationSetPluginGeneratorSchemaV0(),
 			"cluster_decision_resource": applicationSetClusterDecisionResourceGeneratorSchemaV0(),
 			"clusters":                  applicationSetClustersGeneratorSchemaV0(),
 			"git":                       applicationSetGitGeneratorSchemaV0(),
@@ -281,6 +283,57 @@ func applicationSetClusterDecisionResourceGeneratorSchemaV0() *schema.Schema {
 	}
 }
 
+func applicationSetPluginGeneratorSchemaV0() *schema.Schema {
+	return &schema.Schema{
+		Type:        schema.TypeList,
+		Description: "[Plugin generators](https://argo-cd.readthedocs.io/en/stable/operator-manual/applicationset/Generators-Plugin/) generates parameters using a custom plugin.",
+		Optional:    true,
+		Elem: &schema.Resource{
+			Schema: map[string]*schema.Schema{
+				"config_map_ref": {
+					Type:        schema.TypeString,
+					Description: "ConfigMap with the plugin configuration needed to retrieve the data.",
+					Required:    true,
+				},
+				"requeue_after_seconds": {
+					Type:        schema.TypeString,
+					Description: "How often to check for changes (in seconds). Default: 3min.",
+					Optional:    true,
+				},
+				"input": {
+					Type:        schema.TypeList,
+					Description: "The input parameters used for calling the plugin.",
+					Optional:    true,
+					MaxItems:    1,
+					Elem: &schema.Resource{
+						Schema: map[string]*schema.Schema{
+							"parameters": {
+								Type:        schema.TypeMap,
+								Description: "Arbitrary key-value pairs which are passed directly as parameters to the plugin. A current limitation is that this cannot fully express the parameters that can be accepted by the plugin generator.",
+								Required:    true,
+								Elem:        &schema.Schema{Type: schema.TypeString},
+							},
+						},
+					},
+				},
+				"template": {
+					Type:        schema.TypeList,
+					Description: "Generator template. Used to override the values of the spec-level template.",
+					Optional:    true,
+					MaxItems:    1,
+					Elem:        applicationSetTemplateResource(true),
+				},
+				"values": {
+					Type:        schema.TypeMap,
+					Description: "Arbitrary string key-value pairs to pass to the template via the values field of the git generator.",
+					Optional:    true,
+					Elem:        &schema.Schema{Type: schema.TypeString},
+				},
+			},
+		},
+	}
+}
+
 func applicationSetGitGeneratorSchemaV0() *schema.Schema {
 	return &schema.Schema{
 		Type:        schema.TypeList,

argocd/structure_application_set.go

@@ -95,6 +95,8 @@ func expandApplicationSetGenerators(g []interface{}, featureMultipleApplicationS
 			g, err = expandApplicationSetSCMProviderGenerator(asg[0], featureMultipleApplicationSourcesSupported)
 		} else if asg, ok = v["pull_request"].([]interface{}); ok && len(asg) > 0 {
 			g, err = expandApplicationSetPullRequestGeneratorGenerator(asg[0], featureMultipleApplicationSourcesSupported)
+		} else if asg, ok = v["plugin"].([]interface{}); ok && len(asg) > 0 {
+			g, err = expandApplicationSetPluginGenerator(asg[0], featureMultipleApplicationSourcesSupported)
 		}
 
 		if err != nil {
@@ -393,6 +395,70 @@ func expandApplicationSetMergeGenerator(mg interface{}, featureMultipleApplicati
 	return asg, nil
 }
 
+func expandApplicationSetPluginGenerator(mg interface{}, featureMultipleApplicationSourcesSupported bool) (*application.ApplicationSetGenerator, error) {
+	asg := &application.ApplicationSetGenerator{
+		Plugin: &application.PluginGenerator{},
+	}
+
+	m := mg.(map[string]interface{})
+
+	if v, ok := m["input"].([]interface{}); ok && len(v) > 0 {
+		tmp, err := expandApplicationSetInputParameters(v[0].(map[string]interface{}))
+		if err != nil {
+			return nil, err
+		}
+
+		asg.Plugin.Input.Parameters = tmp
+	}
+
+	if v, ok := m["config_map_ref"].(string); ok && v != "" {
+		asg.Plugin.ConfigMapRef.Name = v
+	}
+
+	if v, ok := m["requeue_after_seconds"].(string); ok && v != "" {
+		ras, err := convertStringToInt64Pointer(v)
+		if err != nil {
+			return nil, fmt.Errorf("failed to convert requeue_after_seconds to *int64: %w", err)
+		}
+
+		asg.Plugin.RequeueAfterSeconds = ras
+	}
+
+	if v, ok := m["template"].([]interface{}); ok && len(v) > 0 {
+		temp, err := expandApplicationSetTemplate(v[0], featureMultipleApplicationSourcesSupported)
+		if err != nil {
+			return nil, err
+		}
+
+		asg.Plugin.Template = temp
+	}
+
+	if v, ok := m["values"]; ok {
+		asg.Plugin.Values = expandStringMap(v.(map[string]interface{}))
+	}
+
+	return asg, nil
+}
+
+func expandApplicationSetInputParameters(m map[string]interface{}) (application.PluginParameters, error) {
+	params := application.PluginParameters{}
+
+	if v, ok := m["parameters"].(map[string]interface{}); ok && len(v) > 0 {
+		for k, v := range v {
+			json, err := json.Marshal(v)
+			if err != nil {
+				return params, fmt.Errorf("failed to marshal plugin param to json: %w", err)
+			}
+
+			params[k] = apiextensionsv1.JSON{
+				Raw: json,
+			}
+		}
+	}
+
+	return params, nil
+}
+
 func expandApplicationSetPullRequestGeneratorGenerator(mg interface{}, featureMultipleApplicationSourcesSupported bool) (*application.ApplicationSetGenerator, error) {
 	asg := &application.ApplicationSetGenerator{
 		PullRequest: &application.PullRequestGenerator{},
@@ -1021,6 +1087,13 @@ func flattenGenerator(g application.ApplicationSetGenerator) (map[string]interfa
 		generator["scm_provider"] = flattenApplicationSetSCMProviderGenerator(g.SCMProvider)
 	} else if g.PullRequest != nil {
 		generator["pull_request"] = flattenApplicationSetPullRequestGenerator(g.PullRequest)
+	} else if g.Plugin != nil {
+		pluginGenerator, err := flattenApplicationSetPluginGenerator(g.Plugin)
+		if err != nil {
+			return nil, err
+		}
+
+		generator["plugin"] = pluginGenerator
 	}
 
 	if g.Selector != nil {
@@ -1155,6 +1228,44 @@ func flattenApplicationSetMergeGenerator(mg *application.MergeGenerator) ([]map[
 	return []map[string]interface{}{g}, nil
 }
 
+func flattenApplicationSetPluginGenerator(plg *application.PluginGenerator) ([]map[string]interface{}, error) {
+	g := map[string]interface{}{}
+
+	if plg.Input.Parameters != nil {
+		input := map[string]interface{}{}
+		parameters := map[string]string{}
+
+		// TODO: In reality, the parameters map can potentially contain anything, but
+		// terraform-plugin-sdk doesn't really support the notion of `any`. We need to
+		// improve this once we upgrade to terraform-plugin-framework
+		for k, v := range plg.Input.Parameters {
+			var str string
+			err := json.Unmarshal(v.Raw, &str)
+
+			if err != nil {
+				return nil, err
+			}
+
+			parameters[k] = str
+		}
+
+		input["parameters"] = parameters
+		g["input"] = []map[string]interface{}{input}
+	}
+
+	if plg.ConfigMapRef.Name != "" {
+		g["config_map_ref"] = plg.ConfigMapRef.Name
+	}
+
+	if plg.RequeueAfterSeconds != nil {
+		g["requeue_after_seconds"] = convertInt64PointerToString(plg.RequeueAfterSeconds)
+	}
+
+	g["template"] = flattenApplicationSetTemplate(plg.Template)
+
+	return []map[string]interface{}{g}, nil
+}
+
 func flattenApplicationSetPullRequestGenerator(prg *application.PullRequestGenerator) []map[string]interface{} {
 	g := map[string]interface{}{}