Skip to content

Commit 0abfaa1

Browse files
juevjuev
committed
refactor: rename moduleMaintenanceStateChanged to moduleMaintenanceChanged for consistency
Signed-off-by: Evsyukov Denis <[email protected]>
1 parent 24a5a0b commit 0abfaa1

File tree

8 files changed

+69
-69
lines changed

8 files changed

+69
-69
lines changed

‎pkg/addon-operator/operator.go

+5-5
Original file line numberDiff line numberDiff line change
@@ -1180,7 +1180,7 @@ func (op *AddonOperator) StartModuleManagerEventHandler() {
11801180
slog.Bool("globalSectionChanged", event.GlobalSectionChanged),
11811181
slog.Any("moduleValuesChanged", event.ModuleValuesChanged),
11821182
slog.Any("moduleEnabledStateChanged", event.ModuleEnabledStateChanged),
1183-
slog.Any("moduleMaintenanceStateChanged", event.ModuleMaintenanceStateChanged))
1183+
slog.Any("moduleMaintenanceChanged", event.ModuleMaintenanceChanged))
11841184
if !op.ModuleManager.GetKubeConfigValid() {
11851185
eventLogEntry.Info("KubeConfig become valid")
11861186
}
@@ -1192,15 +1192,15 @@ func (op *AddonOperator) StartModuleManagerEventHandler() {
11921192
convergeTask sh_task.Task
11931193
)
11941194

