Merge pull request #31 from Avarei/refactor/sdk

Refactor/sdk
crossplane-contrib · Jul 13, 2024 · 361836c · 361836c
2 parents 18d7898 + ec7f976
commit 361836c
Show file tree

Hide file tree

Showing 17 changed files with 483 additions and 249 deletions.
diff --git a/Makefile b/Makefile
@@ -59,11 +59,12 @@ PROJECT_DIR := $(dir $(firstword $(MAKEFILE_LIST)))
 .PHONY: generate
 generate: pkl-resolve-hack pkl-resolve
 	go generate ./...
-	pkl eval --working-dir $(PROJECT_DIR)hack/pklcrd -m ../../pkl/crossplane.contrib crd2module.pkl
+	pkl eval --working-dir $(PROJECT_DIR)hack/pklcrd -m ../../pkl/crossplane.contrib crd2module.pkl -p source="package/input/pkl.fn.crossplane.io_pkls.yaml"
+	pkl eval --working-dir $(PROJECT_DIR)hack/pklcrd -m ../../pkl/crossplane.contrib.xrd crd2module.pkl -p source="https://raw.githubusercontent.com/crossplane/crossplane/v1.16.0/cluster/crds/apiextensions.crossplane.io_compositeresourcedefinitions.yaml"
 	pkl eval --working-dir $(PROJECT_DIR)hack/pklcrd -m ../../pkl/crossplane.contrib crd2module-composition-fix.pkl
 	pkl eval --working-dir $(PROJECT_DIR)pkl/crossplane.contrib.example -m crds xrds/ExampleXR.pkl
 	pkl eval --working-dir $(PROJECT_DIR)pkl/crossplane.contrib.example compositions/inline.pkl > $(PROJECT_DIR)example/inline/composition.yaml
-	pkl eval --working-dir $(PROJECT_DIR)pkl/crossplane.contrib.example compositions/uri.pkl > $(PROJECT_DIR)example/full/composition.yaml
+	pkl eval --working-dir $(PROJECT_DIR)pkl/crossplane.contrib.example $(EXAMPLE_PARAM) compositions/uri.pkl > $(PROJECT_DIR)example/full/composition.yaml
 	pkl eval --working-dir $(PROJECT_DIR)pkl/crossplane.contrib.example xrs/inline.pkl > $(PROJECT_DIR)example/inline/xr.yaml
 	pkl eval --working-dir $(PROJECT_DIR)pkl/crossplane.contrib.example xrs/uri.pkl > $(PROJECT_DIR)example/full/xr.yaml
 

diff --git a/example/full/composition.yaml b/example/full/composition.yaml
@@ -15,5 +15,5 @@ spec:
       kind: Pkl
       spec:
         type: uri
-        uri: package://pkg.pkl-lang.org/github.com/crossplane-contrib/function-pkl/[email protected].0#/compositions/steps/full.pkl
+        uri: package://pkg.pkl-lang.org/github.com/crossplane-contrib/function-pkl/[email protected].1#/compositions/steps/full.pkl
     step: pkl-template
