From c367d7be57e40adedf87e158547978fe3c8201c9 Mon Sep 17 00:00:00 2001 From: Quentin McGaw Date: Wed, 10 Nov 2021 11:58:17 +0000 Subject: [PATCH] Rename `ctx` to `flagsKVStore` --- cmd/gossamer/config.go | 14 +++++----- cmd/gossamer/config_test.go | 52 ++++++++++++++++++------------------- 2 files changed, 33 insertions(+), 33 deletions(-) diff --git a/cmd/gossamer/config.go b/cmd/gossamer/config.go index dbea880b5b..21d13dfd14 100644 --- a/cmd/gossamer/config.go +++ b/cmd/gossamer/config.go @@ -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) } @@ -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) } @@ -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) } @@ -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 } diff --git a/cmd/gossamer/config_test.go b/cmd/gossamer/config_test.go index c314556109..c7a8b23799 100644 --- a/cmd/gossamer/config_test.go +++ b/cmd/gossamer/config_test.go @@ -1089,7 +1089,7 @@ func Test_getLogLevel(t *testing.T) { t.Parallel() testCases := map[string]struct { - ctx getStringer + flagsKVStore stringKVStore flagName string tomlValue string defaultLevel log.Lvl @@ -1097,45 +1097,45 @@ func Test_getLogLevel(t *testing.T) { 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, }, } @@ -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 { @@ -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