Merge branch 'main' into main

crossplane-contrib · Nov 28, 2023 · b2bf95c · b2bf95c
2 parents 2bd5227 + d962203
commit b2bf95c
Show file tree

Hide file tree

Showing 20 changed files with 170 additions and 18 deletions.
diff --git a/README.md b/README.md
@@ -110,11 +110,11 @@ about `crossplane beta render`.
 
 | Name                                                             | Description                                         |
 |------------------------------------------------------------------| --------------------------------------------------- |
-| [`randomChoice`](example/functions/randomChoice)                 | Randomly selects one of a given strings             |
+| [`randomChoice`](example/inline)                                 | Randomly selects one of a given strings             |
 | [`toYaml`](example/functions/toYaml)                             | Marshals any object into a YAML string              |
 | [`fromYaml`](example/functions/fromYaml)                         | Unmarshals a YAML string into an object             |
 | [`getResourceCondition`](example/functions/getResourceCondition) | Helper function to retreive conditions of resources |
-| [`setResourceNameAnnotation`](example/functions/inline)          | Returns the special resource-name annotation with given name |
+| [`setResourceNameAnnotation`](example/inline)                    | Returns the special resource-name annotation with given name |
 | [`include`](example/functions/include)                           | Outputs template as a string                        |
 
 ## Developing this function

diff --git a/example/.dev/functions.yaml b/example/.dev/functions.yaml
@@ -10,4 +10,4 @@ metadata:
     render.crossplane.io/runtime: Development
     render.crossplane.io/runtime-development-target: localhost:9443
 spec:
-  package: xpkg.upbound.io/crossplane-contrib/function-go-templating:latest # ignored
+  package: xpkg.upbound.io/crossplane-contrib/function-go-templating:v0.3.0
diff --git a/example/custom-delims/composition.yaml b/example/custom-delims/composition.yaml
@@ -0,0 +1,69 @@
+apiVersion: apiextensions.crossplane.io/v1
+kind: Composition
+metadata:
+  name: example-inline
+spec:
+  compositeTypeRef:
+    apiVersion: example.crossplane.io/v1beta1
+    kind: XR
+  mode: Pipeline
+  pipeline:
+    - step: render-templates
+      functionRef:
+        name: function-go-templating
+      input:
+        apiVersion: gotemplating.fn.crossplane.io/v1beta1
+        kind: GoTemplate
+        delims:
+          left: '[['
+          right: ']]'
+        source: Inline
+        inline:
+          template: |
+            [[- range $i := until ( .observed.composite.resource.spec.count | int ) ]]
+            ---
+            apiVersion: iam.aws.upbound.io/v1beta1
+            kind: User
+            metadata:
+              annotations:
+                gotemplating.fn.crossplane.io/composition-resource-name: test-user-[[ $i ]]
+              labels:
+                testing.upbound.io/example-name: test-user-[[ $i ]]
+              [[ if eq $.observed.resources nil ]]
+                dummy: [[ randomChoice "foo" "bar" "baz" ]]
+              [[ else ]]
+                dummy: [[ ( index $.observed.resources ( print "test-user-" $i ) ).resource.metadata.labels.dummy ]]
+              [[ end ]]
+            spec:
+              forProvider: {}
+            ---
+            apiVersion: iam.aws.upbound.io/v1beta1
+            kind: AccessKey
+            metadata:
+              annotations:
+                  gotemplating.fn.crossplane.io/composition-resource-name: sample-access-key-[[ $i ]]
+            spec:
+              forProvider:
+                userSelector:
+                  matchLabels:
+                    testing.upbound.io/example-name: test-user-[[ $i ]]
+              writeConnectionSecretToRef:
+                name: sample-access-key-secret-[[ $i ]]
+                namespace: crossplane-system
+            [[- end ]]
+            ---
+            apiVersion: meta.gotemplating.fn.crossplane.io/v1alpha1
+            kind: CompositeConnectionDetails
+            [[ if eq $.observed.resources nil ]]
+            data: {}
+            [[ else ]]
+            data:
+              username: [[ ( index $.observed.resources "sample-access-key-0" ).connectionDetails.username ]]
+              password: [[ ( index $.observed.resources "sample-access-key-0" ).connectionDetails.password ]]
+              url: [[ "http://www.example.com" | b64enc ]]
+            [[ end ]]
+            ---
+            apiVersion: example.crossplane.io/v1beta1
+            kind: XR
+            status:
+              dummy: cool-status
diff --git a/example/custom-delims/functions.yaml b/example/custom-delims/functions.yaml
@@ -0,0 +1,6 @@
+apiVersion: pkg.crossplane.io/v1beta1
+kind: Function
+metadata:
+  name: function-go-templating
+spec:
+  package: xpkg.upbound.io/crossplane-contrib/function-go-templating:v0.0.0-20231101231317-cdb49945da4e
diff --git a/example/custom-delims/xr.yaml b/example/custom-delims/xr.yaml
@@ -0,0 +1,6 @@
+apiVersion: example.crossplane.io/v1beta1
+kind: XR
+metadata:
+  name: example
+spec:
+  count: 2
diff --git a/example/filesystem/claim.yaml b/example/filesystem/claim.yaml
@@ -5,4 +5,4 @@ metadata:
   namespace: crossplane-system
 spec:
   id: test-user
