[addon-operator] tests: added ListReleases to LibClient for testing (#602)

* tests: added ListReleases to LibClient for testing

Signed-off-by: Evsyukov Denis <denis.evsyukov@flant.com>

Author: Evsyukov Denis

.github/workflows/lint.yaml

@@ -38,8 +38,8 @@ jobs:
 
       - name: Run golangci-lint
         run: |
-          curl -sSfL https://raw.githubusercontent.com/golangci/golangci-lint/master/install.sh | sh -s -- -b . v1.61.0
-          ./golangci-lint run --sort-results 
+          curl -sSfL https://raw.githubusercontent.com/golangci/golangci-lint/master/install.sh | sh -s -- -b . v2.1.6
+          ./golangci-lint run
 
   codespell:
     name: Run codespell

.golangci.yaml

@@ -1,112 +1,121 @@
-run:
-  timeout: 15m
+version: "2"
+run:  
+  timeout: 15m  
+
 linters:
-  disable-all: true
+  default: none
   enable:
-  - asciicheck
-  - bodyclose
-  - copyloopvar
-  - depguard
-  - dogsled
-  - durationcheck
-  - gci
-  - gochecknoinits
-  - gocritic
-  - gofmt
-  - gofumpt
-  - goimports
-  - goprintffuncname
-  - gosimple
-  - govet
-  - ineffassign
-  - misspell
-  - nolintlint
-  - nonamedreturns
-  - prealloc
-  - revive
-  - sloglint
-  - staticcheck
-  - stylecheck
-  - unconvert
-  - unused
-  - whitespace
-linters-settings:
-  gci:
-    sections:
-      - standard
-      - default
-      - prefix(github.com/flant/)
-  goimports:
-    local-prefixes: github.com/flant/
-  sloglint:
-      # Enforce not mixing key-value pairs and attributes.
+    - asciicheck
+    - bodyclose
+    - copyloopvar
+    - depguard
+    - dogsled
+    - durationcheck
+    - gochecknoinits
+    - gocritic
+    - goprintffuncname
+    - govet
+    - ineffassign
+    - misspell
+    - nolintlint
+    - nonamedreturns
+    - prealloc
+    - revive
+    - sloglint
+    - staticcheck
+    - unconvert
+    - unused
+    - whitespace
+  settings:
+    depguard:
+      rules:
+        Main:
+          files:
+            - $all
+          deny:
+            - pkg: github.com/evanphx/json-patch
+              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-error-in-defer: false
+    sloglint:
       no-mixed-args: true
-      # Enforce using key-value pairs only (overrides no-mixed-args, incompatible with attr-only).
       kv-only: false
-      # Enforce using attributes only (overrides no-mixed-args, incompatible with kv-only).
       attr-only: false
-      # Enforce not using global loggers.
       no-global: ""
-      # Enforce using methods that accept a context.
       context: ""
-      # Enforce using static values for log messages.
       static-msg: false
-      # Enforce using constants instead of raw keys.
       no-raw-keys: false
-      # Enforce a single key naming convention.
-      key-naming-case: ""
-      # Enforce not using specific keys.
       forbidden-keys:
         - level
         - msg
         - logger
         - source
         - stacktrace
         - time
-      # Enforce putting arguments on separate lines.
       args-on-sep-lines: false
-  depguard:
+    staticcheck:
+      checks:
+        - all
+        - '-QF1008' # not need to fix; we understand how to call nested structs
+  exclusions:
+    generated: lax
+    presets:
+      - comments
+      - common-false-positives
+      - legacy
+      - std-error-handling
     rules:
-      Main:
-        files:
-          - $all
-        deny:
-          - pkg: "github.com/evanphx/json-patch"
-            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
+      - path: (.+)\.go$
+        text: 'var-naming: don''t use an underscore in package name'
+      - path: (.+)\.go$
+        text: 'ST1003: should not use underscores in package names'
+      - path: (.+)\.go$
+        text: 'ST1005: error strings should not be capitalized'
+      - path: (.+)\.go$
+        text: 'error-strings: error strings should not be capitalized or end with punctuation or a newline'
+      - path: (.+)\.go$
+        text: 'ST1005: error strings should not end with punctuation or newlines'
+      - path: (.+)\.go$
+        text: 'dot-imports: should not use dot imports'
+      - path: (.+)\.go$
+        text: 'ST1001: should not use dot imports'
+      - path: (.+)\.go$
+        text: don't use `init` function
+      - path: (.+)\.go$
+        text: 'var-naming:'
+      - path: (.+)\.go$
+        text: 'ST1003: '
+      - path: (.+)\.go$
+        text: 'exported: type name will be used as'
+      - path: (.+)\.go$
+        text: 'unexported-return: exported func NewModuleManager'
+    paths:
+      - third_party$
+      - builtin$
+      - examples$
 issues:
-  exclude:
-  # Using underscores is a common practice, refactor in the future
-  - "var-naming: don't use an underscore in package name" # revive
-  - "ST1003: should not use underscores in package names" # stylecheck
-
-  # Sometime errors are used to propagate messages for end-users
-  - "ST1005: error strings should not be capitalized" # stylecheck
-  - "error-strings: error strings should not be capitalized or end with punctuation or a newline" # revive
-  - "ST1005: error strings should not end with punctuation or newlines" # stylecheck
-
-  # Dot imports are used for types, consider refactoring
-  - "dot-imports: should not use dot imports" # revive
-  - "ST1001: should not use dot imports" # stylecheck
-
-  # Init functions are used for global variables' initialization, consider refactoring
-  - "don't use `init` function"
-
-  # Suggests changing Json -> JSON. Figure out which style we want to follow.
-  - "var-naming:" # revive
-  - "ST1003: " # stylecheck
-
-  # Exported name should not start with the package name, e.g., helm3.Helm3Options.
-  # However, this penetrates all the code and sometimes is used to avoid name collisions.
-  # Nice to refactor, but not necessary.
-  - "exported: type name will be used as" # revive
-
-  # Do not know why, but a complicated thing to refactor. Let it be for now.
-  - "unexported-return: exported func NewModuleManager" # revive
   max-issues-per-linter: 0
   max-same-issues: 0
+formatters:
+  enable:
+    - gci
+    - gofmt
+    - gofumpt
+    - goimports
+  settings:
+    gci:
+      sections:
+        - standard
+        - default
+        - prefix(github.com/flant/)
+    goimports:
+      local-prefixes:
+        - github.com/flant/
+  exclusions:
+    generated: lax
+    paths:
+      - third_party$
+      - builtin$
+      - examples$

pkg/addon-operator/debug_server.go

@@ -80,7 +80,7 @@ func (op *AddonOperator) RegisterDebugGraphRoutes(dbgSrv *debug.Server) {
 		image, err := op.ModuleManager.GetGraphImage(req.Context())
 		if err != nil {
 			w.WriteHeader(http.StatusInternalServerError)
-			_, _ = w.Write([]byte(fmt.Sprintf("couldn't get graph's image: %s", err)))
+			_, _ = fmt.Fprintf(w, "couldn't get graph's image: %s", err)
 			return
 		}
 
@@ -267,7 +267,7 @@ func (op *AddonOperator) RegisterDebugModuleRoutes(dbgSrv *debug.Server) {
 				}
 
 				err = differ.Diff(obj, printer, false)
-				if !(err != nil && apierrors.IsConflict(err)) {
+				if err == nil || !apierrors.IsConflict(err) {
 					break
 				}
 			}

pkg/addon-operator/handler_module_manager.go

@@ -164,7 +164,7 @@ func (op *AddonOperator) StartModuleManagerEventHandler() {
 							}
 
 							// Append ModuleRun tasks if ModuleRun is not queued already.
-							if kubeConfigTask != nil && convergeTask == nil {
+							if kubeConfigTask != nil {
 								reloadTasks := op.CreateReloadModulesTasks(modulesToRerun, kubeConfigTask.GetLogLabels(), "KubeConfig-Changed-Modules")
 								op.engine.TaskQueues.GetMain().AddFirst(kubeConfigTask)
 								if len(reloadTasks) > 0 {

pkg/addon-operator/http_server.go

@@ -102,7 +102,7 @@ func (op *AddonOperator) registerDefaultRoutes() {
 
 // handleRootPage serves the main HTML page with links to all available endpoints
 func (op *AddonOperator) handleRootPage(writer http.ResponseWriter, _ *http.Request) {
-	_, _ = writer.Write([]byte(fmt.Sprintf(`<html>
+	_, _ = fmt.Fprintf(writer, `<html>
 	<head><title>Addon-operator</title></head>
 	<body>
 	<h1>Addon-operator</h1>
@@ -115,7 +115,7 @@ func (op *AddonOperator) handleRootPage(writer http.ResponseWriter, _ *http.Requ
 	  <a href="/readyz">ready url</a>
 	</p>
 	</body>
-	</html>`, app.ListenPort)))
+	</html>`, app.ListenPort)
 }
 
 // handleHealthCheck responds with 200 OK for health probes

pkg/addon-operator/queue_test.go

@@ -288,10 +288,9 @@ func Test_RemoveAdjacentConvergeModules(t *testing.T) {
 
 			q := queue.NewTasksQueue().WithMetricStorage(metricStorage)
 
-			//nolint:govet
-			for _, tsk := range tt.in {
-				tmpTsk := tsk
-				q.AddLast(&tmpTsk)
+			for i := range tt.in {
+				tsk := &tt.in[i]
+				q.AddLast(tsk)
 			}
 			require.Equal(t, len(tt.in), q.Length(), "Should add all tasks to the queue.")
 
@@ -532,14 +531,13 @@ func Test_RemoveCurrentConvergeTasks(t *testing.T) {
 
 				// Fill queue from the test case.
 				queues = append(queues, q)
-				//nolint:govet
-				for _, tsk := range tasks {
-					tmpTsk := tsk
+				for i := range tasks {
+					tmpTsk := &tasks[i]
 					// Set metadata to prevent "possible bug" errors.
 					if tmpTsk.Metadata == nil {
 						tmpTsk.Metadata = task.HookMetadata{}
 					}
-					q.AddLast(&tmpTsk)
+					q.AddLast(tmpTsk)
 				}
 				require.Equal(t, len(tasks), q.Length(), "Should add all tasks to the queue.")
 			}
@@ -660,14 +658,13 @@ func Test_RemoveCurrentConvergeTasksFromId(t *testing.T) {
 			q := queue.NewTasksQueue().WithMetricStorage(metricStorage)
 
 			// Fill queue from the test case.
-			//nolint:govet
-			for _, tsk := range tt.initialTasks {
-				tmpTsk := tsk
+			for i := range tt.initialTasks {
+				tmpTsk := &tt.initialTasks[i]
 				// Set metadata to prevent "possible bug" errors.
 				if tmpTsk.Metadata == nil {
 					tmpTsk.Metadata = task.HookMetadata{}
 				}
-				q.AddLast(&tmpTsk)
+				q.AddLast(tmpTsk)
 			}
 			require.Equal(t, len(tt.initialTasks), q.Length(), "Should add all tasks to the queue.")
 

pkg/helm/helm3lib/helm3lib.go

@@ -526,3 +526,16 @@ func (h *LibClient) newDryRunInstAction(namespace, releaseName string) *action.I
 
 	return inst
 }
+
+// ListReleases retrieves all Helm releases regardless of their state.
+func (h *LibClient) ListReleases() ([]*release.Release, error) {
+	l := action.NewList(actionConfig)
+	// list all releases regardless of their state
+	l.StateMask = action.ListAll
+	list, err := l.Run()
+	if err != nil {
+		return nil, fmt.Errorf("helm list failed: %w", err)
+	}
+
+	return list, nil
+}