fix: correct event callback handling as action is now required (#609)

Author: bakito

helm/example-batch-job-controller/bin/run.sh

@@ -9,7 +9,7 @@ echo "calling report callback: ${CALLBACK_SERVICE_RESULT_URL}"
 
 
 curl --silent --show-error -X POST -H 'Content-Disposition: attachment;filename="test.txt"' --data-binary 'This is an uploaded file' "${CALLBACK_SERVICE_FILE_URL}"
-curl --silent --show-error -X POST -H "Content-Type: application/json; charset=utf-8" --data-binary '{"warning": false,"reason": "TestReason","message": "test message with %s","args": ["arg"]}' "${CALLBACK_SERVICE_EVENT_URL}"
+curl --silent --show-error -X POST -H "Content-Type: application/json; charset=utf-8" --data-binary '{"warning": false,"action": "callback","reason": "TestReason","message": "test message with %s","args": ["arg"]}' "${CALLBACK_SERVICE_EVENT_URL}"
 curl --silent --show-error -X POST -H "Content-Type: application/json; charset=utf-8" --data-binary '{ "my_metric": [{ "value": 1.0, "labels": { "label_a": "AAA", "label_b": "BBB" }}] }' "${CALLBACK_SERVICE_RESULT_URL}"
 
 echo "done"

pkg/http/postserver-event.go

@@ -26,10 +26,15 @@ func (s *PostServer) postEventCallback(ctx *gin.Context, postLog logr.Logger, po
 		return err
 	}
 
+	action := event.Action
+	if action == "" {
+		action = "N/A"
+	}
+
 	if len(event.Args) > 0 {
-		s.EventRecorder.Eventf(pod, pod, event.Type(), event.Reason, "", event.Message, event.args()...)
+		s.EventRecorder.Eventf(pod, pod, event.Type(), event.Reason, action, event.Message, event.args()...)
 	} else {
-		s.EventRecorder.Eventf(pod, pod, event.Type(), event.Reason, "", event.Message)
+		s.EventRecorder.Eventf(pod, pod, event.Type(), event.Reason, action, event.Message)
 	}
 	return nil
 }

pkg/http/postserver_test.go

@@ -31,8 +31,8 @@ import (
 
 const (
 	reportJSON              = `{ "test": [{ "value": 1.0, "labels": { "label_a": "AAA", "label_b": "BBB" }}] }`
-	eventMessageJSON        = `{ "warning": true, "reason": "TestReason", "message": "test message" }`
-	eventMessageInvalidJSON = `{ "warning": true, "reason": "testReason", "message": "test message" }`
+	eventMessageJSON        = `{ "warning": true, "action": "TestAction", "reason": "TestReason", "message": "test message" }`
+	eventMessageInvalidJSON = `{ "warning": true, "action": "TestAction", "reason": "testReason", "message": "test message" }`
 	eventMessageArgsJSON    = `{ "warning": true, "reason": "TestReason", "message": "test message: %s" ,"args" : ["a1"]}`
 )
 
@@ -288,7 +288,7 @@ var _ = Describe("HTTP", func() {
 			mockSink.EXPECT().WithValues("node", node, "id", executionID).Return(mockSink)
 			mockSink.EXPECT().WithValues("length", gm.Any()).Return(mockSink)
 			mockSink.EXPECT().WithValues("pod", gm.Any(), "type", "Warning", "reason", "TestReason", "event-message", "test message").Return(mockSink)
-			mockRecord.EXPECT().Eventf(gm.Any(), gm.Any(), "Warning", "TestReason", "", "test message")
+			mockRecord.EXPECT().Eventf(gm.Any(), gm.Any(), "Warning", "TestReason", "TestAction", "test message")
 			mockSink.EXPECT().Info(gm.Any(), "event created")
 			mockReader.EXPECT().
 				Get(gm.Any(), client.ObjectKey{Namespace: s.Config.Namespace, Name: s.Config.PodName(node, executionID)}, gm.AssignableToTypeOf(&corev1.Pod{}))
@@ -304,7 +304,7 @@ var _ = Describe("HTTP", func() {
 			mockSink.EXPECT().WithValues("node", node, "id", executionID).Return(mockSink)
 			mockSink.EXPECT().WithValues("length", gm.Any()).Return(mockSink)
 			mockSink.EXPECT().WithValues("pod", gm.Any(), "type", "Warning", "reason", "TestReason", "event-message", "test message: a1").Return(mockSink)
-			mockRecord.EXPECT().Eventf(gm.Any(), gm.Any(), "Warning", "TestReason", "", "test message: %s", "a1")
+			mockRecord.EXPECT().Eventf(gm.Any(), gm.Any(), "Warning", "TestReason", "N/A", "test message: %s", "a1")
 			mockSink.EXPECT().Info(gm.Any(), "event created")
 			mockReader.EXPECT().
 				Get(gm.Any(), client.ObjectKey{Namespace: s.Config.Namespace, Name: s.Config.PodName(node, executionID)}, gm.AssignableToTypeOf(&corev1.Pod{}))

pkg/http/types.go

@@ -10,6 +10,7 @@ import (
 // Event to be sent as k8s event
 type Event struct {
 	Waring  bool     `json:"warning"`
+	Action  string   `json:"action"`
 	Reason  string   `json:"reason" validate:"required,first_char_must_be_uppercase"`
 	Message string   `json:"message,omitempty" validate:"required"`
 	Args    []string `json:"args,omitempty"`

pkg/http/types_test.go

@@ -14,6 +14,7 @@ var _ = Describe("types", func() {
 			Waring:  false,
 			Reason:  "AnyReason",
 			Message: "message",
+			Action:  "action",
 		}
 	})
 	Context("Event.Validate", func() {