-  count: 2
+  count: 2
diff --git a/example/filesystem/functions.yaml b/example/filesystem/functions.yaml
@@ -4,14 +4,14 @@ kind: Function
 metadata:
   name: function-auto-ready
 spec:
-  package: xpkg.upbound.io/crossplane-contrib/function-auto-ready:v0.1.0
+  package: xpkg.upbound.io/crossplane-contrib/function-auto-ready:v0.2.1
 ---
 apiVersion: pkg.crossplane.io/v1beta1
 kind: Function
 metadata:
   name: function-go-templating
 spec:
-  package: xpkg.upbound.io/crossplane-contrib/function-go-templating:v0.0.0-20231102045703-5dbf5b2adbc4
+  package: xpkg.upbound.io/crossplane-contrib/function-go-templating:v0.3.0
   runtimeConfigRef:
     name: mount-templates
 ---

diff --git a/example/filesystem/templates.tmpl b/example/filesystem/templates.tmpl
@@ -44,4 +44,4 @@ data:
 apiVersion: aws.platformref.upbound.io/v1alpha1
 kind: XUser
 status:
-  dummy: cool-status
+  dummy: cool-status
diff --git a/example/functions/fromYaml/functions.yaml b/example/functions/fromYaml/functions.yaml
@@ -3,4 +3,4 @@ kind: Function
 metadata:
   name: function-go-templating
 spec:
-  package: xpkg.upbound.io/crossplane-contrib/function-go-templating:latest
+  package: xpkg.upbound.io/crossplane-contrib/function-go-templating:v0.3.0
diff --git a/example/functions/fromYaml/xr.yaml b/example/functions/fromYaml/xr.yaml
@@ -6,4 +6,4 @@ spec:
   yamlBlob: |
     key1: value1
     key2: value2
-    key3: value3
+    key3: value3
diff --git a/example/functions/getResourceCondition/functions.yaml b/example/functions/getResourceCondition/functions.yaml
@@ -3,4 +3,4 @@ kind: Function
 metadata:
   name: function-go-templating
 spec:
-  package: xpkg.upbound.io/crossplane-contrib/function-go-templating:latest
+  package: xpkg.upbound.io/crossplane-contrib/function-go-templating:v0.3.0
diff --git a/example/functions/getResourceCondition/observed.yaml b/example/functions/getResourceCondition/observed.yaml
@@ -18,4 +18,4 @@ status:
     - type: Ready
       status: "True"
       reason: "foo"
-      lastTransitionTime: "2023-11-03T09:07:31Z"
+      lastTransitionTime: "2023-11-03T09:07:31Z"
diff --git a/example/functions/toYaml/functions.yaml b/example/functions/toYaml/functions.yaml
@@ -3,4 +3,4 @@ kind: Function
 metadata:
   name: function-go-templating
 spec:
-  package: xpkg.upbound.io/crossplane-contrib/function-go-templating:latest
+  package: xpkg.upbound.io/crossplane-contrib/function-go-templating:v0.3.0
diff --git a/example/inline/functions.yaml b/example/inline/functions.yaml
@@ -3,4 +3,4 @@ kind: Function
 metadata:
   name: function-go-templating
 spec:
