Merge pull request #1 from sebastocorp/feat/add-condition-value-additional-sources

achetronic · web-flow · commit 42b12c85f2d4 · 2023-05-15T12:51:01.000+01:00
Feat/add condition value additional sources
diff --git a/README.md b/README.md
@@ -73,6 +73,14 @@ spec:
           name: testing-secret
           key: RABBITMQ_PASSWORD
 
+  # Additional sources to get information from.
+  # This sources can be used on condition.value
+  additionalSources:
+    - apiVersion: apps/v1
+      kind: Deployment
+      name: testing-workload
+      namespace: default
+
   # This is the condition that will trigger the execution of the action.
   # The 'key' field admits dot notation, and it's covered by gjson
   # Ref: https://github.com/tidwall/gjson
@@ -359,6 +367,73 @@ spec:
     value: ""
 ```
 
+Until now, we have talked about the capabilities of the field `condition.key`, but `condition.value` is really 
+powerful too. If `additionalSources` is filled, the content of these sources is available to craft complex values.
+All you need to do, is to use the pattern `[<list-index>]{{ <GJSON-expression> }}` inside the `condition.value` field
+to use some value coming from a source.
+
+> Hey! Sources is a list composed by `workloadRef` + `additionalSources`. This means position [0] is reserved for 
+> the target workload and higher positions starting from [1] will be filled with additionalSources
+
+Let's see an example:
+
+```yaml
+apiVersion: rabbit-stalker.docplanner.com/v1alpha1
+kind: WorkloadAction
+metadata:
+  name: workloadaction-sample
+spec:
+  # ...
+  condition:
+    
+    # string literal example
+    key: rabbit@fancy-monk-sample-01
+
+    # This will take the value of an annotation named 'node' coming from workloadRef object
+    value: "[0]{{ metadata.annotations.node }}"
+```
+
+You can craft a value adding some string literals at any side of the pattern used to search. The structure will be 
+replaced by the value found in the source:
+
+```yaml
+apiVersion: rabbit-stalker.docplanner.com/v1alpha1
+kind: WorkloadAction
+metadata:
+  name: workloadaction-sample
+spec:
+  # ...
+  condition:
+    
+    # string literal example
+    key: rabbit@fancy-monk-sample-01
+
+    # This will take the value of an annotation named 'node' coming from the resource in first position at sources list.
+    # Imagine the value for this annotation is '1'
+    # The '[0]{{ metadata.annotations.node }}' string will be replaced before the comparison, so the final value will 
+    # be 'rabbit@fancy-monk-sample-01'
+    value: "rabbit@fancy-monk-sample-0[0]{{ metadata.annotations.node }}"
+```
+
+As final feature you can use the patterns as many times as needed to build the final string:
+
+```yaml
+apiVersion: rabbit-stalker.docplanner.com/v1alpha1
+kind: WorkloadAction
+metadata:
+  name: workloadaction-sample
+spec:
+  # ...
+  condition:
+    
+    # string literal example
+    key: rabbit@fancy-monk-sample-03
+
+    # This will take the value from multiples sources in the source list
+    # The final value will be 'rabbit@fancy-monk-sample-03' for example
+    value: "rabbit@[1]{{ cluster.name }}-0[0]{{ metadata.annotations.node }}"
+```
+
 ### Running on the cluster
 
 #### Easy way (recommended)
diff --git a/api/v1alpha1/workloadaction_types.go b/api/v1alpha1/workloadaction_types.go
@@ -72,6 +72,9 @@ type WorkloadActionSpec struct {
 	// RabbitConnection represents the connection settings to connect with RabbitMQ admin API
 	RabbitConnection RabbitConnectionSpec `json:"rabbitConnection"`
 
+	// AdditionalSources represent references to Kubernetes resources that whill be available on condition.value
+	AdditionalSources []corev1.ObjectReference `json:"additionalSources,omitempty"`
+
 	// Condition represent a key/value pair found in the JSON of the HTTP response
 	Condition ConditionSpec `json:"condition"`
 
diff --git a/api/v1alpha1/zz_generated.deepcopy.go b/api/v1alpha1/zz_generated.deepcopy.go
diff --git a/config/crd/bases/rabbit-stalker.docplanner.com_workloadactions.yaml b/config/crd/bases/rabbit-stalker.docplanner.com_workloadactions.yaml
@@ -55,6 +55,71 @@ spec:
                 - restart
                 - delete
                 type: string
+              additionalSources:
+                description: AdditionalSources represent references to Kubernetes
+                  resources that whill be available on condition.value
+                items:
+                  description: "ObjectReference contains enough information to let
+                    you inspect or modify the referred object. --- New uses of this
+                    type are discouraged because of difficulty describing its usage
+                    when embedded in APIs. 1. Ignored fields.  It includes many fields
+                    which are not generally honored.  For instance, ResourceVersion
+                    and FieldPath are both very rarely valid in actual usage. 2. Invalid
+                    usage help.  It is impossible to add specific help for individual
+                    usage.  In most embedded usages, there are particular restrictions
+                    like, \"must refer only to types A and B\" or \"UID not honored\"
+                    or \"name must be restricted\". Those cannot be well described
+                    when embedded. 3. Inconsistent validation.  Because the usages
+                    are different, the validation rules are different by usage, which
+                    makes it hard for users to predict what will happen. 4. The fields
+                    are both imprecise and overly precise.  Kind is not a precise
+                    mapping to a URL. This can produce ambiguity during interpretation
+                    and require a REST mapping.  In most cases, the dependency is
+                    on the group,resource tuple and the version of the actual struct
+                    is irrelevant. 5. We cannot easily change it.  Because this type
+                    is embedded in many locations, updates to this type will affect
+                    numerous schemas.  Don't make new APIs embed an underspecified
+                    API type they do not control. \n Instead of using this type, create
+                    a locally provided and used type that is well-focused on your
+                    reference. For example, ServiceReferences for admission registration:
+                    https://github.com/kubernetes/api/blob/release-1.17/admissionregistration/v1/types.go#L533
+                    ."
+                  properties:
+                    apiVersion:
+                      description: API version of the referent.
+                      type: string
+                    fieldPath:
+                      description: 'If referring to a piece of an object instead of
+                        an entire object, this string should contain a valid JSON/Go
+                        field access statement, such as desiredState.manifest.containers[2].
+                        For example, if the object reference is to a container within
+                        a pod, this would take on a value like: "spec.containers{name}"
+                        (where "name" refers to the name of the container that triggered
+                        the event) or if no container name is specified "spec.containers[2]"
+                        (container with index 2 in this pod). This syntax is chosen
+                        only to have some well-defined way of referencing a part of
+                        an object. TODO: this design is not final and this field is
+                        subject to change in the future.'
+                      type: string
+                    kind:
+                      description: 'Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds'
+                      type: string
+                    name:
+                      description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names'
+                      type: string
+                    namespace:
+                      description: 'Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/'
+                      type: string
+                    resourceVersion:
+                      description: 'Specific resourceVersion to which this reference
+                        is made, if any. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency'
+                      type: string
+                    uid:
+                      description: 'UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids'
+                      type: string
+                  type: object
+                  x-kubernetes-map-type: atomic
+                type: array
               condition:
                 description: Condition represent a key/value pair found in the JSON
                   of the HTTP response
diff --git a/config/samples/rabbit-stalker_v1alpha1_workloadaction.yaml b/config/samples/rabbit-stalker_v1alpha1_workloadaction.yaml
@@ -18,7 +18,7 @@ spec:
     vhost: "shared"
     queue: "your-queue-here"
 
-    # Credentials are optional.
+    # (Optional) Credentials to authenticate against endpoint.
     # If set, both are required
     credentials:
       username:
@@ -30,12 +30,25 @@ spec:
           name: testing-secret
           key: RABBITMQ_PASSWORD
 
+  # (Optional) Additional sources to get information from.
+  # This sources can be used on condition.value
+  additionalSources:
+    - apiVersion: apps/v1
+      kind: Deployment
+      name: testing-workload
+      namespace: default
+
   # Condition under the action is executed.
-  # The 'key' field admits dot notation, and it's covered by gjson
-  # Ref: https://github.com/tidwall/gjson
   condition:
-    key: "test"
-    value: "something"
+    # The 'key' field admits dot notation, and it's covered by gjson
+    # Ref: https://github.com/tidwall/gjson
+    key: |-
+      consumer_details.#(channel_details.node==rabbit@fancy-monk-sample-01).channel_details.node
+
+    # Additional sources can be used here to craft complex values using the following pattern:
+    # [index]{{ gjson }}
+    value: |-
+      [0]{{ metadata.annotations.node }}
 
   # Action to do with the workload when the condition is met
   action: "restart"
diff --git a/controllers/workloadaction_controller.go b/controllers/workloadaction_controller.go
@@ -114,8 +114,9 @@ func (r *WorkloadActionReconciler) Reconcile(ctx context.Context, req ctrl.Reque
 	defer func() {
 		err = r.Status().Update(ctx, workloadActionManifest)
 		if err != nil {
-			LogInfof(ctx, workloadActionConditionUpdateError, req.Name)
+			LogInfof(ctx, workloadActionConditionUpdateError, err)
 		}
+		err = nil
 	}()
 
 	// 6. Schedule periodical request
@@ -125,6 +126,7 @@ func (r *WorkloadActionReconciler) Reconcile(ctx context.Context, req ctrl.Reque
 		return result, err
 	}
 	result = ctrl.Result{
+		Requeue:      true,
 		RequeueAfter: RequeueTime,
 	}
 
diff --git a/controllers/workloadaction_status.go b/controllers/workloadaction_status.go
@@ -36,6 +36,10 @@ const (
 	ConditionReasonInvalidAction        = "InvalidAction"
 	ConditionReasonInvalidActionMessage = "Action is invalid"
 
+	// Condition value parsing failed
+	ConditionReasonConditionValueParsingFailed        = "ConditionValueParsingFailed"
+	ConditionReasonConditionValueParsingFailedMessage = "Condition value parsing process failed"
+
 	// Action execution failed
 	ConditionReasonActionExecutionFailed        = "ActionExecutionFailed"
 	ConditionReasonActionExecutionFailedMessage = "Action failed during execution"
diff --git a/controllers/workloadaction_sync.go b/controllers/workloadaction_sync.go

Original file line number	Diff line number	Diff line change
`@@ -114,8 +114,9 @@ func (r *WorkloadActionReconciler) Reconcile(ctx context.Context, req ctrl.Reque`
`114`	`114`	`defer func() {`
`115`	`115`	`err = r.Status().Update(ctx, workloadActionManifest)`
`116`	`116`	`if err != nil {`
`117`		`- LogInfof(ctx, workloadActionConditionUpdateError, req.Name)`
	`117`	`+ LogInfof(ctx, workloadActionConditionUpdateError, err)`
`118`	`118`	`}`
	`119`	`+ err = nil`
`119`	`120`	`}()`
`120`	`121`
`121`	`122`	`// 6. Schedule periodical request`
`@@ -125,6 +126,7 @@ func (r *WorkloadActionReconciler) Reconcile(ctx context.Context, req ctrl.Reque`
`125`	`126`	`return result, err`
`126`	`127`	`}`
`127`	`128`	`result = ctrl.Result{`
	`129`	`+ Requeue: true,`
`128`	`130`	`RequeueAfter: RequeueTime,`
`129`	`131`	`}`
`130`	`132`