Vet source code using NilAway #73
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
ericcornelissen
force-pushed
the
nilaway
branch
from
8a1a90d
to
6c44099
Compare
ericcornelissen
added
dependencies
Add NilAway (<https://github.com/uber-go/nilaway>) as a new vet check in order to detect and address potential runtime errors due to nil values. All 4 violations it detected have been addressed. In `analyze.go` this simply constitutes checking that received pointers aren't nil. In `main.go` this constites, first, explicitly relying on the `ok` check of a map lookup when trying to use said key (instead of implicitly relying on the control flow being such that said key is injected if it isn't there already), and second, rewriting to avoid using `strings.Split` and instead using index lookup - in this case the finding by NilAway was a false positive (`nil` can never be returned by `strings.Split`, even if the internal function used may return `nil` in some cases) but rewriting reduces memory usage. The modifications are partially tested, covering only `analyze.go` because `main.go` isn't covered by unit tests. Signed-off-by: Eric Cornelissen <ericornelissen@gmail.com>
ericcornelissen
force-pushed
the
nilaway
branch
from
6c44099
to
e39b14a
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Relates to #48, #52, #55
Summary
Add NilAway as a new vet check in order to detect and address potential runtime errors due to nil values. It found 4 problems as of fa28274, which have all been addressed.
One of the findings was a false positive for which an alternative implementation was feasible (and favorable in terms of memory usage). While the overall assessment as of this Pull Request is that the false positives are tolerable, having false positives is not ideal for a tool that is continuously run. If it turns out to be a problem the continuous usage of NilAway will be reconsidered.