Upgrade to 1.15, mainly adding the extra resources (#5)

knutejoh · web-flow · commit 0ea149bed5a6 · 2024-06-24T23:55:48.000+02:00
Signed-off-by: Knut-Erik Johnsen &lt;abstract@knut-erik.org&gt;
diff --git a/crossplane-crd-model/src/main/resources/kubernetes/apiextensions.crossplane.io_compositeresourcedefinitions.yaml b/crossplane-crd-model/src/main/resources/kubernetes/apiextensions.crossplane.io_compositeresourcedefinitions.yaml
diff --git a/crossplane-crd-model/src/main/resources/kubernetes/apiextensions.crossplane.io_compositionrevisions.yaml b/crossplane-crd-model/src/main/resources/kubernetes/apiextensions.crossplane.io_compositionrevisions.yaml
diff --git a/crossplane-crd-model/src/main/resources/kubernetes/apiextensions.crossplane.io_compositions.yaml b/crossplane-crd-model/src/main/resources/kubernetes/apiextensions.crossplane.io_compositions.yaml
diff --git a/crossplane-crd-model/src/main/resources/kubernetes/apiextensions.crossplane.io_environmentconfigs.yaml b/crossplane-crd-model/src/main/resources/kubernetes/apiextensions.crossplane.io_environmentconfigs.yaml
@@ -2,7 +2,7 @@ apiVersion: apiextensions.k8s.io/v1
 kind: CustomResourceDefinition
 metadata:
   annotations:
-    controller-gen.kubebuilder.io/version: v0.13.0
+    controller-gen.kubebuilder.io/version: v0.14.0
   name: environmentconfigs.apiextensions.crossplane.io
 spec:
   group: apiextensions.crossplane.io
@@ -28,20 +28,26 @@ spec:
           values.
         properties:
           apiVersion:
-            description: 'APIVersion defines the versioned schema of this representation
-              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'
+            description: |-
+              APIVersion defines the versioned schema of this representation 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
           data:
             additionalProperties:
               x-kubernetes-preserve-unknown-fields: true
-            description: The data of this EnvironmentConfig. This may contain any
-              kind of structure that can be serialized into JSON.
+            description: |-
+              The data of this EnvironmentConfig.
+              This may contain any kind of structure that can be serialized into JSON.
             type: object
           kind:
-            description: 'Kind is a string value representing the REST resource this
-              object represents. Servers may infer this from the endpoint the client
-              submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds'
+            description: |-
+              Kind is a string value representing the REST resource this object represents.
+              Servers may infer this from the endpoint the client submits requests to.
+              Cannot be updated.
+              In CamelCase.
+              More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
             type: string
           metadata:
             type: object
diff --git a/crossplane-crd-model/src/main/resources/kubernetes/apiextensions.crossplane.io_usages.yaml b/crossplane-crd-model/src/main/resources/kubernetes/apiextensions.crossplane.io_usages.yaml
@@ -2,7 +2,7 @@ apiVersion: apiextensions.k8s.io/v1
 kind: CustomResourceDefinition
 metadata:
   annotations:
-    controller-gen.kubebuilder.io/version: v0.13.0
+    controller-gen.kubebuilder.io/version: v0.14.0
   name: usages.apiextensions.crossplane.io
 spec:
   group: apiextensions.crossplane.io
@@ -32,14 +32,19 @@ spec:
           resources.
         properties:
           apiVersion:
-            description: 'APIVersion defines the versioned schema of this representation
-              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'
+            description: |-
+              APIVersion defines the versioned schema of this representation 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
           kind:
-            description: 'Kind is a string value representing the REST resource this
-              object represents. Servers may infer this from the endpoint the client
-              submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds'
+            description: |-
+              Kind is a string value representing the REST resource this object represents.
+              Servers may infer this from the endpoint the client submits requests to.
+              Cannot be updated.
+              In CamelCase.
+              More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
             type: string
           metadata:
             type: object
@@ -53,7 +58,9 @@ spec:
                     description: API version of the referent.
                     type: string
                   kind:
-                    description: 'Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds'
+                    description: |-
+                      Kind of the referent.
+                      More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
                     type: string
                   resourceRef:
                     description: Reference to the resource.
@@ -65,12 +72,14 @@ spec:
                     - name
                     type: object
                   resourceSelector:
-                    description: Selector to the resource. This field will be ignored
-                      if ResourceRef is set.
+                    description: |-
+                      Selector to the resource.
+                      This field will be ignored if ResourceRef is set.
                     properties:
                       matchControllerRef:
-                        description: MatchControllerRef ensures an object with the
-                          same controller reference as the selecting object is selected.
+                        description: |-
+                          MatchControllerRef ensures an object with the same controller reference
+                          as the selecting object is selected.
                         type: boolean
                       matchLabels:
                         additionalProperties:
@@ -91,7 +100,9 @@ spec:
                     description: API version of the referent.
                     type: string
                   kind:
-                    description: 'Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds'
+                    description: |-
+                      Kind of the referent.
+                      More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
                     type: string
                   resourceRef:
                     description: Reference to the resource.
@@ -103,12 +114,14 @@ spec:
                     - name
                     type: object
                   resourceSelector:
-                    description: Selector to the resource. This field will be ignored
-                      if ResourceRef is set.
+                    description: |-
+                      Selector to the resource.
+                      This field will be ignored if ResourceRef is set.
                     properties:
                       matchControllerRef:
-                        description: MatchControllerRef ensures an object with the
-                          same controller reference as the selecting object is selected.
+                        description: |-
+                          MatchControllerRef ensures an object with the same controller reference
+                          as the selecting object is selected.
                         type: boolean
                       matchLabels:
                         additionalProperties:
@@ -145,13 +158,15 @@ spec:
                   description: A Condition that may apply to a resource.
                   properties:
                     lastTransitionTime:
-                      description: LastTransitionTime is the last time this condition
-                        transitioned from one status to another.
+                      description: |-
+                        LastTransitionTime is the last time this condition transitioned from one
+                        status to another.
                       format: date-time
                       type: string
                     message:
-                      description: A Message containing details about this condition's
-                        last transition from one status to another, if any.
+                      description: |-
+                        A Message containing details about this condition's last transition from
+                        one status to another, if any.
                       type: string
                     reason:
                       description: A Reason for this condition's last transition from
@@ -162,8 +177,9 @@ spec:
                         False, or Unknown?
                       type: string
                     type:
-                      description: Type of this condition. At most one of each condition
-                        type may apply to a resource at any point in time.
+                      description: |-
+                        Type of this condition. At most one of each condition type may apply to
+                        a resource at any point in time.
                       type: string
                   required:
                   - lastTransitionTime
diff --git a/crossplane-crd-model/src/main/resources/kubernetes/fetch.sh b/crossplane-crd-model/src/main/resources/kubernetes/fetch.sh
@@ -1,6 +1,6 @@
 #!/bin/bash
 
-release="release-1.14"
+release="release-1.15"
 
 apiextensions=$(gh api --jq '.[].name' "/repos/crossplane/crossplane/contents/cluster/crds?ref=${release}" | grep apiextensions)
 
diff --git a/crossplane-function-base/src/main/java/io/crossplane/compositefunctions/base/CrossplaneCompositeFunctionBase.java b/crossplane-function-base/src/main/java/io/crossplane/compositefunctions/base/CrossplaneCompositeFunctionBase.java
@@ -2,6 +2,7 @@
 
 
 import io.crossplane.compositefunctions.protobuf.FunctionRunnerServiceGrpc;
+import io.crossplane.compositefunctions.protobuf.Requirements;
 import io.crossplane.compositefunctions.protobuf.RunFunctionRequest;
 import io.crossplane.compositefunctions.protobuf.RunFunctionResponse;
 import io.crossplane.compositefunctions.protobuf.State;
@@ -32,9 +33,9 @@ public void runFunction(RunFunctionRequest request, StreamObserver<RunFunctionRe
             desiredBuilder.putAllResources(desired.getResourcesMap());
 
             CrossplaneFunctionRequest crossplaneFunctionRequest = new CrossplaneFunctionRequest(request.getObserved(),
-                    request.getDesired());
+                    request.getExtraResourcesMap(),  request.getDesired());
 
-            // request.getExtraResourcesMap(), request.getCredentialsMap()
+            //  request.getCredentialsMap(),
 
             logger.debug("Calling method with implemented logic");
             CrossplaneFunctionResponse crossplaneFunctionResponse = runFunction(crossplaneFunctionRequest);
@@ -46,14 +47,14 @@ public void runFunction(RunFunctionRequest request, StreamObserver<RunFunctionRe
 
             RunFunctionResponse.Builder responseBuilder = RunFunctionResponse.newBuilder();
 
-            /*
+
             if (! crossplaneFunctionResponse.resourceSelectors().isEmpty()) {
                 Requirements requirements = Requirements.newBuilder()
                         .putAllExtraResources(crossplaneFunctionResponse.resourceSelectors())
                         .build();
                 responseBuilder.setRequirements(requirements);
             }
-            */
+
 
             if (! crossplaneFunctionResponse.results().isEmpty()) {
                 responseBuilder.addAllResults(crossplaneFunctionResponse.results());
diff --git a/crossplane-function-base/src/main/java/io/crossplane/compositefunctions/base/CrossplaneFunctionRequest.java b/crossplane-function-base/src/main/java/io/crossplane/compositefunctions/base/CrossplaneFunctionRequest.java
@@ -1,18 +1,20 @@
 package io.crossplane.compositefunctions.base;
 
+import io.crossplane.compositefunctions.protobuf.Resources;
 import io.crossplane.compositefunctions.protobuf.State;
 
 import java.util.Map;
 
 /**
  * Holder for the request from crossplane
  * @param observedState The observedstate of the crossplane resources
+ * @param extraResourcesMap A map of any extra resources requested
  * @param desiredState The sum of previously called functions state. To override, create a new resource with the same name in the response
  */
-public record CrossplaneFunctionRequest(State observedState, State desiredState) {
+public record CrossplaneFunctionRequest(State observedState, Map<String, Resources> extraResourcesMap, State desiredState) {
 
-    //  * @param extraResourcesMap A map of any extra resources requested
+    //  *
     // * @param credentialsMap A map of credentials sent as input
-    // Map<String, Resources> extraResourcesMap,
+    //
     // Map<String, Credentials> credentialsMap
 }
diff --git a/crossplane-function-base/src/main/java/io/crossplane/compositefunctions/base/CrossplaneFunctionResponse.java b/crossplane-function-base/src/main/java/io/crossplane/compositefunctions/base/CrossplaneFunctionResponse.java
@@ -1,5 +1,6 @@
 package io.crossplane.compositefunctions.base;
 
+import io.crossplane.compositefunctions.protobuf.ResourceSelector;
 import io.crossplane.compositefunctions.protobuf.Result;
 
 import java.util.ArrayList;
@@ -10,19 +11,21 @@
 /**
  * Holder for the response to Crossplane
  * @param desiredResources Map of the desired resources
+ * @param resourceSelectors Map of the resource selectors for any extra resources
  * @param results List of the results
  */
 public record CrossplaneFunctionResponse(Map<String, Object> desiredResources,
+                                         Map<String, ResourceSelector> resourceSelectors,
                                          List<Result> results) {
 
-    // @param resourceSelectors Map of the resource selectors for any extra resources
-    // Map<String, ResourceSelector> resourceSelectors,
+    //
+    //
 
 
     /**
      * Create an empty response with all fields initiated
       */
     public CrossplaneFunctionResponse() {
-        this(new HashMap<>(), new ArrayList<>());
+        this(new HashMap<>(), new HashMap<>(), new ArrayList<>());
     }
 }
diff --git a/crossplane-function-springboot-starter/src/main/java/io/crossplane/compositefunctions/starter/conversion/CrossplaneExtraResourcesService.java b/crossplane-function-springboot-starter/src/main/java/io/crossplane/compositefunctions/starter/conversion/CrossplaneExtraResourcesService.java
@@ -2,18 +2,29 @@
 
 import com.google.protobuf.util.JsonFormat;
 
+import io.crossplane.compositefunctions.protobuf.ResourceSelector;
+import io.crossplane.compositefunctions.protobuf.Resources;
+import io.crossplane.compositefunctions.starter.exception.CrossplaneUnexpectedItemsException;
+import io.crossplane.compositefunctions.starter.exception.CrossplaneUnmarshallException;
+import io.fabric8.kubernetes.api.model.HasMetadata;
+import io.fabric8.kubernetes.client.utils.Serialization;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 import org.springframework.stereotype.Component;
 
+import java.util.ArrayList;
+import java.util.List;
+import java.util.Map;
+import java.util.Optional;
+
 
 @Component
 public class CrossplaneExtraResourcesService {
 
     private static final Logger logger = LoggerFactory.getLogger(CrossplaneExtraResourcesService.class);
     private final JsonFormat.Printer printer = JsonFormat.printer();
 
-    /*
+
     public <T> Optional<T> getExtraResource(Map<String, Resources> extraResources, String resourceName, Class<T> clazz) {
         return getExtraResources(extraResources, resourceName, 1, clazz).get(0);
     }
@@ -49,5 +60,5 @@ public Map<String, ResourceSelector> createExtraResourcesSelector(String resourc
         return Map.of(resourceName, resourceSelector);
     }
 
-     */
+
 }
diff --git a/crossplane-protobuf-model/src/main/proto/fetch.sh b/crossplane-protobuf-model/src/main/proto/fetch.sh
@@ -1,6 +1,6 @@
 #!/bin/bash
 
-release="release-1.14"
+release="release-1.15"
 file="run_function.proto"
 gh api   -H "Accept: application/vnd.github.raw+json"  "/repos/crossplane/crossplane/contents/apis/apiextensions/fn/proto/v1beta1/${file}?ref=${release}" > $file
 
diff --git a/crossplane-protobuf-model/src/main/proto/run_function.proto b/crossplane-protobuf-model/src/main/proto/run_function.proto
@@ -62,6 +62,19 @@ message RunFunctionRequest {
   // and that context will be passed to subsequent Functions. Crossplane
   // discards all context returned by the last Function in the pipeline.
   optional google.protobuf.Struct context = 5;
+
+  // Optional extra resources that the Function required.
+  // Note that extra resources is a map to Resources, plural.
+  // The map key corresponds to the key in a RunFunctionResponse's
+  // extra_resources field. If a Function requested extra resources that
+  // did not exist, Crossplane sets the map key to an empty Resources message to
+  // indicate that it attempted to satisfy the request.
+  map<string, Resources> extra_resources = 6;
+}
+
+// Resources represents the state of several Crossplane resources.
+message Resources {
+  repeated Resource items = 1;
 }
 
 // A RunFunctionResponse contains the result of a Composition Function run.
@@ -89,6 +102,9 @@ message RunFunctionResponse {
   // Optional context to be passed to the next Function in the pipeline as part
   // of the RunFunctionRequest. Dropped on the last function in the pipeline.
   optional google.protobuf.Struct context = 4;
+
+  // Requirements that must be satisfied for this Function to run successfully.
+  Requirements requirements = 5;
 }
 
 // RequestMeta contains metadata pertaining to a RunFunctionRequest.
@@ -98,6 +114,29 @@ message RequestMeta {
   string tag = 1;
 }
 
+// Requirements that must be satisfied for a Function to run successfully.
+message Requirements {
+  // Extra resources that this Function requires.
+  // The map key uniquely identifies the group of resources.
+  map<string, ResourceSelector> extra_resources = 1;
+}
+
+// ResourceSelector selects a group of resources, either by name or by label.
+message ResourceSelector {
+  string api_version = 1;
+  string kind = 2;
+
+  oneof match {
+    string match_name = 3;
+    MatchLabels match_labels = 4;
+  }
+}
+
+// MatchLabels defines a set of labels to match resources against.
+message MatchLabels {
+  map<string, string> labels = 1;
+}
+
 // ResponseMeta contains metadata pertaining to a RunFunctionResponse.
 message ResponseMeta {
   // An opaque string identifying the content of the request. Must match the
