Feature: support kubectl default-container annotation (#17)

* feat(cli): add support for default-container well known annotation Signed-off-by: ArtemTrofimushkin <artemtrofimushkin@gmail.com> * chore(test): add test cases for default-container Signed-off-by: ArtemTrofimushkin <artemtrofimushkin@gmail.com> * chore(tests): sync test names with flags package Signed-off-by: ArtemTrofimushkin <artemtrofimushkin@gmail.com> * fix(cli): resolve lint issues Signed-off-by: ArtemTrofimushkin <artemtrofimushkin@gmail.com>
dodopizza · Feb 21, 2022 · 81c18cd · 81c18cd
1 parent 1425096
commit 81c18cd
Show file tree

Hide file tree

Showing 7 changed files with 49 additions and 5 deletions.
diff --git a/cli/cmd/launch.go b/cli/cmd/launch.go
@@ -31,7 +31,12 @@ func (cb *CommandBuilder) launch() error {
 		return errors.Wrap(err, "Failed to get info about target pod")
 	}
 
-	targetContainer, err := targetPod.FindContainerInfo(cb.CommonOptions.Container)
+	targetContainerName := cb.CommonOptions.Container
+	if targetContainerName == "" {
+		targetContainerName = targetPod.Annotations["kubectl.kubernetes.io/default-container"]
+	}
+
+	targetContainer, err := targetPod.FindContainerInfo(targetContainerName)
 	if err != nil {
 		return errors.Wrap(err, "Failed to get info about target container")
 	}
@@ -40,7 +45,7 @@ func (cb *CommandBuilder) launch() error {
 		NewJobRunSpec(cb.args(targetContainer), cb.CommonOptions.Image, targetPod).
 		WithContainerFSVolume(targetContainer)
 
-	if targetPod.ContainsMountedTmp(cb.CommonOptions.Container) {
+	if targetPod.ContainsMountedTmp(targetContainerName) {
 		jobSpec.WithContainerMountsVolume(targetContainer)
 	}
 

diff --git a/internal/kubernetes/containers.go b/internal/kubernetes/containers.go
@@ -11,8 +11,8 @@ import (
 
 // ContainerInfo is information about container struct
 type ContainerInfo struct {
-	Runtime string
 	ID      string
+	Runtime string
 }
 
 type containerConfig struct {
@@ -30,8 +30,8 @@ func NewContainerInfo(cs *core.ContainerStatus) *ContainerInfo {
 	containerInfo := strings.Split(cs.ContainerID, "://")
 
 	return &ContainerInfo{
-		Runtime: containerInfo[0],
 		ID:      containerInfo[1],
+		Runtime: containerInfo[0],
 	}
 }
 

diff --git a/internal/kubernetes/pods.go b/internal/kubernetes/pods.go
@@ -15,6 +15,7 @@ import (
 )
 
 type PodInfo struct {
+	Annotations       map[string]string
 	Name              string
 	Node              string
 	containers        []core.Container
@@ -24,6 +25,7 @@ type PodInfo struct {
 // NewPodInfo returns PodInfo generated from core.Pod spec
 func NewPodInfo(pod *core.Pod) *PodInfo {
 	return &PodInfo{
+		Annotations:       pod.Annotations,
 		Name:              pod.Name,
 		Node:              pod.Spec.NodeName,
 		containers:        pod.Spec.Containers,

diff --git a/test/integration/manageddump_test.go → test/integration/dotnet_dump_test.go b/test/integration/manageddump_test.go → test/integration/dotnet_dump_test.go
@@ -41,6 +41,11 @@ func Test_DumpSubcommand(t *testing.T) {
 			},
 			pod: multiContainerPod(),
 		},
+		{
+			name: "MultiContainer pod with default-container annotation",
+			args: []string{},
+			pod:  multiContainerPodWithDefaultContainer(),
+		},
 		{
 			name: "MultiContainer pod with shared mount",
 			args: []string{

diff --git a/test/integration/gcdump_test.go → test/integration/dotnet_gcdump_test.go b/test/integration/gcdump_test.go → test/integration/dotnet_gcdump_test.go
@@ -50,6 +50,11 @@ func Test_GCDumpSubcommand(t *testing.T) {
 			},
 			pod: multiContainerPod(),
 		},
+		{
+			name: "MultiContainer pod with default-container annotation",
+			args: []string{},
+			pod:  multiContainerPodWithDefaultContainer(),
+		},
 		{
 			name: "MultiContainer pod with shared mount",
 			args: []string{

diff --git a/test/integration/trace_test.go → test/integration/dotnet_trace_test.go b/test/integration/trace_test.go → test/integration/dotnet_trace_test.go
@@ -51,13 +51,18 @@ func Test_TraceSubcommand(t *testing.T) {
 			pod: singleContainerPod(),
 		},
 		{
-			name: "Multicontainer pod",
+			name: "MultiContainer pod",
 			args: []string{
 				"--container",
 				targetContainerName,
 			},
 			pod: multiContainerPod(),
 		},
+		{
+			name: "MultiContainer pod with default-container annotation",
+			args: []string{},
+			pod:  multiContainerPodWithDefaultContainer(),
+		},
 		{
 			name: "MultiContainer pod with shared mount",
 			args: []string{

diff --git a/test/integration/helpers_test.go b/test/integration/helpers_test.go
@@ -118,6 +118,28 @@ func multiContainerPod() *core.Pod {
 	}
 }
 
+func multiContainerPodWithDefaultContainer() *core.Pod {
+	objectMeta := generateRandomPodMeta()
+	objectMeta.Annotations = map[string]string{
+		"kubectl.kubernetes.io/default-container": targetContainerName,
+	}
+	return &core.Pod{
+		ObjectMeta: objectMeta,
+		Spec: core.PodSpec{
+			Containers: []core.Container{
+				{
+					Name:  targetContainerName,
+					Image: sampleAppImage,
+				},
+				{
+					Name:  "sidecar",
+					Image: "gcr.io/google_containers/pause-amd64:3.1",
+				},
+			},
+		},
+	}
+}
+
 func multiContainerPodWithSharedMount() *core.Pod {
 	return &core.Pod{
 		ObjectMeta: generateRandomPodMeta(),