Skip to content

Commit 9b41e73

Browse files
calindcalind
committed
PR review round 3
1 parent 12b7536 commit 9b41e73

File tree

2 files changed

+45
-45
lines changed

2 files changed

+45
-45
lines changed

‎pkg/controller/controllerutil/controllerutil.go

Lines changed: 26 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -102,32 +102,32 @@ func referSameObject(a, b v1.OwnerReference) bool {
102102
return aGV == bGV && a.Kind == b.Kind && a.Name == b.Name
103103
}
104104

105-
// OperationType is the action result of a CreateOrUpdate call
106-
type OperationType string
105+
// OperationResult is the action result of a CreateOrUpdate call
106+
type OperationResult string
107107

108108
const ( // They should complete the sentence "Deployment default/foo has been ..."
109-
// OperationNoop means that the resource has not been changed
110-
OperationNoop = "unchanged"
111-
// OperationCreate means that a new resource is created
112-
OperationCreate = "created"
113-
// OperationUpdate means that an existing resource is updated
114-
OperationUpdate = "updated"
109+
// OperationResultNone means that the resource has not been changed
110+
OperationResultNone OperationResult = "unchanged"
111+
// OperationResultCreated means that a new resource is created
112+
OperationResultCreated OperationResult = "created"
113+
// OperationResultUpdated means that an existing resource is updated
114+
OperationResultUpdated OperationResult = "updated"
115115
)
116116

