feat: log format option for main containers (#9468)

* feat: log format option for main containers adds --log-format and --loglevel flags to "argoexec emissary" for consistent logging output. related to: #8986 #9169 #7361 Signed-off-by: Thomas Bonfort <thomas.bonfort@airbus.com> * update tests Signed-off-by: Thomas Bonfort <thomas.bonfort@airbus.com> * update tests Signed-off-by: Thomas Bonfort <thomas.bonfort@airbus.com> Signed-off-by: Thomas Bonfort <thomas.bonfort@airbus.com>
argoproj · Sep 2, 2022 · 06d2957 · 06d2957
1 parent 1696fb2
commit 06d2957
Show file tree

Hide file tree

Showing 4 changed files with 22 additions and 7 deletions.
diff --git a/workflow/controller/controller_test.go b/workflow/controller/controller_test.go
@@ -186,6 +186,7 @@ func newController(options ...interface{}) (context.CancelFunc, *WorkflowControl
 				S3Bucket: wfv1.S3Bucket{Endpoint: "my-endpoint", Bucket: "my-bucket"},
 			},
 		}),
+		cliExecutorLogFormat:      "text",
 		kubeclientset:             kube,
 		dynamicInterface:          dynamicClient,
 		wfclientset:               wfclientset,

diff --git a/workflow/controller/operator_test.go b/workflow/controller/operator_test.go
@@ -2818,7 +2818,9 @@ func TestResolveIOPathPlaceholders(t *testing.T) {
 	assert.NoError(t, err)
 	assert.True(t, len(pods.Items) > 0, "pod was not created successfully")
 
-	assert.Equal(t, []string{"/var/run/argo/argoexec", "emissary", "--", "sh", "-c", "head -n 3 <\"/inputs/text/data\" | tee \"/outputs/text/data\" | wc -l > \"/outputs/actual-lines-count/data\""}, pods.Items[0].Spec.Containers[1].Command)
+	assert.Equal(t, []string{"/var/run/argo/argoexec", "emissary",
+		"--loglevel", getExecutorLogLevel(), "--log-format", woc.controller.cliExecutorLogFormat,
+		"--", "sh", "-c", "head -n 3 <\"/inputs/text/data\" | tee \"/outputs/text/data\" | wc -l > \"/outputs/actual-lines-count/data\""}, pods.Items[0].Spec.Containers[1].Command)
 }
 
 var outputValuePlaceholders = `

diff --git a/workflow/controller/workflowpod.go b/workflow/controller/workflowpod.go
@@ -385,7 +385,9 @@ func (woc *wfOperationCtx) createWorkflowPod(ctx context.Context, nodeName strin
 					c.Args = x.Cmd
 				}
 			}
-			c.Command = append([]string{common.VarRunArgoPath + "/argoexec", "emissary", "--"}, c.Command...)
+			c.Command = append([]string{common.VarRunArgoPath + "/argoexec", "emissary",
+				"--loglevel", getExecutorLogLevel(), "--log-format", woc.controller.executorLogFormat(),
+				"--"}, c.Command...)
 		}
 		if c.Image == woc.controller.executorImage() {
 			// mount tmp dir to wait container

diff --git a/workflow/controller/workflowpod_test.go b/workflow/controller/workflowpod_test.go
@@ -660,21 +660,27 @@ func Test_createWorkflowPod_emissary(t *testing.T) {
 		woc := newWoc()
 		pod, err := woc.createWorkflowPod(context.Background(), "", []apiv1.Container{{Command: []string{"foo"}}}, &wfv1.Template{}, &createWorkflowPodOpts{})
 		assert.NoError(t, err)
-		assert.Equal(t, []string{"/var/run/argo/argoexec", "emissary", "--", "foo"}, pod.Spec.Containers[1].Command)
+		assert.Equal(t, []string{"/var/run/argo/argoexec", "emissary",
+			"--loglevel", getExecutorLogLevel(), "--log-format", woc.controller.cliExecutorLogFormat,
+			"--", "foo"}, pod.Spec.Containers[1].Command)
 	})
 	t.Run("NoCommandWithImageIndex", func(t *testing.T) {
 		woc := newWoc()
 		pod, err := woc.createWorkflowPod(context.Background(), "", []apiv1.Container{{Image: "my-image"}}, &wfv1.Template{}, &createWorkflowPodOpts{})
 		if assert.NoError(t, err) {
-			assert.Equal(t, []string{"/var/run/argo/argoexec", "emissary", "--", "my-entrypoint"}, pod.Spec.Containers[1].Command)
+			assert.Equal(t, []string{"/var/run/argo/argoexec", "emissary",
+				"--loglevel", getExecutorLogLevel(), "--log-format", woc.controller.cliExecutorLogFormat,
+				"--", "my-entrypoint"}, pod.Spec.Containers[1].Command)
 			assert.Equal(t, []string{"my-cmd"}, pod.Spec.Containers[1].Args)
 		}
 	})
 	t.Run("NoCommandWithArgsWithImageIndex", func(t *testing.T) {
 		woc := newWoc()
 		pod, err := woc.createWorkflowPod(context.Background(), "", []apiv1.Container{{Image: "my-image", Args: []string{"foo"}}}, &wfv1.Template{}, &createWorkflowPodOpts{})
 		if assert.NoError(t, err) {
-			assert.Equal(t, []string{"/var/run/argo/argoexec", "emissary", "--", "my-entrypoint"}, pod.Spec.Containers[1].Command)
+			assert.Equal(t, []string{"/var/run/argo/argoexec", "emissary",
+				"--loglevel", getExecutorLogLevel(), "--log-format", woc.controller.cliExecutorLogFormat,
+				"--", "my-entrypoint"}, pod.Spec.Containers[1].Command)
 			assert.Equal(t, []string{"foo"}, pod.Spec.Containers[1].Args)
 		}
 	})
@@ -689,7 +695,9 @@ func Test_createWorkflowPod_emissary(t *testing.T) {
 		assert.NoError(t, err)
 		pod, err := woc.createWorkflowPod(context.Background(), "", []apiv1.Container{{Command: []string{"foo"}}}, &wfv1.Template{PodSpecPatch: string(podSpecPatch)}, &createWorkflowPodOpts{})
 		assert.NoError(t, err)
-		assert.Equal(t, []string{"/var/run/argo/argoexec", "emissary", "--", "bar"}, pod.Spec.Containers[1].Command)
+		assert.Equal(t, []string{"/var/run/argo/argoexec", "emissary",
+			"--loglevel", getExecutorLogLevel(), "--log-format", woc.controller.cliExecutorLogFormat,
+			"--", "bar"}, pod.Spec.Containers[1].Command)
 	})
 }
 
@@ -745,7 +753,9 @@ func TestVolumeAndVolumeMounts(t *testing.T) {
 				assert.Equal(t, "var-run-argo", wait.VolumeMounts[2].Name)
 			}
 			main := containers[1]
-			assert.Equal(t, []string{"/var/run/argo/argoexec", "emissary", "--", "cowsay"}, main.Command)
+			assert.Equal(t, []string{"/var/run/argo/argoexec", "emissary",
+				"--loglevel", getExecutorLogLevel(), "--log-format", woc.controller.cliExecutorLogFormat,
+				"--", "cowsay"}, main.Command)
 			if assert.Len(t, main.VolumeMounts, 2) {
 				assert.Equal(t, "volume-name", main.VolumeMounts[0].Name)
 				assert.Equal(t, "var-run-argo", main.VolumeMounts[1].Name)