Add crds attribute to helm_template data source (#1050)

* Add crds attribute to helm_template data source

* include test chart

* Add changelog entry

.changelog/1050.txt

@@ -0,0 +1,3 @@
+```release-note:enhancement
+Add `crds` attribute to helm_template data source
+```

helm/data_template.go

@@ -334,6 +334,15 @@ func dataTemplate() *schema.Resource {
 					Type: schema.TypeString,
 				},
 			},
+			"crds": {
+				Type:        schema.TypeList,
+				Optional:    true,
+				Computed:    true,
+				Description: "List of rendered CRDs from the chart.",
+				Elem: &schema.Schema{
+					Type: schema.TypeString,
+				},
+			},
 			"manifest": {
 				Type:        schema.TypeString,
 				Optional:    true,
@@ -507,6 +516,11 @@ func dataTemplateRead(ctx context.Context, d *schema.ResourceData, meta interfac
 	}
 	sort.Sort(releaseutil.BySplitManifestsOrder(manifestsKeys))
 
+	var chartCRDs []string
+	for _, crd := range rel.Chart.CRDObjects() {
+		chartCRDs = append(chartCRDs, string(crd.File.Data))
+	}
+
 	// Mapping of manifest key to manifest template name
 	manifestNamesByKey := make(map[string]string, len(manifestsKeys))
 
@@ -577,6 +591,11 @@ func dataTemplateRead(ctx context.Context, d *schema.ResourceData, meta interfac
 
 	d.SetId(name)
 
+	err = d.Set("crds", chartCRDs)
+	if err != nil {
+		return diag.FromErr(err)
+	}
+
 	err = d.Set("manifests", computedManifests)
 	if err != nil {
 		return diag.FromErr(err)

helm/data_template_test.go

@@ -33,6 +33,115 @@ func TestAccDataTemplate_basic(t *testing.T) {
 	})
 }
 
+func TestAccDataTemplate_crds(t *testing.T) {
+	name := randName("basic")
+	namespace := randName(testNamespacePrefix)
+
+	datasourceAddress := fmt.Sprintf("data.helm_template.%s", testResourceName)
+
+	resource.Test(t, resource.TestCase{
+		PreCheck:  func() { testAccPreCheck(t) },
+		Providers: testAccProviders,
+		Steps: []resource.TestStep{{
+			Config: testAccDataHelmTemplateCRDs(testResourceName, namespace, name, "1.2.3"),
+			Check: resource.ComposeAggregateTestCheckFunc(
+				resource.TestCheckResourceAttr(datasourceAddress, "manifests.%", "8"),
+				resource.TestCheckResourceAttrSet(datasourceAddress, "manifests.templates/deployment.yaml"),
+				resource.TestCheckResourceAttrSet(datasourceAddress, "manifests.templates/service.yaml"),
+				resource.TestCheckResourceAttrSet(datasourceAddress, "manifests.templates/serviceaccount.yaml"),
+				resource.TestCheckResourceAttrSet(datasourceAddress, "manifests.templates/configmaps.yaml"),
+				resource.TestCheckResourceAttrSet(datasourceAddress, "manifests.templates/tests/test-connection.yaml"),
+				resource.TestCheckResourceAttrSet(datasourceAddress, "manifest"),
+				resource.TestCheckResourceAttrSet(datasourceAddress, "notes"),
+				resource.TestCheckResourceAttr(datasourceAddress, "crds.0", `---
+apiVersion: apiextensions.k8s.io/v1
+kind: CustomResourceDefinition
+metadata:
+  # name must match the spec fields below, and be in the form: <plural>.<group>
+  name: apples.stable.example.com
+spec:
+  # group name to use for REST API: /apis/<group>/<version>
+  group: stable.example.com
+  # list of versions supported by this CustomResourceDefinition
+  versions:
+    - name: v1
+      # Each version can be enabled/disabled by Served flag.
+      served: true
+      # One and only one version must be marked as the storage version.
+      storage: true
+      schema:
+        openAPIV3Schema:
+          type: object
+          properties:
+            spec:
+              type: object
+              properties:
+                cronSpec:
+                  type: string
+                image:
+                  type: string
+                replicas:
+                  type: integer
+  # either Namespaced or Cluster
+  scope: Namespaced
+  names:
+    # plural name to be used in the URL: /apis/<group>/<version>/<plural>
+    plural: apples
+    # singular name to be used as an alias on the CLI and for display
+    singular: apple
+    # kind is normally the CamelCased singular type. Your resource manifests use this.
+    kind: Apple
+    # shortNames allow shorter string to match your resource on the CLI
+    shortNames:
+    - ap
+`),
+				resource.TestCheckResourceAttr(datasourceAddress, "crds.1", `---
+apiVersion: apiextensions.k8s.io/v1
+kind: CustomResourceDefinition
+metadata:
+  # name must match the spec fields below, and be in the form: <plural>.<group>
+  name: oranges.stable.example.com
+spec:
+  # group name to use for REST API: /apis/<group>/<version>
+  group: stable.example.com
+  # list of versions supported by this CustomResourceDefinition
+  versions:
+    - name: v1
+      # Each version can be enabled/disabled by Served flag.
+      served: true
+      # One and only one version must be marked as the storage version.
+      storage: true
+      schema:
+        openAPIV3Schema:
+          type: object
+          properties:
+            spec:
+              type: object
+              properties:
+                cronSpec:
+                  type: string
+                image:
+                  type: string
+                replicas:
+                  type: integer
+  # either Namespaced or Cluster
+  scope: Namespaced
+  names:
+    # plural name to be used in the URL: /apis/<group>/<version>/<plural>
+    plural: oranges
+    # singular name to be used as an alias on the CLI and for display
+    singular: orange
+    # kind is normally the CamelCased singular type. Your resource manifests use this.
+    kind: Orange
+    # shortNames allow shorter string to match your resource on the CLI
+    shortNames:
+    - or
+`),
+			),
+		}},
+	})
+}
+
 func TestAccDataTemplate_templates(t *testing.T) {
 	name := randName("basic")
 	namespace := randName(testNamespacePrefix)
@@ -212,3 +321,17 @@ func testAccDataHelmTemplateKubeVersionNoVersionSet(resource, ns, name, version
 		}
 	`, resource, name, ns, testRepositoryURL, version)
 }
+
+func testAccDataHelmTemplateCRDs(resource, ns, name, version string) string {
+	return fmt.Sprintf(`
+		data "helm_template" "%s" {
+ 			name         = %q
+			namespace    = %q
+			description  = "Test"
+			repository   = %q
+  			chart        = "crds-chart"
+			include_crds = true
+			version      = %q
+		}
+	`, resource, name, ns, testRepositoryURL, version)
+}

helm/testdata/charts/crds-chart/.helmignore

@@ -0,0 +1,23 @@
+# Patterns to ignore when building packages.
+# This supports shell glob matching, relative path matching, and
+# negation (prefixed with !). Only one pattern per line.
+.DS_Store
+# Common VCS dirs
+.git/
+.gitignore
+.bzr/
+.bzrignore
+.hg/
+.hgignore
+.svn/
+# Common backup files
+*.swp
+*.bak
+*.tmp
+*.orig
+*~
+# Various IDEs
+.project
+.idea/
+*.tmproj
+.vscode/

helm/testdata/charts/crds-chart/Chart.yaml

@@ -0,0 +1,23 @@
+apiVersion: v2
+name: crds-chart
+description: This is a simple chart to use as a test fixture
+
+# A chart can be either an 'application' or a 'library' chart.
+#
+# Application charts are a collection of templates that can be packaged into versioned archives
+# to be deployed.
+#
+# Library charts provide useful utilities or functions for the chart developer. They're included as
+# a dependency of application charts to inject those utilities and functions into the rendering
+# pipeline. Library charts do not define any templates and therefore cannot be deployed.
+type: application
+
+# This is the chart version. This version number should be incremented each time you make changes
+# to the chart and its templates, including the app version.
+# Versions are expected to follow Semantic Versioning (https://semver.org/)
+version: 1.2.3
+
+# This is the version number of the application being deployed. This version number should be
+# incremented each time you make changes to the application. Versions are not expected to
+# follow Semantic Versioning. They should reflect the version the application is using.
+appVersion: 1.19.5

helm/testdata/charts/crds-chart/crds/apples.yaml

@@ -0,0 +1,41 @@
+---
+apiVersion: apiextensions.k8s.io/v1
+kind: CustomResourceDefinition
+metadata:
+  # name must match the spec fields below, and be in the form: <plural>.<group>
+  name: apples.stable.example.com
+spec:
+  # group name to use for REST API: /apis/<group>/<version>
+  group: stable.example.com
+  # list of versions supported by this CustomResourceDefinition
+  versions:
+    - name: v1
+      # Each version can be enabled/disabled by Served flag.
+      served: true
+      # One and only one version must be marked as the storage version.
+      storage: true
+      schema:
+        openAPIV3Schema:
+          type: object
+          properties:
+            spec:
+              type: object
+              properties:
+                cronSpec:
+                  type: string
+                image:
+                  type: string
+                replicas:
+                  type: integer
+  # either Namespaced or Cluster
+  scope: Namespaced
+  names:
+    # plural name to be used in the URL: /apis/<group>/<version>/<plural>
+    plural: apples
+    # singular name to be used as an alias on the CLI and for display
+    singular: apple
+    # kind is normally the CamelCased singular type. Your resource manifests use this.
+    kind: Apple
+    # shortNames allow shorter string to match your resource on the CLI
+    shortNames:
+    - ap

helm/testdata/charts/crds-chart/crds/oranges.yaml

@@ -0,0 +1,41 @@
+---
+apiVersion: apiextensions.k8s.io/v1
+kind: CustomResourceDefinition
+metadata:
+  # name must match the spec fields below, and be in the form: <plural>.<group>
+  name: oranges.stable.example.com
+spec:
+  # group name to use for REST API: /apis/<group>/<version>
+  group: stable.example.com
+  # list of versions supported by this CustomResourceDefinition
+  versions:
+    - name: v1
+      # Each version can be enabled/disabled by Served flag.
+      served: true
+      # One and only one version must be marked as the storage version.
+      storage: true
+      schema:
+        openAPIV3Schema:
+          type: object
+          properties:
+            spec:
+              type: object
+              properties:
+                cronSpec:
+                  type: string
+                image:
+                  type: string
+                replicas:
+                  type: integer
+  # either Namespaced or Cluster
+  scope: Namespaced
+  names:
+    # plural name to be used in the URL: /apis/<group>/<version>/<plural>
+    plural: oranges
+    # singular name to be used as an alias on the CLI and for display
+    singular: orange
+    # kind is normally the CamelCased singular type. Your resource manifests use this.
+    kind: Orange
+    # shortNames allow shorter string to match your resource on the CLI
+    shortNames:
+    - or

helm/testdata/charts/crds-chart/templates/NOTES.txt

@@ -0,0 +1,21 @@
+1. Get the application URL by running these commands:
+{{- if .Values.ingress.enabled }}
+{{- range $host := .Values.ingress.hosts }}
+  {{- range .paths }}
+  http{{ if $.Values.ingress.tls }}s{{ end }}://{{ $host.host }}{{ . }}
+  {{- end }}
+{{- end }}
+{{- else if contains "NodePort" .Values.service.type }}
+  export NODE_PORT=$(kubectl get --namespace {{ .Release.Namespace }} -o jsonpath="{.spec.ports[0].nodePort}" services {{ include "test-chart.fullname" . }})
+  export NODE_IP=$(kubectl get nodes --namespace {{ .Release.Namespace }} -o jsonpath="{.items[0].status.addresses[0].address}")
+  echo http://$NODE_IP:$NODE_PORT
+{{- else if contains "LoadBalancer" .Values.service.type }}
+     NOTE: It may take a few minutes for the LoadBalancer IP to be available.
+           You can watch the status of by running 'kubectl get --namespace {{ .Release.Namespace }} svc -w {{ include "test-chart.fullname" . }}'
+  export SERVICE_IP=$(kubectl get svc --namespace {{ .Release.Namespace }} {{ include "test-chart.fullname" . }} --template "{{"{{ range (index .status.loadBalancer.ingress 0) }}{{.}}{{ end }}"}}")
+  echo http://$SERVICE_IP:{{ .Values.service.port }}
+{{- else if contains "ClusterIP" .Values.service.type }}
+  export POD_NAME=$(kubectl get pods --namespace {{ .Release.Namespace }} -l "app.kubernetes.io/name={{ include "test-chart.name" . }},app.kubernetes.io/instance={{ .Release.Name }}" -o jsonpath="{.items[0].metadata.name}")
+  echo "Visit http://127.0.0.1:8080 to use your application"
+  kubectl --namespace {{ .Release.Namespace }} port-forward $POD_NAME 8080:80
+{{- end }}

helm/testdata/charts/crds-chart/templates/_helpers.tpl

@@ -0,0 +1,62 @@
+{{/*
+Expand the name of the chart.
+*/}}
+{{- define "test-chart.name" -}}
+{{- default .Chart.Name .Values.nameOverride | trunc 63 | trimSuffix "-" }}
+{{- end }}
+
+{{/*
+Create a default fully qualified app name.
+We truncate at 63 chars because some Kubernetes name fields are limited to this (by the DNS naming spec).
+If release name contains chart name it will be used as a full name.
+*/}}
+{{- define "test-chart.fullname" -}}
+{{- if .Values.fullnameOverride }}
+{{- .Values.fullnameOverride | trunc 63 | trimSuffix "-" }}
+{{- else }}
+{{- $name := default .Chart.Name .Values.nameOverride }}
+{{- if contains $name .Release.Name }}
+{{- .Release.Name | trunc 63 | trimSuffix "-" }}
+{{- else }}
+{{- printf "%s-%s" .Release.Name $name | trunc 63 | trimSuffix "-" }}
+{{- end }}
+{{- end }}
+{{- end }}
+
+{{/*
+Create chart name and version as used by the chart label.
+*/}}
+{{- define "test-chart.chart" -}}
+{{- printf "%s-%s" .Chart.Name .Chart.Version | replace "+" "_" | trunc 63 | trimSuffix "-" }}
+{{- end }}
+
+{{/*
+Common labels
+*/}}
+{{- define "test-chart.labels" -}}
+helm.sh/chart: {{ include "test-chart.chart" . }}
+{{ include "test-chart.selectorLabels" . }}
+{{- if .Chart.AppVersion }}
+app.kubernetes.io/version: {{ .Chart.AppVersion | quote }}
+{{- end }}
+app.kubernetes.io/managed-by: {{ .Release.Service }}
+{{- end }}
+
+{{/*
+Selector labels
+*/}}
+{{- define "test-chart.selectorLabels" -}}
+app.kubernetes.io/name: {{ include "test-chart.name" . }}
+app.kubernetes.io/instance: {{ .Release.Name }}
+{{- end }}
+
+{{/*
+Create the name of the service account to use
+*/}}
+{{- define "test-chart.serviceAccountName" -}}
+{{- if .Values.serviceAccount.create }}
+{{- default (include "test-chart.fullname" .) .Values.serviceAccount.name }}
+{{- else }}
+{{- default "default" .Values.serviceAccount.name }}
+{{- end }}
+{{- end }}