From f5e19a01387aae71cdd2b95395554e950d9ce211 Mon Sep 17 00:00:00 2001 From: Mario Trangoni Date: Fri, 3 Nov 2023 13:08:36 +0100 Subject: [PATCH 1/3] golangci-lint: Update depguard configuration for golangci >= 1.53 Signed-off-by: Mario Trangoni --- .github/workflows/lint.yaml | 4 ++-- .golangci.yaml | 48 ++++++++++++++++++++++++++++++------- 2 files changed, 41 insertions(+), 11 deletions(-) diff --git a/.github/workflows/lint.yaml b/.github/workflows/lint.yaml index 500ef349..184744f7 100644 --- a/.github/workflows/lint.yaml +++ b/.github/workflows/lint.yaml @@ -23,9 +23,9 @@ jobs: go-version: '1.19' - name: Checkout code - uses: actions/checkout@v3 + uses: actions/checkout@v4 - name: Golangci lint uses: golangci/golangci-lint-action@v3 with: - version: v1.51.0 + version: v1.55.1 diff --git a/.golangci.yaml b/.golangci.yaml index ed5ebd34..24c7c19f 100644 --- a/.golangci.yaml +++ b/.golangci.yaml @@ -138,14 +138,44 @@ linters-settings: 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" + depguard: + # Rules to apply. + # Default: Only allow $gostd in all files. + rules: + # Name of a rule. + main: + # List of file globs that will match this list of settings to compare against. + # Default: $all + files: + - "!**/*_a _file.go" + # List of allowed packages. + allow: + - $gostd + - github.com/Masterminds/semver + - github.com/aryann/difflib + - github.com/databus23/helm-diff/v3 + - github.com/evanphx/json-patch + - github.com/gonvenience/ytbx + - github.com/google/go-cmp/cmp + - github.com/homeport/dyff/pkg/dyff + - github.com/json-iterator/go + - github.com/mgutz/ansi + - github.com/spf13/cobra + - github.com/spf13/pflag + - github.com/stretchr/testify/require + - helm.sh/helm/v3 + - k8s.io/api/core/v1 + - k8s.io/apiextensions-apiserver + - k8s.io/apimachinery + - k8s.io/cli-runtime + - k8s.io/client-go + - sigs.k8s.io/yaml + # Packages that are not allowed where the value is a suggestion. + deny: + - pkg: "github.com/sirupsen/logrus" + desc: not allowed + - pkg: "github.com/pkg/errors" + desc: Should be replaced by standard lib errors package misspell: # Correct spellings using locale preferences for US or UK. # Default is to use a neutral variety of English. @@ -357,4 +387,4 @@ issues: # 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 + # new-from-patch: path/to/patch/file From 9fc0b197eb11c321d5030e5c248b55c5edbdcb0b Mon Sep 17 00:00:00 2001 From: Mario Trangoni Date: Fri, 3 Nov 2023 13:09:07 +0100 Subject: [PATCH 2/3] depguard: Replace deprecated github.com/pkg/errors with stdlib error package. See, cmd/upgrade.go:14:2: import 'github.com/pkg/errors' is not allowed from list 'main': Should be replaced by standard lib errors package (depguard) "github.com/pkg/errors" ^ Signed-off-by: Mario Trangoni --- cmd/upgrade.go | 34 +++++++++++++++++----------------- 1 file changed, 17 insertions(+), 17 deletions(-) diff --git a/cmd/upgrade.go b/cmd/upgrade.go index 5a975f00..f0b116a3 100644 --- a/cmd/upgrade.go +++ b/cmd/upgrade.go @@ -3,6 +3,7 @@ package cmd import ( "bytes" "encoding/json" + "errors" "fmt" "log" "os" @@ -11,7 +12,6 @@ import ( 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" @@ -249,15 +249,15 @@ func (d *diffCmd) runHelm3() error { } original, err := actionConfig.KubeClient.Build(bytes.NewBuffer(releaseManifest), false) if err != nil { - return errors.Wrap(err, "unable to build kubernetes objects from original release manifest") + return fmt.Errorf("unable to build kubernetes objects from original release manifest: %w", err) } target, err := actionConfig.KubeClient.Build(bytes.NewBuffer(installManifest), false) if err != nil { - return errors.Wrap(err, "unable to build kubernetes objects from new release manifest") + return fmt.Errorf("unable to build kubernetes objects from new release manifest: %w", err) } releaseManifest, installManifest, err = genManifest(original, target) if err != nil { - return errors.Wrap(err, "unable to generate manifests") + return fmt.Errorf("unable to generate manifests: %w", err) } } @@ -325,7 +325,7 @@ func genManifest(original, target kube.ResourceList) ([]byte, []byte, error) { toBeUpdated, err := existingResourceConflict(toBeCreated) if err != nil { - return nil, nil, errors.Wrap(err, "rendered manifests contain a resource that already exists. Unable to continue with update") + return nil, nil, fmt.Errorf("rendered manifests contain a resource that already exists. Unable to continue with update: %w", err) } _ = toBeUpdated.Visit(func(r *resource.Info, err error) error { @@ -347,7 +347,7 @@ func genManifest(original, target kube.ResourceList) ([]byte, []byte, error) { currentObj, err := helper.Get(info.Namespace, info.Name) if err != nil { if !apierrors.IsNotFound(err) { - return errors.Wrap(err, "could not get information about the resource") + return fmt.Errorf("could not get information about the resource: %w", err) } // to be created out, _ := yaml.Marshal(info.Object) @@ -359,11 +359,11 @@ func genManifest(original, target kube.ResourceList) ([]byte, []byte, error) { out, _ := jsoniterator.ConfigCompatibleWithStandardLibrary.Marshal(currentObj) pruneObj, err := deleteStatusAndTidyMetadata(out) if err != nil { - return errors.Wrapf(err, "prune current obj %q with kind %s", info.Name, kind) + return fmt.Errorf("prune current obj %q with kind %s: %w", info.Name, kind, err) } pruneOut, err := yaml.Marshal(pruneObj) if err != nil { - return errors.Wrapf(err, "prune current out %q with kind %s", info.Name, kind) + return fmt.Errorf("prune current out %q with kind %s: %w", info.Name, kind, err) } releaseManifest = append(releaseManifest, yamlSeperator...) releaseManifest = append(releaseManifest, pruneOut...) @@ -381,16 +381,16 @@ func genManifest(original, target kube.ResourceList) ([]byte, []byte, error) { helper.ServerDryRun = true targetObj, err := helper.Patch(info.Namespace, info.Name, patchType, patch, nil) if err != nil { - return errors.Wrapf(err, "cannot patch %q with kind %s", info.Name, kind) + return fmt.Errorf("cannot patch %q with kind %s: %w", info.Name, kind, err) } out, _ = jsoniterator.ConfigCompatibleWithStandardLibrary.Marshal(targetObj) pruneObj, err = deleteStatusAndTidyMetadata(out) if err != nil { - return errors.Wrapf(err, "prune current obj %q with kind %s", info.Name, kind) + return fmt.Errorf("prune current obj %q with kind %s: %w", info.Name, kind, err) } pruneOut, err = yaml.Marshal(pruneObj) if err != nil { - return errors.Wrapf(err, "prune current out %q with kind %s", info.Name, kind) + return fmt.Errorf("prune current out %q with kind %s: %w", info.Name, kind, err) } installManifest = append(installManifest, yamlSeperator...) installManifest = append(installManifest, pruneOut...) @@ -403,17 +403,17 @@ func genManifest(original, target kube.ResourceList) ([]byte, []byte, error) { func createPatch(originalObj, currentObj runtime.Object, target *resource.Info) ([]byte, types.PatchType, error) { oldData, err := json.Marshal(originalObj) if err != nil { - return nil, types.StrategicMergePatchType, errors.Wrap(err, "serializing current configuration") + return nil, types.StrategicMergePatchType, fmt.Errorf("serializing current configuration: %w", err) } newData, err := json.Marshal(target.Object) if err != nil { - return nil, types.StrategicMergePatchType, errors.Wrap(err, "serializing target configuration") + return nil, types.StrategicMergePatchType, fmt.Errorf("serializing target configuration: %w", err) } // Even if currentObj is nil (because it was not found), it will marshal just fine currentData, err := json.Marshal(currentObj) if err != nil { - return nil, types.StrategicMergePatchType, errors.Wrap(err, "serializing live configuration") + return nil, types.StrategicMergePatchType, fmt.Errorf("serializing live configuration: %w", err) } // kind := target.Mapping.GroupVersionKind.Kind // if kind == "Deployment" { @@ -441,7 +441,7 @@ func createPatch(originalObj, currentObj runtime.Object, target *resource.Info) patchMeta, err := strategicpatch.NewPatchMetaFromStruct(versionedObject) if err != nil { - return nil, types.StrategicMergePatchType, errors.Wrap(err, "unable to create patch metadata from object") + return nil, types.StrategicMergePatchType, fmt.Errorf("unable to create patch metadata from object: %w", err) } patch, err := strategicpatch.CreateThreeWayMergePatch(oldData, newData, currentData, patchMeta, true) @@ -467,7 +467,7 @@ func existingResourceConflict(resources kube.ResourceList) (kube.ResourceList, e if apierrors.IsNotFound(err) { return nil } - return errors.Wrap(err, "could not get information about the resource") + return fmt.Errorf("could not get information about the resource: %w", err) } requireUpdate.Append(info) @@ -481,7 +481,7 @@ func deleteStatusAndTidyMetadata(obj []byte) (map[string]interface{}, error) { var objectMap map[string]interface{} err := jsoniterator.Unmarshal(obj, &objectMap) if err != nil { - return nil, errors.Wrap(err, "could not unmarshal byte sequence") + return nil, fmt.Errorf("could not unmarshal byte sequence: %w", err) } delete(objectMap, "status") From 49c62fc3a7466a3f9fe950f715ad38fd6e69c63f Mon Sep 17 00:00:00 2001 From: Yusuke Kuoka Date: Sat, 27 Jan 2024 10:33:37 +0900 Subject: [PATCH 3/3] Update .golangci.yaml --- .golangci.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.golangci.yaml b/.golangci.yaml index 24c7c19f..a6b9400f 100644 --- a/.golangci.yaml +++ b/.golangci.yaml @@ -147,7 +147,7 @@ linters-settings: # List of file globs that will match this list of settings to compare against. # Default: $all files: - - "!**/*_a _file.go" + - $all # List of allowed packages. allow: - $gostd