Skip to content

refactor(cmd): use an injected viper instance instead of the global singleton #64

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
sbldevnet merged 1 commit into from
Sep 28, 2026
Merged

refactor(cmd): use an injected viper instance instead of the global singleton #64

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 11 additions & 10 deletions internal/cmd/cmd.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,29 +70,30 @@ func Run() *cobra.Command {
}
} else {
// If config or default provided
if err := initConfig(log, cfgFile); err != nil {
v := viper.New()
if err := initConfig(v, log, cfgFile); err != nil {
return err
}

// The config file can only be read after the bootstrap logger is
// built, because loading it logs; its log settings therefore apply
// from here on and messages logged while loading follow the flag and
// environment only.
logOpts, changed, err := logOpts.withConfig()
logOpts, changed, err := logOpts.withConfig(v)
if err != nil {
return err
}
if changed {
log = logOpts.logger()
}
log.Debug("config file loaded", "path", viper.ConfigFileUsed())
log.Debug("config file loaded", "path", v.ConfigFileUsed())

if !viper.IsSet("proxies") {
if !v.IsSet("proxies") {
return fmt.Errorf("no proxies defined in config file")
}

var cfg config.Config
if err := viper.Unmarshal(&cfg); err != nil {
if err := v.Unmarshal(&cfg); err != nil {
return fmt.Errorf("unable to decode into struct, %v", err)
}
config.SetDefaults(cfg.Proxies)
Expand Down Expand Up @@ -193,23 +194,23 @@ func validateListen(proxies []config.ProxyConfig) error {
return nil
}

func initConfig(log *slog.Logger, cfgFile string) error {
func initConfig(v *viper.Viper, log *slog.Logger, cfgFile string) error {
var dir string
if cfgFile != "" {
log.Debug("using explicit config file", "path", cfgFile)
viper.SetConfigFile(cfgFile)
v.SetConfigFile(cfgFile)
} else {
home, err := os.UserHomeDir()
if err != nil {
return err
}
dir = filepath.Join(home, ".config", "cloudflared-proxy")
log.Debug("using default config location", "path", dir)
viper.AddConfigPath(dir)
viper.SetConfigName("config")
v.AddConfigPath(dir)
v.SetConfigName("config")
}

if err := viper.ReadInConfig(); err != nil {
if err := v.ReadInConfig(); err != nil {
if _, ok := err.(viper.ConfigFileNotFoundError); ok {
if cfgFile != "" {
return fmt.Errorf("config file not found: %s", cfgFile)
Expand Down
15 changes: 6 additions & 9 deletions internal/cmd/cmd_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,8 +52,6 @@ func (h *recordingHandler) messages() [][2]string {

func TestInitConfigDiagnostics(t *testing.T) {
setup := func(t *testing.T) (*slog.Logger, *recordingHandler) {
viper.Reset()
t.Cleanup(viper.Reset)
h := &recordingHandler{}
return slog.New(h), h
}
Expand All @@ -63,7 +61,7 @@ func TestInitConfigDiagnostics(t *testing.T) {
file := filepath.Join(t.TempDir(), "cfg.yaml")
require.NoError(t, os.WriteFile(file, []byte("proxies: []\n"), 0o600))

require.NoError(t, initConfig(log, file))
require.NoError(t, initConfig(viper.New(), log, file))

assert.Equal(t, [][2]string{{"using explicit config file", file}}, h.messages())
})
Expand All @@ -76,7 +74,7 @@ func TestInitConfigDiagnostics(t *testing.T) {
require.NoError(t, os.MkdirAll(dir, 0o700))
require.NoError(t, os.WriteFile(filepath.Join(dir, "config.yaml"), []byte("proxies: []\n"), 0o600))

require.NoError(t, initConfig(log, ""))
require.NoError(t, initConfig(viper.New(), log, ""))

assert.Equal(t, [][2]string{{"using default config location", dir}}, h.messages())
})
Expand All @@ -87,7 +85,7 @@ func TestInitConfigDiagnostics(t *testing.T) {
t.Setenv("HOME", home)
dir := filepath.Join(home, ".config", "cloudflared-proxy")

err := initConfig(log, "")
err := initConfig(viper.New(), log, "")

assert.EqualError(t, err, "no config file or endpoints provided")
assert.Equal(t, [][2]string{
Expand Down Expand Up @@ -132,8 +130,7 @@ func TestValidateListen(t *testing.T) {
}

func TestListenConfigKeys(t *testing.T) {
viper.Reset()
t.Cleanup(viper.Reset)
v := viper.New()
file := filepath.Join(t.TempDir(), "cfg.yaml")
yaml := `listen: 0.0.0.0
proxies:
Expand All @@ -142,10 +139,10 @@ proxies:
listen: 127.0.0.1
`
require.NoError(t, os.WriteFile(file, []byte(yaml), 0o600))
require.NoError(t, initConfig(slog.New(&recordingHandler{}), file))
require.NoError(t, initConfig(v, slog.New(&recordingHandler{}), file))

var cfg config.Config
require.NoError(t, viper.Unmarshal(&cfg))
require.NoError(t, v.Unmarshal(&cfg))
applyListenDefault(cfg.Proxies, cfg.Listen)

assert.Equal(t, "0.0.0.0", cfg.Listen)
Expand Down
10 changes: 5 additions & 5 deletions internal/cmd/logger.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,17 +69,17 @@ func resolveLogOptions(flagLevel, flagFormat string, levelFlagSet, formatFlagSet
// withConfig fills in the settings that no flag or environment variable set
// from the logLevel and logFormat keys of the loaded config file. It reports
// whether anything changed.
func (o logOptions) withConfig() (logOptions, bool, error) {
func (o logOptions) withConfig(v *viper.Viper) (logOptions, bool, error) {
changed := false
if !o.levelSet && viper.IsSet("logLevel") {
level, err := parseLogLevel("logLevel", viper.GetString("logLevel"))
if !o.levelSet && v.IsSet("logLevel") {
level, err := parseLogLevel("logLevel", v.GetString("logLevel"))
if err != nil {
return o, false, err
}
o.level, changed = level, true
}
if !o.formatSet && viper.IsSet("logFormat") {
json, err := parseLogFormat("logFormat", viper.GetString("logFormat"))
if !o.formatSet && v.IsSet("logFormat") {
json, err := parseLogFormat("logFormat", v.GetString("logFormat"))
if err != nil {
return o, false, err
}
Expand Down
17 changes: 6 additions & 11 deletions internal/cmd/logger_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -145,13 +145,12 @@ func logFromEnv() *slog.Logger {
// resolveWithConfig runs the full resolution: flag, environment, then the config file.
func resolveWithConfig(t *testing.T, flag, env, cfg string, key, envName string) (logOptions, error) {
t.Helper()
viper.Reset()
t.Cleanup(viper.Reset)
v := viper.New()
t.Setenv("LOG_LEVEL", "")
t.Setenv("LOG_FORMAT", "")
t.Setenv(envName, env)
if cfg != "" {
viper.Set(key, cfg)
v.Set(key, cfg)
}
var o logOptions
var err error
Expand All @@ -163,7 +162,7 @@ func resolveWithConfig(t *testing.T, flag, env, cfg string, key, envName string)
if err != nil {
return o, err
}
o, _, err = o.withConfig()
o, _, err = o.withConfig(v)
return o, err
}

Expand Down Expand Up @@ -238,9 +237,6 @@ func TestInvalidFlagAndConfigValues(t *testing.T) {
func TestInvalidEnvLevelWarns(t *testing.T) {
t.Setenv("LOG_LEVEL", "bogus")
t.Setenv("LOG_FORMAT", "")
viper.Reset()
t.Cleanup(viper.Reset)
viper.Set("logFormat", "json")

o, err := resolveLogOptions("", "", false, false)
require.NoError(t, err)
Expand All @@ -251,17 +247,16 @@ func TestInvalidEnvLevelWarns(t *testing.T) {
func TestConfigFileLogSettingsApplyAfterLoading(t *testing.T) {
t.Setenv("LOG_LEVEL", "")
t.Setenv("LOG_FORMAT", "")
viper.Reset()
t.Cleanup(viper.Reset)
v := viper.New()
file := filepath.Join(t.TempDir(), "cfg.yaml")
require.NoError(t, os.WriteFile(file, []byte("logLevel: debug\nlogFormat: json\nproxies: []\n"), 0o600))

o, err := resolveLogOptions("", "", false, false)
require.NoError(t, err)
assert.Equal(t, slog.LevelInfo, o.level)

require.NoError(t, initConfig(slog.New(&recordingHandler{}), file))
o, changed, err := o.withConfig()
require.NoError(t, initConfig(v, slog.New(&recordingHandler{}), file))
o, changed, err := o.withConfig(v)
require.NoError(t, err)
assert.True(t, changed)

Expand Down
Loading