chore: Code quality cleanup and godoc improvements #352
Conversation
This file contains hidden or 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
- Remove unused code: - etcdWatcher interface in pkg/backends/etcd/client.go - replacer variable in pkg/backends/file/client.go - Fix bugs: - Ineffective break statement in intervalProcessor.Process() - Variable shadowing in vault kubernetes auth (err -> jwtErr) - Remove deprecated tlsConfig.BuildNameToCertificate() call - Fix error strings per Go conventions (lowercase, no punctuation): - "Invalid backend" -> "invalid backend" - "Invalid file extentsion. YAML or JSON only." -> "invalid file extension, YAML or JSON only" - Add godoc comments for exported types and functions: - backends.Config, ssm.Client, ssm.New, file.ResultError, file.NewFileClient - template.Processor, template.Process, template.IntervalProcessor, template.WatchProcessor - util.AppendPrefix, util.ArrayShift Closes #349, #348
Codecov Report❌ Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## main #352 +/- ##
==========================================
+ Coverage 48.33% 48.36% +0.02%
==========================================
Files 20 20
Lines 1864 1863 -1
==========================================
Hits 901 901
+ Misses 882 881 -1
Partials 81 81 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
5 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Summary
Changes
Dead Code Removed
pkg/backends/etcd/client.go: Removed unusedetcdWatcherinterfacepkg/backends/file/client.go: Removed unusedreplacervariableBug Fixes
pkg/template/processor.go: Fixed ineffectivebreakstatement - changed toreturnto properly exit the for looppkg/backends/vault/client.go: Fixed variable shadowing in kubernetes auth casepkg/backends/vault/client.go: Removed deprecatedtlsConfig.BuildNameToCertificate()(deprecated since Go 1.14)Error String Fixes
Godoc Comments Added
backends.Config,ssm.Client,ssm.Newfile.ResultError,file.NewFileClienttemplate.Processor,template.Process,template.IntervalProcessor,template.WatchProcessorutil.AppendPrefix,util.ArrayShiftTest plan
go test -vet=off ./pkg/...)go build ./...)Closes #349, #348