From d7e0038ebb780f25cd17ce1927c5ba7f494f8b72 Mon Sep 17 00:00:00 2001 From: Victor Date: Tue, 3 Jun 2025 12:58:33 +0100 Subject: [PATCH] removed .golangci.yml version field and usetesting linter Removed usetesting as it's not a valid linter in golangci-lint, run Enabled by default linters: errcheck: errcheck is a program for checking for unchecked errors in Go code. These unchecked errors can be critical bugs in some cases [fast: false, auto-fix: false] gosimple (megacheck): Linter for Go source code that specializes in simplifying code [fast: false, auto-fix: false] govet (vet, vetshadow): Vet examines Go source code and reports suspicious constructs, such as Printf calls whose arguments do not align with the format string [fast: false, auto-fix: false] ineffassign: Detects when assignments to existing variables are not used [fast: true, auto-fix: false] staticcheck (megacheck): It's a set of rules from staticcheck. It's not the same thing as the staticcheck binary. The author of staticcheck doesn't support or approve the use of staticcheck as a library inside golangci-lint. [fast: false, auto-fix: false] unused (megacheck): Checks Go code for unused constants, variables, functions and types [fast: false, auto-fix: false] Disabled by default linters: asasalint: check for pass []any as any in variadic func(...any) [fast: false, auto-fix: false] asciicheck: Simple linter to check that your code does not contain non-ASCII identifiers [fast: true, auto-fix: false] bidichk: Checks for dangerous unicode character sequences [fast: true, auto-fix: false] bodyclose: checks whether HTTP response body is closed successfully [fast: false, auto-fix: false] containedctx: containedctx is a linter that detects struct contained context.Context field [fast: false, auto-fix: false] contextcheck: check whether the function uses a non-inherited context [fast: false, auto-fix: false] cyclop: checks function and package cyclomatic complexity [fast: false, auto-fix: false] deadcode [deprecated]: Finds unused code [fast: false, auto-fix: false] decorder: check declaration order and count of types, constants, variables and functions [fast: true, auto-fix: false] depguard: Go linter that checks if package imports are in a list of acceptable packages [fast: true, auto-fix: false] dogsled: Checks assignments with too many blank identifiers (e.g. x, _, _, _, := f()) [fast: true, auto-fix: false] dupl: Tool for code clone detection [fast: true, auto-fix: false] dupword: checks for duplicate words in the source code [fast: true, auto-fix: true] durationcheck: check for two durations multiplied together [fast: false, auto-fix: false] errchkjson: Checks types passed to the json encoding functions. Reports unsupported types and optionally reports occasions, where the check for the returned error can be omitted. [fast: false, auto-fix: false] errname: Checks that sentinel errors are prefixed with the `Err` and error types are suffixed with the `Error`. [fast: false, auto-fix: false] errorlint: errorlint is a linter for that can be used to find code that will cause problems with the error wrapping scheme introduced in Go 1.13. [fast: false, auto-fix: false] execinquery: execinquery is a linter about query string checker in Query function which reads your Go src files and warning it finds [fast: false, auto-fix: false] exhaustive: check exhaustiveness of enum switch statements [fast: false, auto-fix: false] exhaustivestruct [deprecated]: Checks if all struct's fields are initialized [fast: false, auto-fix: false] exhaustruct: Checks if all structure fields are initialized [fast: false, auto-fix: false] exportloopref: checks for pointers to enclosing loop variables [fast: false, auto-fix: false] forbidigo: Forbids identifiers [fast: false, auto-fix: false] forcetypeassert: finds forced type assertions [fast: true, auto-fix: false] funlen: Tool for detection of long functions [fast: true, auto-fix: false] gci: Gci controls Go package import order and makes it always deterministic. [fast: true, auto-fix: false] ginkgolinter: enforces standards of using ginkgo and gomega [fast: false, auto-fix: false] gocheckcompilerdirectives: Checks that go compiler directive comments (//go:) are valid. [fast: true, auto-fix: false] gochecknoglobals: check that no global variables exist [fast: false, auto-fix: false] gochecknoinits: Checks that no init functions are present in Go code [fast: true, auto-fix: false] gochecksumtype: Run exhaustiveness checks on Go "sum types" [fast: false, auto-fix: false] gocognit: Computes and checks the cognitive complexity of functions [fast: true, auto-fix: false] goconst: Finds repeated strings that could be replaced by a constant [fast: true, auto-fix: false] gocritic: Provides diagnostics that check for bugs, performance and style issues. [fast: false, auto-fix: false] gocyclo: Computes and checks the cyclomatic complexity of functions [fast: true, auto-fix: false] godot: Check if comments end in a period [fast: true, auto-fix: true] godox: Tool for detection of FIXME, TODO and other comment keywords [fast: true, auto-fix: false] goerr113: Go linter to check the errors handling expressions [fast: false, auto-fix: false] gofmt: Gofmt checks whether code was gofmt-ed. By default this tool runs with -s option to check for code simplification [fast: true, auto-fix: true] gofumpt: Gofumpt checks whether code was gofumpt-ed. [fast: true, auto-fix: true] goheader: Checks is file header matches to pattern [fast: true, auto-fix: false] goimports: Check import statements are formatted according to the 'goimport' command. Reformat imports in autofix mode. [fast: true, auto-fix: true] golint [deprecated]: Golint differs from gofmt. Gofmt reformats Go source code, whereas golint prints out style mistakes [fast: false, auto-fix: false] gomnd: An analyzer to detect magic numbers. [fast: true, auto-fix: false] gomoddirectives: Manage the use of 'replace', 'retract', and 'excludes' directives in go.mod. [fast: true, auto-fix: false] gomodguard: Allow and block list linter for direct Go module dependencies. This is different from depguard where there are different block types for example version constraints and module recommendations. [fast: true, auto-fix: false] goprintffuncname: Checks that printf-like functions are named with `f` at the end [fast: true, auto-fix: false] gosec (gas): Inspects source code for security problems [fast: false, auto-fix: false] gosmopolitan: Report certain i18n/l10n anti-patterns in your Go codebase [fast: false, auto-fix: false] grouper: An analyzer to analyze expression groups. [fast: true, auto-fix: false] ifshort [deprecated]: Checks that your code uses short syntax for if-statements whenever possible [fast: true, auto-fix: false] importas: Enforces consistent import aliases [fast: false, auto-fix: false] inamedparam: reports interfaces with unnamed method parameters [fast: true, auto-fix: false] interfacebloat: A linter that checks the number of methods inside an interface. [fast: true, auto-fix: false] interfacer [deprecated]: Linter that suggests narrower interface types [fast: false, auto-fix: false] ireturn: Accept Interfaces, Return Concrete Types [fast: false, auto-fix: false] lll: Reports long lines [fast: true, auto-fix: false] loggercheck (logrlint): Checks key value pairs for common logger libraries (kitlog,klog,logr,zap). [fast: false, auto-fix: false] maintidx: maintidx measures the maintainability index of each function. [fast: true, auto-fix: false] makezero: Finds slice declarations with non-zero initial length [fast: false, auto-fix: false] maligned [deprecated]: Tool to detect Go structs that would take less memory if their fields were sorted [fast: false, auto-fix: false] mirror: reports wrong mirror patterns of bytes/strings usage [fast: false, auto-fix: false] misspell: Finds commonly misspelled English words in comments [fast: true, auto-fix: true] musttag: enforce field tags in (un)marshaled structs [fast: false, auto-fix: false] nakedret: Finds naked returns in functions greater than a specified function length [fast: true, auto-fix: false] nestif: Reports deeply nested if statements [fast: true, auto-fix: false] nilerr: Finds the code that returns nil even if it checks that the error is not nil. [fast: false, auto-fix: false] nilnil: Checks that there is no simultaneous return of `nil` error and an invalid value. [fast: false, auto-fix: false] nlreturn: nlreturn checks for a new line before return and branch statements to increase code clarity [fast: true, auto-fix: false] noctx: noctx finds sending http request without context.Context [fast: false, auto-fix: false] nolintlint: Reports ill-formed or insufficient nolint directives [fast: true, auto-fix: false] nonamedreturns: Reports all named returns [fast: false, auto-fix: false] nosnakecase [deprecated]: nosnakecase is a linter that detects snake case of variable naming and function name. [fast: true, auto-fix: false] nosprintfhostport: Checks for misuse of Sprintf to construct a host with port in a URL. [fast: true, auto-fix: false] paralleltest: paralleltest detects missing usage of t.Parallel() method in your Go test [fast: false, auto-fix: false] perfsprint: Checks that fmt.Sprintf can be replaced with a faster alternative. [fast: false, auto-fix: false] prealloc: Finds slice declarations that could potentially be pre-allocated [fast: true, auto-fix: false] predeclared: find code that shadows one of Go's predeclared identifiers [fast: true, auto-fix: false] promlinter: Check Prometheus metrics naming via promlint [fast: true, auto-fix: false] protogetter: Reports direct reads from proto message fields when getters should be used [fast: false, auto-fix: true] reassign: Checks that package variables are not reassigned [fast: false, auto-fix: false] revive: Fast, configurable, extensible, flexible, and beautiful linter for Go. Drop-in replacement of golint. [fast: false, auto-fix: false] rowserrcheck: checks whether Err of rows is checked successfully [fast: false, auto-fix: false] scopelint [deprecated]: Scopelint checks for unpinned variables in go programs [fast: true, auto-fix: false] sloglint: ensure consistent code style when using log/slog [fast: false, auto-fix: false] sqlclosecheck: Checks that sql.Rows and sql.Stmt are closed. [fast: false, auto-fix: false] structcheck [deprecated]: Finds unused struct fields [fast: false, auto-fix: false] stylecheck: Stylecheck is a replacement for golint [fast: false, auto-fix: false] tagalign: check that struct tags are well aligned [fast: true, auto-fix: true] tagliatelle: Checks the struct tags. [fast: true, auto-fix: false] tenv: tenv is analyzer that detects using os.Setenv instead of t.Setenv since Go1.17 [fast: false, auto-fix: false] testableexamples: linter checks if examples are testable (have an expected output) [fast: true, auto-fix: false] testifylint: Checks usage of github.com/stretchr/testify. [fast: false, auto-fix: false] testpackage: linter that makes you use a separate _test package [fast: true, auto-fix: false] thelper: thelper detects Go test helpers without t.Helper() call and checks the consistency of test helpers [fast: false, auto-fix: false] tparallel: tparallel detects inappropriate usage of t.Parallel() method in your Go test codes [fast: false, auto-fix: false] unconvert: Remove unnecessary type conversions [fast: false, auto-fix: false] unparam: Reports unused function parameters [fast: false, auto-fix: false] usestdlibvars: A linter that detect the possibility to use variables/constants from the Go standard library. [fast: true, auto-fix: false] varcheck [deprecated]: Finds unused global variables and constants [fast: false, auto-fix: false] varnamelen: checks that the length of a variable's name matches its scope [fast: false, auto-fix: false] wastedassign: wastedassign finds wasted assignment statements. [fast: false, auto-fix: false] whitespace: Tool for detection of leading and trailing whitespace [fast: true, auto-fix: true] wrapcheck: Checks that errors returned from external packages are wrapped [fast: false, auto-fix: false] wsl: Whitespace Linter - Forces you to use empty lines! [fast: true, auto-fix: false] zerologlint: Detects the wrong usage of `zerolog` that a user forgets to dispatch with `Send` or `Msg`. [fast: false, auto-fix: false] Linters presets: bugs: asasalint, asciicheck, bidichk, bodyclose, contextcheck, durationcheck, errcheck, errchkjson, errorlint, exhaustive, exportloopref, gocheckcompilerdirectives, gochecksumtype, gosec, gosmopolitan, govet, loggercheck, makezero, musttag, nilerr, noctx, protogetter, reassign, rowserrcheck, sqlclosecheck, staticcheck, testifylint, zerologlint comment: dupword, godot, godox, misspell complexity: cyclop, funlen, gocognit, gocyclo, maintidx, nestif error: errcheck, errorlint, goerr113, wrapcheck format: decorder, gci, gofmt, gofumpt, goimports, sloglint, tagalign import: depguard, gci, goimports, gomodguard metalinter: gocritic, govet, revive, staticcheck module: depguard, gomoddirectives, gomodguard performance: bodyclose, noctx, perfsprint, prealloc sql: execinquery, rowserrcheck, sqlclosecheck style: asciicheck, containedctx, decorder, depguard, dogsled, dupl, errname, exhaustruct, forbidigo, forcetypeassert, ginkgolinter, gochecknoglobals, gochecknoinits, goconst, gocritic, godot, godox, goerr113, goheader, gomnd, gomoddirectives, gomodguard, goprintffuncname, gosimple, grouper, importas, inamedparam, interfacebloat, ireturn, lll, loggercheck, makezero, mirror, misspell, musttag, nakedret, nilnil, nlreturn, nolintlint, nonamedreturns, nosprintfhostport, paralleltest, predeclared, promlinter, revive, sloglint, stylecheck, tagalign, tagliatelle, tenv, testpackage, thelper, tparallel, unconvert, usestdlibvars, varnamelen, wastedassign, whitespace, wrapcheck, wsl test: exhaustruct, paralleltest, testableexamples, testifylint, testpackage, tparallel unused: ineffassign, unparam, unused to check Removed version field from .golangci.yml to fix config parsing error. see review #r2125688313. Signed-off-by: Victor --- .golangci.yml | 107 +++++++++----------------------------------------- Makefile | 40 ++++++++++++++++++- 2 files changed, 56 insertions(+), 91 deletions(-) diff --git a/.golangci.yml b/.golangci.yml index f36b7edb8..62139929a 100644 --- a/.golangci.yml +++ b/.golangci.yml @@ -44,96 +44,25 @@ linters: warn-unused: true -linters-settings: - depguard: - rules: - Main: - deny: - - pkg: github.com/hashicorp/go-multierror - desc: "use errors instead" - - pkg: github.com/pkg/errors - desc: "use errors instead" - - dupl: - threshold: 400 - - gomodguard: - blocked: - modules: - - github.com/evanphx/json-patch: - recommendations: - - github.com/evanphx/json-patch/v5 - -run: - timeout: 10m - -version: "2"formatters: - enable: - - gofmt - - goimports - - exclusions: - generated: lax - settings: - gofmt: - simplify: true - - goimports: - local-prefixes: - - helm.sh/helm/v4 - -linters: - default: none - - enable: - - depguard - - dupl - - gomodguard - - govet - - ineffassign - - misspell - - nakedret - - revive - - staticcheck - - thelper - - unused - - usestdlibvars - - exclusions: - generated: lax - - presets: - - comments - - common-false-positives - - legacy - - std-error-handling - - rules: [] - - warn-unused: true - -linters-settings: - depguard: - rules: - Main: - deny: - - pkg: github.com/hashicorp/go-multierror - desc: "use errors instead" - - pkg: github.com/pkg/errors - desc: "use errors instead" - - dupl: - threshold: 400 - - gomodguard: - blocked: - modules: - - github.com/evanphx/json-patch: - recommendations: - - github.com/evanphx/json-patch/v5 + depguard: + rules: + Main: + deny: + - pkg: github.com/hashicorp/go-multierror + desc: "use errors instead" + - pkg: github.com/pkg/errors + desc: "use errors instead" + + dupl: + threshold: 400 + + gomodguard: + blocked: + modules: + - github.com/evanphx/json-patch: + recommendations: + - github.com/evanphx/json-patch/v5 run: timeout: 10m - -version: "2" \ No newline at end of file diff --git a/Makefile b/Makefile index cc27c2b45..899cf01dc 100644 --- a/Makefile +++ b/Makefile @@ -15,6 +15,7 @@ GOLANGCI_LINT = $(GOBIN)/golangci-lint ARCH = $(shell go env GOARCH) ACCEPTANCE_DIR:=../acceptance-testing +# To specify the subset of acceptance tests to run. '.' means all tests ACCEPTANCE_RUN_TESTS=. # go option @@ -41,7 +42,7 @@ ifdef VERSION BINARY_VERSION = $(VERSION) endif BINARY_VERSION ?= ${GIT_TAG} - +# Only set Version if building a tag or VERSION is set ifneq ($(BINARY_VERSION),) LDFLAGS += -X helm.sh/helm/v4/internal/version.version=${BINARY_VERSION} endif @@ -55,7 +56,7 @@ LDFLAGS += -X helm.sh/helm/v4/internal/version.metadata=${VERSION_METADATA} LDFLAGS += -X helm.sh/helm/v4/internal/version.gitCommit=${GIT_COMMIT} LDFLAGS += -X helm.sh/helm/v4/internal/version.gitTreeState=${GIT_DIRTY} LDFLAGS += $(EXT_LDFLAGS) - +# Define constants based on the client-go version K8S_MODULES_VER=$(subst ., ,$(subst v,,$(shell go list -f '{{.Version}}' -m k8s.io/client-go))) K8S_MODULES_MAJOR_VER=$(shell echo $$(($(firstword $(K8S_MODULES_VER)) + 1))) K8S_MODULES_MINOR_VER=$(word 2,$(K8S_MODULES_VER)) @@ -68,16 +69,25 @@ LDFLAGS += -X helm.sh/helm/v4/pkg/chart/v2/util.k8sVersionMinor=$(K8S_MODULES_MI .PHONY: all all: build +# ------------------------------------------------------------------------------ +# build + .PHONY: build build: $(BINDIR)/$(BINNAME) $(BINDIR)/$(BINNAME): $(SRC) CGO_ENABLED=$(CGO_ENABLED) go build $(GOFLAGS) -trimpath -tags '$(TAGS)' -ldflags '$(LDFLAGS)' -o '$(BINDIR)'/$(BINNAME) ./cmd/helm +# ------------------------------------------------------------------------------ +# install + .PHONY: install install: build @install "$(BINDIR)/$(BINNAME)" "$(INSTALL_PATH)/$(BINNAME)" +# ------------------------------------------------------------------------------ +# test + .PHONY: test test: build ifeq ($(ARCH),s390x) @@ -95,6 +105,11 @@ test-unit: go test $(GOFLAGS) -run $(TESTS) $(PKG) $(TESTFLAGS) @echo @echo "==> Running unit test(s) with ldflags <==" + # Test to check the deprecation warnings on Kubernetes templates created by `helm create` against the current Kubernetes +# version. Note: The version details are set in var LDFLAGS. To avoid the ldflags impact on other unit tests that are +# based on older versions, this is run separately. When run without the ldflags in the unit test (above) or coverage +# test, it still passes with a false-positive result as the resources shouldn’t be deprecated in the older Kubernetes +# version if it only starts failing with the latest. go test $(GOFLAGS) -run ^TestHelmCreateChart_CheckDeprecatedWarnings$$ ./pkg/lint/ $(TESTFLAGS) -ldflags '$(LDFLAGS)' .PHONY: test-coverage @@ -135,12 +150,20 @@ coverage: format: $(GOIMPORTS) go list -f '{{.Dir}}' ./... | xargs $(GOIMPORTS) -w -local helm.sh/helm +# Generate golden files used in unit tests .PHONY: gen-test-golden gen-test-golden: gen-test-golden: PKG = ./pkg/cmd ./pkg/action gen-test-golden: TESTFLAGS = -update gen-test-golden: test-unit +# ------------------------------------------------------------------------------ +# dependencies + +# If go install is run from inside the project directory it will add the +# dependencies to the go.mod file. To avoid that we change to a directory +# without a go.mod file when downloading the following dependencies + $(GOX): (cd /; go install github.com/mitchellh/gox@v1.0.2-0.20220701044238-9f712387e2d2) @@ -150,6 +173,9 @@ $(GOIMPORTS): $(GOLANGCI_LINT): (cd /; go install github.com/golangci/golangci-lint/cmd/golangci-lint@v1.55.2) +# ------------------------------------------------------------------------------ +# release + .PHONY: build-cross build-cross: LDFLAGS += -extldflags "-static" build-cross: $(GOX) @@ -179,6 +205,14 @@ sign: gpg --armor --detach-sign $${f} ; \ done +# The contents of the .sha256sum file are compatible with tools like +# shasum. For example, using the following command will verify +# the file helm-3.1.0-rc.1-darwin-amd64.tar.gz: +# shasum -a 256 -c helm-3.1.0-rc.1-darwin-amd64.tar.gz.sha256sum +# The .sha256 files hold only the hash and are not compatible with +# verification tools like shasum or sha256sum. This method and file can be +# removed in Helm v4. + .PHONY: checksum checksum: for f in $$(ls _dist/*.{gz,zip} 2>/dev/null) ; do \ @@ -186,6 +220,8 @@ checksum: shasum -a 256 "$${f}" | awk '{print $$1}' > "$${f}.sha256" ; \ done +# ------------------------------------------------------------------------------ + .PHONY: clean clean: @rm -rf '$(BINDIR)' ./_dist