Remove single use XRD and Composition, Crossplane does not like them in function packages

Signed-off-by: Patrick J. McNerthney <pat@mcnerthney.com>

Author: iciclespider

.github/workflows/ci.yaml

@@ -15,14 +15,14 @@ on:
 env:
   # Common versions
   PYTHON_VERSION: '3.14.0' # TODO: Used?
-  HATCH_VERSION: '1.14.2'
+  HATCH_VERSION: 'v1.29.0'
   DOCKER_BUILDX_VERSION: 'v0.26.1'
 
   # These environment variables are important to the Crossplane CLI install.sh
   # script. They determine what version it installs.
   XP_CHANNEL: stable
   # v2.2.0 does not allow functions to include anything but CRDs.
-  XP_VERSION: v2.1.0
+  XP_VERSION: v2.2.0
 
   # This CI job will automatically push new builds to xpkg.upbound.io if the
   # XPKG_ACCESS_ID and XPKG_TOKEN secrets are set in the GitHub respository (or
@@ -52,8 +52,8 @@ jobs:
   #       with:
   #         python-version: ${{ env.PYTHON_VERSION }}
 
-  #     - name: Setup Hatch
-  #       run: pipx install hatch==${{ env.HATCH_VERSION }}
+  #     - name: Install Hatch
+  #       uses: pypa/hatch@$hatch-{{ env.HATCH_VERSION }}
 
   #     - name: Lint
   #       run: hatch run lint:check
@@ -69,8 +69,8 @@ jobs:
       with:
         python-version: ${{ env.PYTHON_VERSION }}
 
-    - name: Setup Hatch
-      run: pipx install hatch==${{ env.HATCH_VERSION }}
+    - name: Install Hatch
+      uses: pypa/hatch@hatch-${{ env.HATCH_VERSION }}
 
     - name: Run Unit Tests
       run: hatch run test:ci
@@ -102,8 +102,8 @@ jobs:
         with:
           python-version: ${{ env.PYTHON_VERSION }}
 
-      - name: Setup Hatch
-        run: pipx install hatch==${{ env.HATCH_VERSION }}
+      - name: Install Hatch
+        uses: pypa/hatch@hatch-${{ env.HATCH_VERSION }}
 
       # If a version wasn't explicitly passed as a workflow_dispatch input we
       # default to version v0.0.0+<git-commit-date>-<git-short-sha>, for example
@@ -205,8 +205,8 @@ jobs:
           name: dist
           path: dist
 
-      - name: Setup Hatch
-        run: pipx install hatch==${{ env.HATCH_VERSION }}
+      - name: Install Hatch
+        uses: pypa/hatch@hatch-${{ env.HATCH_VERSION }}
 
       - name: Publish to PyPI
         env:

README.md

@@ -385,25 +385,78 @@ optionally to the Claim.
 | Result.message | String | Human-readable details about the result |
 | Result.claim | Boolean | Also apply the result to the claim |
 
-## Single use Composites
+## Inlined Composites
 
 Tired of creating a CompositeResourceDefinition, a Composition, and a Composite
-just to run that Composition once in a single use or initialize task?
+just to run that Composition once in a setup or initialize task?
 
