Merge pull request #247 from swghosh/refactor/template-for-testdata

Refactor `test/e2e/testdata` to use go template based replacements

Author: openshift-merge-bot[bot]

test/e2e/certificates_test.go

@@ -5,6 +5,7 @@ package e2e
 
 import (
 	"context"
+	"fmt"
 	"os"
 	"path/filepath"
 	"time"
@@ -508,29 +509,22 @@ var _ = Describe("ACME Certificate", Ordered, func() {
 			By("Creating new certificate ClusterIssuer")
 			// The name is defined by the testdata YAML file clusterissuer_gcp.yaml
 			clusterIssuerName := "acme-dns01-clouddns-ambient"
-			replaceStrMap := map[string]string{
-				"PROJECT_ID": gcpProjectId,
-			}
-			loadFileAndReplaceStr := func(fileName string) ([]byte, error) {
-				fileContentsStr, err := replaceStrInFile(replaceStrMap, fileName)
-				return []byte(fileContentsStr), err
-			}
-			loader.CreateFromFile(loadFileAndReplaceStr, filepath.Join("testdata", "acme", "clusterissuer_gcp.yaml"), "")
+			loader.CreateFromFile(AssetFunc(testassets.ReadFile).WithTemplateValues(
+				IssuerConfig{
+					GCPProjectID: gcpProjectId,
+				},
+			), filepath.Join("testdata", "acme", "clusterissuer_gcp.yaml"), "")
 			defer certmanagerClient.CertmanagerV1().ClusterIssuers().Delete(ctx, clusterIssuerName, metav1.DeleteOptions{})
 
 			By("Creating new certificate")
 			randomString := randomStr(3)
-			replaceStrMap = map[string]string{
-				"RANDOM_STR": randomString,
-				"DNS_NAME":   baseDomain,
-			}
-			loadFileAndReplaceStr = func(fileName string) ([]byte, error) {
-				fileContentsStr, err := replaceStrInFile(replaceStrMap, fileName)
-				return []byte(fileContentsStr), err
-			}
 			// The name is defined by the testdata YAML file certificate_gcp.yaml
 			certName := "cert-with-acme-dns01-clouddns-ambient"
-			loader.CreateFromFile(loadFileAndReplaceStr, filepath.Join("testdata", "acme", "certificate_gcp.yaml"), ns.Name)
+			loader.CreateFromFile(AssetFunc(testassets.ReadFile).WithTemplateValues(
+				CertificateConfig{
+					DNSName: fmt.Sprintf("%s.%s", randomString, baseDomain),
+				},
+			), filepath.Join("testdata", "acme", "certificate_gcp.yaml"), ns.Name)
 
 			By("Waiting for certificate to get ready")
 			err = waitForCertificateReadiness(ctx, certName, ns.Name)
@@ -559,29 +553,23 @@ var _ = Describe("ACME Certificate", Ordered, func() {
 			By("creating new certificate ClusterIssuer with IBM Cloud CIS webhook solver")
 			randomString := randomStr(3)
 			clusterIssuerName := "letsencrypt-dns01-explicit-ic"
-			replaceStrMap := map[string]string{
-				"CIS_CRN": cisCRN,
-			}
-			loadFileAndReplaceStr := func(fileName string) ([]byte, error) {
-				fileContentsStr, err := replaceStrInFile(replaceStrMap, fileName)
-				return []byte(fileContentsStr), err
-			}
-			loader.CreateFromFile(loadFileAndReplaceStr, filepath.Join("testdata", "acme", "clusterissuer_ibmcis.yaml"), "")
+			loader.CreateFromFile(AssetFunc(testassets.ReadFile).WithTemplateValues(
+				IssuerConfig{
+					IBMCloudCISCRN: cisCRN,
+				},
+			), filepath.Join("testdata", "acme", "clusterissuer_ibmcis.yaml"), "")
 			defer certmanagerClient.CertmanagerV1().ClusterIssuers().Delete(ctx, clusterIssuerName, metav1.DeleteOptions{})
 
 			By("creating new certificate")
 			// The name is defined by the testdata YAML file certificate_ibmcis.yaml
 			certDomain := "adwie." + appsDomain // acronym for "ACME dns-01 ibmcloud Webhook Explicit", short naming to pass dns name validation
 			certName := "letsencrypt-cert-ic"
-			replaceStrMap = map[string]string{
-				"RANDOM_STR": randomString,
-				"DNS_NAME":   certDomain,
-			}
-			loadFileAndReplaceStr = func(fileName string) ([]byte, error) {
-				fileContentsStr, err := replaceStrInFile(replaceStrMap, fileName)
-				return []byte(fileContentsStr), err
-			}
-			loader.CreateFromFile(loadFileAndReplaceStr, filepath.Join("testdata", "acme", "certificate_ibmcis.yaml"), ns.Name)
+			loader.CreateFromFile(
+				AssetFunc(testassets.ReadFile).WithTemplateValues(
+					CertificateConfig{
+						DNSName: certDomain,
+					},
+				), filepath.Join("testdata", "acme", "certificate_ibmcis.yaml"), ns.Name)
 
 			By("waiting for certificate to get ready")
 			err := waitForCertificateReadiness(ctx, certName, ns.Name)

test/e2e/config_template.go

@@ -0,0 +1,55 @@
+//go:build e2e
+// +build e2e
+
+package e2e
+
+import (
+	"bytes"
+	"text/template"
+)
+
+// IssuerConfig customizes fields in the issuer spec
+type IssuerConfig struct {
+	GCPProjectID   string
+	IBMCloudCISCRN string
+}
+
+// Certificate customize fields in the cert spec
+type CertificateConfig struct {
+	DNSName string
+}
+
+// replaceWithTemplate puts field values from a template struct
+func replaceWithTemplate(sourceFileContents string, templatedValues any) ([]byte, error) {
+	tmpl, err := template.New("template").Parse(sourceFileContents)
+	if err != nil {
+		return nil, err
+	}
+
+	var doc bytes.Buffer
+	err = tmpl.Execute(&doc, templatedValues)
+	if err != nil {
+		return nil, err
+	}
+
+	return doc.Bytes(), nil
+}
+
+// AssetFunc wraps the asset load function (used in dynamic resource loader),
+// and extends it with a hook to allow template value replacement.
+type AssetFunc func(name string) ([]byte, error)
+
+// WithTemplateValues is a wrapper for using `replaceWithTemplate` with an `AssetFunc`,
+// i.e. chains the loading -> modification.
+func (sourceFn AssetFunc) WithTemplateValues(templatedValues any) AssetFunc {
+	x := func(name string) ([]byte, error) {
+		bytes, err := sourceFn(name)
+		if err != nil {
+			return nil, err
+		}
+
+		fileContentsStr := string(bytes)
+		return replaceWithTemplate(fileContentsStr, templatedValues)
+	}
+	return x
+}

test/e2e/testdata/acme/certificate_gcp.yaml

@@ -9,5 +9,5 @@ spec:
     kind: ClusterIssuer
     name: acme-dns01-clouddns-ambient
   dnsNames:
-    - RANDOM_STR.DNS_NAME
-    - '*.RANDOM_STR.DNS_NAME'
+    - {{.DNSName}}
+    - '*.{{.DNSName}}'

test/e2e/testdata/acme/certificate_ibmcis.yaml

@@ -4,8 +4,8 @@ metadata:
   name: letsencrypt-cert-ic
 spec:
   dnsNames:
-    - RANDOM_STR.DNS_NAME
-    - '*.RANDOM_STR.DNS_NAME'
+    - {{.DNSName}}
+    - '*.{{.DNSName}}'
   issuerRef:
     name: letsencrypt-dns01-explicit-ic
     kind: ClusterIssuer

test/e2e/testdata/acme/clusterissuer_gcp.yaml

@@ -12,4 +12,4 @@ spec:
     - dns01:
         cloudDNS:
           # The ID of the GCP project
-          project: PROJECT_ID
+          project: {{.GCPProjectId}}

test/e2e/testdata/acme/clusterissuer_ibmcis.yaml

@@ -17,5 +17,4 @@ spec:
               name: ibmcis-credentials
               key: api-token
             cisCRN: 
-              - "CIS_CRN"
-              
+              - "{{.IBMCloudCISCRN}}"