Merge pull request #17 from hashmap-kz/feature/lint

feature/lint

.golangci.yml

@@ -0,0 +1,121 @@
+---
+run:
+  concurrency: 6
+  timeout: 10m
+issues:
+  exclude-dirs:
+    - integration/*
+
+  # Maximum issues count per one linter. Set to 0 to disable. Default is 50.
+  max-issues-per-linter: 0
+
+  # Maximum count of issues with the same text. Set to 0 to disable. Default is 3.
+  max-same-issues: 0
+linters:
+  disable-all: true
+  enable:
+    - asciicheck
+    - bodyclose
+    - dogsled
+    - dupl
+    - durationcheck
+    - errcheck
+    - goconst
+    - gocritic
+    - gocyclo
+    - godox
+    - gofmt
+    - gofumpt
+    - goheader
+    - goimports
+    - gomoddirectives
+    - gomodguard
+    - goprintffuncname
+    - gosec
+    - gosimple
+    - govet
+    - importas
+    - ineffassign
+    - makezero
+    - misspell
+    - nakedret
+    - nolintlint
+    - prealloc
+    - predeclared
+    - promlinter
+    - revive
+    - rowserrcheck
+    - sqlclosecheck
+    - staticcheck
+    - stylecheck
+    - typecheck
+    - unconvert
+    - unparam
+    - unused
+    - whitespace
+
+linters-settings:
+  godox:
+    keywords:
+      - BUG
+      - FIXME
+      - HACK
+  errcheck:
+    check-type-assertions: true
+    check-blank: true
+  gocritic:
+    disabled-checks:
+      - ifElseChain
+    enabled-checks:
+      # Diagnostic
+      - commentedOutCode
+      - nilValReturn
+      - sloppyReassign
+      - weakCond
+      - octalLiteral
+
+      # Performance
+      - appendCombine
+      - equalFold
+      - hugeParam
+      - indexAlloc
+      - rangeExprCopy
+      - rangeValCopy
+
+      # Style
+      - boolExprSimplify
+      - commentedOutImport
+      - docStub
+      - emptyFallthrough
+      - emptyStringTest
+      - hexLiteral
+      - methodExprCall
+      - stringXbytes
+      - typeAssertChain
+      - unlabelStmt
+      - yodaStyleExpr
+      # - ifElseChain
+
+      # Opinionated
+      - builtinShadow
+      - importShadow
+      - initClause
+      - nestingReduce
+      - paramTypeCombine
+      - ptrToRefParam
+      - typeUnparen
+      - unnamedResult
+      - unnecessaryBlock
+  nolintlint:
+    # Enable to ensure that nolint directives are all used. Default is true.
+    allow-unused: false
+    # Disable to ensure that nolint directives don't have a leading space. Default is true.
+    # TODO(lint): Enforce machine-readable `nolint` directives
+    allow-leading-space: true
+    # Exclude following linters from requiring an explanation.  Default is [].
+    allow-no-explanation: []
+    # Enable to require an explanation of nonzero length after each nolint directive. Default is false.
+    # TODO(lint): Enforce explanations for `nolint` directives
+    require-explanation: false
+    # Enable to require nolint directives to mention the specific linter being suppressed. Default is false.
+    require-specific: true

cmd/app/app.go

@@ -2,16 +2,16 @@ package app
 
 import (
 	"fmt"
-	"github.com/hashmap-kz/kubectl-envsubst/pkg/cmd"
 	"io"
 	"os"
 	"os/exec"
 	"strings"
+
+	"github.com/hashmap-kz/kubectl-envsubst/pkg/cmd"
 )
 
 // runApp executes the plugin, with logic divided into smaller, testable components
 func RunApp() error {
-
 	// parse all passed cmd arguments without any modification
 	flags, err := cmd.ParseArgs()
 	if err != nil {
@@ -44,15 +44,15 @@ func RunApp() error {
 
 	// apply STDIN (if any)
 	if flags.HasStdin {
-		err := applyStdin(flags, kubectl)
+		err := applyStdin(&flags, kubectl)
 		if err != nil {
 			return err
 		}
 	}
 
 	// apply passed files
 	for _, filename := range files {
-		err := applyOneFile(flags, kubectl, filename)
+		err := applyOneFile(&flags, kubectl, filename)
 		if err != nil {
 			return err
 		}
@@ -62,7 +62,7 @@ func RunApp() error {
 }
 
 // applyStdin substitutes content, passed to stdin `kubectl apply -f -`
-func applyStdin(flags cmd.CmdArgsRawRecognized, kubectl string) error {
+func applyStdin(flags *cmd.ArgsRawRecognized, kubectl string) error {
 	stdin, err := io.ReadAll(os.Stdin)
 	if err != nil {
 		return err
@@ -78,8 +78,7 @@ func applyStdin(flags cmd.CmdArgsRawRecognized, kubectl string) error {
 }
 
 // applyOneFile read file (url, local-path), substitute its content, apply result
-func applyOneFile(flags cmd.CmdArgsRawRecognized, kubectl string, filename string) error {
-
+func applyOneFile(flags *cmd.ArgsRawRecognized, kubectl, filename string) error {
 	// recognize file type
 
 	var contentForSubst []byte
@@ -107,7 +106,7 @@ func applyOneFile(flags cmd.CmdArgsRawRecognized, kubectl string, filename strin
 }
 
 // substituteContent runs the subst module for a given content
-func substituteContent(flags cmd.CmdArgsRawRecognized, contentForSubst []byte) (string, error) {
+func substituteContent(flags *cmd.ArgsRawRecognized, contentForSubst []byte) (string, error) {
 	envSubst := cmd.NewEnvsubst(flags.EnvsubstAllowedVars, flags.EnvsubstAllowedPrefix, true)
 	substitutedBuffer, err := envSubst.SubstituteEnvs(string(contentForSubst))
 	if err != nil {
@@ -117,12 +116,11 @@ func substituteContent(flags cmd.CmdArgsRawRecognized, contentForSubst []byte) (
 }
 
 // execKubectl applies a result buffer, bu running `kubectl apply -f -`
-func execKubectl(flags cmd.CmdArgsRawRecognized, kubectl string, substitutedBuffer string) error {
+func execKubectl(flags *cmd.ArgsRawRecognized, kubectl, substitutedBuffer string) error {
 	// prepare kubectl args
 	args := []string{}
 	args = append(args, flags.Others...)
-	args = append(args, "-f")
-	args = append(args, "-")
+	args = append(args, "-f", "-")
 
 	// pass stream of files to stdin
 	execCmd, err := cmd.ExecWithStdin(kubectl, []byte(substitutedBuffer), args...)

cmd/app/app_test.go

@@ -88,7 +88,10 @@ data:
 
 	// Flush stdout and reset pointer for reading
 	os.Stdout.Sync()
-	_, _ = stdoutFile.Seek(0, io.SeekStart)
+	_, err = stdoutFile.Seek(0, io.SeekStart)
+	if err != nil {
+		t.Fatalf("Failed to seek 0. Stdout file.")
+	}
 
 	// Read and validate stdout content
 	output, err := io.ReadAll(stdoutFile)

cmd/kubectl-envsubst.go

@@ -2,12 +2,12 @@ package main
 
 import (
 	"fmt"
-	"github.com/hashmap-kz/kubectl-envsubst/cmd/app"
 	"os"
+
+	"github.com/hashmap-kz/kubectl-envsubst/cmd/app"
 )
 
 func main() {
-
 	err := app.RunApp()
 	if err != nil {
 		_, _ = fmt.Fprintf(os.Stderr, "%s", err.Error())

integration/apply_file_test.go

@@ -9,7 +9,6 @@ import (
 )
 
 func TestEnvsubstIntegration_SubstApplyFromFile(t *testing.T) {
-
 	if os.Getenv(integrationTestEnv) != integrationTestFlag {
 		t.Log("integration test was skipped due to configuration")
 		return
@@ -56,5 +55,4 @@ func TestEnvsubstIntegration_SubstApplyFromFile(t *testing.T) {
 	if !strings.Contains(string(validateOutput), resourceName) {
 		t.Errorf("Expected resource %s to exist, got %s", resourceName, string(validateOutput))
 	}
-
 }

integration/apply_mixed_test.go

@@ -9,7 +9,6 @@ import (
 )
 
 func TestEnvsubstIntegration_SubstApplyConfigmapMixed(t *testing.T) {
-
 	if os.Getenv(integrationTestEnv) != integrationTestFlag {
 		t.Log("integration test was skipped due to configuration")
 		return

integration/apply_stdin_large_test.go

@@ -42,7 +42,6 @@ data:
 `
 
 func TestEnvsubstIntegration_SubstApplyFromStdinWithLargeContent(t *testing.T) {
-
 	if os.Getenv(integrationTestEnv) != integrationTestFlag {
 		t.Log("integration test was skipped due to configuration")
 		return
@@ -79,5 +78,4 @@ func TestEnvsubstIntegration_SubstApplyFromStdinWithLargeContent(t *testing.T) {
 			t.Errorf("Expected substituted output to contain '%s', got %s", er, stringOutput)
 		}
 	}
-
 }

integration/apply_stdin_test.go

@@ -9,7 +9,6 @@ import (
 )
 
 func TestEnvsubstIntegration_SubstApplyFromStdin(t *testing.T) {
-
 	if os.Getenv(integrationTestEnv) != integrationTestFlag {
 		t.Log("integration test was skipped due to configuration")
 		return
@@ -81,5 +80,4 @@ spec:
 	if !strings.Contains(string(validateOutput), resourceName) {
 		t.Errorf("Expected resource %s to exist, got %s", resourceName, string(validateOutput))
 	}
-
 }

integration/apply_url_test.go

@@ -9,7 +9,6 @@ import (
 )
 
 func TestEnvsubstIntegration_SubstApplyFromUrl(t *testing.T) {
-
 	if os.Getenv(integrationTestEnv) != integrationTestFlag {
 		t.Log("integration test was skipped due to configuration")
 		return
@@ -57,5 +56,4 @@ func TestEnvsubstIntegration_SubstApplyFromUrl(t *testing.T) {
 	if !strings.Contains(string(validateOutput), resourceName) {
 		t.Errorf("Expected resource %s to exist, got %s", resourceName, string(validateOutput))
 	}
-
 }

integration/helpers.go

@@ -85,7 +85,6 @@ func printEnvsubstVersionInfo(t *testing.T) {
 			}
 		}
 	}
-
 }
 
 func getDeploymentImageName(t *testing.T, deploymentName string) string {
@@ -100,7 +99,6 @@ func getDeploymentImageName(t *testing.T, deploymentName string) string {
 }
 
 func createTempFile(t *testing.T, content string, extension string) (string, error) {
-
 	tempFile, err := os.CreateTemp("", "kubectl-envsubst-tmp-*."+extension)
 	if err != nil {
 		return "", fmt.Errorf("failed to create temp file: %w", err)

integration/plain_combined_test.go

@@ -8,7 +8,6 @@ import (
 )
 
 func TestEnvsubstIntegration_NoSubst_MixedManifests(t *testing.T) {
-
 	if os.Getenv(integrationTestEnv) != integrationTestFlag {
 		t.Log("integration test was skipped due to configuration")
 		return
@@ -49,5 +48,4 @@ func TestEnvsubstIntegration_NoSubst_MixedManifests(t *testing.T) {
 			t.Errorf("Expected substituted output to contain '%s', got %s", er, stringOutput)
 		}
 	}
-
 }

integration/plain_glob_test.go

@@ -8,7 +8,6 @@ import (
 )
 
 func TestEnvsubstIntegration_NoSubst_GlobPatterns_Yaml(t *testing.T) {
-
 	if os.Getenv(integrationTestEnv) != integrationTestFlag {
 		t.Log("integration test was skipped due to configuration")
 		return
@@ -54,11 +53,9 @@ func TestEnvsubstIntegration_NoSubst_GlobPatterns_Yaml(t *testing.T) {
 			t.Errorf("Expected substituted output does not contain '%s'", er)
 		}
 	}
-
 }
 
 func TestEnvsubstIntegration_NoSubst_GlobPatterns_Json(t *testing.T) {
-
 	if os.Getenv(integrationTestEnv) != integrationTestFlag {
 		t.Log("integration test was skipped due to configuration")
 		return
@@ -104,5 +101,4 @@ func TestEnvsubstIntegration_NoSubst_GlobPatterns_Json(t *testing.T) {
 			t.Errorf("Expected substituted output does not contain '%s'", er)
 		}
 	}
-
 }

integration/plain_recursive_test.go

@@ -8,7 +8,6 @@ import (
 )
 
 func TestEnvsubstIntegration_NoSubst_Recursive(t *testing.T) {
-
 	if os.Getenv(integrationTestEnv) != integrationTestFlag {
 		t.Log("integration test was skipped due to configuration")
 		return
@@ -54,5 +53,4 @@ func TestEnvsubstIntegration_NoSubst_Recursive(t *testing.T) {
 			t.Errorf("Expected substituted output to contain '%s', got %s", er, stringOutput)
 		}
 	}
-
 }

integration/plain_yaml_json_test.go

@@ -8,7 +8,6 @@ import (
 )
 
 func TestEnvsubstIntegration_NoSubst_MixedManifests_MixedFileFormats(t *testing.T) {
-
 	if os.Getenv(integrationTestEnv) != integrationTestFlag {
 		t.Log("integration test was skipped due to configuration")
 		return
@@ -49,5 +48,4 @@ func TestEnvsubstIntegration_NoSubst_MixedManifests_MixedFileFormats(t *testing.
 			t.Errorf("Expected substituted output to contain '%s', got %s", er, stringOutput)
 		}
 	}
-
 }

integration/subst_combined_test.go

@@ -8,7 +8,6 @@ import (
 )
 
 func TestEnvsubstIntegration_SubstMixedManifestsCombined(t *testing.T) {
-
 	if os.Getenv(integrationTestEnv) != integrationTestFlag {
 		t.Log("integration test was skipped due to configuration")
 		return
@@ -63,5 +62,4 @@ func TestEnvsubstIntegration_SubstMixedManifestsCombined(t *testing.T) {
 			t.Errorf("Expected substituted output to contain '%s', got %s", er, stringOutput)
 		}
 	}
-
 }