Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[ci] add nonamedreturns linter #545

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

[ci] add nonamedreturns linter #545

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .golangci.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@ linters:
- ineffassign
- misspell
- nolintlint
- nonamedreturns
- prealloc
- revive
- sloglint
Expand Down Expand Up @@ -79,6 +80,10 @@ linters-settings:
desc: "The 'github.com/evanphx/json-patch' package is superseded. Use pkg/utils/jsonpatch.go instead."
- pkg: "gopkg.in/satori/go.uuid.v1"
desc: "Use https://github.com/gofrs/uuid instead. Satori/go.uuid is no longer maintained and has critical vulnerabilities."
nonamedreturns:
# Report named error if it is assigned inside defer.
# Default: false
report-error-in-defer: false
issues:
exclude:
# Using underscores is a common practice, refactor in the future
Expand Down
5 changes: 2 additions & 3 deletions pkg/addon-operator/bootstrap.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ func (op *AddonOperator) bootstrap() error {
return nil
}

func (op *AddonOperator) Assemble(debugServer *debug.Server) (err error) {
func (op *AddonOperator) Assemble(debugServer *debug.Server) error {
op.registerDefaultRoutes()
if app.AdmissionServerEnabled {
op.AdmissionServer.start(op.ctx)
Expand All @@ -55,8 +55,7 @@ func (op *AddonOperator) Assemble(debugServer *debug.Server) (err error) {
op.RegisterDebugModuleRoutes(debugServer)
op.RegisterDiscoveryRoute(debugServer)

err = op.InitModuleManager()
if err != nil {
if err := op.InitModuleManager(); err != nil {
return err
}

Expand Down
103 changes: 59 additions & 44 deletions pkg/addon-operator/operator.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -738,12 +738,15 @@ func (op *AddonOperator) CreatePurgeTasks(modulesToPurge []string, t sh_task.Tas
}

// ApplyKubeConfigValues
func (op *AddonOperator) HandleApplyKubeConfigValues(t sh_task.Task, logLabels map[string]string) (res queue.TaskResult) {
var handleErr error
func (op *AddonOperator) HandleApplyKubeConfigValues(t sh_task.Task, logLabels map[string]string) queue.TaskResult {
defer trace.StartRegion(context.Background(), "HandleApplyKubeConfigValues").End()
logEntry := utils.EnrichLoggerWithLabels(op.Logger, logLabels)

hm := task.HookMetadataAccessor(t)
var (
handleErr error
res queue.TaskResult
logEntry = utils.EnrichLoggerWithLabels(op.Logger, logLabels)
hm = task.HookMetadataAccessor(t)
)

op.KubeConfigManager.SafeReadConfig(func(config *config.KubeConfig) {
handleErr = op.ModuleManager.ApplyNewKubeConfigValues(config, hm.GlobalValuesChanged)
Expand All @@ -759,14 +762,16 @@ func (op *AddonOperator) HandleApplyKubeConfigValues(t sh_task.Task, logLabels m
}

res.Status = queue.Success

logEntry.Debugf("HandleApplyKubeConfigValues success")
return

return res
}

// HandleConvergeModules is a multi-phase task.
func (op *AddonOperator) HandleConvergeModules(t sh_task.Task, logLabels map[string]string) (res queue.TaskResult) {
func (op *AddonOperator) HandleConvergeModules(t sh_task.Task, logLabels map[string]string) queue.TaskResult {
defer trace.StartRegion(context.Background(), "ConvergeModules").End()

var res queue.TaskResult
logEntry := utils.EnrichLoggerWithLabels(op.Logger, logLabels)

taskEvent, ok := t.GetProp(converge.ConvergeEventProp).(converge.ConvergeEvent)
Expand Down Expand Up @@ -798,7 +803,7 @@ func (op *AddonOperator) HandleConvergeModules(t sh_task.Task, logLabels map[str
res.HeadTasks = tasks
res.Status = queue.Keep
op.logTaskAdd(logEntry, "head", res.HeadTasks...)
return
return res
}
}

Expand All @@ -825,7 +830,7 @@ func (op *AddonOperator) HandleConvergeModules(t sh_task.Task, logLabels map[str
res.HeadTasks = tasks
res.Status = queue.Keep
op.logTaskAdd(logEntry, "head", res.HeadTasks...)
return
return res
}
}
}
Expand All @@ -840,7 +845,7 @@ func (op *AddonOperator) HandleConvergeModules(t sh_task.Task, logLabels map[str
res.HeadTasks = tasks
res.Status = queue.Keep
op.logTaskAdd(logEntry, "head", res.HeadTasks...)
return
return res
}
}
}
Expand All @@ -864,6 +869,7 @@ func (op *AddonOperator) HandleConvergeModules(t sh_task.Task, logLabels map[str

logEntry.Debugf("ConvergeModules success")
res.Status = queue.Success

return res
}

Expand Down Expand Up @@ -906,6 +912,7 @@ func (op *AddonOperator) CreateBeforeAllTasks(logLabels map[string]string, event
})
tasks = append(tasks, newTask.WithQueuedAt(queuedAt))
}

return tasks
}

Expand Down Expand Up @@ -962,6 +969,7 @@ func (op *AddonOperator) CreateAndStartQueue(queueName string) bool {
}
op.engine.TaskQueues.NewNamedQueue(queueName, op.TaskHandler)
op.engine.TaskQueues.GetByName(queueName).Start()

return true
}

Expand Down Expand Up @@ -1434,9 +1442,10 @@ func (op *AddonOperator) UpdateWaitInQueueMetric(t sh_task.Task) {
}

// HandleGlobalHookEnableKubernetesBindings add Synchronization tasks.
func (op *AddonOperator) HandleGlobalHookEnableKubernetesBindings(t sh_task.Task, labels map[string]string) (res queue.TaskResult) {
func (op *AddonOperator) HandleGlobalHookEnableKubernetesBindings(t sh_task.Task, labels map[string]string) queue.TaskResult {
defer trace.StartRegion(context.Background(), "DiscoverHelmReleases").End()

var res queue.TaskResult
logEntry := utils.EnrichLoggerWithLabels(op.Logger, labels)
logEntry.Debugf("Global hook enable kubernetes bindings")

Expand Down Expand Up @@ -1507,7 +1516,7 @@ func (op *AddonOperator) HandleGlobalHookEnableKubernetesBindings(t sh_task.Task
t.UpdateFailureMessage(err.Error())
t.WithQueuedAt(queuedAt)
res.Status = queue.Fail
return
return res
}
// Substitute current task with Synchronization tasks for the main queue.
// Other Synchronization tasks are queued into specified queues.
Expand Down Expand Up @@ -1544,13 +1553,14 @@ func (op *AddonOperator) HandleGlobalHookEnableKubernetesBindings(t sh_task.Task

res.Status = queue.Success

return
return res
}

// HandleDiscoverHelmReleases runs RefreshStateFromHelmReleases to detect modules state at start.
func (op *AddonOperator) HandleDiscoverHelmReleases(t sh_task.Task, labels map[string]string) (res queue.TaskResult) {
func (op *AddonOperator) HandleDiscoverHelmReleases(t sh_task.Task, labels map[string]string) queue.TaskResult {
defer trace.StartRegion(context.Background(), "DiscoverHelmReleases").End()

var res queue.TaskResult
logEntry := utils.EnrichLoggerWithLabels(op.Logger, labels)
logEntry.Debugf("Discover Helm releases state")

Expand All @@ -1560,20 +1570,21 @@ func (op *AddonOperator) HandleDiscoverHelmReleases(t sh_task.Task, labels map[s
logEntry.Errorf("Discover helm releases failed, requeue task to retry after delay. Failed count is %d. Error: %s", t.GetFailureCount()+1, err)
t.UpdateFailureMessage(err.Error())
t.WithQueuedAt(time.Now())
return
return res
}

res.Status = queue.Success
tasks := op.CreatePurgeTasks(state.ModulesToPurge, t)
res.AfterTasks = tasks
op.logTaskAdd(logEntry, "after", res.AfterTasks...)
return
return res
}

// HandleModulePurge run helm purge for unknown module.
func (op *AddonOperator) HandleModulePurge(t sh_task.Task, labels map[string]string) (status queue.TaskStatus) {
func (op *AddonOperator) HandleModulePurge(t sh_task.Task, labels map[string]string) queue.TaskStatus {
defer trace.StartRegion(context.Background(), "ModulePurge").End()

var status queue.TaskStatus
logEntry := utils.EnrichLoggerWithLabels(op.Logger, labels)
logEntry.Debugf("Module purge start")

Expand All @@ -1587,18 +1598,17 @@ func (op *AddonOperator) HandleModulePurge(t sh_task.Task, labels map[string]str
}

status = queue.Success
return

return status
}

// HandleModuleDelete deletes helm release for known module.
func (op *AddonOperator) HandleModuleDelete(t sh_task.Task, labels map[string]string) (status queue.TaskStatus) {
func (op *AddonOperator) HandleModuleDelete(t sh_task.Task, labels map[string]string) queue.TaskStatus {
defer trace.StartRegion(context.Background(), "ModuleDelete").End()

var status queue.TaskStatus
hm := task.HookMetadataAccessor(t)
status = queue.Success

baseModule := op.ModuleManager.GetModule(hm.ModuleName)

logEntry := utils.EnrichLoggerWithLabels(op.Logger, labels)
logEntry.Debugf("Module delete '%s'", hm.ModuleName)

Expand Down Expand Up @@ -1629,18 +1639,18 @@ func (op *AddonOperator) HandleModuleDelete(t sh_task.Task, labels map[string]st
status = queue.Success
}

return
return status
}

// HandleModuleEnsureCRDs ensure CRDs for module.
func (op *AddonOperator) HandleModuleEnsureCRDs(t sh_task.Task, labels map[string]string) (res queue.TaskResult) {
func (op *AddonOperator) HandleModuleEnsureCRDs(t sh_task.Task, labels map[string]string) queue.TaskResult {
defer trace.StartRegion(context.Background(), "ModuleEnsureCRDs").End()

hm := task.HookMetadataAccessor(t)
res.Status = queue.Success

res := queue.TaskResult{
Status: queue.Success,
}
baseModule := op.ModuleManager.GetModule(hm.ModuleName)

logEntry := utils.EnrichLoggerWithLabels(op.Logger, labels)
logEntry.Debugf("Module ensureCRDs '%s'", hm.ModuleName)

Expand All @@ -1658,12 +1668,14 @@ func (op *AddonOperator) HandleModuleEnsureCRDs(t sh_task.Task, labels map[strin
op.discoveredGVKsLock.Unlock()
}

return
return res
}

// HandleParallelModuleRun runs multiple HandleModuleRun tasks in parallel and aggregates their results
func (op *AddonOperator) HandleParallelModuleRun(t sh_task.Task, labels map[string]string) (res queue.TaskResult) {
func (op *AddonOperator) HandleParallelModuleRun(t sh_task.Task, labels map[string]string) queue.TaskResult {
defer trace.StartRegion(context.Background(), "ParallelModuleRun").End()

var res queue.TaskResult
logEntry := utils.EnrichLoggerWithLabels(op.Logger, labels)
hm := task.HookMetadataAccessor(t)

Expand Down Expand Up @@ -1751,6 +1763,7 @@ L:
}
op.parallelTaskChannels.Delete(t.GetId())
res.Status = queue.Success

return res
}

Expand All @@ -1760,6 +1773,7 @@ func formatErrorSummary(errors map[string]string) string {
for moduleName, moduleErr := range errors {
errSummary += fmt.Sprintf("\t- %s: %s", moduleName, moduleErr)
}

return errSummary
}

Expand All @@ -1777,17 +1791,18 @@ func formatErrorSummary(errors map[string]string) string {
//
// ModuleRun is restarted if hook or chart is failed.
// After first HandleModuleRun success, no onStartup and kubernetes.Synchronization tasks will run.
func (op *AddonOperator) HandleModuleRun(t sh_task.Task, labels map[string]string) (res queue.TaskResult) {
func (op *AddonOperator) HandleModuleRun(t sh_task.Task, labels map[string]string) queue.TaskResult {
defer trace.StartRegion(context.Background(), "ModuleRun").End()
logEntry := utils.EnrichLoggerWithLabels(op.Logger, labels)

var res queue.TaskResult
logEntry := utils.EnrichLoggerWithLabels(op.Logger, labels)
hm := task.HookMetadataAccessor(t)
baseModule := op.ModuleManager.GetModule(hm.ModuleName)

// Break error loop when module becomes disabled.
if !op.ModuleManager.IsModuleEnabled(baseModule.GetName()) {
res.Status = queue.Success
return
return res
}

metricLabels := map[string]string{
Expand Down Expand Up @@ -1949,7 +1964,7 @@ func (op *AddonOperator) HandleModuleRun(t sh_task.Task, labels map[string]strin
res.HeadTasks = mainSyncTasks
res.Status = queue.Keep
op.logTaskAdd(logEntry, "head", mainSyncTasks...)
return
return res
}
}
}
Expand All @@ -1969,7 +1984,7 @@ func (op *AddonOperator) HandleModuleRun(t sh_task.Task, labels map[string]strin
logEntry.Debugf("Synchronization not completed, keep ModuleRun task in repeat mode")
t.WithQueuedAt(time.Now())
res.Status = queue.Repeat
return
return res
}
}

Expand Down Expand Up @@ -2015,14 +2030,15 @@ func (op *AddonOperator) HandleModuleRun(t sh_task.Task, labels map[string]strin
logEntry.Infof("ModuleRun success, module is ready")
}
}
return

return res
}

func (op *AddonOperator) HandleModuleHookRun(t sh_task.Task, labels map[string]string) (res queue.TaskResult) {
func (op *AddonOperator) HandleModuleHookRun(t sh_task.Task, labels map[string]string) queue.TaskResult {
defer trace.StartRegion(context.Background(), "ModuleHookRun").End()

var res queue.TaskResult
logEntry := utils.EnrichLoggerWithLabels(op.Logger, labels)

hm := task.HookMetadataAccessor(t)
baseModule := op.ModuleManager.GetModule(hm.ModuleName)
// TODO: check if module exists
Expand All @@ -2031,7 +2047,7 @@ func (op *AddonOperator) HandleModuleHookRun(t sh_task.Task, labels map[string]s
// Prevent hook running in parallel queue if module is disabled in "main" queue.
if !op.ModuleManager.IsModuleEnabled(baseModule.GetName()) {
res.Status = queue.Success
return
return res
}

err := taskHook.RateLimitWait(context.Background())
Expand All @@ -2040,7 +2056,7 @@ func (op *AddonOperator) HandleModuleHookRun(t sh_task.Task, labels map[string]s
// canceled, or the expected wait time exceeds the Context's Deadline.
// The best we can do without proper context usage is to repeat the task.
res.Status = queue.Repeat
return
return res
}

metricLabels := map[string]string{
Expand Down Expand Up @@ -2213,11 +2229,11 @@ func (op *AddonOperator) HandleModuleHookRun(t sh_task.Task, labels map[string]s
return res
}

func (op *AddonOperator) HandleGlobalHookRun(t sh_task.Task, labels map[string]string) (res queue.TaskResult) {
func (op *AddonOperator) HandleGlobalHookRun(t sh_task.Task, labels map[string]string) queue.TaskResult {
defer trace.StartRegion(context.Background(), "GlobalHookRun").End()

var res queue.TaskResult
logEntry := utils.EnrichLoggerWithLabels(op.Logger, labels)

hm := task.HookMetadataAccessor(t)
taskHook := op.ModuleManager.GetGlobalHook(hm.HookName)

Expand All @@ -2226,9 +2242,8 @@ func (op *AddonOperator) HandleGlobalHookRun(t sh_task.Task, labels map[string]s
// This could happen when the Context is
// canceled, or the expected wait time exceeds the Context's Deadline.
// The best we can do without proper context usage is to repeat the task.
return queue.TaskResult{
Status: "Repeat",
}
res.Status = "Repeat"
return res
}

metricLabels := map[string]string{
Expand Down
Loading
Loading