unistack-org/micro-config-env
4
0
Fork 1
Code Issues Pull Requests Actions Packages Projects Releases 23 Wiki Activity

[v3] add time/duration parsing support (#122)
All checks were successful
test / test (push) Successful in 4m22s
Details

Browse Source 
* fix: add time parsing support
* changing tests and fixing override
This commit is contained in:
kukasaurs
2025-09-04 15:49:16 +05:00
committed by GitHub
parent bd465fdb70
commit 2cab7ddad2
4 changed files with 439 additions and 29 deletions
Download Patch File Download Diff File Expand all files Collapse all files

334
env_test.go
View File

@@ -6,6 +6,7 @@ import (
"testing"
"time"
"github.com/stretchr/testify/require"
"go.unistack.org/micro/v3/config"
rutil "go.unistack.org/micro/v3/util/reflect"
)
@@ -238,3 +239,336 @@ func TestLoadMultiple(t *testing.T) {
}
}
}
func TestEnv_SupportedTypes(t *testing.T) {
type Config struct {
IntValue int `env:"INT_VALUE"`
Int8Value int8 `env:"INT8_VALUE"`
Int16Value int16 `env:"INT16_VALUE"`
Int32Value int32 `env:"INT32_VALUE"`
Int64Value int64 `env:"INT64_VALUE"`
UintValue uint `env:"UINT_VALUE"`
Uint8Value uint8 `env:"UINT8_VALUE"`
Uint16Value uint16 `env:"UINT16_VALUE"`
Uint32Value uint32 `env:"UINT32_VALUE"`
Uint64Value uint64 `env:"UINT64_VALUE"`
Float32Value float32 `env:"FLOAT32_VALUE"`
Float64Value float64 `env:"FLOAT64_VALUE"`
BoolValue bool `env:"BOOL_VALUE"`
StringValue string `env:"STRING_VALUE"`
StringSlice []string `env:"STRING_SLICE"`
IntSlice []int `env:"INT_SLICE"`
MapStringValue map[string]string `env:"MAP_STRING"`
MapIntValue map[string]int `env:"MAP_INT"`
DurationValue time.Duration `env:"DURATION_VALUE"`
TimeValue time.Time `env:"TIME_VALUE"`
TimePtrValue *time.Time `env:"TIME_PTR_VALUE"`
}
tests := []struct {
name string
envVar string
envVal string
want func() *Config
}{
// integers
{
name: "int type",
envVar: "INT_VALUE",
envVal: "100",
want: func() *Config { return &Config{IntValue: 100} },
},
{
name: "int8 type",
envVar: "INT8_VALUE",
envVal: "127",
want: func() *Config { return &Config{Int8Value: 127} },
},
{
name: "int16 type",
envVar: "INT16_VALUE",
envVal: "32767",
want: func() *Config { return &Config{Int16Value: 32767} },
},
{
name: "int32 type",
envVar: "INT32_VALUE",
envVal: "2147483647",
want: func() *Config { return &Config{Int32Value: 2147483647} },
},
{
name: "int64 type",
envVar: "INT64_VALUE",
envVal: "9223372036854775807",
want: func() *Config { return &Config{Int64Value: 9223372036854775807} },
},
// unsigned integers
{
name: "uint type",
envVar: "UINT_VALUE",
envVal: "100",
want: func() *Config { return &Config{UintValue: 100} },
},
{
name: "uint8 type",
envVar: "UINT8_VALUE",
envVal: "255",
want: func() *Config { return &Config{Uint8Value: 255} },
},
{
name: "uint16 type",
envVar: "UINT16_VALUE",
envVal: "65535",
want: func() *Config { return &Config{Uint16Value: 65535} },
},
{
name: "uint32 type",
envVar: "UINT32_VALUE",
envVal: "4294967295",
want: func() *Config { return &Config{Uint32Value: 4294967295} },
},
{
name: "uint64 type",
envVar: "UINT64_VALUE",
envVal: "18446744073709551615",
want: func() *Config { return &Config{Uint64Value: 18446744073709551615} },
},
// floats
{
name: "float32 type",
envVar: "FLOAT32_VALUE",
envVal: "3.14159",
want: func() *Config { return &Config{Float32Value: 3.14159} },
},
{
name: "float64 type",
envVar: "FLOAT64_VALUE",
envVal: "3.141592653589793",
want: func() *Config { return &Config{Float64Value: 3.141592653589793} },
},
// bool
{
name: "bool true",
envVar: "BOOL_VALUE",
envVal: "true",
want: func() *Config { return &Config{BoolValue: true} },
},
{
name: "bool false",
envVar: "BOOL_VALUE",
envVal: "false",
want: func() *Config { return &Config{BoolValue: false} },
},
{
name: "bool 1",
envVar: "BOOL_VALUE",
envVal: "1",
want: func() *Config { return &Config{BoolValue: true} },
},
{
name: "bool 0",
envVar: "BOOL_VALUE",
envVal: "0",
want: func() *Config { return &Config{BoolValue: false} },
},
// string
{
name: "string type",
envVar: "STRING_VALUE",
envVal: "hello world",
want: func() *Config { return &Config{StringValue: "hello world"} },
},
// slices
{
name: "string slice comma separated",
envVar: "STRING_SLICE",
envVal: "val1,val2,val3",
want: func() *Config { return &Config{StringSlice: []string{"val1", "val2", "val3"}} },
},
{
name: "string slice semicolon separated",
envVar: "STRING_SLICE",
envVal: "val1;val2;val3",
want: func() *Config { return &Config{StringSlice: []string{"val1", "val2", "val3"}} },
},
{
name: "int slice comma separated",
envVar: "INT_SLICE",
envVal: "1,2,3,4,5",
want: func() *Config { return &Config{IntSlice: []int{1, 2, 3, 4, 5}} },
},
{
name: "int slice semicolon separated",
envVar: "INT_SLICE",
envVal: "1;2;3;4;5",
want: func() *Config { return &Config{IntSlice: []int{1, 2, 3, 4, 5}} },
},
// maps
{
name: "string map",
envVar: "MAP_STRING",
envVal: "key1=val1,key2=val2",
want: func() *Config {
return &Config{MapStringValue: map[string]string{"key1": "val1", "key2": "val2"}}
},
},
{
name: "int map",
envVar: "MAP_INT",
envVal: "key1=1,key2=2",
want: func() *Config {
return &Config{MapIntValue: map[string]int{"key1": 1, "key2": 2}}
},
},
// time && duration
{
name: "duration type",
envVar: "DURATION_VALUE",
envVal: "15m30s",
want: func() *Config { return &Config{DurationValue: 15*time.Minute + 30*time.Second} },
},
{
name: "time type RFC3339",
envVar: "TIME_VALUE",
envVal: "2025-08-28T15:04:05Z",
want: func() *Config {
return &Config{TimeValue: time.Date(2025, 8, 28, 15, 4, 5, 0, time.UTC)}
},
},
{
name: "time type RFC3339",
envVar: "TIME_PTR_VALUE",
envVal: "2025-08-28T15:04:05Z",
want: func() *Config {
timeValue := time.Date(2025, 8, 28, 15, 4, 5, 0, time.UTC)
return &Config{TimePtrValue: &timeValue}
},
},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
require.NoError(t, os.Setenv(tt.envVar, tt.envVal))
defer os.Unsetenv(tt.envVar)
cfgData := &Config{}
cfg := NewConfig(config.Struct(cfgData))
require.NoError(t, cfg.Init())
require.NoError(t, cfg.Load(context.Background()))
require.Equal(t, tt.want(), cfgData)
})
}
}
func TestEnv_TimeType_Override(t *testing.T) {
type Config struct {
TimeValue time.Time `env:"TIME"`
}
tests := []struct {
name string
cfg *Config
envVar string
envVal string
want *Config
}{
{
name: "init value is empty",
cfg: &Config{},
envVar: "TIME",
envVal: "2025-08-28T15:04:05Z",
want: &Config{
TimeValue: time.Date(2025, 8, 28, 15, 4, 5, 0, time.UTC),
},
},
{
name: "init value is not empty",
cfg: &Config{
TimeValue: time.Date(2025, 5, 25, 15, 5, 5, 5, time.UTC),
},
envVar: "TIME",
envVal: "2025-08-28T15:04:05Z",
want: &Config{
TimeValue: time.Date(2025, 8, 28, 15, 4, 5, 0, time.UTC),
},
},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
require.NoError(t, os.Setenv(tt.envVar, tt.envVal))
defer os.Unsetenv(tt.envVar)
cfg := NewConfig(config.Struct(tt.cfg))
require.NoError(t, cfg.Init())
require.NoError(t, cfg.Load(context.Background(), config.LoadOverride(true)))
require.Equal(t, tt.want, tt.cfg)
})
}
}
func TestEnv_TimePointerType_Override(t *testing.T) {
type Config struct {
TimeValue *time.Time `env:"TIME"`
}
tests := []struct {
name string
cfg func() *Config
envVar string
envVal string
want func() *Config
}{
{
name: "init value is empty",
cfg: func() *Config { return &Config{} },
envVar: "TIME",
envVal: "2025-08-28T15:04:05Z",
want: func() *Config {
timeValue := time.Date(2025, 8, 28, 15, 4, 5, 0, time.UTC)
return &Config{
TimeValue: &timeValue,
}
},
},
{
name: "init value is not empty",
cfg: func() *Config {
timeValue := time.Date(2025, 5, 25, 15, 5, 5, 5, time.UTC)
return &Config{
TimeValue: &timeValue,
}
},
envVar: "TIME",
envVal: "2025-08-28T15:04:05Z",
want: func() *Config {
timeValue := time.Date(2025, 8, 28, 15, 4, 5, 0, time.UTC)
return &Config{
TimeValue: &timeValue,
}
},
},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
require.NoError(t, os.Setenv(tt.envVar, tt.envVal))
defer os.Unsetenv(tt.envVar)
cfgData := tt.cfg()
cfg := NewConfig(config.Struct(cfgData))
require.NoError(t, cfg.Init())
require.NoError(t, cfg.Load(context.Background(), config.LoadOverride(true)))
require.Equal(t, tt.want(), cfgData)
})
}
}