Skip to content

Commit

Permalink
Rename ctx to flagsKVStore
Browse files Browse the repository at this point in the history
  • Loading branch information
qdm12 committed Nov 10, 2021
1 parent 26cd469 commit c367d7b
Show file tree
Hide file tree
Showing 2 changed files with 33 additions and 33 deletions.
14 changes: 7 additions & 7 deletions cmd/gossamer/config.go
Original file line number Diff line number Diff line change
Expand Up @@ -288,7 +288,7 @@ func createExportConfig(ctx *cli.Context) (*dot.Config, error) {
return cfg, nil
}

type getStringer interface {
type stringKVStore interface {
String(key string) (value string)
}

Expand All @@ -298,9 +298,9 @@ type getStringer interface {
// 3. Return the default value given if both previous steps failed.
// For steps 1 and 2, it tries to parse the level as an integer to convert it
// to a level, and also tries to parse it as a string.
func getLogLevel(ctx getStringer, flagName, tomlValue string, defaultLevel log.Lvl) (
func getLogLevel(flagsKVStore stringKVStore, flagName, tomlValue string, defaultLevel log.Lvl) (
level log.Lvl, err error) {
if flagValue := ctx.String(flagName); flagValue != "" {
if flagValue := flagsKVStore.String(flagName); flagValue != "" {
return parseLogLevelString(flagValue)
}

Expand Down Expand Up @@ -331,12 +331,12 @@ func parseLogLevelString(logLevelString string) (logLevel log.Lvl, err error) {
return logLevel, nil
}

func setLogConfig(ctx getStringer, cfg *ctoml.Config, globalCfg *dot.GlobalConfig, logCfg *dot.LogConfig) (err error) {
func setLogConfig(flagsKVStore stringKVStore, cfg *ctoml.Config, globalCfg *dot.GlobalConfig, logCfg *dot.LogConfig) (err error) {
if cfg == nil {
cfg = new(ctoml.Config)
}

globalCfg.LogLvl, err = getLogLevel(ctx, LogFlag.Name, cfg.Global.LogLvl, gssmr.DefaultLvl)
globalCfg.LogLvl, err = getLogLevel(flagsKVStore, LogFlag.Name, cfg.Global.LogLvl, gssmr.DefaultLvl)
if err != nil {
return fmt.Errorf("cannot get global log level: %w", err)
}
Expand Down Expand Up @@ -405,14 +405,14 @@ func setLogConfig(ctx getStringer, cfg *ctoml.Config, globalCfg *dot.GlobalConfi
}

for _, levelData := range levelsData {
level, err := getLogLevel(ctx, levelData.flagName, levelData.tomlValue, globalCfg.LogLvl)
level, err := getLogLevel(flagsKVStore, levelData.flagName, levelData.tomlValue, globalCfg.LogLvl)
if err != nil {
return fmt.Errorf("cannot get %s log level: %w", levelData.name, err)
}
*levelData.levelPtr = level
}

logger.Debug("set log configuration", "--log", ctx.String(LogFlag.Name), "global", globalCfg.LogLvl)
logger.Debug("set log configuration", "--log", flagsKVStore.String(LogFlag.Name), "global", globalCfg.LogLvl)
return nil
}

Expand Down
52 changes: 26 additions & 26 deletions cmd/gossamer/config_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -1089,53 +1089,53 @@ func Test_getLogLevel(t *testing.T) {
t.Parallel()

testCases := map[string]struct {
ctx getStringer
flagsKVStore stringKVStore
flagName string
tomlValue string
defaultLevel log.Lvl
level log.Lvl
err error
}{
"no value with default": {
ctx: newMockGetStringer(map[string]string{}),
flagsKVStore: newMockGetStringer(map[string]string{}),
defaultLevel: log.LvlError,
level: log.LvlError,
},
"flag integer value": {
ctx: newMockGetStringer(map[string]string{"x": "1"}),
flagName: "x",
level: log.LvlError,
flagsKVStore: newMockGetStringer(map[string]string{"x": "1"}),
flagName: "x",
level: log.LvlError,
},
"flag string value": {
ctx: newMockGetStringer(map[string]string{"x": "eror"}),
flagName: "x",
level: log.LvlError,
flagsKVStore: newMockGetStringer(map[string]string{"x": "eror"}),
flagName: "x",
level: log.LvlError,
},
"flag bad string value": {
ctx: newMockGetStringer(map[string]string{"x": "garbage"}),
flagName: "x",
err: errors.New("cannot parse log level string: Unknown level: garbage"),
flagsKVStore: newMockGetStringer(map[string]string{"x": "garbage"}),
flagName: "x",
err: errors.New("cannot parse log level string: Unknown level: garbage"),
},
"toml integer value": {
ctx: newMockGetStringer(map[string]string{}),
tomlValue: "1",
level: log.LvlError,
flagsKVStore: newMockGetStringer(map[string]string{}),
tomlValue: "1",
level: log.LvlError,
},
"toml string value": {
ctx: newMockGetStringer(map[string]string{}),
tomlValue: "eror",
level: log.LvlError,
flagsKVStore: newMockGetStringer(map[string]string{}),
tomlValue: "eror",
level: log.LvlError,
},
"toml bad string value": {
ctx: newMockGetStringer(map[string]string{}),
tomlValue: "garbage",
err: errors.New("cannot parse log level string: Unknown level: garbage"),
flagsKVStore: newMockGetStringer(map[string]string{}),
tomlValue: "garbage",
err: errors.New("cannot parse log level string: Unknown level: garbage"),
},
"flag takes precedence": {
ctx: newMockGetStringer(map[string]string{"x": "eror"}),
flagName: "x",
tomlValue: "warn",
level: log.LvlError,
flagsKVStore: newMockGetStringer(map[string]string{"x": "eror"}),
flagName: "x",
tomlValue: "warn",
level: log.LvlError,
},
}

Expand All @@ -1144,7 +1144,7 @@ func Test_getLogLevel(t *testing.T) {
t.Run(name, func(t *testing.T) {
t.Parallel()

level, err := getLogLevel(testCase.ctx, testCase.flagName,
level, err := getLogLevel(testCase.flagsKVStore, testCase.flagName,
testCase.tomlValue, testCase.defaultLevel)

if testCase.err != nil {
Expand Down Expand Up @@ -1207,7 +1207,7 @@ func Test_setLogConfig(t *testing.T) {
t.Parallel()

testCases := map[string]struct {
ctx getStringer
ctx stringKVStore
initialCfg ctoml.Config
initialGlobalCfg dot.GlobalConfig
initialLogCfg dot.LogConfig
Expand Down

0 comments on commit c367d7b

Please sign in to comment.