More pytest cases and add CI report

Author: Patrick J. McNerthney

.coveragerc

@@ -0,0 +1,2 @@
+[run]
+omit = tests/*

.github/workflows/ci.yaml

@@ -3,8 +3,8 @@ name: CI
 on:
   push:
     branches:
-      - main
-      - release-*
+    - main
+    - release-*
   pull_request: {}
   workflow_dispatch:
     inputs:
@@ -53,22 +53,38 @@ jobs:
   #     - name: Lint
   #       run: hatch run lint:check
 
-  unit-test:
+  test:
     runs-on: ubuntu-24.04
     steps:
-      - name: Checkout
-        uses: actions/checkout@v4
-
-      - name: Setup Python
-        uses: actions/setup-python@v5
-        with:
-          python-version: ${{ env.PYTHON_VERSION }}
-
-      - name: Setup Hatch
-        run: pipx install hatch==1.14.1
-
-      - name: Run Unit Tests
-        run: hatch run test:unit
+    - name: Checkout
+      uses: actions/checkout@v4
+
+    - name: Setup Python
+      uses: actions/setup-python@v5
+      with:
+        python-version: ${{ env.PYTHON_VERSION }}
+
+    - name: Setup Hatch
+      run: pipx install hatch==1.14.1
+
+    - name: Run Unit Tests
+      run: hatch run test:ci
+
+    - name: Pytest coverage comment
+      uses: MishaKav/pytest-coverage-comment@v1.1.54
+      with:
+        badge-title: Coverage
+        title: Coverage Report
+        pytest-xml-coverage-path: reports/pytest-coverage.xml
+        junitxml-title: Unit Tests
+        junitxml-path: reports/pytest-junit.xml
+        #hide-badge: false
+        #hide-report: false
+        #create-new-comment: false
+        #hide-comment: false
+        #report-only-changed-files: false
+        #remove-link-from-badge: false
+        #unique-id-for-comment: python3.8
 
   # We want to build most packages for the amd64 and arm64 architectures. To
   # speed this up we build single-platform packages in parallel. We then upload

.gitignore

@@ -53,6 +53,7 @@ coverage.xml
 .hypothesis/
 .pytest_cache/
 cover/
+reports/
 
 # Translations
 *.mo

README.md

@@ -85,7 +85,7 @@ region = request.observed.composite.resource.spec.region
 region = request['observed']['composite']['resource']['spec']['region']
 ```
 Getting values from free form map and list values will not throw
-errors for keys that do not exist, but will return an empty placeholder
+errors for keys that do not exist, but will return an unknown placeholder
 which evaluates as False. For example, the following will evaluate as False
 with a just created RunFunctionResponse message:
 ```python
@@ -97,7 +97,7 @@ Note that maps or lists that do exist but do not have any members will evaluate
 as True, contrary to Python dicts and lists. Use the `len` function to test
 if the map or list exists and has members.
 
-When setting fields, all empty intermediary placeholders will automatically
+When setting fields, all intermediary unknown placeholders will automatically
 be created. For example, this will create all items needed to set the
 region on the desired resource:
 ```python
@@ -114,6 +114,7 @@ The following functions are provided to create Protobuf structures:
 | ----- | ----------- |
 | Map | Create a new Protobuf map |
 | List | Create a new Protobuf list |
+| Unknown | Create a new Protobuf unknown placeholder |
 | Yaml | Create a new Protobuf structure from a yaml string |
 | Json | Create a new Protobuf structure from a json string |
 | Base64Encode | Encode a string into base 64 |

examples/helm-copy-secret/composition.yaml

@@ -41,7 +41,7 @@ spec:
             #vcluster_secrets = self.requireds.Secret('v1', 'Secret', namespace, secret_name)
             vcluster_secrets = self.requireds.Secret('v1', 'Secret', labels={'vcluster-name':name})
             for secret in vcluster_secrets:
-              if secret.metadata.name != secret_name:
+              if secret.metadata.namespace != namespace or secret.metadata.name != secret_name:
                 continue
               argocd_secret = self.resources.secret('v1', 'Secret', 'argocd', secret_name)
               argocd_secret.metadata.labels['argocd.argoproj.io/secret-type'] = 'cluster'

examples/helm-copy-secret/xrd.yaml

@@ -0,0 +1,21 @@
+apiVersion: apiextensions.crossplane.io/v1
+kind: CompositeResourceDefinition
+metadata:
+  name: xclusters.example.joebowbeer.com
+spec:
+  group: example.joebowbeer.com
+  names:
+    kind: XCluster
+    plural: xclusters
+  scope: Cluster
+  versions:
+  - name: v1alpha1
+    served: true
+    referenceable: true
+    schema:
+      openAPIV3Schema:
+        type: object
+        properties:
+          spec:
+            type: object
+            properties: {}

function/fn.py

@@ -106,6 +106,7 @@ def __init__(self):
         self.BaseComposite = function.composite.BaseComposite
         self.Map = function.protobuf.Map
         self.List = function.protobuf.List
+        self.Unknown = function.protobuf.Unknown
         self.Yaml = function.protobuf.Yaml
         self.Json = function.protobuf.Json
         self.B64Encode = lambda s: base64.b64encode(s.encode('utf-8')).decode('utf-8')

function/protobuf.py

@@ -22,16 +22,13 @@
 
 
 def Map(**kwargs):
-    values = Values(None, None, google.protobuf.struct_pb2.Struct(), Values.Type.MAP)
-    for key, value in kwargs.items():
-        values[key] = value
-    return values
+    return Values(None, None, google.protobuf.struct_pb2.Struct(), Values.Type.MAP)(**kwargs)
 
 def List(*args):
-    values = Values(None, None, google.protobuf.struct_pb2.ListValue(), Values.Type.LIST)
-    for ix, value in enumerate(args):
-        values[ix] = value
-    return values
+    return Values(None, None, google.protobuf.struct_pb2.ListValue(), Values.Type.LIST)(*args)
+
+def Unknown():
+    return Values(None, None, None, Values.Type.UNKNOWN)
 
 def Yaml(string, readOnly=None):
     return _Object(yaml.safe_load(string), readOnly)
@@ -618,15 +615,21 @@ def _create_child(self, key, type):
                     raise ValueError('Invalid key, must be a str for maps')
                 self.__dict__['_type'] = self.Type.MAP
             if self._values is None:
-                self.__dict__['_values'] = self._parent._create_child(self._key, self._type)
+                if self._parent is None:
+                    self.__dict__['_values'] = google.protobuf.struct_pb2.Struct()
+                else:
+                    self.__dict__['_values'] = self._parent._create_child(self._key, self._type)
             struct_value = self._values.fields[key]
         elif isinstance(key, int):
             if not self._isList:
                 if not self._isUnknown:
                     raise ValueError('Invalid key, must be an int for lists')
                 self.__dict__['_type'] = self.Type.LIST
             if self._values is None:
-                self.__dict__['_values'] = self._parent._create_child(self._key, self._type)
+                if self._parent is None:
+                    self.__dict__['_values'] = google.protobuf.struct_pb2.ListValue()
+                else:
+                    self.__dict__['_values'] = self._parent._create_child(self._key, self._type)
             while key >= len(self._values.values):
                 self._values.values.add()
             struct_value = self._values.values[key]
@@ -671,13 +674,6 @@ def __call__(self, *args, **kwargs):
             self._values.Clear()
             for key in range(len(args)):
                 self[key] = args[key]
-        else:
-            if not self._isMap:
-                if not self._isUnknown:
-                    self.__dict__['_type'] = self.Type.MAP # Assume a map is wanted
-            if self._values is None:
-                self.__dict__['_values'] = self._parent._create_child(self._key, self._type)
-            self._values.Clear()
         return self
 
     def __setattr__(self, key, value):
@@ -692,15 +688,21 @@ def __setitem__(self, key, value):
                     raise ValueError('Invalid key, must be a str for maps')
                 self.__dict__['_type'] = self.Type.MAP
             if self._values is None:
-                self.__dict__['_values'] = self._parent._create_child(self._key, self._type)
+                if self._parent is None:
+                    self.__dict__['_values'] = google.protobuf.struct_pb2.Struct()
+                else:
+                    self.__dict__['_values'] = self._parent._create_child(self._key, self._type)
             values = self._values.fields
         elif isinstance(key, int):
             if not self._isList:
                 if not self._isUnknown:
                     raise ValueError('Invalid key, must be an int for lists')
                 self.__dict__['_type'] = self.Type.LIST
             if self._values is None:
-                self.__dict__['_values'] = self._parent._create_child(self._key, self._type)
+                if self._parent is None:
+                    self.__dict__['_values'] = google.protobuf.struct_pb2.ListValue()
+                else:
+                    self.__dict__['_values'] = self._parent._create_child(self._key, self._type)
             values = self._values.values
             while key >= len(values):
                 values.add()

pyproject.toml

@@ -43,20 +43,29 @@ validate-bump = false            # Allow going from 0.0.0.dev0+x to 0.0.0.dev0+y
 type = "virtual"
 path = ".venv-default"
 dependencies = ["ipython==9.1.0"]
-scripts = { development = "python function/main.py --insecure --debug" }
+[tool.hatch.envs.default.scripts]
+development = "python function/main.py --insecure --debug"
 
 [tool.hatch.envs.lint]
 type = "virtual"
 detached = true
 path = ".venv-lint"
 dependencies = ["ruff==0.11.5"]
-scripts = { check = "ruff check function tests && ruff format --diff function tests" }
+[tool.hatch.envs.lint.scripts]
+check = "ruff check function tests && ruff format --diff function tests"
 
 [tool.hatch.envs.test]
 type = "virtual"
 path = ".venv-test"
-dependencies = ["pytest==8.4.1", "pytest-asyncio==1.1.0"]
-scripts = { unit = "python -m pytest tests" }
+dependencies = [
+  "pytest==8.4.1",
+  "pytest-asyncio==1.1.0",
+  "pytest-cov==6.2.1",
+]
+[tool.hatch.envs.test.scripts]
+all = "pytest tests/ --verbose --verbose --cov --cov-report=term --cov-report=html:reports"
+protobuf = "pytest tests/test_protobuf*.py --verbose --verbose --cov --cov-report=term --cov-report=html:reports"
+ci = "pytest tests --junitxml=reports/pytest-junit.xml --cov --cov-report=xml:reports/pytest-coverage.xml"
 
 [tool.ruff]
 target-version = "py311"

tests/fn_cases/get-started-app.yaml

@@ -0,0 +1,95 @@
+request:
+  observed:
+    composite:
+      resource:
+        metadata:
+          name: my-app
+        spec:
+          image: nginx
+    resources:
+      deployment:
+        resource:
+          status:
+            availableReplicas: 2
+            conditions:
+            - type: Available
+              status: 'True'
+              reason: MinimumReplicasAvailable
+              message: Deployment has minimum availability
+      service:
+        resource:
+          spec:
+            clusterIP: 10.96.196.65
+  input:
+    composite: |
+        class Composite(BaseComposite):
+          def compose(self):
+            labels = {'example.crossplane.io/app': self.metadata.name}
+
+            d = self.resources.deployment('apps/v1', 'Deployment')
+            d.metadata.labels = labels
+            d.spec.replicas = 2
+            d.spec.selector.matchLabels = labels
+            d.spec.template.metadata.labels = labels
+            d.spec.template.spec.containers[0].name = 'app'
+            d.spec.template.spec.containers[0].image = self.spec.image
+            d.spec.template.spec.containers[0].ports[0].containerPort = 80
+            d.ready = d.conditions.Available.status
+
+            s = self.resources.service('v1', 'Service')
+            s.metadata.labels = labels
+            s.spec.selector = labels
+            s.spec.ports[0].protocol = 'TCP'
+            s.spec.ports[0].port = 8080
+            s.spec.ports[0].targetPort = 80
+            s.ready = s.observed.spec.clusterIP
+
+            self.status.replicas = d.status.availableReplicas
+            self.status.address = s.observed.spec.clusterIP
+
+response:
+  desired:
+    composite:
+      resource:
+        status:
+          replicas: 2
+          address: 10.96.196.65
+    resources:
+      deployment:
+        resource:
+          apiVersion: apps/v1
+          kind: Deployment
+          metadata:
+            labels:
+              example.crossplane.io/app: my-app
+          spec:
+            replicas: 2
+            selector:
+              matchLabels:
+                example.crossplane.io/app: my-app
+            template:
+              metadata:
+                labels:
+                  example.crossplane.io/app: my-app
+              spec:
+                containers:
+                - image: nginx
+                  name: app
+                  ports:
+                  - containerPort: 80
+        ready: 1
+      service:
+        resource:
+          apiVersion: v1
+          kind: Service
+          metadata:
+            labels:
+              example.crossplane.io/app: my-app
+          spec:
+            selector:
+              example.crossplane.io/app: my-app
+            ports:
+            - protocol: TCP
+              port: 8080
+              targetPort: 80
+        ready: 1