crossplane-function-pythonic 0.1.3__tar.gz → 0.1.4__tar.gz

{crossplane_function_pythonic-0.1.3 → crossplane_function_pythonic-0.1.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: crossplane-function-pythonic
-Version: 0.1.3
+Version: 0.1.4
 Summary: A Python centric Crossplane Function
 Project-URL: Documentation, https://github.com/fortra/function-pythonic#readme
 Project-URL: Issues, https://github.com/fortra/function-pythonic/issues
@@ -227,8 +227,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:
@@ -238,6 +238,7 @@ The BaseComposite also provides access to the following Crossplane Function leve
 | self.request | Message | Low level direct access to the RunFunctionRequest message |
 | self.response | Message | Low level direct access to the RunFunctionResponse message |
 | self.logger | Logger | Python logger to log messages to the running function stdout |
+| self.parameters | Map | The configured step parameters |
 | self.ttl | Integer | Get or set the response TTL, in seconds |
 | self.credentials | Credentials | The request credentials |
 | self.context | Map | The response context, initialized from the request context |
@@ -576,6 +577,41 @@ Secrets can also be used in an identical manner as ConfigMaps by enabling the
 `--packages-secrets` command line option. Secrets permissions need to be
 added to the above RBAC configuration.
 
+## Step Parameters
+
+Step specific parameters can be configured to be used by the composite
+implementation. This is useful when setting the composite to the python class.
+For example:
+```yaml
+apiVersion: v1
+kind: ConfigMap
+metadata:
+  namespace: crossplane-system
+  name: example-pythonic
+  labels:
+    function-pythonic.package: example.pythonic
+data:
+  features.py: |
+    from crossplane.pythonic import BaseComposite
+    class GreetingComposite(BaseComposite):
+        def compose(self):
+            cm = self.resources.ConfigMap('v1', 'ConfigMap')
+            cm.data.greeting = f"Hello, {self.parameters.who}!"
+```
+```yaml
+    ...
+    - step: pythonic
+    functionRef:
+      name: function-pythonic
+    input:
+      apiVersion: pythonic.fn.fortra.com/v1alpha1
+      kind: Composite
+      parameters:
+        who: World
+      composite: example.pythonic.features.GreetingComposite
+    ...
+```
+
 ## Filing System Packages
 
 Composition Composite implementations can be coded in a stand alone python files

{crossplane_function_pythonic-0.1.3 → crossplane_function_pythonic-0.1.4}/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:
@@ -214,6 +214,7 @@ The BaseComposite also provides access to the following Crossplane Function leve
 | self.request | Message | Low level direct access to the RunFunctionRequest message |
 | self.response | Message | Low level direct access to the RunFunctionResponse message |
 | self.logger | Logger | Python logger to log messages to the running function stdout |
+| self.parameters | Map | The configured step parameters |
 | self.ttl | Integer | Get or set the response TTL, in seconds |
 | self.credentials | Credentials | The request credentials |
 | self.context | Map | The response context, initialized from the request context |
@@ -552,6 +553,41 @@ Secrets can also be used in an identical manner as ConfigMaps by enabling the
 `--packages-secrets` command line option. Secrets permissions need to be
 added to the above RBAC configuration.
 
+## Step Parameters
+
+Step specific parameters can be configured to be used by the composite
+implementation. This is useful when setting the composite to the python class.
+For example:
+```yaml
+apiVersion: v1
+kind: ConfigMap
+metadata:
+  namespace: crossplane-system
+  name: example-pythonic
+  labels:
+    function-pythonic.package: example.pythonic
+data:
+  features.py: |
+    from crossplane.pythonic import BaseComposite
+    class GreetingComposite(BaseComposite):
+        def compose(self):
+            cm = self.resources.ConfigMap('v1', 'ConfigMap')
+            cm.data.greeting = f"Hello, {self.parameters.who}!"
+```
+```yaml
+    ...
+    - step: pythonic
+    functionRef:
+      name: function-pythonic
+    input:
+      apiVersion: pythonic.fn.fortra.com/v1alpha1
+      kind: Composite
+      parameters:
+        who: World
+      composite: example.pythonic.features.GreetingComposite
+    ...
+```
+
 ## Filing System Packages
 
 Composition Composite implementations can be coded in a stand alone python files

{crossplane_function_pythonic-0.1.3 → crossplane_function_pythonic-0.1.4}/crossplane/pythonic/composite.py

@@ -10,7 +10,7 @@ _notset = object()
 
 
 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,6 +24,10 @@ class BaseComposite:
         )
         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.credentials = Credentials(self.request)
         self.context = self.response.context
         self.environment = self.context['apiextensions.crossplane.io/environment']
@@ -43,7 +47,6 @@ class BaseComposite:
         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
@@ -66,6 +69,16 @@ class BaseComposite:
         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
@@ -189,7 +202,7 @@ class Resource:
         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
@@ -554,38 +567,6 @@ class Condition(protobuf.ProtobufValue):
         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_function_pythonic-0.1.3 → crossplane_function_pythonic-0.1.4}/crossplane/pythonic/function.py

@@ -47,10 +47,12 @@ class FunctionRunner(grpcv1.FunctionRunnerService):
         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 @@ class FunctionRunner(grpcv1.FunctionRunnerService):
             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_function_pythonic-0.1.3 → crossplane_function_pythonic-0.1.4}/crossplane/pythonic/protobuf.py

@@ -336,9 +336,12 @@ class MapMessage:
             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 @@ class RepeatedMessage:
             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: