Cleanup lint codebase #13110
Merged
Cleanup lint codebase #13110
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
Test files have some calls that don't necessarily get checked since they have a very low probability to fail, and in a testing environment it's acceptable to not have bulletproof code. Therefore, we add a rule to not run that check on any file that ends with `_test.go` (Go test convention), so the linter isn't as noisy as it used to be.
Some of the variables we create are flagged by our linters as ineffective assignments, which makes sense as those are generally fed by code below, so we don't need to use the declaration/assignation syntax (:=) but instead can fall back to using var with a type to get the zero value of the declared entity.
The logOutput function had a bunch of nested checks in the code for the function, as well as one ineffasign pointed out by golangci-lint. This commit changes how special cases are processed, and changes a bit how log redirection to a file is handled. Prior to this commit, only when PACKER_LOG and PACKER_LOG_FILE are set does Packer redirect logs to the specified path, which is a bit superfluous as setting PACKER_LOG_FILE should be enough on its own to redirect logs and enable verbose logs. Now, when neither is set, no logOutput is set, if PACKER_LOG_FILE is set (regardless of PACKER_LOG), we redirect to the specified file, and finally if PACKER_LOG is set, we redirect to stderr.
In a couple places in the codebase we didn't check the errors from functions we execute. In some cases this is harmless (or at least ignorable), but others may need to log what went wrong, so for all the reported occurrences we either ignore explicitly or handle the error with a log.
lbajolet-hashicorp
added
the
tech-debt
|
Should, and can, this be back ported to the 1.11.x branch? |
|
I don't see a reason why this couldn't! I'll add the backport label |
lbajolet-hashicorp
added
the
backport/1.11.x
|
I'm going to lock this pull request because it has been closed for 30 days ⏳. This helps our maintainers find and focus on the active issues. |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
This PR is a collection of fixups for linters run by golangci-lint.
With this, we should be able to run
golangci-linton the whole codebase as all smells are eliminated.