117-
// CreateOrUpdate the given object obj in the Kubernetes cluster. The object's
118-
// desired state should be reconciled with the existing state using the passed
119-
// in ReconcileFn. obj must be a struct pointer so that obj can be updated with
120-
// the content returned by the Server.
117+
// CreateOrUpdate creates or updates the given object obj in the Kubernetes
118+
// cluster. The object's desired state should be reconciled with the existing
119+
// state using the passed in ReconcileFn. obj must be a struct pointer so that
120+
// obj can be updated with the content returned by the Server.
121121
//
122122
// It returns the executed operation and an error.
123-
func CreateOrUpdate(ctx context.Context, c client.Client, obj runtime.Object, r ReconcileFn) (OperationType, error) {
123+
func CreateOrUpdate(ctx context.Context, c client.Client, obj runtime.Object, f MutateFn) (OperationResult, error) {
124124
// op is the operation we are going to attempt
125-
var op OperationType = OperationNoop
125+
op := OperationResultNone
126126

127127
// get the existing object meta
128128
metaObj, ok := obj.(v1.Object)
129129
if !ok {
130-
return OperationNoop, fmt.Errorf("%T does not implement metav1.Object interface", obj)
130+
return OperationResultNone, fmt.Errorf("%T does not implement metav1.Object interface", obj)
131131
}
132132

133133
// retrieve the existing object
@@ -143,36 +143,36 @@ func CreateOrUpdate(ctx context.Context, c client.Client, obj runtime.Object, r
143143
existingObjMeta.SetName(metaObj.GetName())
144144
existingObjMeta.SetNamespace(metaObj.GetNamespace())
145145

146-
if e := r(obj); e != nil {
147-
return OperationNoop, e
146+
if e := f(obj); e != nil {
147+
return OperationResultNone, e
148148
}
149149

150150
if metaObj.GetName() != existingObjMeta.GetName() {
151-
return OperationNoop, fmt.Errorf("ReconcileFn cannot mutate objects name")
151+
return OperationResultNone, fmt.Errorf("ReconcileFn cannot mutate objects name")
152152
}
153153

154154
if metaObj.GetNamespace() != existingObjMeta.GetNamespace() {
155-
return OperationNoop, fmt.Errorf("ReconcileFn cannot mutate objects namespace")
155+
return OperationResultNone, fmt.Errorf("ReconcileFn cannot mutate objects namespace")
156156
}
157157

158158
if errors.IsNotFound(err) {
159159
err = c.Create(ctx, obj)
160-
op = OperationCreate
160+
op = OperationResultCreated
161161
} else if err == nil {
162162
if reflect.DeepEqual(existing, obj) {
163-
return OperationNoop, nil
163+
return OperationResultNone, nil
164164
}
165165
err = c.Update(ctx, obj)
166-
op = OperationUpdate
166+
op = OperationResultUpdated
167167
} else {
168-
return OperationNoop, err
168+
return OperationResultNone, err
169169
}
170170

171171
if err != nil {
172-
op = OperationNoop
172+
op = OperationResultNone
173173
}
174174
return op, err
175175
}
176176

177-
// ReconcileFn is a function which mutates the existing object into it's desired state.
178-
type ReconcileFn func(existing runtime.Object) error
177+
// MutateFn is a function which mutates the existing object into it's desired state.
178+
type MutateFn func(existing runtime.Object) error

‎pkg/controller/controllerutil/controllerutil_test.go

Lines changed: 19 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -142,8 +142,8 @@ var _ = Describe("Controllerutil", func() {
142142
It("creates a new object if one doesn't exists", func() {
143143
op, err := controllerutil.CreateOrUpdate(context.TODO(), c, deploy, deploymentSpecr(deplSpec))
144144

145-
By("returning OperationCreated")
146-
Expect(op).To(BeEquivalentTo(controllerutil.OperationCreate))
145+
By("returning OperationResultCreatedd")
146+
Expect(op).To(BeEquivalentTo(controllerutil.OperationResultCreated))
147147

148148
By("returning no error")
149149
Expect(err).NotTo(HaveOccurred())
@@ -157,11 +157,11 @@ var _ = Describe("Controllerutil", func() {
157157
var scale int32 = 2
158158
op, err := controllerutil.CreateOrUpdate(context.TODO(), c, deploy, deploymentSpecr(deplSpec))
159159
Expect(err).NotTo(HaveOccurred())
160-
Expect(op).To(BeEquivalentTo(controllerutil.OperationCreate))
160+
Expect(op).To(BeEquivalentTo(controllerutil.OperationResultCreated))
161161

162162
op, err = controllerutil.CreateOrUpdate(context.TODO(), c, deploy, deploymentScaler(scale))
163-
By("returning OperationUpdated")
164-
Expect(op).To(BeEquivalentTo(controllerutil.OperationUpdate))
163+
By("returning OperationResultUpdatedd")
164+
Expect(op).To(BeEquivalentTo(controllerutil.OperationResultUpdated))
165165

166166
By("returning no error")
167167
Expect(err).NotTo(HaveOccurred())
@@ -175,13 +175,13 @@ var _ = Describe("Controllerutil", func() {
175175
It("updates only changed objects", func() {
176176
op, err := controllerutil.CreateOrUpdate(context.TODO(), c, deploy, deploymentSpecr(deplSpec))
177177

178-
Expect(op).To(BeEquivalentTo(controllerutil.OperationCreate))
178+
Expect(op).To(BeEquivalentTo(controllerutil.OperationResultCreated))
179179
Expect(err).NotTo(HaveOccurred())
180180

181181
op, err = controllerutil.CreateOrUpdate(context.TODO(), c, deploy, deploymentIdentity)
182182

183-
By("returning OperationNoop")
184-
Expect(op).To(BeEquivalentTo(controllerutil.OperationNoop))
183+
By("returning OperationResultNone")
184+
Expect(op).To(BeEquivalentTo(controllerutil.OperationResultNone))
185185

186186
By("returning no error")
187187
Expect(err).NotTo(HaveOccurred())
@@ -190,13 +190,13 @@ var _ = Describe("Controllerutil", func() {
190190
It("errors when reconcile renames an object", func() {
191191
op, err := controllerutil.CreateOrUpdate(context.TODO(), c, deploy, deploymentSpecr(deplSpec))
192192

193-
Expect(op).To(BeEquivalentTo(controllerutil.OperationCreate))
193+
Expect(op).To(BeEquivalentTo(controllerutil.OperationResultCreated))
194194
Expect(err).NotTo(HaveOccurred())
195195

196196
op, err = controllerutil.CreateOrUpdate(context.TODO(), c, deploy, deploymentRenamer)
197197

198-
By("returning OperationNoop")
199-
Expect(op).To(BeEquivalentTo(controllerutil.OperationNoop))
198+
By("returning OperationResultNone")
199+
Expect(op).To(BeEquivalentTo(controllerutil.OperationResultNone))
200200

201201
By("returning error")
202202
Expect(err).To(HaveOccurred())
@@ -205,13 +205,13 @@ var _ = Describe("Controllerutil", func() {
205205
It("errors when object namespace changes", func() {
206206
op, err := controllerutil.CreateOrUpdate(context.TODO(), c, deploy, deploymentSpecr(deplSpec))
207207

208-
Expect(op).To(BeEquivalentTo(controllerutil.OperationCreate))
208+
Expect(op).To(BeEquivalentTo(controllerutil.OperationResultCreated))
209209
Expect(err).NotTo(HaveOccurred())
210210

211211
op, err = controllerutil.CreateOrUpdate(context.TODO(), c, deploy, deploymentNamespaceChanger)
212212

213-
By("returning OperationNoop")
214-
Expect(op).To(BeEquivalentTo(controllerutil.OperationNoop))
213+
By("returning OperationResultNone")
214+
Expect(op).To(BeEquivalentTo(controllerutil.OperationResultNone))
215215

216216
By("returning error")
217217
Expect(err).To(HaveOccurred())
@@ -225,31 +225,31 @@ type errMetaObj struct {
225225
metav1.ObjectMeta
226226
}
227227

228-
func deploymentSpecr(spec appsv1.DeploymentSpec) controllerutil.ReconcileFn {
228+
func deploymentSpecr(spec appsv1.DeploymentSpec) controllerutil.MutateFn {
229229
return func(obj runtime.Object) error {
230230
deploy := obj.(*appsv1.Deployment)
231231
deploy.Spec = spec
232232
return nil
233233
}
234234
}
235235

236-
var deploymentIdentity controllerutil.ReconcileFn = func(obj runtime.Object) error {
236+
var deploymentIdentity controllerutil.MutateFn = func(obj runtime.Object) error {
237237
return nil
238238
}
239239

240-
var deploymentRenamer controllerutil.ReconcileFn = func(obj runtime.Object) error {
240+
var deploymentRenamer controllerutil.MutateFn = func(obj runtime.Object) error {
241241
deploy := obj.(*appsv1.Deployment)
242242
deploy.Name = fmt.Sprintf("%s-1", deploy.Name)
243243
return nil
244244
}
245245

246-
var deploymentNamespaceChanger controllerutil.ReconcileFn = func(obj runtime.Object) error {
246+
var deploymentNamespaceChanger controllerutil.MutateFn = func(obj runtime.Object) error {
247247
deploy := obj.(*appsv1.Deployment)
248248
deploy.Namespace = fmt.Sprintf("%s-1", deploy.Namespace)
249249
return nil
250250
}
251251

252-
func deploymentScaler(replicas int32) controllerutil.ReconcileFn {
252+
func deploymentScaler(replicas int32) controllerutil.MutateFn {
253253
fn := func(obj runtime.Object) error {
254254
deploy := obj.(*appsv1.Deployment)
255255
deploy.Spec.Replicas = &replicas

0 commit comments

Comments
 (0)