Skip to content

Commit 2c27ff6

Browse files
committed
NO-JIRA: Rename fields in ClusterCapabilities for readability
1 parent 86f0c69 commit 2c27ff6

File tree

6 files changed

+86
-86
lines changed

6 files changed

+86
-86
lines changed

lib/capability/capability.go

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -9,14 +9,14 @@ import (
99
)
1010

1111
type ClusterCapabilities struct {
12-
KnownCapabilities map[configv1.ClusterVersionCapability]struct{}
13-
EnabledCapabilities map[configv1.ClusterVersionCapability]struct{}
14-
ImplicitlyEnabledCapabilities []configv1.ClusterVersionCapability
12+
Known map[configv1.ClusterVersionCapability]struct{}
13+
Enabled map[configv1.ClusterVersionCapability]struct{}
14+
ImplicitlyEnabled []configv1.ClusterVersionCapability
1515
}
1616

1717
func (c *ClusterCapabilities) Equal(capabilities *ClusterCapabilities) error {
18-
if !reflect.DeepEqual(c.EnabledCapabilities, capabilities.EnabledCapabilities) {
19-
return fmt.Errorf("enabled %v not equal to %v", c.EnabledCapabilities, capabilities.EnabledCapabilities)
18+
if !reflect.DeepEqual(c.Enabled, capabilities.Enabled) {
19+
return fmt.Errorf("enabled %v not equal to %v", c.Enabled, capabilities.Enabled)
2020
}
2121

2222
return nil
@@ -36,9 +36,9 @@ func SetCapabilities(config *configv1.ClusterVersion,
3636
capabilities []configv1.ClusterVersionCapability) ClusterCapabilities {
3737

3838
var clusterCapabilities ClusterCapabilities
39-
clusterCapabilities.KnownCapabilities = GetCapabilitiesAsMap(configv1.KnownClusterVersionCapabilities)
39+
clusterCapabilities.Known = GetCapabilitiesAsMap(configv1.KnownClusterVersionCapabilities)
4040

41-
clusterCapabilities.EnabledCapabilities, clusterCapabilities.ImplicitlyEnabledCapabilities =
41+
clusterCapabilities.Enabled, clusterCapabilities.ImplicitlyEnabled =
4242
categorizeEnabledCapabilities(config.Spec.Capabilities, capabilities)
4343

4444
return clusterCapabilities
@@ -59,10 +59,10 @@ func GetCapabilitiesAsMap(capabilities []configv1.ClusterVersionCapability) map[
5959
func SetFromImplicitlyEnabledCapabilities(implicitlyEnabled []configv1.ClusterVersionCapability,
6060
capabilities ClusterCapabilities) ClusterCapabilities {
6161

62-
capabilities.ImplicitlyEnabledCapabilities = implicitlyEnabled
62+
capabilities.ImplicitlyEnabled = implicitlyEnabled
6363
for _, c := range implicitlyEnabled {
64-
if _, ok := capabilities.EnabledCapabilities[c]; !ok {
65-
capabilities.EnabledCapabilities[c] = struct{}{}
64+
if _, ok := capabilities.Enabled[c]; !ok {
65+
capabilities.Enabled[c] = struct{}{}
6666
}
6767
}
6868
return capabilities
@@ -71,11 +71,11 @@ func SetFromImplicitlyEnabledCapabilities(implicitlyEnabled []configv1.ClusterVe
7171
// GetCapabilitiesStatus populates and returns ClusterVersion capabilities status from given capabilities.
7272
func GetCapabilitiesStatus(capabilities ClusterCapabilities) configv1.ClusterVersionCapabilitiesStatus {
7373
var status configv1.ClusterVersionCapabilitiesStatus
74-
for k := range capabilities.EnabledCapabilities {
74+
for k := range capabilities.Enabled {
7575
status.EnabledCapabilities = append(status.EnabledCapabilities, k)
7676
}
7777
sort.Sort(capabilitiesSort(status.EnabledCapabilities))
78-
for k := range capabilities.KnownCapabilities {
78+
for k := range capabilities.Known {
7979
status.KnownCapabilities = append(status.KnownCapabilities, k)
8080
}
8181
sort.Sort(capabilitiesSort(status.KnownCapabilities))
@@ -95,8 +95,8 @@ func GetImplicitlyEnabledCapabilities(enabledManifestCaps []configv1.ClusterVers
9595
if Contains(enabledManifestCaps, c) {
9696
continue
9797
}
98-
if _, ok := capabilities.EnabledCapabilities[c]; !ok {
99-
if !Contains(capabilities.ImplicitlyEnabledCapabilities, c) {
98+
if _, ok := capabilities.Enabled[c]; !ok {
99+
if !Contains(capabilities.ImplicitlyEnabled, c) {
100100
caps = append(caps, c)
101101
}
102102
}

lib/capability/capability_test.go

Lines changed: 42 additions & 42 deletions
Original file line numberDiff line numberDiff line change
@@ -108,20 +108,20 @@ func TestSetCapabilities(t *testing.T) {
108108
test.wantKnownKeys = configv1.KnownClusterVersionCapabilities
109109
test.wantEnabledKeys = configv1.ClusterVersionCapabilitySets[configv1.ClusterVersionCapabilitySetCurrent]
110110
}
111-
if len(caps.KnownCapabilities) != len(test.wantKnownKeys) {
112-
t.Errorf("Incorrect number of KnownCapabilities keys, wanted: %q. KnownCapabilities returned: %v", test.wantKnownKeys, caps.KnownCapabilities)
111+
if len(caps.Known) != len(test.wantKnownKeys) {
112+
t.Errorf("Incorrect number of Known keys, wanted: %q. Known returned: %v", test.wantKnownKeys, caps.Known)
113113
}
114114
for _, v := range test.wantKnownKeys {
115-
if _, ok := caps.KnownCapabilities[v]; !ok {
116-
t.Errorf("Missing KnownCapabilities key %q. KnownCapabilities returned : %v", v, caps.KnownCapabilities)
115+
if _, ok := caps.Known[v]; !ok {
116+
t.Errorf("Missing Known key %q. Known returned : %v", v, caps.Known)
117117
}
118118
}
119-
if len(caps.EnabledCapabilities) != len(test.wantEnabledKeys) {
120-
t.Errorf("Incorrect number of EnabledCapabilities keys, wanted: %q. EnabledCapabilities returned: %v", test.wantEnabledKeys, caps.EnabledCapabilities)
119+
if len(caps.Enabled) != len(test.wantEnabledKeys) {
120+
t.Errorf("Incorrect number of Enabled keys, wanted: %q. Enabled returned: %v", test.wantEnabledKeys, caps.Enabled)
121121
}
122122
for _, v := range test.wantEnabledKeys {
123-
if _, ok := caps.EnabledCapabilities[v]; !ok {
124-
t.Errorf("Missing EnabledCapabilities key %q. EnabledCapabilities returned : %v", v, caps.EnabledCapabilities)
123+
if _, ok := caps.Enabled[v]; !ok {
124+
t.Errorf("Missing Enabled key %q. Enabled returned : %v", v, caps.Enabled)
125125
}
126126
}
127127
})
@@ -150,19 +150,19 @@ func TestSetCapabilitiesWithImplicitlyEnabled(t *testing.T) {
150150
for _, test := range tests {
151151
t.Run(test.name, func(t *testing.T) {
152152
caps := SetCapabilities(test.config, test.priorEnabled)
153-
if len(caps.ImplicitlyEnabledCapabilities) != len(test.wantImplicit) {
154-
t.Errorf("Incorrect number of implicitly enabled keys, wanted: %q. ImplicitlyEnabledCapabilities returned: %v", test.wantImplicit, caps.ImplicitlyEnabledCapabilities)
153+
if len(caps.ImplicitlyEnabled) != len(test.wantImplicit) {
154+
t.Errorf("Incorrect number of implicitly enabled keys, wanted: %q. ImplicitlyEnabled returned: %v", test.wantImplicit, caps.ImplicitlyEnabled)
155155
}
156156
for _, wanted := range test.wantImplicit {
157157
found := false
158-
for _, have := range caps.ImplicitlyEnabledCapabilities {
158+
for _, have := range caps.ImplicitlyEnabled {
159159
if wanted == string(have) {
160160
found = true
161161
break
162162
}
163163
}
164164
if !found {
165-
t.Errorf("Missing ImplicitlyEnabledCapabilities key %q. ImplicitlyEnabledCapabilities returned : %v", wanted, caps.ImplicitlyEnabledCapabilities)
165+
t.Errorf("Missing ImplicitlyEnabled key %q. ImplicitlyEnabled returned : %v", wanted, caps.ImplicitlyEnabled)
166166
}
167167
}
168168
})
@@ -177,8 +177,8 @@ func TestGetCapabilitiesStatus(t *testing.T) {
177177
}{
178178
{name: "empty capabilities",
179179
caps: ClusterCapabilities{
180-
KnownCapabilities: map[configv1.ClusterVersionCapability]struct{}{},
181-
EnabledCapabilities: map[configv1.ClusterVersionCapability]struct{}{},
180+
Known: map[configv1.ClusterVersionCapability]struct{}{},
181+
Enabled: map[configv1.ClusterVersionCapability]struct{}{},
182182
},
183183
wantStatus: configv1.ClusterVersionCapabilitiesStatus{
184184
EnabledCapabilities: []configv1.ClusterVersionCapability{},
@@ -187,8 +187,8 @@ func TestGetCapabilitiesStatus(t *testing.T) {
187187
},
188188
{name: "capabilities",
189189
caps: ClusterCapabilities{
190-
KnownCapabilities: map[configv1.ClusterVersionCapability]struct{}{configv1.ClusterVersionCapabilityOpenShiftSamples: {}},
191-
EnabledCapabilities: map[configv1.ClusterVersionCapability]struct{}{configv1.ClusterVersionCapabilityOpenShiftSamples: {}},
190+
Known: map[configv1.ClusterVersionCapability]struct{}{configv1.ClusterVersionCapabilityOpenShiftSamples: {}},
191+
Enabled: map[configv1.ClusterVersionCapability]struct{}{configv1.ClusterVersionCapabilityOpenShiftSamples: {}},
192192
},
193193
wantStatus: configv1.ClusterVersionCapabilitiesStatus{
194194
EnabledCapabilities: []configv1.ClusterVersionCapability{configv1.ClusterVersionCapabilityOpenShiftSamples},
@@ -200,7 +200,7 @@ func TestGetCapabilitiesStatus(t *testing.T) {
200200
t.Run(test.name, func(t *testing.T) {
201201
config := GetCapabilitiesStatus(test.caps)
202202
if len(config.KnownCapabilities) != len(test.wantStatus.KnownCapabilities) {
203-
t.Errorf("Incorrect number of KnownCapabilities keys, wanted: %q. KnownCapabilities returned: %v",
203+
t.Errorf("Incorrect number of Known keys, wanted: %q. Known returned: %v",
204204
test.wantStatus.KnownCapabilities, config.KnownCapabilities)
205205
}
206206
for _, v := range test.wantStatus.KnownCapabilities {
@@ -211,12 +211,12 @@ func TestGetCapabilitiesStatus(t *testing.T) {
211211
break
212212
}
213213
if !vFound {
214-
t.Errorf("Missing KnownCapabilities key %q. KnownCapabilities returned : %v", v, config.KnownCapabilities)
214+
t.Errorf("Missing Known key %q. Known returned : %v", v, config.KnownCapabilities)
215215
}
216216
}
217217
}
218218
if len(config.EnabledCapabilities) != len(test.wantStatus.EnabledCapabilities) {
219-
t.Errorf("Incorrect number of EnabledCapabilities keys, wanted: %q. EnabledCapabilities returned: %v",
219+
t.Errorf("Incorrect number of Enabled keys, wanted: %q. Enabled returned: %v",
220220
test.wantStatus.EnabledCapabilities, config.EnabledCapabilities)
221221
}
222222
for _, v := range test.wantStatus.EnabledCapabilities {
@@ -227,7 +227,7 @@ func TestGetCapabilitiesStatus(t *testing.T) {
227227
break
228228
}
229229
if !vFound {
230-
t.Errorf("Missing EnabledCapabilities key %q. EnabledCapabilities returned : %v", v, config.EnabledCapabilities)
230+
t.Errorf("Missing Enabled key %q. Enabled returned : %v", v, config.EnabledCapabilities)
231231
}
232232
}
233233
}
@@ -249,16 +249,16 @@ func TestSetFromImplicitlyEnabledCapabilities(t *testing.T) {
249249
configv1.ClusterVersionCapability("cap4"),
250250
},
251251
capabilities: ClusterCapabilities{
252-
KnownCapabilities: map[configv1.ClusterVersionCapability]struct{}{"cap1": {}, "cap2": {}, "cap3": {}, "cap4": {}, "cap5": {}},
253-
EnabledCapabilities: map[configv1.ClusterVersionCapability]struct{}{"cap1": {}},
254-
ImplicitlyEnabledCapabilities: []configv1.ClusterVersionCapability{
252+
Known: map[configv1.ClusterVersionCapability]struct{}{"cap1": {}, "cap2": {}, "cap3": {}, "cap4": {}, "cap5": {}},
253+
Enabled: map[configv1.ClusterVersionCapability]struct{}{"cap1": {}},
254+
ImplicitlyEnabled: []configv1.ClusterVersionCapability{
255255
configv1.ClusterVersionCapability("cap1"),
256256
},
257257
},
258258
wantCapabilities: ClusterCapabilities{
259-
KnownCapabilities: map[configv1.ClusterVersionCapability]struct{}{"cap1": {}, "cap2": {}, "cap3": {}, "cap4": {}, "cap5": {}},
260-
EnabledCapabilities: map[configv1.ClusterVersionCapability]struct{}{"cap1": {}, "cap2": {}, "cap3": {}, "cap4": {}},
261-
ImplicitlyEnabledCapabilities: []configv1.ClusterVersionCapability{
259+
Known: map[configv1.ClusterVersionCapability]struct{}{"cap1": {}, "cap2": {}, "cap3": {}, "cap4": {}, "cap5": {}},
260+
Enabled: map[configv1.ClusterVersionCapability]struct{}{"cap1": {}, "cap2": {}, "cap3": {}, "cap4": {}},
261+
ImplicitlyEnabled: []configv1.ClusterVersionCapability{
262262
configv1.ClusterVersionCapability("cap2"),
263263
configv1.ClusterVersionCapability("cap3"),
264264
configv1.ClusterVersionCapability("cap4"),
@@ -270,28 +270,28 @@ func TestSetFromImplicitlyEnabledCapabilities(t *testing.T) {
270270
configv1.ClusterVersionCapability("cap2"),
271271
},
272272
capabilities: ClusterCapabilities{
273-
KnownCapabilities: map[configv1.ClusterVersionCapability]struct{}{"cap1": {}, "cap2": {}},
274-
EnabledCapabilities: map[configv1.ClusterVersionCapability]struct{}{"cap1": {}, "cap2": {}},
273+
Known: map[configv1.ClusterVersionCapability]struct{}{"cap1": {}, "cap2": {}},
274+
Enabled: map[configv1.ClusterVersionCapability]struct{}{"cap1": {}, "cap2": {}},
275275
},
276276
wantCapabilities: ClusterCapabilities{
277-
KnownCapabilities: map[configv1.ClusterVersionCapability]struct{}{"cap1": {}, "cap2": {}},
278-
EnabledCapabilities: map[configv1.ClusterVersionCapability]struct{}{"cap1": {}, "cap2": {}},
279-
ImplicitlyEnabledCapabilities: []configv1.ClusterVersionCapability{
277+
Known: map[configv1.ClusterVersionCapability]struct{}{"cap1": {}, "cap2": {}},
278+
Enabled: map[configv1.ClusterVersionCapability]struct{}{"cap1": {}, "cap2": {}},
279+
ImplicitlyEnabled: []configv1.ClusterVersionCapability{
280280
configv1.ClusterVersionCapability("cap2"),
281281
},
282282
},
283283
},
284284
{name: "no implicitly enabled capabilities",
285285
capabilities: ClusterCapabilities{
286-
KnownCapabilities: map[configv1.ClusterVersionCapability]struct{}{"cap1": {}, "cap2": {}},
287-
EnabledCapabilities: map[configv1.ClusterVersionCapability]struct{}{"cap1": {}},
288-
ImplicitlyEnabledCapabilities: []configv1.ClusterVersionCapability{
286+
Known: map[configv1.ClusterVersionCapability]struct{}{"cap1": {}, "cap2": {}},
287+
Enabled: map[configv1.ClusterVersionCapability]struct{}{"cap1": {}},
288+
ImplicitlyEnabled: []configv1.ClusterVersionCapability{
289289
configv1.ClusterVersionCapability("cap2"),
290290
},
291291
},
292292
wantCapabilities: ClusterCapabilities{
293-
KnownCapabilities: map[configv1.ClusterVersionCapability]struct{}{"cap1": {}, "cap2": {}},
294-
EnabledCapabilities: map[configv1.ClusterVersionCapability]struct{}{"cap1": {}},
293+
Known: map[configv1.ClusterVersionCapability]struct{}{"cap1": {}, "cap2": {}},
294+
Enabled: map[configv1.ClusterVersionCapability]struct{}{"cap1": {}},
295295
},
296296
},
297297
}
@@ -317,7 +317,7 @@ func TestGetImplicitlyEnabledCapabilities(t *testing.T) {
317317
enabledManCaps: []configv1.ClusterVersionCapability{"cap1", "cap3"},
318318
updatedManCaps: []configv1.ClusterVersionCapability{"cap2"},
319319
capabilities: ClusterCapabilities{
320-
EnabledCapabilities: map[configv1.ClusterVersionCapability]struct{}{"cap1": {}},
320+
Enabled: map[configv1.ClusterVersionCapability]struct{}{"cap1": {}},
321321
},
322322
wantImplicit: []string{"cap2"},
323323
},
@@ -334,7 +334,7 @@ func TestGetImplicitlyEnabledCapabilities(t *testing.T) {
334334
enabledManCaps: []configv1.ClusterVersionCapability{"cap1", "cap3"},
335335
updatedManCaps: []configv1.ClusterVersionCapability{"cap1"},
336336
capabilities: ClusterCapabilities{
337-
EnabledCapabilities: map[configv1.ClusterVersionCapability]struct{}{"cap1": {}},
337+
Enabled: map[configv1.ClusterVersionCapability]struct{}{"cap1": {}},
338338
},
339339
},
340340
{name: "prior cap, no updated caps, no implicitly enabled capability",
@@ -344,22 +344,22 @@ func TestGetImplicitlyEnabledCapabilities(t *testing.T) {
344344
enabledManCaps: []configv1.ClusterVersionCapability{"cap1", "cap2"},
345345
updatedManCaps: []configv1.ClusterVersionCapability{"cap2"},
346346
capabilities: ClusterCapabilities{
347-
EnabledCapabilities: map[configv1.ClusterVersionCapability]struct{}{"cap1": {}, "cap2": {}},
347+
Enabled: map[configv1.ClusterVersionCapability]struct{}{"cap1": {}, "cap2": {}},
348348
},
349349
},
350350
{name: "no implicitly enable capability, new cap but already enabled",
351351
enabledManCaps: []configv1.ClusterVersionCapability{"cap1"},
352352
updatedManCaps: []configv1.ClusterVersionCapability{"cap2"},
353353
capabilities: ClusterCapabilities{
354-
EnabledCapabilities: map[configv1.ClusterVersionCapability]struct{}{"cap2": {}},
354+
Enabled: map[configv1.ClusterVersionCapability]struct{}{"cap2": {}},
355355
},
356356
},
357357
{name: "no implicitly enable capability, already implcitly enabled",
358358
enabledManCaps: []configv1.ClusterVersionCapability{"cap1"},
359359
updatedManCaps: []configv1.ClusterVersionCapability{"cap2"},
360360
capabilities: ClusterCapabilities{
361-
EnabledCapabilities: map[configv1.ClusterVersionCapability]struct{}{"cap2": {}},
362-
ImplicitlyEnabledCapabilities: []configv1.ClusterVersionCapability{"cap2"},
361+
Enabled: map[configv1.ClusterVersionCapability]struct{}{"cap2": {}},
362+
ImplicitlyEnabled: []configv1.ClusterVersionCapability{"cap2"},
363363
},
364364
},
365365
}

pkg/cvo/status.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -172,7 +172,7 @@ const DesiredReleaseAccepted configv1.ClusterStatusConditionType = "ReleaseAccep
172172
// requesting via spec.capabilities, because the cluster version operator does not support uninstalling
173173
// capabilities if any associated resources were previously managed by the CVO or disabling previously
174174
// enabled capabilities.
175-
const ImplicitlyEnabledCapabilities configv1.ClusterStatusConditionType = "ImplicitlyEnabledCapabilities"
175+
const ImplicitlyEnabledCapabilities configv1.ClusterStatusConditionType = "ImplicitlyEnabled"
176176

177177
// syncStatus calculates the new status of the ClusterVersion based on the current sync state and any
178178
// validation errors found. We allow the caller to pass the original object to avoid DeepCopying twice.

pkg/cvo/sync_worker.go

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -270,7 +270,7 @@ func (w *SyncWorker) syncPayload(ctx context.Context, work *SyncWork) ([]configv
270270
// so that we don't fail, then immediately start reporting an earlier status
271271
reporter := &statusWrapper{w: w, previousStatus: w.status.DeepCopy()}
272272

273-
implicitlyEnabledCaps := work.Capabilities.ImplicitlyEnabledCapabilities
273+
implicitlyEnabledCaps := work.Capabilities.ImplicitlyEnabled
274274

275275
desired := configv1.Update{
276276
Version: work.Desired.Version,
@@ -474,7 +474,7 @@ func (w *SyncWorker) Update(ctx context.Context, generation int64, desired confi
474474
// If this is the first time through initialize priorCaps to the last known value of enabled capabilities.
475475
if w.work != nil {
476476
w.work.Generation = generation
477-
priorCaps = w.work.Capabilities.EnabledCapabilities
477+
priorCaps = w.work.Capabilities.Enabled
478478
} else {
479479
klog.V(2).Info("Initializing prior known value of enabled capabilities from ClusterVersion status.")
480480
priorCaps = capability.GetCapabilitiesAsMap(config.Status.Capabilities.EnabledCapabilities)
@@ -493,7 +493,7 @@ func (w *SyncWorker) Update(ctx context.Context, generation int64, desired confi
493493
equalSyncWork(w.work, work, fmt.Sprintf("considering cluster version generation %d", generation))
494494

495495
// needs to be set here since changes in implicitly enabled capabilities are not considered a "capabilities change"
496-
w.status.CapabilitiesStatus.ImplicitlyEnabledCaps = work.Capabilities.ImplicitlyEnabledCapabilities
496+
w.status.CapabilitiesStatus.ImplicitlyEnabledCaps = work.Capabilities.ImplicitlyEnabled
497497

498498
if versionEqual && overridesEqual && capabilitiesEqual {
499499
klog.V(2).Info("Update work is equal to current target; no change required")
@@ -553,7 +553,7 @@ func (w *SyncWorker) Update(ctx context.Context, generation int64, desired confi
553553
// Update capabilities settings and status to include any capabilities that were implicitly enabled due
554554
// to previously managed resources.
555555
w.work.Capabilities = capability.SetFromImplicitlyEnabledCapabilities(implicit, w.work.Capabilities)
556-
w.status.CapabilitiesStatus.ImplicitlyEnabledCaps = w.work.Capabilities.ImplicitlyEnabledCapabilities
556+
w.status.CapabilitiesStatus.ImplicitlyEnabledCaps = w.work.Capabilities.ImplicitlyEnabled
557557
w.status.CapabilitiesStatus.Status = capability.GetCapabilitiesStatus(w.work.Capabilities)
558558

559559
// Update syncWorker status with architecture of newly loaded payload.

pkg/payload/payload.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -241,7 +241,7 @@ func GetImplicitlyEnabledCapabilities(updatePayloadManifests []manifest.Manifest
241241
clusterCaps := capability.GetCapabilitiesStatus(capabilities)
242242

243243
// Initialize so it contains existing implicitly enabled capabilities
244-
implicitlyEnabledCaps := capabilities.ImplicitlyEnabledCapabilities
244+
implicitlyEnabledCaps := capabilities.ImplicitlyEnabled
245245

246246
for _, updateManifest := range updatePayloadManifests {
247247
updateManErr := updateManifest.IncludeAllowUnknownCapabilities(nil, nil, nil, &clusterCaps, nil, true)

0 commit comments

Comments
 (0)