Add internal packages error and reconcile
- internal/error - Contains internal error type used across the source-controller reconcilers. - internal/reconcile - Contains helper abstractions for the controller-runtime reconcile Result type and functions to interact with the abstractions. Signed-off-by: Sunny <darkowlzz@protonmail.com>
This commit is contained in:
Sunny
parent
4d96fd80a8
commit
729941ab2d
|
|
@ -0,0 +1,56 @@
|
|||
/*
|
||||
Copyright 2021 The Flux authors
|
||||
|
||||
Licensed under the Apache License, Version 2.0 (the "License");
|
||||
you may not use this file except in compliance with the License.
|
||||
You may obtain a copy of the License at
|
||||
|
||||
http://www.apache.org/licenses/LICENSE-2.0
|
||||
|
||||
Unless required by applicable law or agreed to in writing, software
|
||||
distributed under the License is distributed on an "AS IS" BASIS,
|
||||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
See the License for the specific language governing permissions and
|
||||
limitations under the License.
|
||||
*/
|
||||
|
||||
package error
|
||||
|
||||
// Stalling is the reconciliation stalled state error. It contains an error
|
||||
// and a reason for the stalled condition.
|
||||
type Stalling struct {
|
||||
// Reason is the stalled condition reason string.
|
||||
Reason string
|
||||
// Err is the error that caused stalling. This can be used as the message in
|
||||
// stalled condition.
|
||||
Err error
|
||||
}
|
||||
|
||||
// Error implements error interface.
|
||||
func (se *Stalling) Error() string {
|
||||
return se.Err.Error()
|
||||
}
|
||||
|
||||
// Unwrap returns the underlying error.
|
||||
func (se *Stalling) Unwrap() error {
|
||||
return se.Err
|
||||
}
|
||||
|
||||
// Event is an error event. It can be used to construct an event to be
|
||||
// recorded.
|
||||
type Event struct {
|
||||
// Reason is the reason for the event error.
|
||||
Reason string
|
||||
// Error is the actual error for the event.
|
||||
Err error
|
||||
}
|
||||
|
||||
// Error implements error interface.
|
||||
func (ee *Event) Error() string {
|
||||
return ee.Err.Error()
|
||||
}
|
||||
|
||||
// Unwrap returns the underlying error.
|
||||
func (ee *Event) Unwrap() error {
|
||||
return ee.Err
|
||||
}
|
||||
|
|
@ -0,0 +1,148 @@
|
|||
/*
|
||||
Copyright 2021 The Flux authors
|
||||
|
||||
Licensed under the Apache License, Version 2.0 (the "License");
|
||||
you may not use this file except in compliance with the License.
|
||||
You may obtain a copy of the License at
|
||||
|
||||
http://www.apache.org/licenses/LICENSE-2.0
|
||||
|
||||
Unless required by applicable law or agreed to in writing, software
|
||||
distributed under the License is distributed on an "AS IS" BASIS,
|
||||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
See the License for the specific language governing permissions and
|
||||
limitations under the License.
|
||||
*/
|
||||
|
||||
package reconcile
|
||||
|
||||
import (
|
||||
"context"
|
||||
|
||||
corev1 "k8s.io/api/core/v1"
|
||||
kuberecorder "k8s.io/client-go/tools/record"
|
||||
ctrl "sigs.k8s.io/controller-runtime"
|
||||
|
||||
"github.com/fluxcd/pkg/apis/meta"
|
||||
"github.com/fluxcd/pkg/runtime/conditions"
|
||||
"github.com/fluxcd/pkg/runtime/patch"
|
||||
|
||||
sourcev1 "github.com/fluxcd/source-controller/api/v1beta2"
|
||||
serror "github.com/fluxcd/source-controller/internal/error"
|
||||
)
|
||||
|
||||
// Result is a type for creating an abstraction for the controller-runtime
|
||||
// reconcile Result to simplify the Result values.
|
||||
type Result int
|
||||
|
||||
const (
|
||||
// ResultEmpty indicates a reconcile result which does not requeue.
|
||||
ResultEmpty Result = iota
|
||||
// ResultRequeue indicates a reconcile result which should immediately
|
||||
// requeue.
|
||||
ResultRequeue
|
||||
// ResultSuccess indicates a reconcile result which should be
|
||||
// requeued on the interval as defined on the reconciled object.
|
||||
ResultSuccess
|
||||
)
|
||||
|
||||
// BuildRuntimeResult converts a given Result and error into the
|
||||
// return values of a controller's Reconcile function.
|
||||
func BuildRuntimeResult(ctx context.Context, recorder kuberecorder.EventRecorder, obj sourcev1.Source, rr Result, err error) (ctrl.Result, error) {
|
||||
// NOTE: The return values can be modified based on the error type.
|
||||
// For example, if an error signifies a short requeue period that's
|
||||
// not equal to the requeue period of the object, the error can be checked
|
||||
// and an appropriate result with the period can be returned.
|
||||
//
|
||||
// Example:
|
||||
// if e, ok := err.(*waitError); ok {
|
||||
// return ctrl.Result{RequeueAfter: e.RequeueAfter}, err
|
||||
// }
|
||||
|
||||
// Log and record event based on the error.
|
||||
switch e := err.(type) {
|
||||
case *serror.Event:
|
||||
recorder.Eventf(obj, corev1.EventTypeWarning, e.Reason, e.Error())
|
||||
case *serror.Stalling:
|
||||
// Stalling errors are not returned to the runtime. Log it explicitly.
|
||||
ctrl.LoggerFrom(ctx).Error(e, "reconciliation stalled")
|
||||
recorder.Eventf(obj, corev1.EventTypeWarning, e.Reason, e.Error())
|
||||
}
|
||||
|
||||
switch rr {
|
||||
case ResultRequeue:
|
||||
return ctrl.Result{Requeue: true}, err
|
||||
case ResultSuccess:
|
||||
return ctrl.Result{RequeueAfter: obj.GetRequeueAfter()}, err
|
||||
default:
|
||||
return ctrl.Result{}, err
|
||||
}
|
||||
}
|
||||
|
||||
// ComputeReconcileResult analyzes the reconcile results (result + error),
|
||||
// updates the status conditions of the object with any corrections and returns
|
||||
// result patch configuration and any error to the caller. The caller is
|
||||
// responsible for using the patch option to patch the object in the API server.
|
||||
func ComputeReconcileResult(obj conditions.Setter, res Result, recErr error, ownedConditions []string) ([]patch.Option, error) {
|
||||
// Remove reconciling condition on successful reconciliation.
|
||||
if recErr == nil && res == ResultSuccess {
|
||||
conditions.Delete(obj, meta.ReconcilingCondition)
|
||||
}
|
||||
|
||||
// Patch the object, ignoring conflicts on the conditions owned by this controller.
|
||||
pOpts := []patch.Option{
|
||||
patch.WithOwnedConditions{
|
||||
Conditions: ownedConditions,
|
||||
},
|
||||
}
|
||||
|
||||
// Analyze the reconcile error.
|
||||
switch t := recErr.(type) {
|
||||
case *serror.Stalling:
|
||||
if res == ResultEmpty {
|
||||
// The current generation has been reconciled successfully and it
|
||||
// has resulted in a stalled state. Return no error to stop further
|
||||
// requeuing.
|
||||
pOpts = append(pOpts, patch.WithStatusObservedGeneration{})
|
||||
conditions.MarkStalled(obj, t.Reason, t.Error())
|
||||
return pOpts, nil
|
||||
}
|
||||
// NOTE: Non-empty result with stalling error indicates that the
|
||||
// returned result is incorrect.
|
||||
case nil:
|
||||
// The reconcile didn't result in any error, we are not in stalled
|
||||
// state. If a requeue is requested, the current generation has not been
|
||||
// reconciled successfully.
|
||||
if res != ResultRequeue {
|
||||
pOpts = append(pOpts, patch.WithStatusObservedGeneration{})
|
||||
}
|
||||
conditions.Delete(obj, meta.StalledCondition)
|
||||
default:
|
||||
// The reconcile resulted in some error, but we are not in stalled
|
||||
// state.
|
||||
conditions.Delete(obj, meta.StalledCondition)
|
||||
}
|
||||
|
||||
return pOpts, recErr
|
||||
}
|
||||
|
||||
// LowestRequeuingResult returns the ReconcileResult with the lowest requeue
|
||||
// period.
|
||||
// Weightage:
|
||||
// ResultRequeue - immediate requeue (lowest)
|
||||
// ResultSuccess - requeue at an interval
|
||||
// ResultEmpty - no requeue
|
||||
func LowestRequeuingResult(i, j Result) Result {
|
||||
switch {
|
||||
case i == ResultEmpty:
|
||||
return j
|
||||
case j == ResultEmpty:
|
||||
return i
|
||||
case i == ResultRequeue:
|
||||
return i
|
||||
case j == ResultRequeue:
|
||||
return j
|
||||
default:
|
||||
return j
|
||||
}
|
||||
}
|
||||
|
|
@ -0,0 +1,47 @@
|
|||
/*
|
||||
Copyright 2021 The Flux authors
|
||||
|
||||
Licensed under the Apache License, Version 2.0 (the "License");
|
||||
you may not use this file except in compliance with the License.
|
||||
You may obtain a copy of the License at
|
||||
|
||||
http://www.apache.org/licenses/LICENSE-2.0
|
||||
|
||||
Unless required by applicable law or agreed to in writing, software
|
||||
distributed under the License is distributed on an "AS IS" BASIS,
|
||||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
See the License for the specific language governing permissions and
|
||||
limitations under the License.
|
||||
*/
|
||||
|
||||
package reconcile
|
||||
|
||||
import (
|
||||
"testing"
|
||||
|
||||
. "github.com/onsi/gomega"
|
||||
)
|
||||
|
||||
func TestLowestRequeuingResult(t *testing.T) {
|
||||
tests := []struct {
|
||||
name string
|
||||
i Result
|
||||
j Result
|
||||
wantResult Result
|
||||
}{
|
||||
{"bail,requeue", ResultEmpty, ResultRequeue, ResultRequeue},
|
||||
{"bail,requeueInterval", ResultEmpty, ResultSuccess, ResultSuccess},
|
||||
{"requeue,bail", ResultRequeue, ResultEmpty, ResultRequeue},
|
||||
{"requeue,requeueInterval", ResultRequeue, ResultSuccess, ResultRequeue},
|
||||
{"requeueInterval,requeue", ResultSuccess, ResultRequeue, ResultRequeue},
|
||||
{"requeueInterval,requeueInterval", ResultSuccess, ResultSuccess, ResultSuccess},
|
||||
}
|
||||
|
||||
for _, tt := range tests {
|
||||
t.Run(tt.name, func(t *testing.T) {
|
||||
g := NewWithT(t)
|
||||
|
||||
g.Expect(LowestRequeuingResult(tt.i, tt.j)).To(Equal(tt.wantResult))
|
||||
})
|
||||
}
|
||||
}
|
||||
Loading…
Reference in New Issue