function - c.d.

Author: mbakalarski

example/README.md

@@ -5,21 +5,27 @@ with these example manifests.
 
 ```shell
 # Run the function locally
-$ hatch run development
+hatch run development
 ```
 
 ```shell
 # Then, in another terminal, call it with these example manifests
-$ crossplane beta render xr.yaml composition.yaml functions.yaml -r
+crossplane render xr.yaml composition.yaml functions.yaml \
+  --required-resources secret.yaml --extra-resources environment.yaml -r
+```
+
+```
 ---
-apiVersion: example.crossplane.io/v1
-kind: XR
+apiVersion: eos.netclab.dev/v1alpha1
+kind: EosCommand
 metadata:
-  name: example-xr
+  name: eoscommand-1
+spec:
+  endpoint: ceos01.default.svc.cluster.local
+  cmds:
+    ip prefix-list PL-Loopback0:
+      seq 10 permit 10.0.0.1/32 eq 32: {}
+      seq 20 permit 10.0.0.2/32 eq 32: {}
 ---
-apiVersion: render.crossplane.io/v1beta1
-kind: Result
-message: I was run with input "Hello world"!
-severity: SEVERITY_NORMAL
-step: run-the-template
+<...>
 ```

example/composition.yaml

@@ -8,6 +8,25 @@ spec:
     kind: EosCommand
   mode: Pipeline
   pipeline:
-  - step: create-requests
+  - step: environmentConfigs
+    functionRef:
+      name: crossplane-contrib-function-environment-configs
+    input:
+      apiVersion: environmentconfigs.fn.crossplane.io/v1beta1
+      kind: Input
+      spec:
+        environmentConfigs:
+        - type: Reference
+          ref:
+            name: endpoint-protocols
+
+  - step: requests
     functionRef:
       name: function-eapi
+    requirements:
+      requiredResources:
+        - apiVersion: v1
+          kind: Secret
+          name: eos-creds
+          namespace: crossplane-system
+          requirementName: eos-creds

example/environment.yaml

@@ -0,0 +1,11 @@
+apiVersion: apiextensions.crossplane.io/v1beta1
+kind: EnvironmentConfig
+metadata:
+  name: endpoint-protocols
+data:
+  restconf:
+    scheme: https
+    port: 6020
+  jsonrpc:
+    scheme: http
+    port: 6021

example/functions.yaml

@@ -6,6 +6,13 @@ metadata:
   annotations:
     # This tells crossplane beta render to connect to the function locally.
     render.crossplane.io/runtime: Development
+# spec:
+#   # This is ignored when using the Development runtime.
+#   package: function-
+---
+apiVersion: pkg.crossplane.io/v1
+kind: Function
+metadata:
+  name: crossplane-contrib-function-environment-configs
 spec:
-  # This is ignored when using the Development runtime.
-  package: function-
+  package: xpkg.upbound.io/crossplane-contrib/function-environment-configs:v0.4.0

example/secret.yaml

@@ -0,0 +1,8 @@
+apiVersion: v1
+kind: Secret
+metadata:
+  name: eos-creds
+  namespace: crossplane-system
+type: Opaque
+data:
+  basicAuth: YXJpc3RhOmFyaXN0YQ==

example/xr.yaml

@@ -7,3 +7,4 @@ spec:
   cmds:
     ip prefix-list PL-Loopback0:
       seq 10 permit 10.0.0.1/32 eq 32: {}
+      seq 20 permit 10.0.0.2/32 eq 32: {}

function/fn.py

@@ -1,9 +1,12 @@
 """A Crossplane composition function."""
 
+import hashlib
+
 import grpc
-from crossplane.function import logging, resource, response
+from crossplane.function import logging, request, resource, response
 from crossplane.function.proto.v1 import run_function_pb2 as fnv1
 from crossplane.function.proto.v1 import run_function_pb2_grpc as grpcv1
+from jsonrpcclient import request_json
 
 
 class FunctionRunner(grpcv1.FunctionRunnerService):
