diff --git a/.github/workflows/lint.yaml b/.github/workflows/lint.yaml new file mode 100644 index 00000000..500ef349 --- /dev/null +++ b/.github/workflows/lint.yaml @@ -0,0 +1,31 @@ +--- +name: Lint + +on: + push: + branches: [ master ] + paths-ignore: [ '**.md' ] + pull_request: + branches: [ master ] + paths-ignore: [ '**.md' ] + +env: + GO_VERSION: 1.19 + +jobs: + lint: + name: Lint + runs-on: ubuntu-latest + timeout-minutes: 10 + steps: + - uses: actions/setup-go@v3 + with: + go-version: '1.19' + + - name: Checkout code + uses: actions/checkout@v3 + + - name: Golangci lint + uses: golangci/golangci-lint-action@v3 + with: + version: v1.51.0 diff --git a/.golangci.yaml b/.golangci.yaml new file mode 100644 index 00000000..ed5ebd34 --- /dev/null +++ b/.golangci.yaml @@ -0,0 +1,360 @@ +# This file contains all available configuration options +# with their default values. + +# options for analysis running +run: + # default concurrency is a available CPU number + # concurrency: 4 + + # timeout for analysis, e.g. 30s, 5m, default is 1m + timeout: 30m + + # exit code when at least one issue was found, default is 1 + issues-exit-code: 1 + + # include test files or not, default is true + tests: true + + # list of build tags, all linters use it. Default is empty list. + # build-tags: + # - mytag + + # which dirs to skip: issues from them won't be reported; + # can use regexp here: generated.*, regexp is applied on full path; + # default value is empty list, but default dirs are skipped independently + # from this option's value (see skip-dirs-use-default). + # skip-dirs: + # - src/external_libs + # - autogenerated_by_my_lib + + # default is true. Enables skipping of directories: + # vendor$, third_party$, testdata$, examples$, Godeps$, builtin$ + skip-dirs-use-default: true + + # which files to skip: they will be analyzed, but issues from them + # won't be reported. Default value is empty list, but there is + # no need to include all autogenerated files, we confidently recognize + # autogenerated files. If it's not please let us know. + # skip-files: + # - ".*\\.my\\.go$" + # - lib/bad.go + + # by default isn't set. If set we pass it to "go list -mod={option}". From "go help modules": + # If invoked with -mod=readonly, the go command is disallowed from the implicit + # automatic updating of go.mod described above. Instead, it fails when any changes + # to go.mod are needed. This setting is most useful to check that go.mod does + # not need updates, such as in a continuous integration and testing system. + # If invoked with -mod=vendor, the go command assumes that the vendor + # directory holds the correct copies of dependencies and ignores + # the dependency descriptions in go.mod. + # modules-download-mode: readonly|release|vendor + +# output configuration options +output: + # colored-line-number|line-number|json|tab|checkstyle|code-climate, default is "colored-line-number" + format: line-number + + # print lines of code with issue, default is true + print-issued-lines: true + + # print linter name in the end of issue text, default is true + print-linter-name: true + +# all available settings of specific linters +linters-settings: + gci: + sections: + - standard + - default + - prefix(github.com/databus23/helm-diff/v3) + + errcheck: + # report about not checking of errors in type assetions: `a := b.(MyStruct)`; + # default is false: such cases aren't reported by default. + check-type-assertions: false + + # report about assignment of errors to blank identifier: `num, _ := strconv.Atoi(numStr)`; + # default is false: such cases aren't reported by default. + check-blank: false + + # [deprecated] comma-separated list of pairs of the form pkg:regex + # the regex is used to ignore names within pkg. (default "fmt:.*"). + # see https://github.com/kisielk/errcheck#the-deprecated-method for details + # ignore: fmt:.* + + # path to a file containing a list of functions to exclude from checking + # see https://github.com/kisielk/errcheck#excluding-functions for details + # exclude: /path/to/file.txt + + # Disable error checking, as errorcheck detects more errors and is more configurable. + gosec: + exclude: + - "G104" + + govet: + # report about shadowed variables + check-shadowing: false + + # settings per analyzer + settings: + printf: # analyzer name, run `go tool vet help` to see all analyzers + funcs: # run `go tool vet help printf` to see available settings for `printf` analyzer + - (github.com/golangci/golangci-lint/pkg/logutils.Log).Infof + - (github.com/golangci/golangci-lint/pkg/logutils.Log).Warnf + - (github.com/golangci/golangci-lint/pkg/logutils.Log).Errorf + - (github.com/golangci/golangci-lint/pkg/logutils.Log).Fatalf + + # enable or disable analyzers by name + # enable: + # - atomicalign + # enable-all: false + # disable: + # - shadow + # disable-all: false + golint: + # minimal confidence for issues, default is 0.8 + min-confidence: 0.8 + gofmt: + # simplify code: gofmt with `-s` option, true by default + simplify: true + goimports: + # put imports beginning with prefix after 3rd-party packages; + # it's a comma-separated list of prefixes + # local-prefixes: github.com/org/project + gocyclo: + # minimal code complexity to report, 30 by default (but we recommend 10-20) + min-complexity: 30 + gocognit: + # minimal code complexity to report, 30 by default (but we recommend 10-20) + min-complexity: 100 + maligned: + # print struct with more effective memory layout or not, false by default + suggest-new: true + dupl: + # tokens count to trigger issue, 150 by default + threshold: 100 + goconst: + # minimal length of string constant, 3 by default + min-len: 3 + # minimal occurrences count to trigger, 3 by default + min-occurrences: 8 + # depguard: + # list-type: blacklist + # include-go-root: false + # packages: + # - github.com/sirupsen/logrus + # packages-with-error-messages: + # # specify an error message to output when a blacklisted package is used + # github.com/sirupsen/logrus: "logging is allowed only by logutils.Log" + misspell: + # Correct spellings using locale preferences for US or UK. + # Default is to use a neutral variety of English. + # Setting locale to US will correct the British spelling of 'colour' to 'color'. + locale: US + ignore-words: + - GitLab + lll: + # max line length, lines longer will be reported. Default is 120. + # '\t' is counted as 1 character by default, and can be changed with the tab-width option + line-length: 120 + # tab width in spaces. Default to 1. + tab-width: 1 + unused: + # treat code as a program (not a library) and report unused exported identifiers; default is false. + # XXX: if you enable this setting, unused will report a lot of false-positives in text editors: + # if it's called for subdir of a project it can't find funcs usages. All text editor integrations + # with golangci-lint call it on a directory with the changed file. + check-exported: false + unparam: + # Inspect exported functions, default is false. Set to true if no external program/library imports your code. + # XXX: if you enable this setting, unparam will report a lot of false-positives in text editors: + # if it's called for subdir of a project it can't find external interfaces. All text editor integrations + # with golangci-lint call it on a directory with the changed file. + check-exported: false + nakedret: + # make an issue if func has more lines of code than this setting and it has naked returns; default is 30 + max-func-lines: 30 + prealloc: + # XXX: we don't recommend using this linter before doing performance profiling. + # For most programs usage of prealloc will be a premature optimization. + + # Report preallocation suggestions only on simple loops that have no returns/breaks/continues/gotos in them. + # True by default. + simple: true + range-loops: true # Report preallocation suggestions on range loops, true by default + for-loops: false # Report preallocation suggestions on for loops, false by default + gocritic: + # Which checks should be enabled; can't be combined with 'disabled-checks'; + # See https://go-critic.github.io/overview#checks-overview + # To check which checks are enabled run `GL_DEBUG=gocritic golangci-lint run` + # By default list of stable checks is used. + # enabled-checks: + # - rangeValCopy + + # Which checks should be disabled; can't be combined with 'enabled-checks'; default is empty + # disabled-checks: + # - regexpMust + + # Enable multiple checks by tags, run `GL_DEBUG=gocritic golangci-lint run` to see all tags and checks. + # Empty list by default. See https://github.com/go-critic/go-critic#usage -> section "Tags". + # enabled-tags: + # - performance + + settings: # settings passed to gocritic + captLocal: # must be valid enabled check name + paramsOnly: true + # rangeValCopy: + # sizeThreshold: 32 + godox: + # report any comments starting with keywords, this is useful for TODO or FIXME comments that + # might be left in the code accidentally and should be resolved before merging + keywords: # default keywords are TODO, BUG, and FIXME, these can be overwritten by this setting + - TODO + - BUG + - FIXME + - NOTE + - OPTIMIZE # marks code that should be optimized before merging + - HACK # marks hack-arounds that should be removed before merging + dogsled: + # checks assignments with too many blank identifiers; default is 2 + max-blank-identifiers: 2 + + whitespace: + multi-if: false # Enforces newlines (or comments) after every multi-line if statement + multi-func: false # Enforces newlines (or comments) after every multi-line function signature + wsl: + # If true append is only allowed to be cuddled if appending value is + # matching variables, fields or types on line above. Default is true. + strict-append: true + # Allow calls and assignments to be cuddled as long as the lines have any + # matching variables, fields or types. Default is true. + allow-assign-and-call: true + # Allow multiline assignments to be cuddled. Default is true. + allow-multiline-assign: true + # Allow declarations (var) to be cuddled. + allow-cuddle-declarations: false + # Allow trailing comments in ending of blocks + allow-trailing-comment: false + # Force newlines in end of case at this limit (0 = never). + force-case-trailing-whitespace: 0 + revive: + ignore-generated-header: true + severity: warning + funlen: + # Checks the number of lines in a function. + # If lower than 0, disable the check. + # Default: 60 + lines: 280 + # Checks the number of statements in a function. + # If lower than 0, disable the check. + # Default: 40 + statements: 140 + +linters: + # please, do not use `enable-all`: it's deprecated and will be removed soon. + # inverted configuration with `enable-all` and `disable` is not scalable during updates of golangci-lint + disable-all: true + enable: + - bodyclose + - depguard + - usestdlibvars + - reassign + - errcheck + - funlen + - gocognit + - goconst + - gofmt + - goimports + - revive + - gosimple + - govet + - ineffassign + - misspell + - nakedret + - exportloopref + - staticcheck + - typecheck + - unconvert + - unparam + - unused + - whitespace + - gci + # - gocritic + # - godox + # - gosec + # - interfacer + # - stylecheck + # - dogsled + # - dupl + # don't enable: + # - deadcode + # - gochecknoglobals + # - gochecknoinits + # - gocyclo + # - lll + # - maligned + # - prealloc + # - varcheck + +issues: + # List of regexps of issue texts to exclude, empty list by default. + # But independently from this option we use default exclude patterns, + # it can be disabled by `exclude-use-default: false`. To list all + # excluded by default patterns execute `golangci-lint run --help` + # exclude: + # - abcdef + + # Excluding configuration per-path, per-linter, per-text and per-source + exclude-rules: + # Exclude some linters from running on tests files. + - path: _test\.go + linters: + - gocyclo + - errcheck + - dupl + - gosec + - funlen + + # Exclude known linters from partially hard-vendored code, + # which is impossible to exclude via "nolint" comments. + # - path: internal/hmac/ + # text: "weak cryptographic primitive" + # linters: + # - gosec + + # Exclude some staticcheck messages + # - linters: + # - staticcheck + # text: "SA9003:" + + # Exclude lll issues for long lines with go:generate + - linters: + - lll + source: "^//go:generate " + + # Independently from option `exclude` we use default exclude patterns, + # it can be disabled by this option. To list all + # excluded by default patterns execute `golangci-lint run --help`. + # Default value for this option is true. + exclude-use-default: false + + # 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 + + # Show only new issues: if there are unstaged changes or untracked files, + # only those changes are analyzed, else only changes in HEAD~ are analyzed. + # It's a super-useful option for integration of golangci-lint into existing + # large codebase. It's not practical to fix all existing issues at the moment + # of integration: much better don't allow issues in new code. + # Default is false. + new: false + + # Show only new issues created after git revision `REV` + # This should be passed as flag during individual CI jobs. + # new-from-rev: REV + + # Show only new issues created in git patch with set file path. + # new-from-patch: path/to/patch/file \ No newline at end of file diff --git a/cmd/helm3.go b/cmd/helm3.go index a608cbcd..3068b57c 100644 --- a/cmd/helm3.go +++ b/cmd/helm3.go @@ -40,7 +40,6 @@ func compatibleHelm3Version() error { return fmt.Errorf("helm diff upgrade requires at least helm version %s", minHelmVersion.String()) } return nil - } func getRelease(release, namespace string) ([]byte, error) { args := []string{"get", "manifest", release} @@ -117,7 +116,9 @@ func (d *diffCmd) template(isUpgrade bool) ([]byte, error) { if err != nil { return nil, err } - defer os.Remove(tmpfile.Name()) + defer func() { + _ = os.Remove(tmpfile.Name()) + }() if err := d.writeExistingValues(tmpfile); err != nil { return nil, err } @@ -140,10 +141,12 @@ func (d *diffCmd) template(isUpgrade bool) ([]byte, error) { if err != nil { return nil, err } - defer os.Remove(tmpfile.Name()) + defer func() { + _ = os.Remove(tmpfile.Name()) + }() if _, err := tmpfile.Write(bytes); err != nil { - tmpfile.Close() + _ = tmpfile.Close() return nil, err } @@ -220,7 +223,9 @@ func (d *diffCmd) template(isUpgrade bool) ([]byte, error) { func (d *diffCmd) writeExistingValues(f *os.File) error { cmd := exec.Command(os.Getenv("HELM_BIN"), "get", "values", d.release, "--all", "--output", "yaml") debugPrint("Executing %s", strings.Join(cmd.Args, " ")) - defer f.Close() + defer func() { + _ = f.Close() + }() cmd.Stdout = f return cmd.Run() } diff --git a/cmd/options.go b/cmd/options.go index 1c97c4b6..50846887 100644 --- a/cmd/options.go +++ b/cmd/options.go @@ -1,8 +1,9 @@ package cmd import ( - "github.com/databus23/helm-diff/v3/diff" "github.com/spf13/pflag" + + "github.com/databus23/helm-diff/v3/diff" ) // AddDiffOptions adds flags for the various consolidated options to the functions in the diff package diff --git a/cmd/root.go b/cmd/root.go index 231512a9..565436c6 100644 --- a/cmd/root.go +++ b/cmd/root.go @@ -32,7 +32,6 @@ The Helm Diff Plugin // New creates a new cobra client func New() *cobra.Command { - chartCommand := newChartCommand() cmd := &cobra.Command{ diff --git a/cmd/upgrade.go b/cmd/upgrade.go index c37f78cd..44b5a328 100644 --- a/cmd/upgrade.go +++ b/cmd/upgrade.go @@ -9,12 +9,12 @@ import ( "strconv" "strings" + jsonpatch "github.com/evanphx/json-patch" jsoniterator "github.com/json-iterator/go" + "github.com/pkg/errors" + "github.com/spf13/cobra" "helm.sh/helm/v3/pkg/action" "helm.sh/helm/v3/pkg/cli" - - jsonpatch "github.com/evanphx/json-patch" - "github.com/pkg/errors" "helm.sh/helm/v3/pkg/kube" apiextv1 "k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1" apierrors "k8s.io/apimachinery/pkg/api/errors" @@ -24,8 +24,6 @@ import ( "k8s.io/cli-runtime/pkg/resource" "sigs.k8s.io/yaml" - "github.com/spf13/cobra" - "github.com/databus23/helm-diff/v3/diff" "github.com/databus23/helm-diff/v3/manifest" ) @@ -204,11 +202,9 @@ func newChartCommand() *cobra.Command { AddDiffOptions(f, &diff.Options) return cmd - } func (d *diffCmd) runHelm3() error { - if err := compatibleHelm3Version(); err != nil { return err } diff --git a/diff/diff.go b/diff/diff.go index cda0f9b3..28d861dd 100644 --- a/diff/diff.go +++ b/diff/diff.go @@ -234,7 +234,6 @@ func getComment(s string) string { return "" } return s[:i+1] - } // Releases reindex the content based on the template names and pass it to Manifests @@ -267,7 +266,6 @@ func split(value string, stripTrailingCR bool) []string { func printDiffRecords(suppressedKinds []string, kind string, context int, diffs []difflib.DiffRecord, to io.Writer) { for _, ckind := range suppressedKinds { - if ckind == kind { str := fmt.Sprintf("+ Changes suppressed on sensitive content of type %s\n", kind) fmt.Fprint(to, ansi.Color(str, "yellow")) @@ -350,7 +348,6 @@ func calculateDistances(diffs []difflib.DiffRecord) map[int]int { // reIndexForRelease based on template names func reIndexForRelease(index map[string]*manifest.MappingResult) map[string]*manifest.MappingResult { - // sort the index to iterate map in the same order var keys []string for key := range index { @@ -364,7 +361,6 @@ func reIndexForRelease(index map[string]*manifest.MappingResult) map[string]*man newIndex := make(map[string]*manifest.MappingResult) for key := range keys { - str := strings.Replace(strings.Split(index[keys[key]].Content, "\n")[0], "# Source: ", "", 1) if _, ok := newIndex[str]; ok { diff --git a/diff/diff_test.go b/diff/diff_test.go index 8df93823..0474e9aa 100644 --- a/diff/diff_test.go +++ b/diff/diff_test.go @@ -48,7 +48,6 @@ var text3 = "" + "line10" func TestPrintDiffWithContext(t *testing.T) { - t.Run("context-disabled", func(t *testing.T) { assertDiff(t, text1, text2, -1, false, ""+ "- line1\n"+ @@ -154,7 +153,6 @@ func TestPrintDiffWithContext(t *testing.T) { " line9\n"+ " line10\n") }) - } func assertDiff(t *testing.T, before, after string, context int, stripTrailingCR bool, expected string) { diff --git a/diff/report.go b/diff/report.go index 2e624f21..48f1fa94 100644 --- a/diff/report.go +++ b/diff/report.go @@ -3,8 +3,6 @@ package diff import ( "errors" "fmt" - "github.com/gonvenience/ytbx" - "github.com/homeport/dyff/pkg/dyff" "io" "log" "os" @@ -14,6 +12,8 @@ import ( "text/template" "github.com/aryann/difflib" + "github.com/gonvenience/ytbx" + "github.com/homeport/dyff/pkg/dyff" "github.com/mgutz/ansi" ) @@ -76,9 +76,13 @@ func setupDyffReport(r *Report) { func printDyffReport(r *Report, to io.Writer) { currentFile, _ := os.CreateTemp("", "existing-values") - defer os.Remove(currentFile.Name()) + defer func() { + _ = os.Remove(currentFile.Name()) + }() newFile, _ := os.CreateTemp("", "new-values") - defer os.Remove(newFile.Name()) + defer func() { + _ = os.Remove(newFile.Name()) + }() for _, entry := range r.entries { _, _ = currentFile.WriteString("---\n") @@ -147,7 +151,6 @@ func printDiffReport(r *Report, to io.Writer) { fmt.Fprintf(to, ansi.Color("%s %s", "yellow")+"\n", entry.key, r.format.changestyles[entry.changeType].message) printDiffRecords(entry.suppressedKinds, entry.kind, entry.context, entry.diffs, to) } - } // setup report for simple output. @@ -262,7 +265,7 @@ func templateReportPrinter(t *template.Template) func(r *Report, to io.Writer) { } } - t.Execute(to, templateDataArray) + _ = t.Execute(to, templateDataArray) _, _ = to.Write([]byte("\n")) } } diff --git a/main.go b/main.go index 4d813ef3..e3393999 100644 --- a/main.go +++ b/main.go @@ -3,11 +3,12 @@ package main import ( "os" - "github.com/databus23/helm-diff/v3/cmd" _ "k8s.io/client-go/plugin/pkg/client/auth/azure" _ "k8s.io/client-go/plugin/pkg/client/auth/exec" _ "k8s.io/client-go/plugin/pkg/client/auth/gcp" _ "k8s.io/client-go/plugin/pkg/client/auth/oidc" + + "github.com/databus23/helm-diff/v3/cmd" ) func main() { diff --git a/manifest/parse_test.go b/manifest/parse_test.go index c5a7e319..1ae65f28 100644 --- a/manifest/parse_test.go +++ b/manifest/parse_test.go @@ -1,7 +1,7 @@ package manifest_test import ( - "io/ioutil" + "os" "sort" "testing" @@ -20,7 +20,7 @@ func foundObjects(result map[string]*MappingResult) []string { } func TestPod(t *testing.T) { - spec, err := ioutil.ReadFile("testdata/pod.yaml") + spec, err := os.ReadFile("testdata/pod.yaml") require.NoError(t, err) require.Equal(t, @@ -30,7 +30,7 @@ func TestPod(t *testing.T) { } func TestPodNamespace(t *testing.T) { - spec, err := ioutil.ReadFile("testdata/pod_namespace.yaml") + spec, err := os.ReadFile("testdata/pod_namespace.yaml") require.NoError(t, err) require.Equal(t, @@ -40,7 +40,7 @@ func TestPodNamespace(t *testing.T) { } func TestPodHook(t *testing.T) { - spec, err := ioutil.ReadFile("testdata/pod_hook.yaml") + spec, err := os.ReadFile("testdata/pod_hook.yaml") require.NoError(t, err) require.Equal(t, @@ -60,7 +60,7 @@ func TestPodHook(t *testing.T) { } func TestDeployV1(t *testing.T) { - spec, err := ioutil.ReadFile("testdata/deploy_v1.yaml") + spec, err := os.ReadFile("testdata/deploy_v1.yaml") require.NoError(t, err) require.Equal(t, @@ -70,7 +70,7 @@ func TestDeployV1(t *testing.T) { } func TestDeployV1Beta1(t *testing.T) { - spec, err := ioutil.ReadFile("testdata/deploy_v1beta1.yaml") + spec, err := os.ReadFile("testdata/deploy_v1beta1.yaml") require.NoError(t, err) require.Equal(t, @@ -80,7 +80,7 @@ func TestDeployV1Beta1(t *testing.T) { } func TestList(t *testing.T) { - spec, err := ioutil.ReadFile("testdata/list.yaml") + spec, err := os.ReadFile("testdata/list.yaml") require.NoError(t, err) require.Equal(t, @@ -93,7 +93,7 @@ func TestList(t *testing.T) { } func TestEmpty(t *testing.T) { - spec, err := ioutil.ReadFile("testdata/empty.yaml") + spec, err := os.ReadFile("testdata/empty.yaml") require.NoError(t, err) require.Equal(t, @@ -103,7 +103,7 @@ func TestEmpty(t *testing.T) { } func TestBaseNameAnnotation(t *testing.T) { - spec, err := ioutil.ReadFile("testdata/secret_immutable.yaml") + spec, err := os.ReadFile("testdata/secret_immutable.yaml") require.NoError(t, err) require.Equal(t,