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, single_use, logger):
         self.request = protobuf.Message(None, 'request', request.DESCRIPTOR, request, 'Function Request')
         response = fnv1.RunFunctionResponse(
             meta=fnv1.ResponseMeta(
@@ -24,7 +24,10 @@ def __init__(self, request, logger):
         )
         self.response = protobuf.Message(None, 'response', response.DESCRIPTOR, response)
         self.logger = logger
-        self.parameters = self.request.input.parameters
+        if single_use:
+            self.parameters = self.request.observed.composite.resource.spec.parameters
+        else:
+            self.parameters = self.request.input.parameters
         self.credentials = Credentials(self.request)
         self.context = self.response.context
         self.environment = self.context['apiextensions.crossplane.io/environment']
@@ -44,7 +47,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 +69,16 @@ 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):
+        self.response.desired.composite.connection_details()
+        for key, value in connection:
+            self.response.desired.composite.connection_details[key] = value
+
     @property
     def ready(self):
         ready = self.desired._parent.ready
@@ -190,7 +202,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 +567,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,10 +47,12 @@ 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"')
+            single_use = True
             composite = composite['spec']['composite']
         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
@@ -94,7 +96,7 @@ async def run_function(self, request):
             self.clazzes[composite] = clazz
 
         try:
-            composite = clazz(request, logger)
+            composite = clazz(request, single_use, logger)
         except Exception as e:
             return self.fatal(request, logger, 'Instantiate', e)
 

crossplane/pythonic/protobuf.py

@@ -336,9 +336,12 @@ def __setitem__(self, key, message):
             message = message._value
         elif isinstance(message, Value):
             message = message._raw
-        if self._field.type == self._field.TYPE_BYTES and isinstance(message, str):
-            message = message.encode('utf-8')
-        self._messages[key] = message
+        if message is _Unknown:
+            self._messages.pop(key, None)
+        else:
+            if self._field.type == self._field.TYPE_BYTES and isinstance(message, str):
+                message = message.encode('utf-8')
+            self._messages[key] = message
         self._cache.pop(key, None)
 
     def __delattr__(self, key):
@@ -477,13 +480,18 @@ def __setitem__(self, key, message):
             message = message._value
         elif isinstance(message, Value):
             message = message._raw
-        if self._field.type == self._field.TYPE_BYTES and isinstance(message, str):
-            message = message.encode('utf-8')
-        if key >= len(self._messages):
-            self._messages.append(message)
+        if message is _Unknown:
+            if key < len(self._messages):
+                self._messages.pop(key)
+                self._cache.clear()
         else:
-            self._messages[key] = message
-        self._cache.pop(key, None)
+            if self._field.type == self._field.TYPE_BYTES and isinstance(message, str):
+                message = message.encode('utf-8')
+            if key >= len(self._messages):
+                self._messages.append(message)
+            else:
+                self._messages[key] = message
+            self._cache.pop(key, None)
 
     def __delitem__(self, key):
         if self._readOnly:

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/connection.yaml

@@ -0,0 +1,55 @@
+request:
+  observed:
+    resources:
+      AccessKey:
+        connection_details:
+          username: access-key-username
+          password: access-key-password
+  input:
+    step: pytest
+    parameters:
+      suffix: test
+    composite: |
+      class Test(BaseComposite):
+        def compose(self):
+          user = self.resources.User('iam.aws.crossplane.io/v1beta1', 'User')
+          user.externalName = 'pmcnerthney-test'
+          user.spec.forProvider = {}
+          key = self.resources.AccessKey('iam.aws.crossplane.io/v1beta1', 'AccessKey')
+          key.spec.forProvider.userName = user.externalName
+          key.spec.writeConnectionSecretToRef.namespace = 'default'
+          key.spec.writeConnectionSecretToRef.name = 'accesskey-test'
+          self.connection.constant = 'constant-test'
+          self.connection.parameter = self.parameters.suffix
+          for name, value in key.connection:
+            self.connection[f"{name}-{self.parameters.suffix}"] = value
+          self.connection.client_secret = key.connection.client_secret
+
+response:
+  desired:
+    composite:
+      connection_details:
+        constant: constant-test
+        parameter: test
+        password-test: access-key-password
+        username-test: access-key-username
+    resources:
+      User:
+        resource:
+          apiVersion: iam.aws.crossplane.io/v1beta1
+          kind: User
+          metadata:
+            annotations:
+              crossplane.io/external-name: pmcnerthney-test
+          spec:
+            forProvider: {}
+      AccessKey:
+        resource:
+          apiVersion: iam.aws.crossplane.io/v1beta1
+          kind: AccessKey
+          spec:
+            forProvider:
+              userName: pmcnerthney-test
+            writeConnectionSecretToRef:
+              namespace: default
+              name: accesskey-test

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, single_use, logger):
+          super(InstantiateException, self).__init__(request, single_use, logger)
           foo = bar
 
 response:

