✨ Enable Patching of WorkStatus

.github/workflows/workstatus-creation.yaml

@@ -1,4 +1,4 @@
-name: test workstatus creation
+name: test workstatus operations
 
 on:
   workflow_call:
@@ -15,8 +15,8 @@ on:
       - 'v*'
 
 jobs:
-  test-workstatus-creation:
-    name: Test workstatus creation
+  test-workstatus-operations:
+    name: Test workstatus operations
     runs-on: ubuntu-latest
     steps:
       - uses: actions/[email protected]
@@ -43,34 +43,34 @@ jobs:
         run: |
           test/e2e/run.sh
 
-      - name: show docker images
+      - name: Show docker images
         if: always()
         run: docker images
 
-      - name: show kubeconfig contexts
+      - name: Show kubeconfig contexts
         if: always()
         run: kubectl config get-contexts
 
-      - name: show clustermanagementaddons
+      - name: Show clustermanagementaddons
         if: always()
         run: kubectl --context kind-hub get clustermanagementaddons
 
-      - name: show managedclusteraddons
+      - name: Show managedclusteraddons
         if: always()
         run: kubectl --context kind-hub get managedclusteraddons -A
 
-      - name: show manifestworks in hub
+      - name: Show manifestworks in hub
         if: always()
         run: kubectl --context kind-hub get manifestwork -oyaml -A
 
-      - name: show workloads in cluster1
+      - name: Show workloads in cluster1
         if: always()
         run: kubectl --context kind-cluster1 get all -A
 
-      - name: show logs of the agent in cluster1
+      - name: Show logs of the agent in cluster1
         if: always()
         run: kubectl --context kind-cluster1 -n open-cluster-management-agent-addon logs deployment.apps/status-agent
 
-      - name: show workstatus objects in hub
+      - name: Show workstatus objects in hub
         if: always()
         run: kubectl --context kind-hub get workstatus -oyaml -A

api/v1alpha1/workstatus_types.go

@@ -48,7 +48,6 @@ type WorkStatusList struct {
 
 // Manifest represents a resource to be deployed
 type RawStatus struct {
-	// +kubebuilder:validation:EmbeddedResource
 	// +kubebuilder:pruning:PreserveUnknownFields
 	runtime.RawExtension `json:",inline"`
 }

config/crd/bases/control.kubestellar.io_workstatuses.yaml

@@ -64,7 +64,6 @@ spec:
           status:
             description: Manifest represents a resource to be deployed
             type: object
-            x-kubernetes-embedded-resource: true
             x-kubernetes-preserve-unknown-fields: true
         type: object
     served: true

test/e2e/README.md

@@ -6,7 +6,7 @@ The only exceptions are
 - `clusteradm` is needed to run the test;
 - `helm` is *not* needed to run the test.
 
-## Use the test
+## Use the tests
 
 In the root directory of this git repo:
 ```

test/e2e/run.sh

@@ -22,3 +22,4 @@ ${SRC_DIR}/cleanup.sh
 source "${SRC_DIR}/setup-shell.sh"
 ${SRC_DIR}/setup-ocm.sh
 ${SRC_DIR}/workstatus-creation.sh
+${SRC_DIR}/workstatus-patching.sh

test/e2e/workstatus-creation.sh

@@ -81,4 +81,7 @@ EOF
 :
 wait-for-cmd '[ "$(kubectl --context kind-hub -n cluster1 get workstatus appsv1-deployment-nginx-nginx -o jsonpath="{.status.availableReplicas}" 2>/dev/null)" == 1 ]'
 
-: SUCCESS: Test passed
+:
+: -------------------------------------------------------------------------
+: SUCCESS: Workstatus creation test passed
+:

test/e2e/workstatus-patching.sh

@@ -0,0 +1,70 @@
+#!/usr/bin/env bash
+# Copyright 2024 The KubeStellar Authors.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+set -x # echo so that users can understand what is happening
+set -e # exit on error
+
+:
+: -------------------------------------------------------------------------
+: Create a WorkStatus object in hub
+:
+kubectl --context kind-hub apply -f - <<EOF
+apiVersion: control.kubestellar.io/v1alpha1
+kind: WorkStatus
+metadata:
+  labels:
+    managed-by.kubestellar.io/singletonstatus: "true"
+    managed-by.kubestellar.io/wds1.nginx-singleton-bindingpolicy: "true"
+  name: test
+  namespace: default
+spec:
+  sourceRef:
+    group: apps
+    kind: Deployment
+    name: nginx-deployment
+    namespace: nginx
+    resource: deployments
+    version: v1
+EOF
+
+:
+: -------------------------------------------------------------------------
+: Patch when there is no status set
+:
+kubectl --context kind-hub patch workstatus test --type=merge \
+  --patch '{"metadata":{"annotations":{"version": "v2"}}}'
+wait-for-cmd '[ $(kubectl --context kind-hub get workstatus test -o=jsonpath='{.metadata.annotations.version}') = "v2" ]'
+
+:
+: -------------------------------------------------------------------------
+: Fill in then show the status
+:
+kubectl --context kind-hub patch workstatus test --type=merge \
+  --patch='{"status":{"conditions":[{"type":"Available","status":"True","reason":"DeploymentAvailable","message":"Deployment has minimum availability."}]}}' \
+  --subresource=status
+kubectl --context kind-hub get workstatus test -o=jsonpath='{.status}'
+
+:
+: -------------------------------------------------------------------------
+: Patch when there is some status set
+:
+kubectl --context kind-hub patch workstatus test --type=merge \
+  --patch '{"metadata":{"annotations":{"version": "v3"}}}'
+wait-for-cmd '[ $(kubectl --context kind-hub get workstatus test -o=jsonpath='{.metadata.annotations.version}') = "v3" ]'
+
+:
+: -------------------------------------------------------------------------
+: SUCCESS: Workstatus patching test passed
+: