-
Notifications
You must be signed in to change notification settings - Fork 331
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Move Condition stuff to apis, add a v1beta1 Status.
This moves the common Condition stuff to apis, and creates a v1beta1 form of Status that uses the Condition it defines (changing this in v1alpha1 is too breaking). There aren't really any meaningful changes in this PR, mostly reorganization. Enumerating what I did: 1. Copied `condition_set*.go` to `apis/`, 1. Copied the `Condition` portions of `conditions_types.go` to `apis/`, 1. Copied the balance of `conditions_types.go` to `apis/duck/v1beta1/status_types.go`, 1. Changed the parts of the above to reference things in the appropriate new places, 1. Removed the reflection-based `ConditionsAccessor` stuff, implementing it instead on `duckv1beta1.Status`. 1. Incorporate: #358
- Loading branch information
Showing
62 changed files
with
2,191 additions
and
50 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,318 @@ | ||
/* | ||
Copyright 2019 The Knative 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 apis | ||
|
||
import ( | ||
"reflect" | ||
"sort" | ||
"time" | ||
|
||
"fmt" | ||
|
||
corev1 "k8s.io/api/core/v1" | ||
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1" | ||
) | ||
|
||
// Conditions is the interface for a Resource that implements the getter and | ||
// setter for accessing a Condition collection. | ||
// +k8s:deepcopy-gen=true | ||
type ConditionsAccessor interface { | ||
GetConditions() Conditions | ||
SetConditions(Conditions) | ||
} | ||
|
||
// ConditionSet is an abstract collection of the possible ConditionType values | ||
// that a particular resource might expose. It also holds the "happy condition" | ||
// for that resource, which we define to be one of Ready or Succeeded depending | ||
// on whether it is a Living or Batch process respectively. | ||
// +k8s:deepcopy-gen=false | ||
type ConditionSet struct { | ||
happy ConditionType | ||
dependents []ConditionType | ||
} | ||
|
||
// ConditionManager allows a resource to operate on its Conditions using higher | ||
// order operations. | ||
type ConditionManager interface { | ||
// IsHappy looks at the happy condition and returns true if that condition is | ||
// set to true. | ||
IsHappy() bool | ||
|
||
// GetCondition finds and returns the Condition that matches the ConditionType | ||
// previously set on Conditions. | ||
GetCondition(t ConditionType) *Condition | ||
|
||
// SetCondition sets or updates the Condition on Conditions for Condition.Type. | ||
// If there is an update, Conditions are stored back sorted. | ||
SetCondition(new Condition) | ||
|
||
// MarkTrue sets the status of t to true, and then marks the happy condition to | ||
// true if all dependents are true. | ||
MarkTrue(t ConditionType) | ||
|
||
// MarkUnknown sets the status of t to Unknown and also sets the happy condition | ||
// to Unknown if no other dependent condition is in an error state. | ||
MarkUnknown(t ConditionType, reason, messageFormat string, messageA ...interface{}) | ||
|
||
// MarkFalse sets the status of t and the happy condition to False. | ||
MarkFalse(t ConditionType, reason, messageFormat string, messageA ...interface{}) | ||
|
||
// InitializeConditions updates all Conditions in the ConditionSet to Unknown | ||
// if not set. | ||
InitializeConditions() | ||
|
||
// InitializeCondition updates a Condition to Unknown if not set. | ||
InitializeCondition(t ConditionType) | ||
} | ||
|
||
// NewLivingConditionSet returns a ConditionSet to hold the conditions for the | ||
// living resource. ConditionReady is used as the happy condition. | ||
// The set of condition types provided are those of the terminal subconditions. | ||
func NewLivingConditionSet(d ...ConditionType) ConditionSet { | ||
return newConditionSet(ConditionReady, d...) | ||
} | ||
|
||
// NewBatchConditionSet returns a ConditionSet to hold the conditions for the | ||
// batch resource. ConditionSucceeded is used as the happy condition. | ||
// The set of condition types provided are those of the terminal subconditions. | ||
func NewBatchConditionSet(d ...ConditionType) ConditionSet { | ||
return newConditionSet(ConditionSucceeded, d...) | ||
} | ||
|
||
// newConditionSet returns a ConditionSet to hold the conditions that are | ||
// important for the caller. The first ConditionType is the overarching status | ||
// for that will be used to signal the resources' status is Ready or Succeeded. | ||
func newConditionSet(happy ConditionType, dependents ...ConditionType) ConditionSet { | ||
var deps []ConditionType | ||
for _, d := range dependents { | ||
// Skip duplicates | ||
if d == happy || contains(deps, d) { | ||
continue | ||
} | ||
deps = append(deps, d) | ||
} | ||
return ConditionSet{ | ||
happy: happy, | ||
dependents: deps, | ||
} | ||
} | ||
|
||
func contains(ct []ConditionType, t ConditionType) bool { | ||
for _, c := range ct { | ||
if c == t { | ||
return true | ||
} | ||
} | ||
return false | ||
} | ||
|
||
// Check that conditionsImpl implements ConditionManager. | ||
var _ ConditionManager = (*conditionsImpl)(nil) | ||
|
||
// conditionsImpl implements the helper methods for evaluating Conditions. | ||
// +k8s:deepcopy-gen=false | ||
type conditionsImpl struct { | ||
ConditionSet | ||
accessor ConditionsAccessor | ||
} | ||
|
||
// Manage creates a ConditionManager from a accessor object using the original | ||
// ConditionSet as a reference. Status must be or point to a struct. | ||
func (r ConditionSet) Manage(status ConditionsAccessor) ConditionManager { | ||
return conditionsImpl{ | ||
accessor: status, | ||
ConditionSet: r, | ||
} | ||
} | ||
|
||
// IsHappy looks at the happy condition and returns true if that condition is | ||
// set to true. | ||
func (r conditionsImpl) IsHappy() bool { | ||
if c := r.GetCondition(r.happy); c == nil || !c.IsTrue() { | ||
return false | ||
} | ||
return true | ||
} | ||
|
||
// GetCondition finds and returns the Condition that matches the ConditionType | ||
// previously set on Conditions. | ||
func (r conditionsImpl) GetCondition(t ConditionType) *Condition { | ||
if r.accessor == nil { | ||
return nil | ||
} | ||
|
||
for _, c := range r.accessor.GetConditions() { | ||
if c.Type == t { | ||
return &c | ||
} | ||
} | ||
return nil | ||
} | ||
|
||
// SetCondition sets or updates the Condition on Conditions for Condition.Type. | ||
// If there is an update, Conditions are stored back sorted. | ||
func (r conditionsImpl) SetCondition(new Condition) { | ||
if r.accessor == nil { | ||
return | ||
} | ||
t := new.Type | ||
var conditions Conditions | ||
for _, c := range r.accessor.GetConditions() { | ||
if c.Type != t { | ||
conditions = append(conditions, c) | ||
} else { | ||
// If we'd only update the LastTransitionTime, then return. | ||
new.LastTransitionTime = c.LastTransitionTime | ||
if reflect.DeepEqual(&new, &c) { | ||
return | ||
} | ||
} | ||
} | ||
new.LastTransitionTime = VolatileTime{Inner: metav1.NewTime(time.Now())} | ||
conditions = append(conditions, new) | ||
// Sorted for convenience of the consumer, i.e. kubectl. | ||
sort.Slice(conditions, func(i, j int) bool { return conditions[i].Type < conditions[j].Type }) | ||
r.accessor.SetConditions(conditions) | ||
} | ||
|
||
func (r conditionsImpl) isTerminal(t ConditionType) bool { | ||
for _, cond := range r.dependents { | ||
if cond == t { | ||
return true | ||
} | ||
} | ||
|
||
if t == r.happy { | ||
return true | ||
} | ||
|
||
return false | ||
} | ||
|
||
func (r conditionsImpl) severity(t ConditionType) ConditionSeverity { | ||
if r.isTerminal(t) { | ||
return ConditionSeverityError | ||
} | ||
return ConditionSeverityInfo | ||
} | ||
|
||
// MarkTrue sets the status of t to true, and then marks the happy condition to | ||
// true if all other dependents are also true. | ||
func (r conditionsImpl) MarkTrue(t ConditionType) { | ||
// set the specified condition | ||
r.SetCondition(Condition{ | ||
Type: t, | ||
Status: corev1.ConditionTrue, | ||
Severity: r.severity(t), | ||
}) | ||
|
||
// check the dependents. | ||
for _, cond := range r.dependents { | ||
c := r.GetCondition(cond) | ||
// Failed or Unknown conditions trump true conditions | ||
if !c.IsTrue() { | ||
return | ||
} | ||
} | ||
|
||
// set the happy condition | ||
r.SetCondition(Condition{ | ||
Type: r.happy, | ||
Status: corev1.ConditionTrue, | ||
Severity: r.severity(r.happy), | ||
}) | ||
} | ||
|
||
// MarkUnknown sets the status of t to Unknown and also sets the happy condition | ||
// to Unknown if no other dependent condition is in an error state. | ||
func (r conditionsImpl) MarkUnknown(t ConditionType, reason, messageFormat string, messageA ...interface{}) { | ||
// set the specified condition | ||
r.SetCondition(Condition{ | ||
Type: t, | ||
Status: corev1.ConditionUnknown, | ||
Reason: reason, | ||
Message: fmt.Sprintf(messageFormat, messageA...), | ||
Severity: r.severity(t), | ||
}) | ||
|
||
// check the dependents. | ||
isDependent := false | ||
for _, cond := range r.dependents { | ||
c := r.GetCondition(cond) | ||
// Failed conditions trump Unknown conditions | ||
if c.IsFalse() { | ||
// Double check that the happy condition is also false. | ||
happy := r.GetCondition(r.happy) | ||
if !happy.IsFalse() { | ||
r.MarkFalse(r.happy, reason, messageFormat, messageA...) | ||
} | ||
return | ||
} | ||
if cond == t { | ||
isDependent = true | ||
} | ||
} | ||
|
||
if isDependent { | ||
// set the happy condition, if it is one of our dependent subconditions. | ||
r.SetCondition(Condition{ | ||
Type: r.happy, | ||
Status: corev1.ConditionUnknown, | ||
Reason: reason, | ||
Message: fmt.Sprintf(messageFormat, messageA...), | ||
Severity: r.severity(r.happy), | ||
}) | ||
} | ||
} | ||
|
||
// MarkFalse sets the status of t and the happy condition to False. | ||
func (r conditionsImpl) MarkFalse(t ConditionType, reason, messageFormat string, messageA ...interface{}) { | ||
types := []ConditionType{t} | ||
for _, cond := range r.dependents { | ||
if cond == t { | ||
types = append(types, r.happy) | ||
} | ||
} | ||
|
||
for _, t := range types { | ||
r.SetCondition(Condition{ | ||
Type: t, | ||
Status: corev1.ConditionFalse, | ||
Reason: reason, | ||
Message: fmt.Sprintf(messageFormat, messageA...), | ||
Severity: r.severity(t), | ||
}) | ||
} | ||
} | ||
|
||
// InitializeConditions updates all Conditions in the ConditionSet to Unknown | ||
// if not set. | ||
func (r conditionsImpl) InitializeConditions() { | ||
for _, t := range r.dependents { | ||
r.InitializeCondition(t) | ||
} | ||
r.InitializeCondition(r.happy) | ||
} | ||
|
||
// InitializeCondition updates a Condition to Unknown if not set. | ||
func (r conditionsImpl) InitializeCondition(t ConditionType) { | ||
r.SetCondition(Condition{ | ||
Type: t, | ||
Status: corev1.ConditionUnknown, | ||
Severity: r.severity(t), | ||
}) | ||
} |
Oops, something went wrong.