/
condition_builder.go
140 lines (116 loc) · 4.18 KB
/
condition_builder.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
// Copyright (c) 2020 SAP SE or an SAP affiliate company. All rights reserved. This file is licensed under the Apache Software License, v. 2 except as noted otherwise in the LICENSE file
//
// 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 helper
import (
"fmt"
api "github.com/gardener/gardener/pkg/apis/core/v1alpha1"
apiequality "k8s.io/apimachinery/pkg/api/equality"
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
)
// ConditionBuilder build a Condition.
type ConditionBuilder interface {
WithOldCondition(old api.Condition) ConditionBuilder
WithStatus(status api.ConditionStatus) ConditionBuilder
WithReason(reason string) ConditionBuilder
WithMessage(message string) ConditionBuilder
WithNowFunc(now func() metav1.Time) ConditionBuilder
Build() (new api.Condition, updated bool)
}
// defaultConditionBuilder build a Condition.
type defaultConditionBuilder struct {
old api.Condition
status api.ConditionStatus
conditionType api.ConditionType
reason string
message string
nowFunc func() metav1.Time
}
// NewConditionBuilder returns a ConditionBuilder for a specific condition.
func NewConditionBuilder(conditionType api.ConditionType) (ConditionBuilder, error) {
if conditionType == "" {
return nil, fmt.Errorf("conditionType cannot be empty")
}
return &defaultConditionBuilder{
conditionType: conditionType,
nowFunc: metav1.Now,
}, nil
}
// WithOldCondition sets the old condition. It can be used to prodive default values.
// The old's condition type is overridden to the one specified in the builder.
func (b *defaultConditionBuilder) WithOldCondition(old api.Condition) ConditionBuilder {
old.Type = b.conditionType
b.old = old
return b
}
// WithStatus sets the status of the condition.
func (b *defaultConditionBuilder) WithStatus(status api.ConditionStatus) ConditionBuilder {
b.status = status
return b
}
// WithReason sets the reason of the condition.
func (b *defaultConditionBuilder) WithReason(reason string) ConditionBuilder {
b.reason = reason
return b
}
// WithMessage sets the message of the condition.
func (b *defaultConditionBuilder) WithMessage(message string) ConditionBuilder {
b.message = message
return b
}
// WithNowFunc sets the function used for getting the current time.
// Should only be used for tests.
func (b *defaultConditionBuilder) WithNowFunc(now func() metav1.Time) ConditionBuilder {
b.nowFunc = now
return b
}
// Build creates the condition and returns if there are modifications with the OldCondition.
// If OldCondition is provided:
// - Any changes to status set the `LastTransitionTime`
// - Any updates to the message or the reason cause set `LastUpdateTime` to the current time.
func (b *defaultConditionBuilder) Build() (new api.Condition, updated bool) {
var (
now = b.nowFunc()
emptyTime = metav1.Time{}
)
new = *b.old.DeepCopy()
if new.LastTransitionTime == emptyTime {
new.LastTransitionTime = now
}
if new.LastUpdateTime == emptyTime {
new.LastUpdateTime = now
}
new.Type = b.conditionType
if b.status != "" {
new.Status = b.status
} else if b.status == "" && b.old.Status == "" {
new.Status = api.ConditionUnknown
}
if b.reason != "" {
new.Reason = b.reason
} else if b.reason == "" && b.old.Reason == "" {
new.Reason = "ConditionInitialized"
}
if b.message != "" {
new.Message = b.message
} else if b.message == "" && b.old.Message == "" {
new.Message = "The condition has been initialized but its semantic check has not been performed yet."
}
if new.Status != b.old.Status {
new.LastTransitionTime = now
}
if new.Reason != b.old.Reason || new.Message != b.old.Message {
new.LastUpdateTime = now
}
return new, !apiequality.Semantic.DeepEqual(new, b.old)
}