Skip to content

Commit

Permalink
Remove ignoreNotFound and rely on client
Browse files Browse the repository at this point in the history
  • Loading branch information
@gregoryguillou
gregoryguillou committed Jan 5, 2020
1 parent 37c19b5 commit f9f8f59
Show file tree
Hide file tree
Showing 4 changed files with 9 additions and 52 deletions.
2 changes: 1 addition & 1 deletion docs/book/src/cronjob-tutorial/testdata/finalizer_example.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ func (r *CronJobReconciler) Reconcile(req ctrl.Request) (ctrl.Result, error) {
// we'll ignore not-found errors, since they can't be fixed by an immediate
// requeue (we'll need to wait for a new notification), and we can get them
// on deleted requests.
return ctrl.Result{}, ignoreNotFound(err)
return ctrl.Result{}, client.IgnoreNotFound(err)
}

// name of our custom finalizer
Expand Down
23 changes: 4 additions & 19 deletions docs/book/src/cronjob-tutorial/testdata/project/controllers/cronjob_controller.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,6 @@ import (
"github.com/robfig/cron"
kbatch "k8s.io/api/batch/v1"
corev1 "k8s.io/api/core/v1"
apierrs "k8s.io/apimachinery/pkg/api/errors"
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
"k8s.io/apimachinery/pkg/runtime"
ref "k8s.io/client-go/tools/reference"
Expand Down Expand Up @@ -71,20 +70,6 @@ type Clock interface {

// +kubebuilder:docs-gen:collapse=Clock

/*
We generally want to ignore (not requeue) NotFound errors, since we'll get a
reconciliation request once the object exists, and requeuing in the meantime
won't help.
*/
func ignoreNotFound(err error) error {
if apierrs.IsNotFound(err) {
return nil
}
return err
}

// +kubebuilder:docs-gen:collapse=ignoreNotFound

/*
Notice that we need a few more RBAC permissions -- since we're creating and
managing jobs now, we'll need permissions for those, which means adding
Expand Down Expand Up @@ -125,7 +110,7 @@ func (r *CronJobReconciler) Reconcile(req ctrl.Request) (ctrl.Result, error) {
// we'll ignore not-found errors, since they can't be fixed by an immediate
// requeue (we'll need to wait for a new notification), and we can get them
// on deleted requests.
return ctrl.Result{}, ignoreNotFound(err)
return ctrl.Result{}, client.IgnoreNotFound(err)
}

/*
Expand Down Expand Up @@ -280,7 +265,7 @@ func (r *CronJobReconciler) Reconcile(req ctrl.Request) (ctrl.Result, error) {
if int32(i) >= int32(len(failedJobs))-*cronJob.Spec.FailedJobsHistoryLimit {
break
}
if err := r.Delete(ctx, job, client.PropagationPolicy(metav1.DeletePropagationBackground)); ignoreNotFound(err) != nil {
if err := r.Delete(ctx, job, client.PropagationPolicy(metav1.DeletePropagationBackground)); client.IgnoreNotFound(err) != nil {
log.Error(err, "unable to delete old failed job", "job", job)
} else {
log.V(0).Info("deleted old failed job", "job", job)
Expand All @@ -299,7 +284,7 @@ func (r *CronJobReconciler) Reconcile(req ctrl.Request) (ctrl.Result, error) {
if int32(i) >= int32(len(successfulJobs))-*cronJob.Spec.SuccessfulJobsHistoryLimit {
break
}
if err := r.Delete(ctx, job, client.PropagationPolicy(metav1.DeletePropagationBackground)); ignoreNotFound(err) != nil {
if err := r.Delete(ctx, job, client.PropagationPolicy(metav1.DeletePropagationBackground)); (err) != nil {
log.Error(err, "unable to delete old successful job", "job", job)
} else {
log.V(0).Info("deleted old successful job", "job", job)
Expand Down Expand Up @@ -446,7 +431,7 @@ func (r *CronJobReconciler) Reconcile(req ctrl.Request) (ctrl.Result, error) {
if cronJob.Spec.ConcurrencyPolicy == batch.ReplaceConcurrent {
for _, activeJob := range activeJobs {
// we don't care if the job was already deleted
if err := r.Delete(ctx, activeJob, client.PropagationPolicy(metav1.DeletePropagationBackground)); ignoreNotFound(err) != nil {
if err := r.Delete(ctx, activeJob, client.PropagationPolicy(metav1.DeletePropagationBackground)); client.IgnoreNotFound(err) != nil {
log.Error(err, "unable to delete active job", "job", activeJob)
return ctrl.Result{}, err
}
Expand Down
17 changes: 2 additions & 15 deletions ...ook/src/migration/testdata/gopath/project-v1/pkg/controller/cronjob/cronjob_controller.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,6 @@ import (

kbatch "k8s.io/api/batch/v1"
corev1 "k8s.io/api/core/v1"
apierrs "k8s.io/apimachinery/pkg/api/errors"
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
"k8s.io/apimachinery/pkg/fields"
"k8s.io/apimachinery/pkg/runtime"
Expand Down Expand Up @@ -108,18 +107,6 @@ type Clock interface {
Now() time.Time
}

/*
We generally want to ignore (not requeue) NotFound errors, since we'll get a
reconciliation request once the object exists, and requeuing in the meantime
won't help.
*/
func ignoreNotFound(err error) error {
if apierrs.IsNotFound(err) {
return nil
}
return err
}

var (
scheduledTimeAnnotation = "batch.tutorial.kubebuilder.io/scheduled-at"
)
Expand All @@ -142,7 +129,7 @@ func (r *ReconcileCronJob) Reconcile(req reconcile.Request) (reconcile.Result, e
// we'll ignore not-found errors, since they can't be fixed by an immediate
// requeue (we'll need to wait for a new notification), and we can get them
// on deleted requests.
return ctrl.Result{}, ignoreNotFound(err)
return ctrl.Result{}, client.IgnoreNotFound(err)
}

var childJobs kbatch.JobList
Expand Down Expand Up @@ -372,7 +359,7 @@ func (r *ReconcileCronJob) Reconcile(req reconcile.Request) (reconcile.Result, e
if cronJob.Spec.ConcurrencyPolicy == batchv1.ReplaceConcurrent {
for _, activeJob := range activeJobs {
// we don't care if the job was already deleted
if err := r.Delete(ctx, activeJob); ignoreNotFound(err) != nil {
if err := r.Delete(ctx, activeJob); client.IgnoreNotFound(err) != nil {
log.Error(err, "unable to delete active job", "job", activeJob)
return ctrl.Result{}, err
}
Expand Down
19 changes: 2 additions & 17 deletions docs/book/src/multiversion-tutorial/testdata/project/controllers/cronjob_controller.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,6 @@ import (
"github.com/robfig/cron"
kbatch "k8s.io/api/batch/v1"
corev1 "k8s.io/api/core/v1"
apierrs "k8s.io/apimachinery/pkg/api/errors"
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
"k8s.io/apimachinery/pkg/runtime"
ref "k8s.io/client-go/tools/reference"
Expand Down Expand Up @@ -71,20 +70,6 @@ type Clock interface {

// +kubebuilder:docs-gen:collapse=Clock

/*
We generally want to ignore (not requeue) NotFound errors, since we'll get a
reconciliation request once the object exists, and requeuing in the meantime
won't help.
*/
func ignoreNotFound(err error) error {
if apierrs.IsNotFound(err) {
return nil
}
return err
}

// +kubebuilder:docs-gen:collapse=ignoreNotFound

/*
Notice that we need a few more RBAC permissions -- since we're creating and
managing jobs now, we'll need permissions for those, which means adding
Expand Down Expand Up @@ -125,7 +110,7 @@ func (r *CronJobReconciler) Reconcile(req ctrl.Request) (ctrl.Result, error) {
// we'll ignore not-found errors, since they can't be fixed by an immediate
// requeue (we'll need to wait for a new notification), and we can get them
// on deleted requests.
return ctrl.Result{}, ignoreNotFound(err)
return ctrl.Result{}, client.IgnoreNotFound(err)
}

/*
Expand Down Expand Up @@ -442,7 +427,7 @@ func (r *CronJobReconciler) Reconcile(req ctrl.Request) (ctrl.Result, error) {
if cronJob.Spec.ConcurrencyPolicy == batch.ReplaceConcurrent {
for _, activeJob := range activeJobs {
// we don't care if the job was already deleted
if err := r.Delete(ctx, activeJob); ignoreNotFound(err) != nil {
if err := r.Delete(ctx, activeJob); client.IgnoreNotFound(err) != nil {
log.Error(err, "unable to delete active job", "job", activeJob)
return ctrl.Result{}, err
}
Expand Down

0 comments on commit f9f8f59

Please sign in to comment.