crossplane-function-pythonic 0.4.1__tar.gz → 0.5.0__tar.gz

{crossplane_function_pythonic-0.4.1 → crossplane_function_pythonic-0.5.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: crossplane-function-pythonic
-Version: 0.4.1
+Version: 0.5.0
 Summary: A Python centric Crossplane Function
 Project-URL: Documentation, https://github.com/crossplane-contrib/function-pythonic#readme
 Project-URL: Issues, https://github.com/crossplane-contrib/function-pythonic/issues
@@ -83,7 +83,7 @@ kind: Function
 metadata:
   name: function-pythonic
 spec:
-  package: xpkg.upbound.io/crossplane-contrib/function-pythonic:v0.4.1
+  package: xpkg.upbound.io/crossplane-contrib/function-pythonic:v0.4.2
 ```
 
 ### Crossplane V1
@@ -95,7 +95,7 @@ kind: Function
 metadata:
   name: function-pythonic
 spec:
-  package: xpkg.upbound.io/crossplane-contrib/function-pythonic:v0.4.1
+  package: xpkg.upbound.io/crossplane-contrib/function-pythonic:v0.4.2
   runtimeConfigRef:
     name: function-pythonic
 --
@@ -199,6 +199,11 @@ subnet.spec.forProvider.cidrBlock = '10.0.0.0/20'
 ```
 Will generate the appropriate Crossplane Usage resource.
 
+## API Documentation
+
+- [Composite API (`composite.py`)](https://github.com/crossplane-contrib/function-pythonic/blob/main/docs/composite.md)
+- [Protobuf Wrapper API (`protobuf.py`)](https://github.com/crossplane-contrib/function-pythonic/blob/main/docs/protobuf.md)
+
 ## Pythonic access of Protobuf Messages
 
 All Protobuf messages are wrapped by a set of python classes which enable using
@@ -241,6 +246,7 @@ The following functions are provided to create Protobuf structures:
 | List | Create a new Protobuf list |
 | Unknown | Create a new Protobuf unknown placeholder |
 | Yaml | Create a new Protobuf structure from a yaml string |
+| YamlAll | Create a new Protobuf list from a yaml string |
 | Json | Create a new Protobuf structure from a json string |
 | B64Encode | Encode a string into base 64 |
 | B64Decode | Decode a string from base 64 |
@@ -405,25 +411,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
+is obtained 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 ...`
@@ -616,7 +675,7 @@ kind: Function
 metadata:
   name: function-pythonic
 spec:
-  package: xpkg.upbound.io/crossplane-contrib/function-pythonic:v0.4.1
+  package: xpkg.upbound.io/crossplane-contrib/function-pythonic:v0.4.2
   runtimeConfigRef:
     name: function-pythonic
 ---

{crossplane_function_pythonic-0.4.1 → crossplane_function_pythonic-0.5.0}/README.md

@@ -57,7 +57,7 @@ kind: Function
 metadata:
   name: function-pythonic
 spec:
-  package: xpkg.upbound.io/crossplane-contrib/function-pythonic:v0.4.1
+  package: xpkg.upbound.io/crossplane-contrib/function-pythonic:v0.4.2
 ```
 
 ### Crossplane V1
@@ -69,7 +69,7 @@ kind: Function
 metadata:
   name: function-pythonic
 spec:
-  package: xpkg.upbound.io/crossplane-contrib/function-pythonic:v0.4.1
+  package: xpkg.upbound.io/crossplane-contrib/function-pythonic:v0.4.2
   runtimeConfigRef:
     name: function-pythonic
 --
@@ -173,6 +173,11 @@ subnet.spec.forProvider.cidrBlock = '10.0.0.0/20'
 ```
 Will generate the appropriate Crossplane Usage resource.
 
+## API Documentation
+
+- [Composite API (`composite.py`)](https://github.com/crossplane-contrib/function-pythonic/blob/main/docs/composite.md)
+- [Protobuf Wrapper API (`protobuf.py`)](https://github.com/crossplane-contrib/function-pythonic/blob/main/docs/protobuf.md)
+
 ## Pythonic access of Protobuf Messages
 
 All Protobuf messages are wrapped by a set of python classes which enable using
@@ -215,6 +220,7 @@ The following functions are provided to create Protobuf structures:
 | List | Create a new Protobuf list |
 | Unknown | Create a new Protobuf unknown placeholder |
 | Yaml | Create a new Protobuf structure from a yaml string |
+| YamlAll | Create a new Protobuf list from a yaml string |
 | Json | Create a new Protobuf structure from a json string |
 | B64Encode | Encode a string into base 64 |
 | B64Decode | Decode a string from base 64 |
@@ -379,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
+is obtained 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 ...`
@@ -590,7 +649,7 @@ kind: Function
 metadata:
   name: function-pythonic
 spec:
-  package: xpkg.upbound.io/crossplane-contrib/function-pythonic:v0.4.1
+  package: xpkg.upbound.io/crossplane-contrib/function-pythonic:v0.4.2
   runtimeConfigRef:
     name: function-pythonic
 ---

{crossplane_function_pythonic-0.4.1 → crossplane_function_pythonic-0.5.0}/crossplane/pythonic/__about__.py

@@ -1,2 +1,2 @@
 # This is set at build time, using "hatch version"
-__version__ = "0.4.1"
+__version__ = "0.5.0"

{crossplane_function_pythonic-0.4.1 → crossplane_function_pythonic-0.5.0}/crossplane/pythonic/__init__.py

@@ -1,7 +1,7 @@
 
 
 from .composite import BaseComposite
-from .protobuf import append, Map, List, Unknown, Yaml, Json, B64Encode, B64Decode
+from .protobuf import append, Map, List, Unknown, Yaml, YamlAll, Json, B64Encode, B64Decode
 
 __all__ = [
     'BaseComposite',
@@ -10,6 +10,7 @@ __all__ = [
     'List',
     'Unknown',
     'Yaml',
+    'YamlAll',
     'Json',
     'B64Encode',
     'B64Decode',

{crossplane_function_pythonic-0.4.1 → crossplane_function_pythonic-0.5.0}/crossplane/pythonic/command.py

@@ -63,7 +63,7 @@ class Command:
             help='Enable Crossplane V1 compatibility mode',
         )
 
-    def __init__(self, args):
+    def __init__(self, args=None):
         self.args = args
         self.initialize()
 
@@ -79,6 +79,7 @@ class Command:
         logger.setLevel(logging.DEBUG if self.args.debug else logging.INFO)
         # Suppress noisy libraries, these can be overriden using --logger-level
         logging.getLogger('asyncio').setLevel(logging.INFO)
+        logging.getLogger('grpc').setLevel(logging.INFO)
         logging.getLogger('httpcore').setLevel(logging.INFO)
         logging.getLogger('httpx').setLevel(logging.WARNING)
         logging.getLogger('kr8s').setLevel(logging.INFO)

{crossplane_function_pythonic-0.4.1 → crossplane_function_pythonic-0.5.0}/crossplane/pythonic/composite.py

@@ -89,7 +89,7 @@ class 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 @@ 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.parameters = self.request.input.parameters
         self.credentials = Credentials(self.request)
         self.context = self.response.context
         self.environment = self.context['apiextensions.crossplane.io/environment']

{crossplane_function_pythonic-0.4.1 → crossplane_function_pythonic-0.5.0}/crossplane/pythonic/function.py

@@ -17,9 +17,8 @@ logger = logging.getLogger(__name__)
 class FunctionRunner(grpcv1.FunctionRunnerService):
     """A FunctionRunner handles gRPC RunFunctionRequests."""
 
-    def __init__(self, debug=False, renderUnknowns=False, crossplane_v1=False):
+    def __init__(self, renderUnknowns=False, crossplane_v1=False):
         """Create a new FunctionRunner."""
-        self.debug = debug
         self.renderUnknowns = renderUnknowns
         self.crossplane_v1 = crossplane_v1
         self.clazzes = {}
@@ -49,15 +48,13 @@ class FunctionRunner(grpcv1.FunctionRunnerService):
         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
@@ -101,7 +98,7 @@ class FunctionRunner(grpcv1.FunctionRunnerService):
             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)
 
@@ -182,7 +179,7 @@ class FunctionRunner(grpcv1.FunctionRunnerService):
         for _, resource in sorted(entry for entry in composite.resources):
             dependencies = resource.desired._getDependencies
             if dependencies:
-                if self.debug:
+                if composite.logger.isEnabledFor(logging.DEBUG):
                     for destination, source in sorted(dependencies.items()):
                         destination = self.trimFullName(destination)
                         source = self.trimFullName(source)
@@ -278,7 +275,7 @@ class FunctionRunner(grpcv1.FunctionRunnerService):
                     if resource.unknownsFatal or (resource.unknownsFatal is None and composite.unknownsFatal):
                         fatalResources.append(name)
                         fatal = True
-                if self.debug:
+                if composite.logger.isEnabledFor(logging.DEBUG):
                     for destination, source in sorted(unknowns.items()):
                         destination = self.trimFullName(destination)
                         source = self.trimFullName(source)
@@ -319,7 +316,7 @@ class FunctionRunner(grpcv1.FunctionRunnerService):
             message = 'All resources are composed'
             status = True
             result = None
-        if not self.debug and level:
+        if not composite.logger.isEnabledFor(logging.DEBUG) and level:
             level(message)
         composite.conditions.ResourcesComposed(reason, message, status)
         if result:
@@ -378,6 +375,7 @@ class Module:
         self.List = pythonic.List
         self.Unknown = pythonic.Unknown
         self.Yaml = pythonic.Yaml
+        self.YamlAll = pythonic.YamlAll
         self.Json = pythonic.Json
         self.B64Encode = pythonic.B64Encode
         self.B64Decode = pythonic.B64Decode

{crossplane_function_pythonic-0.4.1 → crossplane_function_pythonic-0.5.0}/crossplane/pythonic/grpc.py

@@ -88,7 +88,7 @@ class Command(command.Command):
 
     async def run(self):
         grpc.aio.init_grpc_aio()
-        grpc_runner = function.FunctionRunner(self.args.debug, self.args.render_unknowns, self.args.crossplane_v1)
+        grpc_runner = function.FunctionRunner(self.args.render_unknowns, self.args.crossplane_v1)
         grpc_server = grpc.aio.server()
         grpcv1.add_FunctionRunnerServiceServicer_to_server(grpc_runner, grpc_server)
         if self.args.insecure:

{crossplane_function_pythonic-0.4.1 → crossplane_function_pythonic-0.5.0}/crossplane/pythonic/protobuf.py

@@ -42,6 +42,13 @@ def Yaml(string, readOnly=None):
         string = str(string)
     return Value(None, None, yaml.safe_load(string), readOnly)
 
+def YamlAll(string, readOnly=None):
+    if isinstance(string, (FieldMessage, Value)):
+        if not string:
+            return string
+        string = str(string)
+    return Value(None, None, [document for document in yaml.safe_load_all(string)], readOnly)
+
 def Json(string, readOnly=None):
     if isinstance(string, (FieldMessage, Value)):
         if not string:
@@ -789,8 +796,10 @@ class Value:
     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: