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.

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

ci: improve error checking (errcheck linter) #11195

Merged
merged 14 commits into from
Apr 13, 2022
Merged

ci: improve error checking (errcheck linter) #11195

merged 14 commits into from
Apr 13, 2022

Conversation

julienrbrt
Copy link
Member

@julienrbrt julienrbrt commented Feb 15, 2022

Description

Implements part of #7258

Check some of currently unchecked errors.

  • baseapp
  • client
  • codec
  • crypto
  • server
  • simapp
  • snapshots
  • store
  • testutil
  • types
  • modules

Author Checklist

All items are required. Please add a note to the item if the item is not applicable and
please add links to any relevant follow up issues.

I have...

  • included the correct type prefix in the PR title
  • added ! to the type prefix if API or client breaking change
  • targeted the correct branch (see PR Targeting)
  • provided a link to the relevant issue or specification
  • followed the guidelines for building modules
  • included the necessary unit and integration tests
  • added a changelog entry to CHANGELOG.md
  • included comments for documenting Go code
  • updated the relevant documentation or specification
  • reviewed "Files changed" and left comments if necessary
  • confirmed all CI checks have passed

Reviewers Checklist

All items are required. Please add a note if the item is not applicable and please add
your handle next to the items reviewed if you only reviewed selected items.

I have...

  • confirmed the correct type prefix in the PR title
  • confirmed ! in the type prefix if API or client breaking change
  • confirmed all author checklist items have been addressed
  • reviewed state machine logic
  • reviewed API design and naming
  • reviewed documentation is accurate
  • reviewed tests and test coverage
  • manually tested (if applicable)

@github-actions github-actions bot added the T: CI label Feb 15, 2022
@robert-zaremba
Copy link
Collaborator

Thanks for doing this. I started similar work 1.5 year ago.
I suggest we do a partial merge, to avoid future conflicts. How about that? I think you can add nested .golangci.yml to enable errcheck in subdirectories.

@julienrbrt
Copy link
Member Author

julienrbrt commented Feb 24, 2022

Thanks for doing this. I started similar work 1.5 year ago. I suggest we do a partial merge, to avoid future conflicts. How about that? I think you can add nested .golangci.yml to enable errcheck in subdirectories.

Yes I've seen 😄 Do you mean merging your branch in this PR or rebasing with master?

@robert-zaremba
Copy link
Collaborator

You can merge my branch or manually copy some stuff from it.

I meant that you don't need to finish everything to merge it into master - if the process will take too long we can break the task into 2 PRs - if that helps.

@github-actions github-actions bot added C:CLI C:Keys Keybase, KMS and HSMs labels Mar 1, 2022
@github-actions github-actions bot removed the T: CI label Apr 11, 2022
@julienrbrt
Copy link
Member Author

julienrbrt commented Apr 11, 2022

The PR makes me think of #11215 ; not sure if the linter should be enforced (as we may need to add many nolint comments).
However, I believe verifying the error checking across the codebase still has an added value.

Splitting this PR as per above comment.

@julienrbrt julienrbrt changed the title feat: re-enable errcheck linter check ci: improve error checking (errcheck linter) Apr 11, 2022
@julienrbrt julienrbrt marked this pull request as ready for review April 11, 2022 13:25
Copy link
Contributor

@alexanderbez alexanderbez left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Skimmed through it. Most error handling spots looks good to me. I left a comment on a few. Mainly just want to make sure we're exiting or panicing where/when we need to, to be consistent with the rest of the logic.

baseapp/grpcserver.go Outdated Show resolved Hide resolved
simapp/export.go Outdated Show resolved Hide resolved
simapp/export.go Outdated Show resolved Hide resolved
simapp/export.go Show resolved Hide resolved
Copy link
Contributor

@likhita-809 likhita-809 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm

@julienrbrt julienrbrt added the A:automerge Automatically merge PR once all prerequisites pass. label Apr 12, 2022
Copy link
Collaborator

@fedekunze fedekunze left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

utACK 💯 thanks @julienrbrt!

@mergify mergify bot merged commit 1fe59eb into cosmos:master Apr 13, 2022
larry0x pushed a commit to larry0x/cosmos-sdk that referenced this pull request May 22, 2023
## Description

Implements part of cosmos#7258

Check some of currently unchecked errors.

- [x] baseapp
- [x] client
- [x] codec
- [x] crypto
- [x] server
- [x] simapp
- [ ] snapshots
- [ ] store
- [x] testutil
- [ ] types
- [ ] modules

---

### Author Checklist

*All items are required. Please add a note to the item if the item is not applicable and
please add links to any relevant follow up issues.*

I have...

- [ ] included the correct [type prefix](https://github.com/commitizen/conventional-commit-types/blob/v3.0.0/index.json) in the PR title
- [ ] added `!` to the type prefix if API or client breaking change
- [ ] targeted the correct branch (see [PR Targeting](https://github.com/cosmos/cosmos-sdk/blob/master/CONTRIBUTING.md#pr-targeting))
- [ ] provided a link to the relevant issue or specification
- [ ] followed the guidelines for [building modules](https://github.com/cosmos/cosmos-sdk/blob/master/docs/building-modules)
- [ ] included the necessary unit and integration [tests](https://github.com/cosmos/cosmos-sdk/blob/master/CONTRIBUTING.md#testing)
- [ ] added a changelog entry to `CHANGELOG.md`
- [ ] included comments for [documenting Go code](https://blog.golang.org/godoc)
- [ ] updated the relevant documentation or specification
- [ ] reviewed "Files changed" and left comments if necessary
- [ ] confirmed all CI checks have passed

### Reviewers Checklist

*All items are required. Please add a note if the item is not applicable and please add
your handle next to the items reviewed if you only reviewed selected items.*

I have...

- [ ] confirmed the correct [type prefix](https://github.com/commitizen/conventional-commit-types/blob/v3.0.0/index.json) in the PR title
- [ ] confirmed `!` in the type prefix if API or client breaking change
- [ ] confirmed all author checklist items have been addressed 
- [ ] reviewed state machine logic
- [ ] reviewed API design and naming
- [ ] reviewed documentation is accurate
- [ ] reviewed tests and test coverage
- [ ] manually tested (if applicable)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A:automerge Automatically merge PR once all prerequisites pass. C:CLI C:Keys Keybase, KMS and HSMs
Projects
No open projects
Archived in project
Archived in project
Development

Successfully merging this pull request may close these issues.

5 participants