Skip to content
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

K8SGCSReporter: Fix handling of aborted jobs #19048

Merged
merged 1 commit into from
Aug 31, 2020
Merged

K8SGCSReporter: Fix handling of aborted jobs #19048

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
1 change: 1 addition & 0 deletions prow/crier/reporters/gcs/kubernetes/BUILD.bazel
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,7 @@ go_test(
"@io_k8s_api//core/v1:go_default_library",
"@io_k8s_apimachinery//pkg/apis/meta/v1:go_default_library",
"@io_k8s_apimachinery//pkg/types:go_default_library",
"@io_k8s_sigs_controller_runtime//pkg/reconcile:go_default_library",
],
)

Expand Down
20 changes: 13 additions & 7 deletions prow/crier/reporters/gcs/kubernetes/reporter.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -94,27 +94,33 @@ func (rg k8sResourceGetter) GetEvents(cluster, namespace string, pod *v1.Pod) ([
}

func (gr *gcsK8sReporter) Report(log *logrus.Entry, pj *prowv1.ProwJob) ([]*prowv1.ProwJob, *reconcile.Result, error) {
return []*prowv1.ProwJob{pj}, nil, gr.report(log, pj)
result, err := gr.report(log, pj)
return []*prowv1.ProwJob{pj}, result, err
}

func (gr *gcsK8sReporter) report(log *logrus.Entry, pj *prowv1.ProwJob) error {
func (gr *gcsK8sReporter) report(log *logrus.Entry, pj *prowv1.ProwJob) (*reconcile.Result, error) {
ctx, cancel := context.WithTimeout(context.Background(), 10*time.Second) // TODO: pass through a global context?
defer cancel()

if !pj.Complete() {
if !pj.Complete() && pj.Status.State != prowv1.AbortedState {
if err := gr.addFinalizer(pj); err != nil {
return fmt.Errorf("failed to add finalizer to pod: %w", err)
return nil, fmt.Errorf("failed to add finalizer to pod: %w", err)
}
return nil
return nil, nil
}

// Aborted jobs are not completed initially
if !pj.Complete() {
return &reconcile.Result{RequeueAfter: 10 * time.Second}, nil
}

_, _, err := util.GetJobDestination(gr.cfg, pj)
if err != nil {
log.WithError(err).Warn("Not uploading because we couldn't find a destination")
return nil
return nil, nil
}

return gr.reportPodInfo(ctx, log, pj)
return nil, gr.reportPodInfo(ctx, log, pj)
}

func (gr *gcsK8sReporter) addFinalizer(pj *prowv1.ProwJob) error {
Expand Down
58 changes: 47 additions & 11 deletions prow/crier/reporters/gcs/kubernetes/reporter_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@ import (
"k8s.io/apimachinery/pkg/types"
"k8s.io/test-infra/prow/config"
"k8s.io/test-infra/prow/crier/reporters/gcs/internal/testutil"
"sigs.k8s.io/controller-runtime/pkg/reconcile"

prowv1 "k8s.io/test-infra/prow/apis/prowjobs/v1"
)
Expand Down Expand Up @@ -176,16 +177,18 @@ func (rg testResourceGetter) PatchPod(cluster, namespace, name string, pt types.

func TestReportPodInfo(t *testing.T) {
tests := []struct {
name string
pjName string
pjComplete bool
pjPending bool
pod *v1.Pod
events []v1.Event
dryRun bool
expectReport bool
expectErr bool
expectedPatch string
name string
pjName string
pjComplete bool
pjPending bool
pjState prowv1.ProwJobState
pod *v1.Pod
events []v1.Event
dryRun bool
expectReport bool
expectErr bool
expectedPatch string
expectedReconcileResult *reconcile.Result
}{
{
name: "prowjob picks up pod and events",
Expand Down Expand Up @@ -291,6 +294,32 @@ func TestReportPodInfo(t *testing.T) {
expectReport: true,
expectedPatch: `{"metadata":{"finalizers":null}}`,
},
{
name: "RequeueAfter is returned for incomplete aborted job and nothing happens",
pjName: "ba123965-4fd4-421f-8509-7590c129ab69",
pjState: prowv1.AbortedState,
pjPending: false,
pjComplete: false,
expectReport: false,
expectedReconcileResult: &reconcile.Result{RequeueAfter: 10 * time.Second},
},
{
name: "Completed aborted job is reported",
pjName: "ba123965-4fd4-421f-8509-7590c129ab69",
pjState: prowv1.AbortedState,
pjPending: false,
pjComplete: true,
pod: &v1.Pod{
ObjectMeta: metav1.ObjectMeta{
Finalizers: []string{"gcsk8sreporter"},
Name: "ba123965-4fd4-421f-8509-7590c129ab69",
Namespace: "test-pods",
Labels: map[string]string{"created-by-prow": "true"},
},
},
expectReport: true,
expectedPatch: `{"metadata":{"finalizers":null}}`,
},
}

for _, tc := range tests {
Expand All @@ -316,6 +345,9 @@ func TestReportPodInfo(t *testing.T) {
if tc.pjPending {
pj.Status.PendingTime = &metav1.Time{}
}
if tc.pjState != "" {
pj.Status.State = tc.pjState
}

fca := testutil.Fca{C: config.Config{ProwConfig: config.ProwConfig{
PodNamespace: "test-pods",
Expand All @@ -342,7 +374,7 @@ func TestReportPodInfo(t *testing.T) {
}
author := &testutil.TestAuthor{}
reporter := internalNew(fca.Config, author, rg, 1.0, tc.dryRun)
err := reporter.report(logrus.NewEntry(logrus.StandardLogger()), pj)
reconcileResult, err := reporter.report(logrus.NewEntry(logrus.StandardLogger()), pj)

if tc.expectErr {
if err == nil {
Expand All @@ -353,6 +385,10 @@ func TestReportPodInfo(t *testing.T) {
t.Fatalf("Unexpected error: %v", err)
}

if diff := cmp.Diff(reconcileResult, tc.expectedReconcileResult); diff != "" {
t.Errorf("reconcileResult differs from expected reconcileResult: %s", diff)
}

if !tc.expectReport {
if author.AlreadyUsed {
t.Fatalf("Expected nothing to be written, but something was written to %q:\n\n%s", author.Path, string(author.Content))
Expand Down