Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Disallow fmt.Errorf usage through code validation #433

Merged
merged 1 commit into from
Dec 11, 2019
Merged

Disallow fmt.Errorf usage through code validation #433

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion cmd/krew/cmd/root.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -94,7 +94,7 @@ func preRun(cmd *cobra.Command, _ []string) error {
}
if !isMigrated && cmd.Use != "receipts-upgrade" {
fmt.Fprintln(os.Stderr, "You need to perform a migration to continue using krew.\nPlease run `kubectl krew system receipts-upgrade`")
return fmt.Errorf("krew home outdated")
return errors.New("krew home outdated")
}

if installation.IsWindows() {
Expand Down
2 changes: 1 addition & 1 deletion cmd/validate-krew-manifest/main.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@ func validateManifestFile(path string) error {
filename := filepath.Base(path)
manifestExtension := filepath.Ext(filename)
if manifestExtension != constants.ManifestExtension {
return fmt.Errorf("expected manifest extension %q but found %q", constants.ManifestExtension, manifestExtension)
return errors.Errorf("expected manifest extension %q but found %q", constants.ManifestExtension, manifestExtension)
}
pluginNameFromFileName := strings.TrimSuffix(filename, manifestExtension)
klog.V(4).Infof("inferred plugin name as %s", pluginNameFromFileName)
Expand Down
8 changes: 8 additions & 0 deletions hack/verify-code-patterns.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,14 @@ if [[ -n "$out" ]]; then
exit 1
fi

# Do not use fmt.Errorf as it does not start a stacktrace at error site
out="$(grep --include '*.go' -EIrn 'fmt\.Errorf?' || true)"
if [[ -n "$out" ]]; then
echo >&2 "You used fmt.Errorf; use pkg/errors.Errorf instead to preserve stack traces:"
echo >&2 "$out"
exit 1
fi

# Do not initialize index.{Plugin,Platform} structs in test code.
out="$(grep --include '*_test.go' --exclude-dir 'vendor/' -EIrn '[^]](index\.)(Plugin|Platform){' || true)"
if [[ -n "$out" ]]; then
Expand Down