lbsadmin/Beego
1
0
Fork 0
mirror of https://github.com/astaxie/beego.git synced 2025-06-12 22:10:39 +00:00
Code Issues Releases Activity

remove config API's context parameter

Browse Source
This commit is contained in:
Ming Deng
2020-10-13 22:32:41 +08:00
parent 568626cd57
commit 2572094a8d
22 changed files with 457 additions and 497 deletions
Download Patch File Download Diff File Expand all files Collapse all files

43
core/config/toml/toml.go
View File

@ -15,7 +15,6 @@
package toml
import (
"context"
"io/ioutil"
"os"
"strings"
@ -57,7 +56,7 @@ type configContainer struct {
}
// Set put key, val
func (c *configContainer) Set(ctx context.Context, key, val string) error {
func (c *configContainer) Set(key, val string) error {
path := strings.Split(key, keySeparator)
sub, err := subTree(c.t, path[0:len(path)-1])
if err != nil {
@ -69,7 +68,7 @@ func (c *configContainer) Set(ctx context.Context, key, val string) error {
// String return the value.
// return error if key not found or value is invalid type
func (c *configContainer) String(ctx context.Context, key string) (string, error) {
func (c *configContainer) String(key string) (string, error) {
res, err := c.get(key)
if err != nil {
@ -89,7 +88,7 @@ func (c *configContainer) String(ctx context.Context, key string) (string, error
// Strings return []string
// return error if key not found or value is invalid type
func (c *configContainer) Strings(ctx context.Context, key string) ([]string, error) {
func (c *configContainer) Strings(key string) ([]string, error) {
val, err := c.get(key)
if err != nil {
@ -115,14 +114,14 @@ func (c *configContainer) Strings(ctx context.Context, key string) ([]string, er
// Int return int value
// return error if key not found or value is invalid type
func (c *configContainer) Int(ctx context.Context, key string) (int, error) {
val, err := c.Int64(ctx, key)
func (c *configContainer) Int(key string) (int, error) {
val, err := c.Int64(key)
return int(val), err
}
// Int64 return int64 value
// return error if key not found or value is invalid type
func (c *configContainer) Int64(ctx context.Context, key string) (int64, error) {
func (c *configContainer) Int64(key string) (int64, error) {
res, err := c.get(key)
if err != nil {
return 0, err
@ -141,7 +140,7 @@ func (c *configContainer) Int64(ctx context.Context, key string) (int64, error)
// bool return bool value
// return error if key not found or value is invalid type
func (c *configContainer) Bool(ctx context.Context, key string) (bool, error) {
func (c *configContainer) Bool(key string) (bool, error) {
res, err := c.get(key)
@ -161,7 +160,7 @@ func (c *configContainer) Bool(ctx context.Context, key string) (bool, error) {
// Float return float value
// return error if key not found or value is invalid type
func (c *configContainer) Float(ctx context.Context, key string) (float64, error) {
func (c *configContainer) Float(key string) (float64, error) {
res, err := c.get(key)
if err != nil {
return 0, err
@ -180,7 +179,7 @@ func (c *configContainer) Float(ctx context.Context, key string) (float64, error
// DefaultString return string value
// return default value if key not found or value is invalid type
func (c *configContainer) DefaultString(ctx context.Context, key string, defaultVal string) string {
func (c *configContainer) DefaultString(key string, defaultVal string) string {
res, err := c.get(key)
if err != nil {
return defaultVal
@ -194,7 +193,7 @@ func (c *configContainer) DefaultString(ctx context.Context, key string, default
// DefaultStrings return []string
// return default value if key not found or value is invalid type
func (c *configContainer) DefaultStrings(ctx context.Context, key string, defaultVal []string) []string {
func (c *configContainer) DefaultStrings(key string, defaultVal []string) []string {
val, err := c.get(key)
if err != nil {
return defaultVal
@ -216,13 +215,13 @@ func (c *configContainer) DefaultStrings(ctx context.Context, key string, defaul
// DefaultInt return int value
// return default value if key not found or value is invalid type
func (c *configContainer) DefaultInt(ctx context.Context, key string, defaultVal int) int {
return int(c.DefaultInt64(ctx, key, int64(defaultVal)))
func (c *configContainer) DefaultInt(key string, defaultVal int) int {
return int(c.DefaultInt64(key, int64(defaultVal)))
}
// DefaultInt64 return int64 value
// return default value if key not found or value is invalid type
func (c *configContainer) DefaultInt64(ctx context.Context, key string, defaultVal int64) int64 {
func (c *configContainer) DefaultInt64(key string, defaultVal int64) int64 {
res, err := c.get(key)
if err != nil {
return defaultVal
@ -238,7 +237,7 @@ func (c *configContainer) DefaultInt64(ctx context.Context, key string, defaultV
// DefaultBool return bool value
// return default value if key not found or value is invalid type
func (c *configContainer) DefaultBool(ctx context.Context, key string, defaultVal bool) bool {
func (c *configContainer) DefaultBool(key string, defaultVal bool) bool {
res, err := c.get(key)
if err != nil {
return defaultVal
@ -252,7 +251,7 @@ func (c *configContainer) DefaultBool(ctx context.Context, key string, defaultVa
// DefaultFloat return float value
// return default value if key not found or value is invalid type
func (c *configContainer) DefaultFloat(ctx context.Context, key string, defaultVal float64) float64 {
func (c *configContainer) DefaultFloat(key string, defaultVal float64) float64 {
res, err := c.get(key)
if err != nil {
return defaultVal
@ -265,12 +264,12 @@ func (c *configContainer) DefaultFloat(ctx context.Context, key string, defaultV
}
// DIY returns the original value
func (c *configContainer) DIY(ctx context.Context, key string) (interface{}, error) {
func (c *configContainer) DIY(key string) (interface{}, error) {
return c.get(key)
}
// GetSection return error if the value is not valid toml doc
func (c *configContainer) GetSection(ctx context.Context, section string) (map[string]string, error) {
func (c *configContainer) GetSection(section string) (map[string]string, error) {
val, err := subTree(c.t, strings.Split(section, keySeparator))
if err != nil {
return map[string]string{}, err
@ -283,7 +282,7 @@ func (c *configContainer) GetSection(ctx context.Context, section string) (map[s
return res, nil
}
func (c *configContainer) Unmarshaler(ctx context.Context, prefix string, obj interface{}, opt ...config.DecodeOption) error {
func (c *configContainer) Unmarshaler(prefix string, obj interface{}, opt ...config.DecodeOption) error {
if len(prefix) > 0 {
t, err := subTree(c.t, strings.Split(prefix, keySeparator))
if err != nil {
@ -296,7 +295,7 @@ func (c *configContainer) Unmarshaler(ctx context.Context, prefix string, obj in
// Sub return sub configer
// return error if key not found or the value is not a sub doc
func (c *configContainer) Sub(ctx context.Context, key string) (config.Configer, error) {
func (c *configContainer) Sub(key string) (config.Configer, error) {
val, err := subTree(c.t, strings.Split(key, keySeparator))
if err != nil {
return nil, err
@ -307,12 +306,12 @@ func (c *configContainer) Sub(ctx context.Context, key string) (config.Configer,
}
// OnChange do nothing
func (c *configContainer) OnChange(ctx context.Context, key string, fn func(value string)) {
func (c *configContainer) OnChange(key string, fn func(value string)) {
// do nothing
}
// SaveConfigFile create or override the file
func (c *configContainer) SaveConfigFile(ctx context.Context, filename string) error {
func (c *configContainer) SaveConfigFile(filename string) error {
// Write configuration file by filename.
f, err := os.Create(filename)
if err != nil {

83
core/config/toml/toml_test.go
View File

@ -15,7 +15,6 @@
package toml
import (
"context"
"fmt"
"os"
"testing"
@ -52,11 +51,11 @@ Woman="true"
assert.Nil(t, err)
assert.NotNil(t, c)
val, err := c.Bool(context.Background(), "Man")
val, err := c.Bool("Man")
assert.Nil(t, err)
assert.True(t, val)
_, err = c.Bool(context.Background(), "Woman")
_, err = c.Bool("Woman")
assert.NotNil(t, err)
assert.Equal(t, config.InvalidValueTypeError, err)
}
@ -71,13 +70,13 @@ Woman="false"
assert.Nil(t, err)
assert.NotNil(t, c)
val := c.DefaultBool(context.Background(), "Man11", true)
val := c.DefaultBool("Man11", true)
assert.True(t, val)
val = c.DefaultBool(context.Background(), "Man", false)
val = c.DefaultBool("Man", false)
assert.True(t, val)
val = c.DefaultBool(context.Background(), "Woman", true)
val = c.DefaultBool("Woman", true)
assert.True(t, val)
}
@ -91,13 +90,13 @@ PriceInvalid="12.3"
assert.Nil(t, err)
assert.NotNil(t, c)
val := c.DefaultFloat(context.Background(), "Price", 11.2)
val := c.DefaultFloat("Price", 11.2)
assert.Equal(t, 12.3, val)
val = c.DefaultFloat(context.Background(), "Price11", 11.2)
val = c.DefaultFloat("Price11", 11.2)
assert.Equal(t, 11.2, val)
val = c.DefaultFloat(context.Background(), "PriceInvalid", 11.2)
val = c.DefaultFloat("PriceInvalid", 11.2)
assert.Equal(t, 11.2, val)
}
@ -111,13 +110,13 @@ AgeInvalid="13"
assert.Nil(t, err)
assert.NotNil(t, c)
val := c.DefaultInt(context.Background(), "Age", 11)
val := c.DefaultInt("Age", 11)
assert.Equal(t, 12, val)
val = c.DefaultInt(context.Background(), "Price11", 11)
val = c.DefaultInt("Price11", 11)
assert.Equal(t, 11, val)
val = c.DefaultInt(context.Background(), "PriceInvalid", 11)
val = c.DefaultInt("PriceInvalid", 11)
assert.Equal(t, 11, val)
}
@ -131,13 +130,13 @@ NameInvalid=13
assert.Nil(t, err)
assert.NotNil(t, c)
val := c.DefaultString(context.Background(), "Name", "Jerry")
val := c.DefaultString("Name", "Jerry")
assert.Equal(t, "Tom", val)
val = c.DefaultString(context.Background(), "Name11", "Jerry")
val = c.DefaultString("Name11", "Jerry")
assert.Equal(t, "Jerry", val)
val = c.DefaultString(context.Background(), "NameInvalid", "Jerry")
val = c.DefaultString("NameInvalid", "Jerry")
assert.Equal(t, "Jerry", val)
}
@ -151,13 +150,13 @@ NameInvalid="Tom"
assert.Nil(t, err)
assert.NotNil(t, c)
val := c.DefaultStrings(context.Background(), "Name", []string{"Jerry"})
val := c.DefaultStrings("Name", []string{"Jerry"})
assert.Equal(t, []string{"Tom", "Jerry"}, val)
val = c.DefaultStrings(context.Background(), "Name11", []string{"Jerry"})
val = c.DefaultStrings("Name11", []string{"Jerry"})
assert.Equal(t, []string{"Jerry"}, val)
val = c.DefaultStrings(context.Background(), "NameInvalid", []string{"Jerry"})
val = c.DefaultStrings("NameInvalid", []string{"Jerry"})
assert.Equal(t, []string{"Jerry"}, val)
}
@ -170,7 +169,7 @@ Name=["Tom", "Jerry"]
assert.Nil(t, err)
assert.NotNil(t, c)
_, err = c.DIY(context.Background(), "Name")
_, err = c.DIY("Name")
assert.Nil(t, err)
}
@ -184,14 +183,14 @@ PriceInvalid="12.3"
assert.Nil(t, err)
assert.NotNil(t, c)
val, err := c.Float(context.Background(), "Price")
val, err := c.Float("Price")
assert.Nil(t, err)
assert.Equal(t, 12.3, val)
_, err = c.Float(context.Background(), "Price11")
_, err = c.Float("Price11")
assert.Equal(t, config.KeyNotFoundError, err)
_, err = c.Float(context.Background(), "PriceInvalid")
_, err = c.Float("PriceInvalid")
assert.Equal(t, config.InvalidValueTypeError, err)
}
@ -205,14 +204,14 @@ AgeInvalid="13"
assert.Nil(t, err)
assert.NotNil(t, c)
val, err := c.Int(context.Background(), "Age")
val, err := c.Int("Age")
assert.Nil(t, err)
assert.Equal(t, 12, val)
_, err = c.Int(context.Background(), "Age11")
_, err = c.Int("Age11")
assert.Equal(t, config.KeyNotFoundError, err)
_, err = c.Int(context.Background(), "AgeInvalid")
_, err = c.Int("AgeInvalid")
assert.Equal(t, config.InvalidValueTypeError, err)
}
@ -234,7 +233,7 @@ func TestConfigContainer_GetSection(t *testing.T) {
assert.Nil(t, err)
assert.NotNil(t, c)
m, err := c.GetSection(context.Background(), "servers")
m, err := c.GetSection("servers")
assert.Nil(t, err)
assert.NotNil(t, m)
assert.Equal(t, 2, len(m))
@ -252,17 +251,17 @@ Name="Jerry"
assert.Nil(t, err)
assert.NotNil(t, c)
val, err := c.String(context.Background(), "Name")
val, err := c.String("Name")
assert.Nil(t, err)
assert.Equal(t, "Tom", val)
_, err = c.String(context.Background(), "Name11")
_, err = c.String("Name11")
assert.Equal(t, config.KeyNotFoundError, err)
_, err = c.String(context.Background(), "NameInvalid")
_, err = c.String("NameInvalid")
assert.Equal(t, config.InvalidValueTypeError, err)
val, err = c.String(context.Background(), "Person.Name")
val, err = c.String("Person.Name")
assert.Nil(t, err)
assert.Equal(t, "Jerry", val)
}
@ -277,14 +276,14 @@ NameInvalid="Tom"
assert.Nil(t, err)
assert.NotNil(t, c)
val, err := c.Strings(context.Background(), "Name")
val, err := c.Strings("Name")
assert.Nil(t, err)
assert.Equal(t, []string{"Tom", "Jerry"}, val)
_, err = c.Strings(context.Background(), "Name11")
_, err = c.Strings("Name11")
assert.Equal(t, config.KeyNotFoundError, err)
_, err = c.Strings(context.Background(), "NameInvalid")
_, err = c.Strings("NameInvalid")
assert.Equal(t, config.InvalidValueTypeError, err)
}
@ -298,9 +297,9 @@ NameInvalid="Tom"
assert.Nil(t, err)
assert.NotNil(t, c)
err = c.Set(context.Background(), "Age", "11")
err = c.Set("Age", "11")
assert.Nil(t, err)
age, err := c.String(context.Background(), "Age")
age, err := c.String("Age")
assert.Nil(t, err)
assert.Equal(t, "11", age)
}
@ -323,24 +322,24 @@ func TestConfigContainer_SubAndMushall(t *testing.T) {
assert.Nil(t, err)
assert.NotNil(t, c)
sub, err := c.Sub(context.Background(), "servers")
sub, err := c.Sub("servers")
assert.Nil(t, err)
assert.NotNil(t, sub)
sub, err = sub.Sub(context.Background(), "alpha")
sub, err = sub.Sub("alpha")
assert.Nil(t, err)
assert.NotNil(t, sub)
ip, err := sub.String(context.Background(), "ip")
ip, err := sub.String("ip")
assert.Nil(t, err)
assert.Equal(t, "10.0.0.1", ip)
svr := &Server{}
err = sub.Unmarshaler(context.Background(), "", svr)
err = sub.Unmarshaler("", svr)
assert.Nil(t, err)
assert.Equal(t, "10.0.0.1", svr.Ip)
svr = &Server{}
err = c.Unmarshaler(context.Background(), "servers.alpha", svr)
err = c.Unmarshaler("servers.alpha", svr)
assert.Nil(t, err)
assert.Equal(t, "10.0.0.1", svr.Ip)
}
@ -368,10 +367,10 @@ func TestConfigContainer_SaveConfigFile(t *testing.T) {
assert.Nil(t, err)
assert.NotNil(t, c)
sub, err := c.Sub(context.Background(), "servers")
sub, err := c.Sub("servers")
assert.Nil(t, err)
err = sub.SaveConfigFile(context.Background(), path)
err = sub.SaveConfigFile(path)
assert.Nil(t, err)
}