@@ -27,37 +30,55 @@ async def RunFunction(
         endpoint = composite["spec"]["endpoint"]
         cmds = composite["spec"]["cmds"]
 
+        environment = resource.struct_to_dict(
+            req.context["apiextensions.crossplane.io/environment"]
+        )
+        port, scheme, insecure_skip_tls_verify = get_envs(environment)
+
+        secret = request.get_required_resource(req, "eos-creds")
+        basic_auth = secret.get("data", {}).get("basicAuth", "") if secret else ""
+
+        jsonrpc_cfg = {
+            "endpoint": endpoint,
+            "port": port,
+            "scheme": scheme,
+            "basicAuth": basic_auth,
+            "insecureSkipTLSVerify": insecure_skip_tls_verify,
+        }
+
         command_paths = walk_cmds(cmds)
         log.info("Generated command paths", count=len(command_paths))
 
         for path in command_paths:
             name = name_prefix + "-" + name_from_path(path)
 
+            jsonrpc_params = {
+                "version": 1,
+                "format": "json",
+                "cmds": ["enable", "configure", *path],
+            }
+            jsonrpc = request_json("runCmds", params=jsonrpc_params)
+
+            resource_data = construct_resource_request(jsonrpc, jsonrpc_cfg)
+
             resource.update(
                 rsp.desired.resources[name],
-                {
-                    "apiVersion": "http.crossplane.io/v1alpha2",
-                    "kind": "Request",
-                    "spec": {
-                        "endpoint": endpoint,
-                        "command": path,
-                    },
-                },
+                resource_data,
             )
 
         return rsp
 
 
 def walk_cmds(cmds: dict, path: list[str] | None = None) -> list[list[str]]:
+    """walk_cmds function."""
     if path is None:
         path = []
 
     results: list[list[str]] = []
 
-    # NOTE: keys are sorted to ensure deterministic reconciliation
     for cmd in sorted(cmds.keys()):
         subtree = cmds[cmd]
-        next_path = path + [cmd]
+        next_path = [*path, cmd]
 
         if subtree == {}:
             # Leaf → emit array
@@ -69,8 +90,42 @@ def walk_cmds(cmds: dict, path: list[str] | None = None) -> list[list[str]]:
     return results
 
 
-import hashlib
-
 def name_from_path(path: list[str]) -> str:
+    """name_from_path function."""
     joined = "|".join(path)
-    return hashlib.sha1(joined.encode()).hexdigest()[:10]
+    return hashlib.sha1(joined.encode(), usedforsecurity=False).hexdigest()[:10]
+
+
+def get_envs(environment: dict) -> tuple[int, str, bool]:
+    """Extract jsonrpc configuration from the environment."""
+    if not environment:
+        return 0, "", True
+
+    protocols_settings = environment.get("jsonrpc", {})
+
+    port = int(protocols_settings.get("port", 0))
+    scheme = protocols_settings.get("scheme", "")
+    insecure_skip_tls_verify = bool(protocols_settings.get("skipTlsVerify", True))
+
+    return port, scheme, insecure_skip_tls_verify
+
+
+def construct_resource_request(jsonrpc: str, config: dict) -> dict:
+    """Construct the resource request for the given data."""
+    return {
+        "apiVersion": "http.crossplane.io/v1alpha2",
+        "kind": "Request",
+        "spec": {
+            "forProvider": {
+                "insecureSkipTLSVerify": config["insecureSkipTLSVerify"],
+                "headers": {
+                    "Accept": ["application/json"],
+                    "Authorization": [f"Basic {config['basicAuth']}"],
+                },
+                "payload": {
+                    "baseUrl": f"{config['scheme']}://{config['endpoint']}:{config['port']}",
+                    "body": jsonrpc,
+                },
+            },
+        },
+    }

package/input/template.fn.crossplane.io_inputs.yaml

@@ -3,31 +3,33 @@ requires = ["hatchling"]
 build-backend = "hatchling.build"
 
 [project]
-name = "function"
+name = "function-eapi"
 description = 'A composition function'
 readme = "README.md"
 requires-python = ">=3.11,<3.12"
 license = "Apache-2.0"
 keywords = []
-authors = [{ name = "Crossplane Maintainers", email = "info@crossplane.io" }]
+authors = [{ name = "Netclab Contributors" }]
 classifiers = [
-  "Development Status :: 4 - Beta",
+  "Development Status :: 3 - Alpha",
   "Programming Language :: Python",
   "Programming Language :: Python :: 3.11",
 ]
 
 dependencies = [
-  "crossplane-function-sdk-python==0.8.0",
+  "jsonrpcclient==4.0.3",
+  "crossplane-function-sdk-python==0.9.0",
   "click==8.3.1",
-  "grpcio==1.73.1",
+  "grpcio==1.74.0",
+  "protobuf==6.31.1"
 ]
 
 dynamic = ["version"]
 
 [project.urls]
-Documentation = "https://github.com/crossplane/function-template-python#readme"
-Issues = "https://github.com/crossplane/function-template-python/issues"
-Source = "https://github.com/crossplane/function-template-python"
+Documentation = "https://github.com/mbakalarski/function-eapi#readme"
+Issues = "https://github.com/mbakalarski/function-eapi/issues"
+Source = "https://github.com/mbakalarski/function-eapi"
 
 [project.scripts]
 function = "function.main:cli"