Merge pull request #17 from ezgidemirel/backport-rename

Backport: Rename the Input type to GoTemplate
crossplane-contrib · Nov 3, 2023 · 0b51ca5 · 0b51ca5
2 parents 59c48e1 + 2630d35
commit 0b51ca5
Show file tree

Hide file tree

Showing 6 changed files with 62 additions and 62 deletions.
diff --git a/fn.go b/fn.go
@@ -45,7 +45,7 @@ func (f *Function) RunFunction(_ context.Context, req *fnv1beta1.RunFunctionRequ
 
 	rsp := response.To(req, response.DefaultTTL)
 
-	in := &v1beta1.Input{}
+	in := &v1beta1.GoTemplate{}
 	if err := request.GetInput(req, in); err != nil {
 		response.Fatal(rsp, errors.Wrapf(err, "cannot get Function input from %T", req))
 		return rsp, nil

diff --git a/fn_test.go b/fn_test.go
@@ -60,7 +60,7 @@ func TestRunFunction(t *testing.T) {
 			args: args{
 				req: &fnv1beta1.RunFunctionRequest{
 					Input: resource.MustStructObject(
-						&v1beta1.Input{
+						&v1beta1.GoTemplate{
 							Source: "wrong",
 						}),
 				},
@@ -99,9 +99,9 @@ func TestRunFunction(t *testing.T) {
 			args: args{
 				req: &fnv1beta1.RunFunctionRequest{
 					Input: resource.MustStructObject(
-						&v1beta1.Input{
+						&v1beta1.GoTemplate{
 							Source: v1beta1.InlineSource,
-							Inline: &v1beta1.InputSourceInline{Template: cdMissingResourceName},
+							Inline: &v1beta1.TemplateSourceInline{Template: cdMissingResourceName},
 						}),
 				},
 			},
@@ -122,9 +122,9 @@ func TestRunFunction(t *testing.T) {
 			args: args{
 				req: &fnv1beta1.RunFunctionRequest{
 					Input: resource.MustStructObject(
-						&v1beta1.Input{
+						&v1beta1.GoTemplate{
 							Source: v1beta1.InlineSource,
-							Inline: &v1beta1.InputSourceInline{Template: cdMissingKind},
+							Inline: &v1beta1.TemplateSourceInline{Template: cdMissingKind},
 						}),
 				},
 			},
@@ -145,9 +145,9 @@ func TestRunFunction(t *testing.T) {
 			args: args{
 				req: &fnv1beta1.RunFunctionRequest{
 					Input: resource.MustStructObject(
-						&v1beta1.Input{
+						&v1beta1.GoTemplate{
 							Source: v1beta1.InlineSource,
-							Inline: &v1beta1.InputSourceInline{Template: cdWrongTmpl},
+							Inline: &v1beta1.TemplateSourceInline{Template: cdWrongTmpl},
 						},
 					),
 					Observed: &fnv1beta1.State{
@@ -185,9 +185,9 @@ func TestRunFunction(t *testing.T) {
 				req: &fnv1beta1.RunFunctionRequest{
 					Meta: &fnv1beta1.RequestMeta{Tag: "nochange"},
 					Input: resource.MustStructObject(
-						&v1beta1.Input{
+						&v1beta1.GoTemplate{
 							Source: v1beta1.InlineSource,
-							Inline: &v1beta1.InputSourceInline{Template: cd},
+							Inline: &v1beta1.TemplateSourceInline{Template: cd},
 						}),
 					Observed: &fnv1beta1.State{
 						Composite: &fnv1beta1.Resource{
@@ -228,9 +228,9 @@ func TestRunFunction(t *testing.T) {
 				req: &fnv1beta1.RunFunctionRequest{
 					Meta: &fnv1beta1.RequestMeta{Tag: "templates"},
 					Input: resource.MustStructObject(
-						&v1beta1.Input{
+						&v1beta1.GoTemplate{
 							Source: v1beta1.InlineSource,
-							Inline: &v1beta1.InputSourceInline{Template: cdTmpl},
+							Inline: &v1beta1.TemplateSourceInline{Template: cdTmpl},
 						}),
 					Observed: &fnv1beta1.State{
 						Composite: &fnv1beta1.Resource{
@@ -266,9 +266,9 @@ func TestRunFunction(t *testing.T) {
 				req: &fnv1beta1.RunFunctionRequest{
 					Meta: &fnv1beta1.RequestMeta{Tag: "status"},
 					Input: resource.MustStructObject(
-						&v1beta1.Input{
+						&v1beta1.GoTemplate{
 							Source: v1beta1.InlineSource,
-							Inline: &v1beta1.InputSourceInline{Template: xrWithStatus},
+							Inline: &v1beta1.TemplateSourceInline{Template: xrWithStatus},
 						}),
 					Observed: &fnv1beta1.State{
 						Composite: &fnv1beta1.Resource{
@@ -299,9 +299,9 @@ func TestRunFunction(t *testing.T) {
 				req: &fnv1beta1.RunFunctionRequest{
 					Meta: &fnv1beta1.RequestMeta{Tag: "status"},
 					Input: resource.MustStructObject(
-						&v1beta1.Input{
+						&v1beta1.GoTemplate{
 							Source: v1beta1.InlineSource,
-							Inline: &v1beta1.InputSourceInline{Template: xrWithNestedStatusBaz},
+							Inline: &v1beta1.TemplateSourceInline{Template: xrWithNestedStatusBaz},
 						}),
 					Observed: &fnv1beta1.State{
 						Composite: &fnv1beta1.Resource{
@@ -332,9 +332,9 @@ func TestRunFunction(t *testing.T) {
 				req: &fnv1beta1.RunFunctionRequest{
 					Meta: &fnv1beta1.RequestMeta{Tag: "templates"},
 					Input: resource.MustStructObject(
-						&v1beta1.Input{
+						&v1beta1.GoTemplate{
 							Source:     v1beta1.FileSystemSource,
-							FileSystem: &v1beta1.InputSourceFileSystem{DirPath: path},
+							FileSystem: &v1beta1.TemplateSourceFileSystem{DirPath: path},
 						}),
 					Observed: &fnv1beta1.State{
 						Composite: &fnv1beta1.Resource{
@@ -369,9 +369,9 @@ func TestRunFunction(t *testing.T) {
 			args: args{
 				req: &fnv1beta1.RunFunctionRequest{
 					Input: resource.MustStructObject(
-						&v1beta1.Input{
+						&v1beta1.GoTemplate{
 							Source:     v1beta1.FileSystemSource,
-							FileSystem: &v1beta1.InputSourceFileSystem{DirPath: wrongPath},
+							FileSystem: &v1beta1.TemplateSourceFileSystem{DirPath: wrongPath},
 						},
 					),
 				},
@@ -393,9 +393,9 @@ func TestRunFunction(t *testing.T) {
 			args: args{
 				req: &fnv1beta1.RunFunctionRequest{
 					Input: resource.MustStructObject(
-						&v1beta1.Input{
+						&v1beta1.GoTemplate{
 							Source: v1beta1.InlineSource,
-							Inline: &v1beta1.InputSourceInline{Template: cdWithReadyWrong},
+							Inline: &v1beta1.TemplateSourceInline{Template: cdWithReadyWrong},
 						}),
 					Observed: &fnv1beta1.State{
 						Composite: &fnv1beta1.Resource{
@@ -431,9 +431,9 @@ func TestRunFunction(t *testing.T) {
 			args: args{
 				req: &fnv1beta1.RunFunctionRequest{
 					Input: resource.MustStructObject(
-						&v1beta1.Input{
+						&v1beta1.GoTemplate{
 							Source: v1beta1.InlineSource,
-							Inline: &v1beta1.InputSourceInline{Template: cdWithReadyTrue},
+							Inline: &v1beta1.TemplateSourceInline{Template: cdWithReadyTrue},
 						}),
 					Observed: &fnv1beta1.State{
 						Composite: &fnv1beta1.Resource{
@@ -474,9 +474,9 @@ func TestRunFunction(t *testing.T) {
 			args: args{
 				req: &fnv1beta1.RunFunctionRequest{
 					Input: resource.MustStructObject(
-						&v1beta1.Input{
+						&v1beta1.GoTemplate{
 							Source: v1beta1.InlineSource,
-							Inline: &v1beta1.InputSourceInline{Template: metaResourceInvalid},
+							Inline: &v1beta1.TemplateSourceInline{Template: metaResourceInvalid},
 						}),
 					Observed: &fnv1beta1.State{
 						Composite: &fnv1beta1.Resource{
@@ -512,9 +512,9 @@ func TestRunFunction(t *testing.T) {
 			args: args{
 				req: &fnv1beta1.RunFunctionRequest{
 					Input: resource.MustStructObject(
-						&v1beta1.Input{
+						&v1beta1.GoTemplate{
 							Source: v1beta1.InlineSource,
-							Inline: &v1beta1.InputSourceInline{Template: metaResourceConDet},
+							Inline: &v1beta1.TemplateSourceInline{Template: metaResourceConDet},
 						}),
 					Observed: &fnv1beta1.State{
 						Composite: &fnv1beta1.Resource{

diff --git a/input/v1beta1/input.go b/input/v1beta1/input.go
@@ -11,36 +11,36 @@ import (
 // This isn't a custom resource, in the sense that we never install its CRD.
 // It is a KRM-like object, so we generate a CRD to describe its schema.
 
-// Input is used to provide templates to this Function.
+// A GoTemplate is used to provide templates to this Function.
 // +kubebuilder:object:root=true
 // +kubebuilder:storageversion
 // +kubebuilder:resource:categories=crossplane
-type Input struct {
+type GoTemplate struct {
 	metav1.TypeMeta   `json:",inline"`
 	metav1.ObjectMeta `json:"metadata,omitempty"`
 
 	// Source specifies the different types of input sources that can be used with this function
-	Source InputSource `json:"source"`
+	Source TemplateSource `json:"source"`
 	// Inline is the inline form input of the templates
-	Inline *InputSourceInline `json:"inline,omitempty"`
+	Inline *TemplateSourceInline `json:"inline,omitempty"`
 	// FileSystem is the folder path where the templates are located
-	FileSystem *InputSourceFileSystem `json:"fileSystem,omitempty"`
+	FileSystem *TemplateSourceFileSystem `json:"fileSystem,omitempty"`
 }
 
-type InputSource string
+type TemplateSource string
 
 const (
 	// InlineSource indicates that function will get its input as inline
-	InlineSource InputSource = "Inline"
+	InlineSource TemplateSource = "Inline"
 
 	// FileSystemSource indicates that function will get its input from a folder
-	FileSystemSource InputSource = "FileSystem"
+	FileSystemSource TemplateSource = "FileSystem"
 )
 
-type InputSourceInline struct {
+type TemplateSourceInline struct {
 	Template string `json:"template,omitempty"`
 }
 
-type InputSourceFileSystem struct {
+type TemplateSourceFileSystem struct {
 	DirPath string `json:"dirPath,omitempty"`
 }
diff --git a/input/v1beta1/zz_generated.deepcopy.go b/input/v1beta1/zz_generated.deepcopy.go
diff --git a/...gotemplating.fn.crossplane.io_inputs.yaml → ...plating.fn.crossplane.io_gotemplates.yaml b/...gotemplating.fn.crossplane.io_inputs.yaml → ...plating.fn.crossplane.io_gotemplates.yaml
@@ -4,22 +4,22 @@ kind: CustomResourceDefinition
 metadata:
   annotations:
     controller-gen.kubebuilder.io/version: v0.13.0
-  name: inputs.gotemplating.fn.crossplane.io
+  name: gotemplates.gotemplating.fn.crossplane.io
 spec:
   group: gotemplating.fn.crossplane.io
   names:
     categories:
     - crossplane
-    kind: Input
-    listKind: InputList
-    plural: inputs
-    singular: input
+    kind: GoTemplate
+    listKind: GoTemplateList
+    plural: gotemplates
+    singular: gotemplate
   scope: Namespaced
   versions:
   - name: v1beta1
     schema:
       openAPIV3Schema:
-        description: Input is used to provide templates to this Function.
+        description: A GoTemplate is used to provide templates to this Function.
         properties:
           apiVersion:
             description: 'APIVersion defines the versioned schema of this representation

diff --git a/template.go b/template.go
@@ -18,7 +18,7 @@ type TemplateGetter interface {
 }
 
 // NewTemplateSourceGetter returns a TemplateGetter based on the cd source
-func NewTemplateSourceGetter(in *v1beta1.Input) (TemplateGetter, error) {
+func NewTemplateSourceGetter(in *v1beta1.GoTemplate) (TemplateGetter, error) {
 	switch in.Source {
 	case v1beta1.InlineSource:
 		return newInlineSource(in)
@@ -47,7 +47,7 @@ func (is *InlineSource) GetTemplates() string {
 	return is.Template
 }
 
-func newInlineSource(in *v1beta1.Input) (*InlineSource, error) {
+func newInlineSource(in *v1beta1.GoTemplate) (*InlineSource, error) {
 	return &InlineSource{
 		Template: in.Inline.Template,
 	}, nil
@@ -58,7 +58,7 @@ func (fs *FileSource) GetTemplates() string {
 	return fs.Template
 }
 
-func newFileSource(in *v1beta1.Input) (*FileSource, error) {
+func newFileSource(in *v1beta1.GoTemplate) (*FileSource, error) {
 	d := in.FileSystem.DirPath
 
 	tmpl, err := readTemplates(d)