tests/fn_cases/parameters.yaml

@@ -0,0 +1,20 @@
+request:
+  input:
+    step: pytest
+    parameters:
+      hello: world
+    composite: |
+      class Composite(BaseComposite):
+        def compose(self):
+          cm = self.resources.ConfigMap('v1', 'ConfigMap')
+          cm.data = self.parameters
+
+response:
+  desired:
+    resources:
+      ConfigMap:
+        resource:
+          apiVersion: v1
+          kind: ConfigMap
+          data:
+            hello: world

tests/fn_cases/usages-namespaced.yaml

@@ -0,0 +1,72 @@
+request:
+  observed:
+    composite:
+      resource:
+        metadata:
+          namespace: default
+          name: usages-test
+    resources:
+      VPC:
+        resource:
+          metadata:
+            name: pytest-0123456
+          status:
+            atProvider:
+              vpcId: vpc-0123456789
+      SubnetA:
+        resource:
+          metadata:
+            name: pytest-1234567
+  input:
+    step: pytest
+    composite: |
+      class UsagesComposite(BaseComposite):
+        def compose(self):
+          vpc = self.resources.VPC('ec2.aws.crossplane.io/v1beta1', 'VPC')
+          vpc.spec.forProvider.region = 'us-east-1'
+          vpc.spec.forProvider.cidrBlock = '10.0.0.0/16'
+          subnet = self.resources.SubnetA('ec2.aws.crossplane.io/v1beta1', 'Subnet')
+          subnet.usages = True
+          subnet.spec.forProvider.region = 'us-east-1'
+          subnet.spec.forProvider.vpcId = vpc.status.atProvider.vpcId
+          subnet.spec.forProvider.availabilityZone = 'us-east-1a'
+          subnet.spec.forProvider.cidrBlock = '10.0.0.0/20'
+
+response:
+  desired:
+    resources:
+      VPC:
+        resource:
+          apiVersion: ec2.aws.crossplane.io/v1beta1
+          kind: VPC
+          spec:
+            forProvider:
+              region: us-east-1
+              cidrBlock: 10.0.0.0/16
+      SubnetA:
+        resource:
+          apiVersion: ec2.aws.crossplane.io/v1beta1
+          kind: Subnet
+          spec:
+            forProvider:
+              region: us-east-1
+              vpcId: vpc-0123456789
+              availabilityZone: us-east-1a
+              cidrBlock: 10.0.0.0/20
+      SubnetA_VPC_pytest-0123456:
+        resource:
+          apiVersion: protection.crossplane.io/v1beta1
+          kind: Usage
+          spec:
+            reason: spec.forProvider.vpcId = status.atProvider.vpcId
+            replayDeletion: true
+            by:
+              apiVersion: ec2.aws.crossplane.io/v1beta1
+              kind: Subnet
+              resourceRef:
+                name: pytest-1234567
+            of:
+              apiVersion: ec2.aws.crossplane.io/v1beta1
+              kind: VPC
+              resourceRef:
+                name: pytest-0123456