1195-
if event.GlobalSectionChanged || len(event.ModuleValuesChanged)+len(event.ModuleMaintenanceStateChanged) > 0 {
1195+
if event.GlobalSectionChanged || len(event.ModuleValuesChanged)+len(event.ModuleMaintenanceChanged) > 0 {
11961196
kubeConfigTask = converge.NewApplyKubeConfigValuesTask(
11971197
"Apply-Kube-Config-Values-Changes",
11981198
logLabels,
11991199
event.GlobalSectionChanged,
12001200
)
12011201
}
12021202

1203-
for module, state := range event.ModuleMaintenanceStateChanged {
1203+
for module, state := range event.ModuleMaintenanceChanged {
12041204
op.ModuleManager.SetModuleMaintenanceState(module, state)
12051205
}
12061206

@@ -1254,14 +1254,14 @@ func (op *AddonOperator) StartModuleManagerEventHandler() {
12541254
op.ConvergeState.Phase = converge.StandBy
12551255
op.ConvergeState.PhaseLock.Unlock()
12561256
} else {
1257-
modulesToRerun := make([]string, 0, len(event.ModuleValuesChanged)+len(event.ModuleMaintenanceStateChanged))
1257+
modulesToRerun := make([]string, 0, len(event.ModuleValuesChanged)+len(event.ModuleMaintenanceChanged))
12581258
for _, moduleName := range event.ModuleValuesChanged {
12591259
if op.ModuleManager.IsModuleEnabled(moduleName) {
12601260
modulesToRerun = append(modulesToRerun, moduleName)
12611261
}
12621262
}
12631263

1264-
for moduleName := range event.ModuleMaintenanceStateChanged {
1264+
for moduleName := range event.ModuleMaintenanceChanged {
12651265
if !slices.Contains(modulesToRerun, moduleName) && op.ModuleManager.IsModuleEnabled(moduleName) {
12661266
modulesToRerun = append(modulesToRerun, moduleName)
12671267
}

‎pkg/kube_config_manager/backend/configmap/configmap.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -274,7 +274,7 @@ func fromConfigMapData(moduleName string, configData map[string]string) (*utils.
274274

275275
maintenanceStateString, hasKey := configData[mc.ModuleMaintenanceStateKey()]
276276
if hasKey {
277-
var state utils.MaintenanceState
277+
var state utils.Maintenance
278278

279279
switch maintenanceStateString {
280280
case "NoResourceReconciliation", "noresourcereconciliation":

‎pkg/kube_config_manager/config/config.go

+5-5
Original file line numberDiff line numberDiff line change
@@ -47,11 +47,11 @@ func NewConfig() *KubeConfig {
4747
type (
4848
KubeConfigType string
4949
KubeConfigEvent struct {
50-
Type KubeConfigType
51-
ModuleEnabledStateChanged []string
52-
ModuleValuesChanged []string
53-
GlobalSectionChanged bool
54-
ModuleMaintenanceStateChanged map[string]utils.MaintenanceState
50+
Type KubeConfigType
51+
ModuleEnabledStateChanged []string
52+
ModuleValuesChanged []string
53+
GlobalSectionChanged bool
54+
ModuleMaintenanceChanged map[string]utils.Maintenance
5555
}
5656
)
5757

‎pkg/kube_config_manager/kube_config_manager.go

+26-26
Original file line numberDiff line numberDiff line change
@@ -244,7 +244,7 @@ func (kcm *KubeConfigManager) handleConfigEvent(obj config.Event) {
244244
// some module values
245245
modulesChanged := []string{}
246246
modulesStateChanged := []string{}
247-
moduleMaintenanceStateChanged := make(map[string]utils.MaintenanceState)
247+
moduleMaintenanceChanged := make(map[string]utils.Maintenance)
248248

249249
// module update
250250
kcm.m.Lock()
@@ -259,17 +259,17 @@ func (kcm *KubeConfigManager) handleConfigEvent(obj config.Event) {
259259
}
260260

261261
if kcm.currentConfig.Modules[moduleName].GetMaintenanceState() == utils.NoResourceReconciliation {
262-
moduleMaintenanceStateChanged[moduleName] = utils.Managed
262+
moduleMaintenanceChanged[moduleName] = utils.Managed
263263
}
264264

265265
moduleCfg.Reset()
266266
moduleCfg.Checksum = moduleCfg.ModuleConfig.Checksum()
267267
kcm.currentConfig.Modules[obj.Key] = moduleCfg
268268
kcm.configEventCh <- config.KubeConfigEvent{
269-
Type: config.KubeConfigChanged,
270-
ModuleValuesChanged: modulesChanged,
271-
ModuleEnabledStateChanged: modulesStateChanged,
272-
ModuleMaintenanceStateChanged: moduleMaintenanceStateChanged,
269+
Type: config.KubeConfigChanged,
270+
ModuleValuesChanged: modulesChanged,
271+
ModuleEnabledStateChanged: modulesStateChanged,
272+
ModuleMaintenanceChanged: moduleMaintenanceChanged,
273273
}
274274
return
275275
}
@@ -288,36 +288,36 @@ func (kcm *KubeConfigManager) handleConfigEvent(obj config.Event) {
288288
}
289289

290290
if kcm.currentConfig.Modules[moduleName].GetMaintenanceState() != moduleCfg.GetMaintenanceState() {
291-
moduleMaintenanceStateChanged[moduleName] = moduleCfg.GetMaintenanceState()
291+
moduleMaintenanceChanged[moduleName] = moduleCfg.GetMaintenanceState()
292292
}
293293
kcm.logger.Info("Module section changed. Enabled flag transition.",
294294
slog.String("moduleName", moduleName),
295295
slog.String("previous", kcm.currentConfig.Modules[moduleName].GetEnabled()),
296296
slog.String("current", moduleCfg.GetEnabled()),
297-
slog.String("MaintenanceStateFlag", moduleCfg.GetMaintenanceState().String()))
297+
slog.String("maintenanceFlag", moduleCfg.GetMaintenanceState().String()))
298298
} else {
299299
modulesChanged = append(modulesChanged, moduleName)
300300
if moduleCfg.GetEnabled() != "" && moduleCfg.GetEnabled() != "n/d" {
301301
modulesStateChanged = append(modulesStateChanged, moduleName)
302302
}
303303

304304
if moduleCfg.GetMaintenanceState() == utils.NoResourceReconciliation {
305-
moduleMaintenanceStateChanged[moduleName] = utils.NoResourceReconciliation
305+
moduleMaintenanceChanged[moduleName] = utils.NoResourceReconciliation
306306
}
307307
kcm.logger.Info("Module section added",
308308
slog.String("moduleName", moduleName),
309309
slog.String("enabledFlag", moduleCfg.GetEnabled()),
310-
slog.String("MaintenanceStateFlag", moduleCfg.GetMaintenanceState().String()))
310+
slog.String("maintenanceFlag", moduleCfg.GetMaintenanceState().String()))
311311
}
312312
}
313313

314-
if len(modulesChanged)+len(modulesStateChanged)+len(moduleMaintenanceStateChanged) > 0 {
314+
if len(modulesChanged)+len(modulesStateChanged)+len(moduleMaintenanceChanged) > 0 {
315315
kcm.currentConfig.Modules[obj.Key] = moduleCfg
316316
kcm.configEventCh <- config.KubeConfigEvent{
317-
Type: config.KubeConfigChanged,
318-
ModuleValuesChanged: modulesChanged,
319-
ModuleEnabledStateChanged: modulesStateChanged,
320-
ModuleMaintenanceStateChanged: moduleMaintenanceStateChanged,
317+
Type: config.KubeConfigChanged,
318+
ModuleValuesChanged: modulesChanged,
319+
ModuleEnabledStateChanged: modulesStateChanged,
320+
ModuleMaintenanceChanged: moduleMaintenanceChanged,
321321
}
322322
}
323323
}
@@ -354,7 +354,7 @@ func (kcm *KubeConfigManager) handleBatchConfigEvent(obj config.Event) {
354354
currentModuleNames := kcm.currentModuleNames()
355355
modulesChanged := []string{}
356356
modulesStateChanged := []string{}
357-
moduleMaintenanceStateChanged := make(map[string]utils.MaintenanceState)
357+
moduleMaintenanceChanged := make(map[string]utils.Maintenance)
358358

359359
for moduleName, moduleCfg := range newConfig.Modules {
360360
// Remove module name from current names to detect deleted sections.
@@ -376,28 +376,28 @@ func (kcm *KubeConfigManager) handleBatchConfigEvent(obj config.Event) {
376376
}
377377

378378
if kcm.currentConfig.Modules[moduleName].GetMaintenanceState() != moduleCfg.GetMaintenanceState() {
379-
moduleMaintenanceStateChanged[moduleName] = moduleCfg.GetMaintenanceState()
379+
moduleMaintenanceChanged[moduleName] = moduleCfg.GetMaintenanceState()
380380
}
381381

382382
kcm.logger.Info("Module section changed. Enabled flag transition",
383383
slog.String("moduleName", moduleName),
384384
slog.String("previous", kcm.currentConfig.Modules[moduleName].GetEnabled()),
385385
slog.String("current", moduleCfg.GetEnabled()),
386-
slog.String("MaintenanceStateFlag", moduleCfg.GetMaintenanceState().String()))
386+
slog.String("maintenanceFlag", moduleCfg.GetMaintenanceState().String()))
387387
} else {
388388
modulesChanged = append(modulesChanged, moduleName)
389389
if moduleCfg.GetEnabled() != "" && moduleCfg.GetEnabled() != "n/d" {
390390
modulesStateChanged = append(modulesStateChanged, moduleName)
391391
}
392392

393393
if moduleCfg.GetMaintenanceState() == utils.NoResourceReconciliation {
394-
moduleMaintenanceStateChanged[moduleName] = utils.NoResourceReconciliation
394+
moduleMaintenanceChanged[moduleName] = utils.NoResourceReconciliation
395395
}
396396

397397
kcm.logger.Info("Module section added",
398398
slog.String("moduleName", moduleName),
399399
slog.String("enabledFlag", moduleCfg.GetEnabled()),
400-
slog.String("MaintenanceStateFlag", moduleCfg.GetMaintenanceState().String()))
400+
slog.String("maintenanceFlag", moduleCfg.GetMaintenanceState().String()))
401401
}
402402
}
403403
}
@@ -419,13 +419,13 @@ func (kcm *KubeConfigManager) handleBatchConfigEvent(obj config.Event) {
419419
kcm.m.Unlock()
420420

421421
// Fire event if ConfigMap has changes.
422-
if globalChanged || len(modulesChanged)+len(moduleMaintenanceStateChanged) > 0 {
422+
if globalChanged || len(modulesChanged)+len(moduleMaintenanceChanged) > 0 {
423423
kcm.configEventCh <- config.KubeConfigEvent{
424-
Type: config.KubeConfigChanged,
425-
GlobalSectionChanged: globalChanged,
426-
ModuleValuesChanged: modulesChanged,
427-
ModuleEnabledStateChanged: modulesStateChanged,
428-
ModuleMaintenanceStateChanged: moduleMaintenanceStateChanged,
424+
Type: config.KubeConfigChanged,
425+
GlobalSectionChanged: globalChanged,
426+
ModuleValuesChanged: modulesChanged,
427+
ModuleEnabledStateChanged: modulesStateChanged,
428+
ModuleMaintenanceChanged: moduleMaintenanceChanged,
429429
}
430430
}
431431
}

‎pkg/kube_config_manager/kube_config_manager_test.go

+7-7
Original file line numberDiff line numberDiff line change
@@ -77,7 +77,7 @@ kubeDns: |
7777
config:
7878
resolver: "192.168.0.1"
7979
kubeDnsEnabled: "true"
80-
kubeDnsMaintenanceState: "NoResourceReconciliation"
80+
kubeDnsMaintenance: "NoResourceReconciliation"
8181
`
8282

8383
kubeClient := klient.NewFake(nil)
@@ -87,9 +87,9 @@ kubeDnsMaintenanceState: "NoResourceReconciliation"
8787
defer kcm.Stop()
8888

8989
tests := map[string]struct {
90-
isEnabled *bool
91-
maintenanceState utils.MaintenanceState
92-
values utils.Values
90+
isEnabled *bool
91+
maintenance utils.Maintenance
92+
values utils.Values
9393
}{
9494
"global": {
9595
nil,
@@ -165,7 +165,7 @@ kubeDnsMaintenanceState: "NoResourceReconciliation"
165165
moduleConfig, hasConfig := config.Modules[name]
166166
assert.True(t, hasConfig)
167167
assert.Equal(t, expect.isEnabled, moduleConfig.IsEnabled)
168-
assert.Equal(t, expect.maintenanceState, moduleConfig.MaintenanceState)
168+
assert.Equal(t, expect.maintenance, moduleConfig.Maintenance)
169169
assert.Equal(t, expect.values, moduleConfig.GetValuesWithModuleName()) //nolint: staticcheck,nolintlint
170170
})
171171
}
@@ -437,7 +437,7 @@ func Test_KubeConfigManager_error_on_Init(t *testing.T) {
437437
"path": "/data/validModuleName",
438438
"value": "modParam1: val1\nmodParam2: val2"},
439439
{"op": "add",
440-
"path": "/data/validModuleNameMaintenanceState",
440+
"path": "/data/validModuleNameMaintenance",
441441
"value": "NoResourceReconciliation"},
442442
{"op": "remove",
443443
"path": "/data/InvalidName-module"}]`
@@ -458,7 +458,7 @@ func Test_KubeConfigManager_error_on_Init(t *testing.T) {
458458
ModuleEnabledStateChanged: []string{},
459459
ModuleValuesChanged: []string{"valid-module-name"},
460460
GlobalSectionChanged: false,
461-
ModuleMaintenanceStateChanged: map[string]utils.MaintenanceState{
461+
ModuleMaintenanceChanged: map[string]utils.Maintenance{
462462
"valid-module-name": "NoResourceReconciliation",
463463
},
464464
}), "Valid section patch should generate 'changed' event")

‎pkg/module_manager/models/modules/basic.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -544,7 +544,7 @@ func (bm *BasicModule) SaveHookError(hookName string, err error) {
544544
bm.l.Unlock()
545545
}
546546

547-
func (bm *BasicModule) SetMaintenanceState(state utils.MaintenanceState) {
547+
func (bm *BasicModule) SetMaintenanceState(state utils.Maintenance) {
548548
bm.l.Lock()
549549
switch state {
550550
case utils.NoResourceReconciliation:

‎pkg/module_manager/module_manager.go

+6-6
Original file line numberDiff line numberDiff line change
@@ -51,8 +51,8 @@ const (
5151
moduleInfoMetricGroup = "mm_module_info"
5252
moduleInfoMetricName = "{PREFIX}mm_module_info"
5353

54-
moduleMaintenanceStateMetricGroup = "mm_module_maintenance_state"
55-
moduleMaintenanceStateMetricName = "{PREFIX}mm_module_maintenance_state"
54+
moduleMaintenanceMetricGroup = "mm_module_maintenance"
55+
moduleMaintenanceMetricName = "{PREFIX}mm_module_maintenance"
5656
)
5757

5858
// ModulesState determines which modules should be enabled, disabled or reloaded.
@@ -285,7 +285,7 @@ func (mm *ModuleManager) validateNewKubeConfig(kubeConfig *config.KubeConfig, al
285285
}
286286

287287
if moduleConfig.GetMaintenanceState() == utils.NoResourceReconciliation {
288-
mm.dependencies.MetricStorage.Grouped().GaugeSet(moduleMaintenanceStateMetricGroup, moduleMaintenanceStateMetricName, 1, map[string]string{"moduleName": moduleName, "state": utils.NoResourceReconciliation.String()})
288+
mm.dependencies.MetricStorage.Grouped().GaugeSet(moduleMaintenanceMetricGroup, moduleMaintenanceMetricName, 1, map[string]string{"moduleName": moduleName, "state": utils.NoResourceReconciliation.String()})
289289
mod.SetMaintenanceState(moduleConfig.GetMaintenanceState())
290290
}
291291

@@ -498,16 +498,16 @@ func (mm *ModuleManager) UpdateModulesMetrics() {
498498
}
499499
}
500500

501-
func (mm *ModuleManager) SetModuleMaintenanceState(moduleName string, state utils.MaintenanceState) {
501+
func (mm *ModuleManager) SetModuleMaintenanceState(moduleName string, state utils.Maintenance) {
502502
if bm := mm.GetModule(moduleName); bm != nil {
503503
bm.SetMaintenanceState(state)
504504
mm.logger.Info("set module management state",
505505
slog.String("module", moduleName),
506506
slog.String("state", state.String()))
507507
if state == utils.NoResourceReconciliation {
508-
mm.dependencies.MetricStorage.Grouped().GaugeSet(moduleMaintenanceStateMetricGroup, moduleMaintenanceStateMetricName, 1, map[string]string{"moduleName": moduleName, "state": utils.NoResourceReconciliation.String()})
508+
mm.dependencies.MetricStorage.Grouped().GaugeSet(moduleMaintenanceMetricGroup, moduleMaintenanceMetricName, 1, map[string]string{"moduleName": moduleName, "state": utils.NoResourceReconciliation.String()})
509509
} else {
510-
mm.dependencies.MetricStorage.Grouped().ExpireGroupMetricByName(moduleMaintenanceStateMetricGroup, moduleMaintenanceStateMetricName)
510+
mm.dependencies.MetricStorage.Grouped().ExpireGroupMetricByName(moduleMaintenanceMetricGroup, moduleMaintenanceMetricName)
511511
}
512512
}
513513
}

‎pkg/utils/module_config.go

+18-18
Original file line numberDiff line numberDiff line change
@@ -15,31 +15,31 @@ var (
1515
ModuleDisabled = false
1616

1717
EnabledSuffix = "Enabled"
18-
MaintenanceStateSuffix = "MaintenanceState"
18+
MaintenanceStateSuffix = "Maintenance"
1919
)
2020

21-
type MaintenanceState string
21+
type Maintenance string
2222

23-
func (m MaintenanceState) String() string {
23+
func (m Maintenance) String() string {
2424
return string(m)
2525
}
2626

2727
const (
28-
Managed MaintenanceState = "Managed"
29-
NoResourceReconciliation MaintenanceState = "NoResourceReconciliation"
28+
Managed Maintenance = "Managed"
29+
NoResourceReconciliation Maintenance = "NoResourceReconciliation"
3030
)
3131

3232
type ModuleConfig struct {
33-
ModuleName string
34-
IsEnabled *bool
35-
MaintenanceState MaintenanceState
33+
ModuleName string
34+
IsEnabled *bool
35+
Maintenance Maintenance
3636
// module values, don't read it directly, use GetValues() for reading
3737
values Values
3838
}
3939

4040
// String returns description of ModuleConfig values.
4141
func (mc *ModuleConfig) String() string {
42-
return fmt.Sprintf("Module(Name=%s IsEnabled=%v MaintenanceState=%v Values:\n%s)", mc.ModuleName, mc.IsEnabled, mc.MaintenanceState, mc.values.DebugString())
42+
return fmt.Sprintf("Module(Name=%s IsEnabled=%v MaintenanceState=%v Values:\n%s)", mc.ModuleName, mc.IsEnabled, mc.Maintenance, mc.values.DebugString())
4343
}
4444

4545
// ModuleConfigKey transforms module kebab-case name to the config camelCase name
@@ -72,23 +72,23 @@ func (mc *ModuleConfig) GetEnabled() string {
7272
}
7373
}
7474

75-
func (mc *ModuleConfig) GetMaintenanceState() MaintenanceState {
75+
func (mc *ModuleConfig) GetMaintenanceState() Maintenance {
7676
if mc == nil {
7777
return Managed
7878
}
7979

80-
return mc.MaintenanceState
80+
return mc.Maintenance
8181
}
8282

8383
func NewModuleConfig(moduleName string, values Values) *ModuleConfig {
8484
if values == nil {
8585
values = make(Values)
8686
}
8787
return &ModuleConfig{
88-
ModuleName: moduleName,
89-
IsEnabled: nil,
90-
values: values,
91-
MaintenanceState: Managed,
88+
ModuleName: moduleName,
89+
IsEnabled: nil,
90+
values: values,
91+
Maintenance: Managed,
9292
}
9393
}
9494

@@ -126,7 +126,7 @@ func (mc *ModuleConfig) GetValues() Values {
126126
func (mc *ModuleConfig) Reset() {
127127
mc.values = Values{}
128128
mc.IsEnabled = nil
129-
mc.MaintenanceState = NoResourceReconciliation
129+
mc.Maintenance = NoResourceReconciliation
130130
}
131131

132132
// LoadFromValues loads module config from a map.
@@ -160,8 +160,8 @@ func (mc *ModuleConfig) LoadFromValues(values Values) (*ModuleConfig, error) {
160160

161161
if maintenanceState, hasMaintenanceState := values[mc.ModuleMaintenanceStateKey()]; hasMaintenanceState {
162162
switch v := maintenanceState.(type) {
163-
case MaintenanceState:
164-
mc.MaintenanceState = v
163+
case Maintenance:
164+
mc.Maintenance = v
165165
default:
166166
return nil, fmt.Errorf("load '%s' MaintenanceState config: MaintenanceState value should be string. Got: %#v", mc.ModuleName, maintenanceState)
167167
}

0 commit comments

Comments
 (0)