-function-pythonic installs a `Composite` CompositeResourceDefinition that enables
-creating such tasks using a single Composite resource:
+function-pythonic supports "inlined" Compositions, where the python module
+from a field in the Composite's spec.
 ```yaml
-apiVersion: pythonic.fn.crossplane.io/v1alpha1
-kind: Composite
+apiVersion: inlined.example.org/v1alpha1
+kind: Step
 metadata:
-  name: composite-example
+  name: inlined-example
 spec:
   composite: |
     class HelloComposite(BaseComposite):
       def compose(self):
-        self.status.composite = 'Hello, World!'
+        self.status.step = 'Hello, World!'
+```
+The CompositeResourceDefinition and Composition to support the above example:
+```yaml
+apiVersion: apiextensions.crossplane.io/v1
+kind: CompositeResourceDefinition
+metadata:
+  name: inlined.example.org/v1alpha1
+spec:
+  group: inlined.example.org
+  names:
+    kind: Step
+    plural: steps
+  defaultCompositionRef:
+    name: steps.inlined.example.org
+  versions:
+  - name: v1alpha1
+    served: true
+    referenceable: true
+    schema:
+      openAPIV3Schema:
+        type: object
+        properties:
+          spec:
+            type: object
+            properties:
+              composite:
+                type: string
+                description: 'A Python module that defines a class with the signature: class Composite(BaseComposite)'
+            required:
+            - composite
+          status:
+            type: object
+            properties:
+              composite:
+                x-kubernetes-preserve-unknown-fields: true
+```
+```yaml
+apiVersion: apiextensions.crossplane.io/v1
+kind: Composition
+metadata:
+  name: steps.inlined.example.org
+spec:
+  compositeTypeRef:
+    apiVersion: inlined.example.org/v1alpha1
+    kind: Step
+  mode: Pipeline
+  pipeline:
+  - step: inlined
+    functionRef:
+      name: function-pythonic
+    input:
+      apiVersion: pythonic.fn.crossplane.io/v1alpha1
+      kind: Composite
+      inlined: composite
 ```
-
 ## Quick Start Development
 
 function-pythonic includes a pure python implementation of the `crossplane render ...`

crossplane/pythonic/composite.py

@@ -89,7 +89,7 @@ def __set__(self, composite, ready):
 
 
 class BaseComposite:
-    def __init__(self, crossplane_v1, request, single_use, logger):
+    def __init__(self, crossplane_v1, request, logger):
         self.crossplane_v1 = crossplane_v1
         self.request = protobuf.Message(None, 'request', request.DESCRIPTOR, request, 'Function Request')
         response = fnv1.RunFunctionResponse(
@@ -104,10 +104,7 @@ def __init__(self, crossplane_v1, request, single_use, logger):
         )
         self.response = protobuf.Message(None, 'response', response.DESCRIPTOR, response)
         self.logger = logger
-        if single_use:
-            self.parameters = self.request.observed.composite.resource.spec.parameters
-        else:
-            self.parameters = self.request.input.parameters
+        self.parameters = self.request.input.parameters
         self.credentials = Credentials(self.request)
         self.context = self.response.context
         self.environment = self.context['apiextensions.crossplane.io/environment']

crossplane/pythonic/function.py

@@ -48,15 +48,13 @@ async def run_function(self, request):
         name.append(composite['metadata']['name'])
         logger = logging.getLogger('.'.join(name))
 
-        if composite['apiVersion'] in ('pythonic.crossplane.io/v1alpha1', 'pythonic.fortra.com/v1alpha1') and composite['kind'] == 'Composite':
-            if 'spec' not in composite or 'composite' not in composite['spec']:
-                return self.fatal(request, logger, 'Missing spec "composite"')
-            single_use = True
-            composite = composite['spec']['composite']
+        if 'inlined' in request.input and request.input['inlined']:
+            if 'spec' not in composite or request.input['inlined'] not in composite['spec']:
+                return self.fatal(request, logger, f"Missing inlined spec.{request.input['inlined']}")
+            composite = composite['spec'][request.input['inlined']]
         else:
             if 'composite' not in request.input:
                 return self.fatal(request, logger, 'Missing input "composite"')
-            single_use = False
             composite = request.input['composite']
 
         # Ideally this is something the Function API provides
@@ -100,7 +98,7 @@ async def run_function(self, request):
             self.clazzes[composite] = clazz
 
         try:
-            composite = clazz(self.crossplane_v1, request, single_use, logger)
+            composite = clazz(self.crossplane_v1, request, logger)
         except Exception as e:
             return self.fatal(request, logger, 'Instantiate', e)
 

crossplane/pythonic/protobuf.py

@@ -796,8 +796,10 @@ def __len__(self):
     def __contains__(self, item):
         match self._kind:
             case 'struct_value':
+                item = self._validate_key(item)
                 return item in self._value.struct_value.fields or item in self._unknowns
             case 'Struct':
+                item = self._validate_key(item)
                 return item in self._value.fields or item in self._unknowns
             case 'list_value' | 'ListValue':
                 for value in self: