Fail loudly on an unparseable SENTRY_DSN and a malformed .env (closes #283)
All checks were successful
check / check (push) Successful in 2m54s
All checks were successful
check / check (push) Successful in 2m54s
This commit was merged in pull request #289.
This commit is contained in:
@@ -518,8 +518,20 @@ type badEnvValueCase struct {
|
||||
}
|
||||
|
||||
// badEnvValueCases is the config.New table, kept out of the test body
|
||||
// so the test itself stays readable.
|
||||
// so the test itself stays readable. It is assembled from per-variable
|
||||
// groups because one literal covering every variable outgrew the
|
||||
// function-length budget.
|
||||
func badEnvValueCases() []badEnvValueCase {
|
||||
cases := listenerEnvValueCases()
|
||||
cases = append(cases, flagEnvValueCases()...)
|
||||
cases = append(cases, sentryEnvValueCases()...)
|
||||
|
||||
return cases
|
||||
}
|
||||
|
||||
// listenerEnvValueCases covers the two variables that describe the
|
||||
// HTTP listener.
|
||||
func listenerEnvValueCases() []badEnvValueCase {
|
||||
return []badEnvValueCase{
|
||||
{
|
||||
name: "valid PORT is used",
|
||||
@@ -542,27 +554,6 @@ func badEnvValueCases() []badEnvValueCase {
|
||||
value: "70000",
|
||||
expectError: true,
|
||||
},
|
||||
{
|
||||
name: "valid DEBUG is used",
|
||||
key: envKeyDebug,
|
||||
value: "true",
|
||||
check: func(t *testing.T, cfg *config.Config) {
|
||||
t.Helper()
|
||||
assert.True(t, cfg.Debug)
|
||||
},
|
||||
},
|
||||
{
|
||||
name: "unparseable DEBUG aborts startup",
|
||||
key: envKeyDebug,
|
||||
value: "ture",
|
||||
expectError: true,
|
||||
},
|
||||
{
|
||||
name: "unparseable MAINTENANCE_MODE aborts startup",
|
||||
key: envKeyMaintenanceMode,
|
||||
value: "sometimes",
|
||||
expectError: true,
|
||||
},
|
||||
{
|
||||
name: "valid BIND_ADDRESS is used",
|
||||
key: envKeyBindAddress,
|
||||
@@ -595,6 +586,69 @@ func badEnvValueCases() []badEnvValueCase {
|
||||
}
|
||||
}
|
||||
|
||||
// flagEnvValueCases covers the boolean variables.
|
||||
func flagEnvValueCases() []badEnvValueCase {
|
||||
return []badEnvValueCase{
|
||||
{
|
||||
name: "valid DEBUG is used",
|
||||
key: envKeyDebug,
|
||||
value: "true",
|
||||
check: func(t *testing.T, cfg *config.Config) {
|
||||
t.Helper()
|
||||
assert.True(t, cfg.Debug)
|
||||
},
|
||||
},
|
||||
{
|
||||
name: "unparseable DEBUG aborts startup",
|
||||
key: envKeyDebug,
|
||||
value: "ture",
|
||||
expectError: true,
|
||||
},
|
||||
{
|
||||
name: "unparseable MAINTENANCE_MODE aborts startup",
|
||||
key: envKeyMaintenanceMode,
|
||||
value: "sometimes",
|
||||
expectError: true,
|
||||
},
|
||||
}
|
||||
}
|
||||
|
||||
// sentryEnvValueCases covers SENTRY_DSN. The three rejected values are
|
||||
// the ones measured on the defect: each initialised the SDK with an
|
||||
// error and left the process serving with error reporting off.
|
||||
func sentryEnvValueCases() []badEnvValueCase {
|
||||
return []badEnvValueCase{
|
||||
{
|
||||
name: "valid SENTRY_DSN is used",
|
||||
key: envKeySentryDSN,
|
||||
value: validSentryDSN,
|
||||
check: func(t *testing.T, cfg *config.Config) {
|
||||
t.Helper()
|
||||
assert.Equal(t, validSentryDSN, cfg.SentryDSN)
|
||||
assert.True(t, cfg.SentryEnabled())
|
||||
},
|
||||
},
|
||||
{
|
||||
name: "unparseable SENTRY_DSN aborts startup",
|
||||
key: envKeySentryDSN,
|
||||
value: "not-a-dsn",
|
||||
expectError: true,
|
||||
},
|
||||
{
|
||||
name: "SENTRY_DSN that is not a URL aborts startup",
|
||||
key: envKeySentryDSN,
|
||||
value: "%%%",
|
||||
expectError: true,
|
||||
},
|
||||
{
|
||||
name: "keyless SENTRY_DSN aborts startup",
|
||||
key: envKeySentryDSN,
|
||||
value: "https://example.invalid/1",
|
||||
expectError: true,
|
||||
},
|
||||
}
|
||||
}
|
||||
|
||||
// TestNewUsesDefaultsWhenUnset proves the fail-loud behaviour did not
|
||||
// break the legitimate unset case: absent variables still get their
|
||||
// documented defaults.
|
||||
@@ -603,7 +657,7 @@ func TestNewUsesDefaultsWhenUnset(t *testing.T) {
|
||||
|
||||
for _, key := range []string{
|
||||
envKeyPort, envKeyDebug, envKeyMaintenanceMode,
|
||||
envKeyBindAddress,
|
||||
envKeyBindAddress, envKeySentryDSN,
|
||||
} {
|
||||
require.NoError(t, os.Unsetenv(key))
|
||||
}
|
||||
@@ -626,4 +680,9 @@ func TestNewUsesDefaultsWhenUnset(t *testing.T) {
|
||||
t, config.DefaultBindAddressForTest, cfg.BindAddress,
|
||||
)
|
||||
assert.Equal(t, bindAddressDefault, cfg.BindAddress)
|
||||
|
||||
// An absent SENTRY_DSN is the common case and must stay a normal
|
||||
// start with error reporting off, not a refusal.
|
||||
assert.Empty(t, cfg.SentryDSN)
|
||||
assert.False(t, cfg.SentryEnabled())
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user