Skip to content

[release-v1.3.x] check initContainers for kubernetes sidecar implementation #8997

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Sep 4, 2025
Merged

[release-v1.3.x] check initContainers for kubernetes sidecar implementation #8997

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 23 additions & 0 deletions pkg/pod/status.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -127,6 +127,13 @@ func MakeTaskRunStatus(ctx context.Context, logger *zap.SugaredLogger, tr v1.Tas

complete := areContainersCompleted(ctx, pod) || isPodCompleted(pod)

// When EnableKubernetesSidecar is true, we need to ensure all init containers
// are completed before considering the taskRun complete, in addition to the regular containers.
// This is because sidecars in Kubernetes can keep running after the main containers complete.
if config.FromContextOrDefaults(ctx).FeatureFlags.EnableKubernetesSidecar {
complete = complete && areInitContainersCompleted(ctx, pod)
}

if complete {
onError, ok := tr.Annotations[v1.PipelineTaskOnErrorAnnotation]
if ok {
Expand Down Expand Up @@ -157,6 +164,7 @@ func MakeTaskRunStatus(ctx context.Context, logger *zap.SugaredLogger, tr v1.Tas
}

err := setTaskRunStatusBasedOnStepStatus(ctx, logger, stepStatuses, &tr, pod.Status.Phase, kubeclient, ts)

setTaskRunStatusBasedOnSidecarStatus(sidecarStatuses, trs)

trs.Results = removeDuplicateResults(trs.Results)
Expand Down Expand Up @@ -699,6 +707,21 @@ func isMatchingAnyFilter(name string, filters []containerNameFilter) bool {
return false
}

// areInitContainersCompleted returns true if all init containers in the pod are completed.
func areInitContainersCompleted(ctx context.Context, pod *corev1.Pod) bool {
if len(pod.Status.InitContainerStatuses) == 0 ||
!(pod.Status.Phase == corev1.PodRunning || pod.Status.Phase == corev1.PodSucceeded) {
return false
}
for _, containerStatus := range pod.Status.InitContainerStatuses {
if containerStatus.State.Terminated == nil {
// if any init container is not completed, return false
return false
}
}
return true
}

// areContainersCompleted returns true if all related containers in the pod are completed.
func areContainersCompleted(ctx context.Context, pod *corev1.Pod) bool {
nameFilters := []containerNameFilter{IsContainerStep}
Expand Down
226 changes: 226 additions & 0 deletions pkg/pod/status_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ package pod

import (
"fmt"
"reflect"
"strings"
"testing"
"time"
Expand Down Expand Up @@ -2193,6 +2194,231 @@ func TestMakeTaskRunStatus_SidecarNotCompleted(t *testing.T) {
}
}

func TestMakeTaskRunStatus_KubernetesNativeSidecar(t *testing.T) {
for _, c := range []struct {
desc string
podStatus corev1.PodStatus
pod corev1.Pod
taskSpec v1.TaskSpec
want v1.TaskRunStatus
}{{
desc: "test sidecar not completed - single sidecar",
podStatus: corev1.PodStatus{
Phase: corev1.PodRunning,
ContainerStatuses: []corev1.ContainerStatus{
{
Name: "step-foo",
State: corev1.ContainerState{
Terminated: &corev1.ContainerStateTerminated{
Message: `[{"key":"resultName","value":"", "type":1}, {"key":"digest","value":"sha256:1234","resourceName":"source-image"}]`,
},
},
},
{
Name: "step-bar",
State: corev1.ContainerState{
Terminated: &corev1.ContainerStateTerminated{
Message: `[{"key":"digest","value":"sha256:1234","resourceName":"source-image"}]`,
},
},
}},
InitContainerStatuses: []corev1.ContainerStatus{
{
Name: "sidecar-baz-1",
State: corev1.ContainerState{
Terminated: nil,
},
},
},
},
taskSpec: v1.TaskSpec{
Steps: []v1.Step{{Name: "step-foo"}, {Name: "step-bar"}},
Sidecars: []v1.Sidecar{{Name: "sidecar-baz"}},
Results: []v1.TaskResult{
{
Name: "resultName",
Type: v1.ResultsTypeString,
},
},
},
pod: corev1.Pod{
ObjectMeta: metav1.ObjectMeta{
Name: "pod",
Namespace: "foo",
CreationTimestamp: metav1.Now(),
},
Spec: corev1.PodSpec{
Containers: []corev1.Container{{
Name: "step-foo",
}, {
Name: "step-bar",
}},
InitContainers: []corev1.Container{{
Name: "sidecar-baz-1",
}},
},
},
want: v1.TaskRunStatus{
Status: statusRunning(),
},
}, {
desc: "test sidecar not completed - two sidecars",
podStatus: corev1.PodStatus{
Phase: corev1.PodRunning,
ContainerStatuses: []corev1.ContainerStatus{
{
Name: "step-foo",
State: corev1.ContainerState{
Terminated: &corev1.ContainerStateTerminated{
Message: `[{"key":"resultName","value":"", "type":1}, {"key":"digest","value":"sha256:1234","resourceName":"source-image"}]`,
},
},
},
{
Name: "step-bar",
State: corev1.ContainerState{
Terminated: &corev1.ContainerStateTerminated{
Message: `[{"key":"digest","value":"sha256:1234","resourceName":"source-image"}]`,
},
},
}},
InitContainerStatuses: []corev1.ContainerStatus{
{
Name: "sidecar-baz-1",
State: corev1.ContainerState{
Terminated: nil,
},
},
{
Name: "sidecar-baz-2",
State: corev1.ContainerState{
Terminated: &corev1.ContainerStateTerminated{
ExitCode: 0,
},
},
},
},
},
taskSpec: v1.TaskSpec{
Steps: []v1.Step{{Name: "step-foo"}, {Name: "step-bar"}},
Sidecars: []v1.Sidecar{{Name: "sidecar-baz"}},
Results: []v1.TaskResult{
{
Name: "resultName",
Type: v1.ResultsTypeString,
},
},
},
want: v1.TaskRunStatus{
Status: statusRunning(),
},
}, {
desc: "test sidecar already completed",
podStatus: corev1.PodStatus{
Phase: corev1.PodRunning,
ContainerStatuses: []corev1.ContainerStatus{
{
Name: "step-foo",
State: corev1.ContainerState{
Terminated: &corev1.ContainerStateTerminated{
Message: `[{"key":"digest","value":"sha256:1234","resourceName":"source-image"}]`,
},
},
},
{
Name: "step-bar",
State: corev1.ContainerState{
Terminated: &corev1.ContainerStateTerminated{
Message: `[{"key":"resultName","value":"", "type":1}, {"key":"digest","value":"sha256:1234","resourceName":"source-image"}]`,
},
},
}},
InitContainerStatuses: []corev1.ContainerStatus{
{
Name: "sidecar-baz-1",
State: corev1.ContainerState{
Terminated: &corev1.ContainerStateTerminated{
ExitCode: 0,
},
},
},
{
Name: "sidecar-baz-2",
State: corev1.ContainerState{
Terminated: &corev1.ContainerStateTerminated{
ExitCode: 0,
},
},
},
},
},
taskSpec: v1.TaskSpec{
Steps: []v1.Step{{Name: "step-bar"}},
Sidecars: []v1.Sidecar{{Name: "sidecar-baz"}},
Results: []v1.TaskResult{
{
Name: "resultName",
Type: v1.ResultsTypeString,
},
},
},
want: v1.TaskRunStatus{
Status: statusSuccess(),
},
}} {
t.Run(c.desc, func(t *testing.T) {
if reflect.DeepEqual(c.pod, corev1.Pod{}) {
c.pod = corev1.Pod{
ObjectMeta: metav1.ObjectMeta{
Name: "pod",
Namespace: "foo",
CreationTimestamp: metav1.Now(),
},
Spec: corev1.PodSpec{
Containers: []corev1.Container{{
Name: "step-foo",
}, {
Name: "step-bar",
}},
InitContainers: []corev1.Container{{
Name: "sidecar-baz-1",
}, {
Name: "sidecar-baz-2",
}},
},
}
}

c.pod.Status = c.podStatus

tr := v1.TaskRun{
ObjectMeta: metav1.ObjectMeta{
Name: "task-run",
Namespace: "foo",
},
Status: v1.TaskRunStatus{
TaskRunStatusFields: v1.TaskRunStatusFields{
TaskSpec: &c.taskSpec,
},
},
}
logger, _ := logging.NewLogger("", "status")
kubeclient := fakek8s.NewSimpleClientset()
ctx := config.ToContext(t.Context(), &config.Config{
FeatureFlags: &config.FeatureFlags{
ResultExtractionMethod: config.ResultExtractionMethodSidecarLogs,
MaxResultSize: 1024,
EnableKubernetesSidecar: true,
},
})
got, _ := MakeTaskRunStatus(ctx, logger, tr, &c.pod, kubeclient, &c.taskSpec)
if d := cmp.Diff(c.want.Status, got.Status, ignoreVolatileTime); d != "" {
t.Errorf("Unexpected status: %s", diff.PrintWantGot(d))
}
})
}
}

func TestMakeTaskRunStatusAlpha(t *testing.T) {
for _, c := range []struct {
desc string
Expand Down
Loading