-  package: xpkg.upbound.io/crossplane-contrib/function-go-templating:v0.0.0-20231101231317-cdb49945da4e
+  package: xpkg.upbound.io/crossplane-contrib/function-go-templating:v0.3.0
diff --git a/fn.go b/fn.go
@@ -57,7 +57,7 @@ func (f *Function) RunFunction(_ context.Context, req *fnv1beta1.RunFunctionRequ
 		return rsp, nil
 	}
 
-	tmpl, err := GetNewTemplateWithFunctionMaps().Parse(tg.GetTemplates())
+	tmpl, err := GetNewTemplateWithFunctionMaps(in.Delims).Parse(tg.GetTemplates())
 	if err != nil {
 		response.Fatal(rsp, errors.Wrap(err, "invalid function input: cannot parse the provided templates"))
 		return rsp, nil

diff --git a/function_maps.go b/function_maps.go
@@ -10,7 +10,7 @@ import (
 	"gopkg.in/yaml.v3"
 
 	sprig "github.com/Masterminds/sprig/v3"
-
+	"github.com/crossplane-contrib/function-go-templating/input/v1beta1"
 	xpv1 "github.com/crossplane/crossplane-runtime/apis/common/v1"
 	"github.com/crossplane/crossplane-runtime/pkg/fieldpath"
 	"github.com/crossplane/function-sdk-go/errors"
@@ -28,9 +28,15 @@ var funcMaps = []template.FuncMap{
 	},
 }
 
-func GetNewTemplateWithFunctionMaps() *template.Template {
+func GetNewTemplateWithFunctionMaps(delims *v1beta1.Delims) *template.Template {
 	tpl := template.New("manifests")
 
+	if delims != nil {
+		if delims.Left != nil && delims.Right != nil {
+			tpl = tpl.Delims(*delims.Left, *delims.Right)
+		}
+	}
+
 	for _, f := range funcMaps {
 		tpl.Funcs(f)
 	}

diff --git a/input/v1beta1/input.go b/input/v1beta1/input.go
@@ -18,7 +18,9 @@ import (
 type GoTemplate struct {
 	metav1.TypeMeta   `json:",inline"`
 	metav1.ObjectMeta `json:"metadata,omitempty"`
-
+	// Template delimiters
+	// +optional
+	Delims *Delims `json:"delims,omitempty"`
 	// Source specifies the different types of input sources that can be used with this function
 	Source TemplateSource `json:"source"`
 	// Inline is the inline form input of the templates
@@ -44,3 +46,14 @@ type TemplateSourceInline struct {
 type TemplateSourceFileSystem struct {
 	DirPath string `json:"dirPath,omitempty"`
 }
+
+type Delims struct {
+	// Template start characters
+	// +kubebuilder:default:="{{"
+	// +optional
+	Left *string `json:"left,omitempty"`
+	// Template end characters
+	// +kubebuilder:default:="}}"
+	// +optional
+	Right *string `json:"right,omitempty"`
+}
diff --git a/input/v1beta1/zz_generated.deepcopy.go b/input/v1beta1/zz_generated.deepcopy.go
diff --git a/package/input/gotemplating.fn.crossplane.io_gotemplates.yaml b/package/input/gotemplating.fn.crossplane.io_gotemplates.yaml
@@ -26,6 +26,18 @@ spec:
               of an object. Servers should convert recognized schemas to the latest
               internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources'
             type: string
+          delims:
+            description: Template delimiters
+            properties:
+              left:
+                default: '{{'
+                description: Template start characters
+                type: string
+              right:
+                default: '}}'
+                description: Template end characters
+                type: string
+            type: object
           fileSystem:
             description: FileSystem is the folder path where the templates are located
             properties:

diff --git a/renovate.json b/renovate.json
@@ -1,6 +1,16 @@
 {
   "$schema": "https://docs.renovatebot.com/renovate-schema.json",
   "extends": [
-    "config:base"
+    "config:recommended"
+  ],
+  "crossplane": {
+    "fileMatch": ["(^|/)example/.*\\.ya?ml$"]
+  },
+  "packageRules": [
+    {
+      "matchManagers": ["crossplane"],
+      "matchFileNames": ["example/**"],
+      "groupName": "examples"
+    }
   ]
 }