diff --git a/example/full/extraresources.yaml b/example/full/extraresources.yaml
@@ -0,0 +1,5 @@
+---
+apiVersion: kubernetes.crossplane.io/v1alpha2
+kind: Object
+metadata:
+  name: required
diff --git a/example/inline/composition.yaml b/example/inline/composition.yaml
@@ -23,14 +23,10 @@ spec:
             resources {
               ["cm-minimal"] = new {
                 resource = new Object {
-                  metadata {
-                    name = "cm-one"
-                  }
                   spec {
                     forProvider {
                       manifest = new ConfigMap {
                         metadata {
-                          name = "cm-minimal"
                           namespace = "crossplane-system"
                         }
                         data {

diff --git a/hack/pklcrd/crd2module.pkl b/hack/pklcrd/crd2module.pkl
@@ -1,6 +1,16 @@
 amends "@k8s.contrib.crd/generate.pkl"
 
-source = "package/input/pkl.fn.crossplane.io_pkls.yaml"
+import "@k8s/apiextensions-apiserver/pkg/apis/apiextensions/v1/CustomResourceDefinition.pkl"
+
+// source = "package/input/pkl.fn.crossplane.io_pkls.yaml"
+
+// These Converters Provide Type Safety on the Object resource. Without them manifest would be of type "Dynamic"
+converters {
+  ["compositeresourcedefinitions.apiextensions.crossplane.io"] {
+    [List("spec", "versions", "version", "schema", "openAPIV3Schema")] = CustomResourceDefinition.JSONSchemaProps
+  }
+}
 
 // The Package references to be used within the new Module
 k8sImportPath = "@k8s" // package://pkg.pkl-lang.org/pkl-k8s/k8s@<version>#
+
diff --git a/internal/function/fn.go b/internal/function/fn.go
@@ -43,7 +43,7 @@ type Function struct {
 
 // RunFunction runs the Function.
 func (f *Function) RunFunction(ctx context.Context, req *fnv1beta1.RunFunctionRequest) (*fnv1beta1.RunFunctionResponse, error) {
-	f.Log.Info("Running function", "tag", req.GetMeta().GetTag())
+	f.Log.Debug("Running function", "tag", req.GetMeta().GetTag())
 
 	rsp := response.To(req, response.DefaultTTL)
 
@@ -101,6 +101,7 @@ func (f *Function) RunFunction(ctx context.Context, req *fnv1beta1.RunFunctionRe
 
 	renderedManifest, err := evaluator.EvaluateOutputText(ctx, moduleSource)
 	if err != nil {
+		f.Log.Debug("Error parsing Pkl file", "error", err)
 		response.Fatal(rsp, errors.Wrap(err, "error while parsing the Pkl file"))
 		return rsp, nil
 	}

diff --git a/internal/function/fn_test.go b/internal/function/fn_test.go
@@ -37,6 +37,14 @@ import (
 var (
 	workdir, _ = os.Getwd()
 	pklPackage = fmt.Sprintf("%s/../../pkl/crossplane.contrib.example", workdir)
+
+	xr                = `{"apiVersion": "example.crossplane.io/v1","kind": "XR","metadata": {"name": "example-xr"},"spec": {}}`
+	xrStatus          = `{"apiVersion": "example.crossplane.io/v1","kind": "XR","status": {"someStatus": "pretty status"}}`
+	environmentConfig = `{"apiextensions.crossplane.io/environment": {"foo": "bar"}, "greetings": "with <3 from function-pkl"}`
+
+	objectWithRequired    = `{"apiVersion": "kubernetes.crossplane.io/v1alpha2","kind": "Object","spec": {"forProvider": {"manifest": {"apiVersion": "v1","kind": "ConfigMap","metadata": {"namespace": "crossplane-system"},"data": {"foo": "example-xr","required": "required"}}}}}`
+	objectWithoutRequired = `{"apiVersion": "kubernetes.crossplane.io/v1alpha2","kind": "Object","spec": {"forProvider": {"manifest": {"apiVersion": "v1","kind": "ConfigMap","metadata": {"namespace": "crossplane-system"},"data": {"foo": "example-xr","required": "i could not find what I needed..."}}}}}`
+	objectMinimal         = `{"apiVersion": "kubernetes.crossplane.io/v1alpha2","kind": "Object","spec": {"forProvider": {"manifest": {"apiVersion": "v1","kind": "ConfigMap","metadata": {"namespace": "crossplane-system"},"data": {"foo": "bar"}}}}}`
 )
 
 func TestRunFunction(t *testing.T) {
@@ -71,14 +79,7 @@ func TestRunFunction(t *testing.T) {
 					}),
 					Observed: &fnv1beta1.State{
 						Composite: &fnv1beta1.Resource{
-							Resource: resource.MustStructJSON(`{
-								"apiVersion": "example.crossplane.io/v1",
-								"kind": "XR",
-								"metadata": {
-									"name": "example-xr"
-								},
-								"spec": {}
-							}`),
+							Resource: resource.MustStructJSON(xr),
 						},
 					},
 				},
@@ -89,30 +90,141 @@ func TestRunFunction(t *testing.T) {
 						Ttl: durationpb.New(response.DefaultTTL),
 					},
 					Desired: &fnv1beta1.State{
-						Composite: &fnv1beta1.Resource{},
 						Resources: map[string]*fnv1beta1.Resource{
 							"cm-minimal": {
-								Resource: resource.MustStructJSON(`{
-									"apiVersion": "kubernetes.crossplane.io/v1alpha2",
-									"kind": "Object",
-									"spec": {
-										"forProvider": {
-											"manifest": {
-												"apiVersion": "v1",
-												"kind": "ConfigMap",
-												"metadata": {
-													"namespace": "crossplane-system"
-												},
-												"data": {
-													"foo": "bar"
-												}
-											}
-										}
-									}
-								}`),
+								Resource: resource.MustStructJSON(objectMinimal),
+							},
+						},
+					},
+				},
+			},
+		},
+		"FullFirstRun": {
+			reason: "The Function should create a full functionResult",
+			args: args{
+				ctx: context.TODO(),
+				req: &fnv1beta1.RunFunctionRequest{
+					Meta: &fnv1beta1.RequestMeta{Tag: "extra"},
+					Input: resource.MustStructObject(&v1beta1.Pkl{
+						Spec: v1beta1.PklSpec{
+							Type: "local",
+							Local: &v1beta1.Local{
+								ProjectDir: pklPackage,
+								File:       pklPackage + "/compositions/steps/full.pkl",
+							},
+						},
+					}),
+					Context: resource.MustStructJSON(environmentConfig),
+					Observed: &fnv1beta1.State{
+						Composite: &fnv1beta1.Resource{
+							Resource: resource.MustStructJSON(xr),
+						},
+					},
+				},
+			},
+			want: want{
+				rsp: &fnv1beta1.RunFunctionResponse{
+					Desired: &fnv1beta1.State{
+						Composite: &fnv1beta1.Resource{
+							Resource: resource.MustStructJSON(xrStatus),
+						},
+						Resources: map[string]*fnv1beta1.Resource{
+							"cm-one": {
+								Resource: resource.MustStructJSON(objectWithoutRequired),
+								Ready:    fnv1beta1.Ready_READY_TRUE,
+							},
+						},
+					},
+					Requirements: &fnv1beta1.Requirements{
+						ExtraResources: map[string]*fnv1beta1.ResourceSelector{
+							"ineed": {
+								ApiVersion: "kubernetes.crossplane.io/v1alpha2",
+								Kind:       "Object",
+								Match: &fnv1beta1.ResourceSelector_MatchName{
+									MatchName: "required",
+								},
 							},
 						},
 					},
+					Meta: &fnv1beta1.ResponseMeta{
+						Tag: "extra",
+						Ttl: &durationpb.Duration{
+							Seconds: 60,
+						},
+					},
+					Context: resource.MustStructJSON(environmentConfig),
+					Results: []*fnv1beta1.Result{
+						{
+							Severity: fnv1beta1.Severity_SEVERITY_NORMAL,
+							Message:  "welcome",
+						},
+					},
+				},
+			},
+		},
+		"FullCantFindRequirement": {
+			reason: "The Function should create a full functionResult",
+			args: args{
+				ctx: context.TODO(),
+				req: &fnv1beta1.RunFunctionRequest{
+					Meta: &fnv1beta1.RequestMeta{Tag: "extra"},
+					Input: resource.MustStructObject(&v1beta1.Pkl{
+						Spec: v1beta1.PklSpec{
+							Type: "local",
+							Local: &v1beta1.Local{
+								ProjectDir: pklPackage,
+								File:       pklPackage + "/compositions/steps/full.pkl",
+							},
+						},
+					}),
+					Context: resource.MustStructJSON(environmentConfig),
+					Observed: &fnv1beta1.State{
+						Composite: &fnv1beta1.Resource{
+							Resource: resource.MustStructJSON(xr),
+						},
+					},
+					ExtraResources: map[string]*fnv1beta1.Resources{
+						"ineed": {},
+					},
+				},
+			},
+			want: want{
+				rsp: &fnv1beta1.RunFunctionResponse{
+					Desired: &fnv1beta1.State{
+						Composite: &fnv1beta1.Resource{
+							Resource: resource.MustStructJSON(xrStatus),
+						},
+						Resources: map[string]*fnv1beta1.Resource{
+							"cm-one": {
+								Resource: resource.MustStructJSON(objectWithoutRequired),
+								Ready:    fnv1beta1.Ready_READY_TRUE,
+							},
+						},
+					},
+					Requirements: &fnv1beta1.Requirements{
+						ExtraResources: map[string]*fnv1beta1.ResourceSelector{
+							"ineed": {
+								ApiVersion: "kubernetes.crossplane.io/v1alpha2",
+								Kind:       "Object",
+								Match: &fnv1beta1.ResourceSelector_MatchName{
+									MatchName: "required",
+								},
+							},
+						},
+					},
+					Meta: &fnv1beta1.ResponseMeta{
+						Tag: "extra",
+						Ttl: &durationpb.Duration{
+							Seconds: 60,
+						},
+					},
+					Context: resource.MustStructJSON(environmentConfig),
+					Results: []*fnv1beta1.Result{
+						{
+							Severity: fnv1beta1.Severity_SEVERITY_NORMAL,
+							Message:  "welcome",
+						},
+					},
 				},
 			},
 		},
@@ -169,36 +281,12 @@ func TestRunFunction(t *testing.T) {
 				rsp: &fnv1beta1.RunFunctionResponse{
 					Desired: &fnv1beta1.State{
 						Composite: &fnv1beta1.Resource{
-							Resource: resource.MustStructJSON(`{
-								"apiVersion": "example.crossplane.io/v1",
-								"kind": "XR",
-								"status": {
-									"someStatus": "pretty status"
-								}
-							}`),
+							Resource: resource.MustStructJSON(xrStatus),
 						},
 						Resources: map[string]*fnv1beta1.Resource{
 							"cm-one": {
-								Resource: resource.MustStructJSON(`{
-									"apiVersion": "kubernetes.crossplane.io/v1alpha2",
-									"kind": "Object",
-									"spec": {
-										"forProvider": {
-											"manifest": {
-												"apiVersion": "v1",
-												"kind": "ConfigMap",
-												"metadata": {
-													"namespace": "crossplane-system"
-												},
-												"data": {
-													"foo": "example-xr",
-													"required": "required"
-												}
-											}
-										}
-									}
-								}`),
-								Ready: fnv1beta1.Ready_READY_TRUE,
+								Resource: resource.MustStructJSON(objectWithRequired),
+								Ready:    fnv1beta1.Ready_READY_TRUE,
 							},
 						},
 					},
@@ -219,12 +307,7 @@ func TestRunFunction(t *testing.T) {
 							Seconds: 60,
 						},
 					},
-					Context: resource.MustStructJSON(`{
-						"apiextensions.crossplane.io/environment": {
-							"foo": "bar"
-						},
-						"greetings": "with <3 from function-pkl"
-					}`),
+					Context: resource.MustStructJSON(environmentConfig),
 					Results: []*fnv1beta1.Result{
 						{
 							Severity: fnv1beta1.Severity_SEVERITY_NORMAL,
@@ -250,13 +333,7 @@ func TestRunFunction(t *testing.T) {
 					}),
 					Desired: &fnv1beta1.State{
 						Composite: &fnv1beta1.Resource{
-							Resource: resource.MustStructJSON(`{
-								"apiVersion": "example.crossplane.io/v1",
-								"kind": "XR",
-								"status": {
-									"someStatus": "pretty status"
-								}
-							}`),
+							Resource: resource.MustStructJSON(xrStatus),
 						},
 					},
 				},
@@ -265,13 +342,7 @@ func TestRunFunction(t *testing.T) {
 				rsp: &fnv1beta1.RunFunctionResponse{
 					Desired: &fnv1beta1.State{
 						Composite: &fnv1beta1.Resource{
-							Resource: resource.MustStructJSON(`{
-								"apiVersion": "example.crossplane.io/v1",
-								"kind": "XR",
-								"status": {
-									"someStatus": "pretty status"
-								}
-							}`),
+							Resource: resource.MustStructJSON(xrStatus),
 						},
 					},
 					Results: []*fnv1beta1.Result{

diff --git a/internal/pkl/reader/crossplane_reader.go b/internal/pkl/reader/crossplane_reader.go
@@ -92,6 +92,7 @@ func (f *CrossplaneReader) BaseRead(url url.URL) ([]byte, error) {
 			return nil, err
 		}
 
+		f.Log.Debug("compositionRequest", "request", requestYaml)
 		return requestYaml, nil
 	default:
 		return nil, fmt.Errorf("unsupported path")

diff --git a/pkl/crossplane.contrib.example/compositions/steps/event.pkl b/pkl/crossplane.contrib.example/compositions/steps/event.pkl
@@ -20,7 +20,7 @@ desired = request.desired
 
 results {
   new {
-    severity = SEVERITY_WARNING
+    severity = "Warning"
     message = "I am an Event from Pkl!"
   }
 }
diff --git a/pkl/crossplane.contrib.example/compositions/steps/full.pkl b/pkl/crossplane.contrib.example/compositions/steps/full.pkl
@@ -57,13 +57,13 @@ desired {
           }
         }
       }
-      ready = READY_TRUE
+      ready = true
     }
   }
 }
 results {
   new {
-    severity = SEVERITY_NORMAL
+    severity = "Normal"
     message = "welcome"
   }
 }