Rework how self.connection and resource.connection are implemented

Author: Patrick J. McNerthney

README.md

@@ -203,8 +203,8 @@ The BaseComposite class provides the following fields for manipulating the Compo
 | self.spec | Map | The composite observed spec |
 | self.status | Map | The composite desired and observed status, read from observed if not in desired |
 | self.conditions | Conditions | The composite desired and observed conditions, read from observed if not in desired |
-| self.connection | Connection | The composite desired and observed connection detials, read from observed if not in desired |
 | self.events | Events | Returned events against the Composite and optionally on the Claim |
+| self.connection | Connection | The composite desired and observed connection detials, read from observed if not in desired |
 | self.ready | Boolean | The composite desired ready state |
 
 The BaseComposite also provides access to the following Crossplane Function level features:

crossplane/pythonic/composite.py

@@ -10,7 +10,7 @@
 
 
 class BaseComposite:
-    def __init__(self, request, logger):
+    def __init__(self, request, parameters, logger):
         self.request = protobuf.Message(None, 'request', request.DESCRIPTOR, request, 'Function Request')
         response = fnv1.RunFunctionResponse(
             meta=fnv1.ResponseMeta(
@@ -24,7 +24,7 @@ def __init__(self, request, logger):
         )
         self.response = protobuf.Message(None, 'response', response.DESCRIPTOR, response)
         self.logger = logger
-        self.parameters = self.request.input.parameters
+        self.parameters = protobuf.Value(None, None, parameters, 'self.parameters')
         self.credentials = Credentials(self.request)
         self.context = self.response.context
         self.environment = self.context['apiextensions.crossplane.io/environment']
@@ -44,7 +44,6 @@ def __init__(self, request, logger):
         self.spec = self.observed.spec
         self.status = self.desired.status
         self.conditions = Conditions(observed, self.response)
-        self.connection = Connection(observed, desired)
         self.events = Events(self.response)
 
     @property
@@ -67,6 +66,15 @@ def ttl(self, ttl):
         else:
             raise ValueError('ttl must be an int or float')
 
+    @property
+    def connection(self):
+        return self.response.desired.composite.connection_details
+
+    @connection.setter
+    def connection(self, connection):
+        for key, value in connection:
+            self.response.desired.composite.connection_details[key] = value
+
     @property
     def ready(self):
         ready = self.desired._parent.ready
@@ -190,7 +198,7 @@ def __init__(self, composite, name):
         self.observed = observed.resource
         self.desired = desired.resource
         self.conditions = Conditions(observed)
-        self.connection = Connection(observed)
+        self.connection = observed.connection_details
         self.unknownsFatal = None
         self.autoReady = None
         self.usages = None
@@ -555,38 +563,6 @@ def _find_condition(self, create=False):
         return self._conditions._response.conditions.append(condition)
 
 
-class Connection:
-    def __init__(self, observed, desired=None):
-        self.__dict__['_observed'] = observed
-        self.__dict__['_desired'] = desired
-
-    def __bool__(self):
-        if self._desired is not None and len(self._desired.connection_details) > 0:
-            return True
-        if self._observed is not None and len(self._observed.connection_details) > 0:
-            return True
-        return False
-
-    def __getattr__(self, key):
-        return self[key]
-
-    def __getitem__(self, key):
-        value = None
-        if self._desired is not None and key in self._desired.connection_details:
-            value = self._desired.connection_details[key]
-        if value is None and key in self._observed.connection_details:
-            value = self._observed.connection_details[key]
-        return value
-
-    def __setattr__(self, key, value):
-        self[key] = value
-
-    def __setitem__(self, key, value):
-        if self._desired is None:
-            raise ValueError('Connection is read only')
-        self._desired.connection_details[key] = value
-
-
 class Events:
     def __init__(self, response):
         self._results = response.results

crossplane/pythonic/function.py

@@ -47,11 +47,13 @@ async def run_function(self, request):
         if composite['apiVersion'] == '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"')
+            parameters = composite['spec'].fields.get('parameters', {})
             composite = composite['spec']['composite']
         else:
             if 'composite' not in request.input:
                 return self.fatal(request, logger, 'Missing input "composite"')
             composite = request.input['composite']
+            parameters = request.input.fields.get('parameters', {})
 
         # Ideally this is something the Function API provides
         if 'step' in request.input:
@@ -94,7 +96,7 @@ async def run_function(self, request):
             self.clazzes[composite] = clazz
 
         try:
-            composite = clazz(request, logger)
+            composite = clazz(request, parameters, logger)
         except Exception as e:
             return self.fatal(request, logger, 'Instantiate', e)
 

package/composite-definition.yaml

@@ -20,6 +20,9 @@ spec:
           spec:
             type: object
             properties:
+              parameters:
+                type: object
+                x-kubernetes-preserve-unknown-fields: true
               composite:
                 type: string
                 description: 'A Python module that defines a class with the signature: class Composite(BaseComposite)'

tests/fn_cases/instantiate-exception.yaml

@@ -3,8 +3,8 @@ request:
     step: pytest
     composite: |
       class InstantiateException(BaseComposite):
-        def __init__(self, request, logger):
-          super(InstantiateException, self).__init__(request, logger)
+        def __init__(self, request, parameters, logger):
+          super(InstantiateException, self).__init__(request, parameters, logger)
           foo = bar
 
 response: