Error signature refactoring #6
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
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #6 +/- ##
==========================================
Coverage 100.00% 100.00%
==========================================
Files 1 4 +3
Lines 138 244 +106
==========================================
+ Hits 138 244 +106 ☔ View full report in Codecov by Sentry. |
ccoVeille
reviewed
Jul 18, 2024
|
|
||
| ```go | ||
| type Config struct { | ||
| ReadDatabase DatabaseConfig `env:"WRITE_DATABASE"` | ||
| WriteDatabase DatabaseConfig `env:"READ_DATABASE"` | ||
| Hosts []string `env:"HOSTS,default=[localhost,localhost2] |
There was a problem hiding this comment.
Suggested change
| Hosts []string `env:"HOSTS,default=[localhost,localhost2] | |
| Hosts []string `env:"HOSTS,default=[localhost,localhost2]` |
| with `DATABASE_` as they are looked for. This allows you to reuse the same | ||
| struct in multiple places without having to worry about conflicting environment | ||
| variables. | ||
| However if you want to declare multiple values as the default, you must enclose |
There was a problem hiding this comment.
Suggested change
| However if you want to declare multiple values as the default, you must enclose | |
| However, if you want to declare multiple values as the default, you must enclose |
|
|
||
| ```go | ||
| type Config struct { | ||
| Hosts []string `env:"HOSTS,default=[localhost,localhost2],required" |
There was a problem hiding this comment.
Suggested change
| Hosts []string `env:"HOSTS,default=[localhost,localhost2],required" | |
| Hosts []string `env:"HOSTS,default=[localhost,localhost2],required"` |
Comment on lines
+267
to
+268
| err := Set("UNSUPPORTED", "invalid") | ||
| assertNoError(t, err, "Set UNSUPPORTED") |
There was a problem hiding this comment.
Here, and in a few other places, you could/should use the test helper
Suggested change
| err := Set("UNSUPPORTED", "invalid") | |
| assertNoError(t, err, "Set UNSUPPORTED") | |
| setEnvForTest(t, "UNSUPPORTED", "invalid") |
| assertError(t, err, "Unmarshal Required") | ||
|
|
||
| expectedErr := "required environment variable REQUIRED_VAR is not set" | ||
| if err != nil && err.Error() != expectedErr { |
There was a problem hiding this comment.
You could add a test helper
func assertErrorContains(t *testing.T, err string, needle string) {
assertError(t, err)
if !strings.Contains(err.Error(), needle) {
t.Fatal("blah blah")
}
}| Float64Value float64 `env:"FLOAT64_VALUE"` | ||
| } | ||
| err := Unmarshal(&cfg) | ||
| assertNoError(t, err, "Unmarshal FloatConfig") |
There was a problem hiding this comment.
What about moving your asserter to a package
This way, you will use assert.NoError, assert.Equal…
It could be a local package, or a go module in a dedicated repository you would reuse in all your dev
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.
val, err := Get("ENV")based signatureval, errsignature to match thisGetSlicetoGetStringSliceand supports more typesdefaultslice values throughdefault=[one,two,three]