Make the --pip-install and --packages dependencies optional,

allow any class name that subclasses BaseComposite.

Author: Patrick J. McNerthney

Dockerfile

@@ -4,12 +4,12 @@ COPY dist/*.whl /root
 WORKDIR /
 RUN \
   set -eux && \
-  pip install --root-user-action ignore --no-build-isolation /root/*.whl && \
+  pip install --root-user-action ignore --no-build-isolation $(echo /root/*.whl)[packages,pip-install] && \
   rm -rf /root/*.whl /root/.cache && \
   groupadd --gid 2000 pythonic && \
   useradd --uid 2000 --gid pythonic --home-dir /opt/pythonic --create-home --shell /usr/sbin/nologin pythonic
 
 USER pythonic:pythonic
 WORKDIR /opt/pythonic
 EXPOSE 9443
-ENTRYPOINT ["python", "-m", "crossplane.pythonic.main"]
+ENTRYPOINT ["function-pythonic"]

README.md

@@ -28,7 +28,7 @@ spec:
       apiVersion: pythonic.fn.crossplane.io/v1beta1
       kind: Composite
       composite: |
-        class Composite(BaseComposite):
+        class VpcComposite(BaseComposite):
           def compose(self):
             vpc = self.resources.vpc('ec2.aws.crossplane.io/v1beta1', 'VPC')
             vpc.spec.forProvider.region = self.spec.region
@@ -57,7 +57,7 @@ kind: Function
 metadata:
   name: function-pythonic
 spec:
-  package: ghcr.io/fortra/function-pythonic:v0.0.7
+  package: ghcr.io/fortra/function-pythonic:v0.0.9
 ```
 ## Composed Resource Dependencies
 
@@ -158,13 +158,13 @@ proto = format(request, 'protobuf') # get the request as a protobuf string
 Composite composition is performed from a Composite orientation. A `BaseComposite` class
 is subclassed and the `compose` method is implemented.
 ```python
-class Composite(BaseComposite):
+class MyComposite(BaseComposite):
     def compose(self):
         # Compose the Composite
 ```
 The compose method can also declare itself as performing async io:
 ```python
-class Composite(BaseComposite):
+class MyAsyncComposite(BaseComposite):
     async def compose(self):
         # Compose the Composite using async io when needed
 ```
@@ -266,7 +266,7 @@ Each resource in the list is the following RequiredResource class:
 
 ### Conditions
 
-The `BaseCompsite.conditions`, `Resource.conditions`, and `RequiredResource.conditions` fields
+The `BaseComposite.conditions`, `Resource.conditions`, and `RequiredResource.conditions` fields
 are maps of that entity's status conditions array, with the map key being the condition type.
 The fields are read only for `Resource.conditions` and `RequiredResource.conditions`.
 
@@ -307,7 +307,7 @@ metadata:
   name: composite-example
 spec:
   composite: |
-    class Composite(BaseComposite):
+    class HelloComposite(BaseComposite):
       def compose(self):
         self.status.composite = 'Hello, World!'
 ```
@@ -349,7 +349,7 @@ spec:
       apiVersion: pythonic.fn.fortra.com/v1alpha1
       kind: Composite
       composite: |
-        class Composite(BaseComposite):
+        class GreetingComposite(BaseComposite):
           def compose(self):
             self.status.greeting = f"Hello, {self.spec.who}!"
 ```
@@ -362,7 +362,7 @@ metadata:
   annotations:
     render.crossplane.io/runtime: Development
 spec:
-  package: ghcr.io/fortra/function-pythonic:v0.0.7
+  package: ghcr.io/fortra/function-pythonic:v0.0.9
 ```
 In one terminal session, run function-pythonic:
 ```shell
@@ -422,7 +422,7 @@ Then, in your Composition:
       kind: Composite
       composite: |
         from example.pythonic import features
-        class Composite(BaseComposite):
+        class FetureComposite(BaseComposite):
             def compose(self):
                 anything = features.anything()
     ...
@@ -464,7 +464,7 @@ kind: Function
 metadata:
   name: function-pythonic
 spec:
-  package: ghcr.io/fortra/function-pythonic:v0.0.7
+  package: ghcr.io/fortra/function-pythonic:v0.0.9
   runtimeConfigRef:
     name: function-pythonic
 ---
@@ -493,12 +493,6 @@ kind: ClusterRole
 metadata:
   name: function-pythonic
 rules:
-- apiGroups:
-  - ''
-  resources:
-  - events
-  verbs:
-  - create
 - apiGroups:
   - ''
   resources:
@@ -507,6 +501,12 @@ rules:
   - list
   - watch
   - patch
+- apiGroups:
+  - ''
+  resources:
+  - events
+  verbs:
+  - create
 ---
 apiVersion: rbac.authorization.k8s.io/v1
 kind: ClusterRoleBinding

crossplane/pythonic/composite.py

@@ -637,15 +637,6 @@ def fatal(self, fatal):
             else:
                 self._result.severity = fnv1.Severity.SEVERITY_NORMAL
 
-    @property
-    def message(self):
-        return self._result.message if bool(self) else None
-
-    @message.setter
-    def message(self, message):
-        if bool(self):
-            self._result.message = message
-
     @property
     def reason(self):
         return self._result.reason if bool(self) else None
@@ -655,6 +646,15 @@ def reason(self, reason):
         if bool(self):
             self._result.reason = reason
 
+    @property
+    def message(self):
+        return self._result.message if bool(self) else None
+
+    @message.setter
+    def message(self, message):
+        if bool(self):
+            self._result.message = message
+
     @property
     def claim(self):
         return bool(self) and self._result == fnv1.Target.TARGET_COMPOSITE_AND_CLAIM

crossplane/pythonic/function.py

@@ -87,7 +87,18 @@ async def run_function(self, request):
                     logger.exception('Exec exception')
                     crossplane.function.response.fatal(response, f"Exec exception: {e}")
                     return response
-                composite = ['<script>', 'Composite']
+                for field in dir(module):
+                    value = getattr(module, field)
+                    if inspect.isclass(value) and issubclass(value, BaseComposite):
+                        if clazz:
+                            logger.error('Composite script has multiple BaseComposite classes')
+                            crossplane.function.response.fatal(response, 'Composite script has multiple BaseComposite classes')
+                            return response
+                        clazz = value
+                if not clazz:
+                    logger.error('Composite script does not have have a BaseComposite class')
+                    crossplane.function.response.fatal(response, 'Composite script does have have a BaseComposite class')
+                    return response
             else:
                 composite = composite.rsplit('.', 1)
                 if len(composite) == 1:
@@ -100,20 +111,20 @@ async def run_function(self, request):
                     logger.error(str(e))
                     crossplane.function.response.fatal(response, f"Import module exception: {e}")
                     return response
-            clazz = getattr(module, composite[1], None)
-            if not clazz:
-                logger.error(f"{composite[0]} did not define: {composite[1]}")
-                crossplane.function.response.fatal(response, f"{composite[0]} did not define: {composite[1]}")
-                return response
-            composite = '.'.join(composite)
-            if not inspect.isclass(clazz):
-                logger.error(f"{composite} is not a class")
-                crossplane.function.response.fatal(response, f"{composite} is not a class")
-                return response
-            if not issubclass(clazz, BaseComposite):
-                logger.error(f"{composite} is not a subclass of BaseComposite")
-                crossplane.function.response.fatal(response, f"{composite} is not a subclass of BaseComposite")
-                return response
+                clazz = getattr(module, composite[1], None)
+                if not clazz:
+                    logger.error(f"{composite[0]} did not define: {composite[1]}")
+                    crossplane.function.response.fatal(response, f"{composite[0]} did not define: {composite[1]}")
+                    return response
+                composite = '.'.join(composite)
+                if not inspect.isclass(clazz):
+                    logger.error(f"{composite} is not a class")
+                    crossplane.function.response.fatal(response, f"{composite} is not a class")
+                    return response
+                if not issubclass(clazz, BaseComposite):
+                    logger.error(f"{composite} is not a subclass of BaseComposite")
+                    crossplane.function.response.fatal(response, f"{composite} is not a subclass of BaseComposite")
+                    return response
             self.clazzes[composite] = clazz
 
         try:

crossplane/pythonic/main.py

@@ -13,7 +13,6 @@
 import crossplane.function.logging
 import crossplane.function.proto.v1.run_function_pb2_grpc as grpcv1
 import grpc
-import pip._internal.cli.main
 
 from . import function
 
@@ -24,7 +23,7 @@ def main():
 
 class Main:
     async def main(self):
-        parser = argparse.ArgumentParser('Forta Crossplane Function')
+        parser = argparse.ArgumentParser('Crossplane Function Pythonic')
         parser.add_argument(
             '--debug', '-d',
             action='store_true',
@@ -40,18 +39,18 @@ async def main(self):
         parser.add_argument(
             '--address',
             default='0.0.0.0:9443',
-            help='Address at which to listen for gRPC connections, default: 0.0.0.0:9443',
+            help='Address to listen on for gRPC connections, default: 0.0.0.0:9443',
         )
         parser.add_argument(
             '--tls-certs-dir',
             default=os.getenv('TLS_SERVER_CERTS_DIR'),
             metavar='DIRECTORY',
-            help='Serve using mTLS certificates.',
+            help='Serve using TLS certificates.',
         )
         parser.add_argument(
             '--insecure',
             action='store_true',
-            help='Run without mTLS credentials. If you supply this flag --tls-certs-dir will be ignored.',
+            help='Run without mTLS credentials, --tls-certs-dir will be ignored.',
         )
         parser.add_argument(
             '--packages',
@@ -94,15 +93,23 @@ async def main(self):
             help='Allow oversized protobuf messages'
         )
         args = parser.parse_args()
+        if not args.tls_certs_dir and not args.insecure:
+            print('Either --tls-certs-dir or --insecure must be specified', file=sys.stderr)
+            sys.exit(1)
+
         self.configure_logging(args)
+        # enables read only volumes or mismatched uid volumes
+        sys.dont_write_bytecode = True
+        await self.run(args)
 
+    # Allow for independent running of function-pythonic
+    async def run(self, args):
         if args.pip_install:
-            pip._internal.cli.main.main(['install', *shlex.split(args.pip_install)])
+            import pip._internal.cli.main
+            pip._internal.cli.main.main(['install', '--user', *shlex.split(args.pip_install)])
 
-        # enables read only volumes or mismatched uid volumes
-        sys.dont_write_bytecode = True
         for path in reversed(args.python_path):
-            sys.path.insert(0, str(pathlib.Path(path).resolve()))
+            sys.path.insert(0, str(pathlib.Path(path).expanduser().resolve()))
 
         if args.allow_oversize_protos:
             from google.protobuf.internal import api_implementation
@@ -113,8 +120,10 @@ async def main(self):
         grpc_runner = function.FunctionRunner(args.debug)
         grpc_server = grpc.aio.server()
         grpcv1.add_FunctionRunnerServiceServicer_to_server(grpc_runner, grpc_server)
-        if args.tls_certs_dir:
-            certs = pathlib.Path(args.tls_certs_dir)
+        if args.insecure:
+            grpc_server.add_insecure_port(args.address)
+        else:
+            certs = pathlib.Path(args.tls_certs_dir).expanduser().resolve()
             grpc_server.add_secure_port(
                 args.address,
                 grpc.ssl_server_credentials(
@@ -126,10 +135,6 @@ async def main(self):
                     require_client_auth=True,
                 ),
             )
-        else:
-            if not args.insecure:
-                raise ValueError('Either --tls-certs-dir or --insecure must be specified')
-            grpc_server.add_insecure_port(args.address)
         await grpc_server.start()
 
         if args.packages:

crossplane/pythonic/packages.py

@@ -14,7 +14,7 @@
 PACKAGES_DIR = None
 
 
-def operator(grpc_server, grpc_runner, packages_secrets, packages_namespace, packages_dir):
+def operator(grpc_server, grpc_runner, packages_secrets, packages_namespaces, packages_dir):
     logging.getLogger('kopf.objects').setLevel(logging.INFO)
     global GRPC_SERVER, GRPC_RUNNER, PACKAGES_DIR
     GRPC_SERVER = grpc_server
@@ -28,8 +28,8 @@ def operator(grpc_server, grpc_runner, packages_secrets, packages_namespace, pac
         kopf.on.delete('', 'v1', 'secrets', labels=PACKAGE_LABEL)(delete)
     return kopf.operator(
         standalone=True,
-        clusterwide=not packages_namespace,
-        namespaces=packages_namespace,
+        clusterwide=not packages_namespaces,
+        namespaces=packages_namespaces,
     )