blackteay/gf
1
0
Fork 0
mirror of https://github.com/gogf/gf.git synced 2025-04-05 11:18:50 +08:00
Code Issues Projects Releases Wiki Activity

add gcmd.GetWithEnv/genv.GetWithCmd; remove package cmdenv;

Browse Source
This commit is contained in:
John Guo 2020-12-04 23:44:54 +08:00
parent c226782f23
commit d2b65f0f91
16 changed files with 114 additions and 103 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
database/gdb/gdb.go
View File

@ -12,7 +12,7 @@ import (
"database/sql"
"errors"
"fmt"
"github.com/gogf/gf/internal/cmdenv"
"github.com/gogf/gf/os/gcmd"
"time"
"github.com/gogf/gf/container/gvar"
@ -287,7 +287,7 @@ var (
func init() {
// allDryRun is initialized from environment or command options.
allDryRun = cmdenv.Get("gf.gdb.dryrun", false).Bool()
allDryRun = gcmd.GetWithEnv("gf.gdb.dryrun", false).Bool()
}
// Register registers custom database driver to gdb.

40
internal/cmdenv/cmdenv.go
View File

@ -1,40 +0,0 @@
// Copyright 2019 gf Author(https://github.com/gogf/gf). All Rights Reserved.
//
// This Source Code Form is subject to the terms of the MIT License.
// If a copy of the MIT was not distributed with this file,
// You can obtain one at https://github.com/gogf/gf.
// Package cmdenv provides access to certain variable for both command options and environment.
package cmdenv
import (
"github.com/gogf/gf/os/gcmd"
"os"
"strings"
"github.com/gogf/gf/container/gvar"
)
// Get returns the command line argument of the specified <key>.
// If the argument does not exist, then it returns the environment variable with specified <key>.
// It returns the default value <def> if none of them exists.
//
// Fetching Rules:
// 1. Command line arguments are in lowercase format, eg: gf.<package name>.<variable name>;
// 2. Environment arguments are in uppercase format, eg: GF_<package name>_<variable name>；
func Get(key string, def ...interface{}) *gvar.Var {
value := interface{}(nil)
if len(def) > 0 {
value = def[0]
}
cmdKey := strings.ToLower(strings.Replace(key, "_", ".", -1))
if v := gcmd.GetOpt(cmdKey); v != "" {
value = v
} else {
envKey := strings.ToUpper(strings.Replace(key, ".", "_", -1))
if v := os.Getenv(envKey); v != "" {
value = v
}
}
return gvar.New(value)
}

28
internal/cmdenv/cmdenv_test.go
View File

@ -1,28 +0,0 @@
// Copyright 2017 gf Author(https://github.com/gogf/gf). All Rights Reserved.
//
// This Source Code Form is subject to the terms of the MIT License.
// If a copy of the MIT was not distributed with this file,
// You can obtain one at https://github.com/gogf/gf.
// go test *.go -bench=".*" -benchmem
package cmdenv
import (
"os"
"testing"
"github.com/gogf/gf/test/gtest"
)
func Test_Get(t *testing.T) {
os.Args = []string{"--gf.test.value1=111"}
os.Setenv("GF_TEST_VALUE1", "222")
os.Setenv("GF_TEST_VALUE2", "333")
gtest.C(t, func(t *gtest.T) {
t.Assert(Get("gf.test.value1").String(), "111")
t.Assert(Get("gf.test.value2").String(), "333")
t.Assert(Get("gf.test.value3").String(), "")
t.Assert(Get("gf.test.value3", 1).String(), "1")
})
}

4
internal/intlog/intlog.go
View File

@ -10,7 +10,7 @@ package intlog
import (
"fmt"
"github.com/gogf/gf/debug/gdebug"
"github.com/gogf/gf/internal/cmdenv"
"github.com/gogf/gf/os/gcmd"
"path/filepath"
"time"
)
@ -26,7 +26,7 @@ var (
func init() {
// Debugging configured.
if !cmdenv.Get("GF_DEBUG").IsEmpty() {
if !gcmd.GetWithEnv("GF_DEBUG").IsEmpty() {
isGFDebug = true
return
}

4
os/gcfg/gcfg.go
View File

@ -11,6 +11,7 @@ import (
"bytes"
"errors"
"fmt"
"github.com/gogf/gf/os/gcmd"
"github.com/gogf/gf/text/gstr"
"github.com/gogf/gf/os/gres"
@ -18,7 +19,6 @@ import (
"github.com/gogf/gf/container/garray"
"github.com/gogf/gf/container/gmap"
"github.com/gogf/gf/encoding/gjson"
"github.com/gogf/gf/internal/cmdenv"
"github.com/gogf/gf/os/gfile"
"github.com/gogf/gf/os/gfsnotify"
"github.com/gogf/gf/os/glog"
@ -55,7 +55,7 @@ func New(file ...string) *Config {
jsons: gmap.NewStrAnyMap(true),
}
// Customized dir path from env/cmd.
if envPath := cmdenv.Get(fmt.Sprintf("%s.path", gCMDENV_KEY)).String(); envPath != "" {
if envPath := gcmd.GetWithEnv(fmt.Sprintf("%s.path", gCMDENV_KEY)).String(); envPath != "" {
if gfile.Exists(envPath) {
_ = c.SetPath(envPath)
} else {

4
os/gcfg/gcfg_error.go
View File

@ -7,7 +7,7 @@
package gcfg
import (
"github.com/gogf/gf/internal/cmdenv"
"github.com/gogf/gf/os/gcmd"
)
const (
@ -18,5 +18,5 @@ const (
// errorPrint checks whether printing error to stdout.
func errorPrint() bool {
return cmdenv.Get(gERROR_PRINT_KEY, true).Bool()
return gcmd.GetWithEnv(gERROR_PRINT_KEY, true).Bool()
}

25
os/gcmd/gcmd.go
View File

@ -10,6 +10,7 @@ package gcmd
import (
"os"
"strings"
"github.com/gogf/gf/container/gvar"
@ -113,6 +114,30 @@ func GetArgAll() []string {
return defaultParsedArgs
}
// GetWithEnv returns the command line argument of the specified <key>.
// If the argument does not exist, then it returns the environment variable with specified <key>.
// It returns the default value <def> if none of them exists.
//
// Fetching Rules:
// 1. Command line arguments are in lowercase format, eg: gf.<package name>.<variable name>;
// 2. Environment arguments are in uppercase format, eg: GF_<package name>_<variable name>；
func GetWithEnv(key string, def ...interface{}) *gvar.Var {
value := interface{}(nil)
if len(def) > 0 {
value = def[0]
}
cmdKey := strings.ToLower(strings.Replace(key, "_", ".", -1))
if v := GetOpt(cmdKey); v != "" {
value = v
} else {
envKey := strings.ToUpper(strings.Replace(key, ".", "_", -1))
if v := os.Getenv(envKey); v != "" {
value = v
}
}
return gvar.New(value)
}
// BuildOptions builds the options as string.
func BuildOptions(m map[string]string, prefix ...string) string {
options := ""

15
os/gcmd/gcmd_z_unit_default_test.go
View File

@ -9,6 +9,7 @@
package gcmd_test
import (
"github.com/gogf/gf/os/genv"
"testing"
"github.com/gogf/gf/frame/g"
@ -47,3 +48,17 @@ func Test_BuildOptions(t *testing.T) {
t.Assert(s, "-testn=john")
})
}
func Test_GetWithEnv(t *testing.T) {
gtest.C(t, func(t *gtest.T) {
genv.Set("TEST", "1")
defer genv.Remove("TEST")
t.Assert(gcmd.GetWithEnv("test"), 1)
})
gtest.C(t, func(t *gtest.T) {
genv.Set("TEST", "1")
defer genv.Remove("TEST")
gcmd.Init("-test", "2")
t.Assert(gcmd.GetWithEnv("test"), 2)
})
}

49
os/genv/genv.go
View File

@ -1,4 +1,4 @@
// Copyright 2017-2019 gf Author(https://github.com/gogf/gf). All Rights Reserved.
// Copyright GoFrame Author(https://github.com/gogf/gf). All Rights Reserved.
//
// This Source Code Form is subject to the terms of the MIT License.
// If a copy of the MIT was not distributed with this file,
@ -9,6 +9,7 @@ package genv
import (
"github.com/gogf/gf/container/gvar"
"github.com/gogf/gf/os/gcmd"
"os"
)
import "strings"
@ -63,17 +64,6 @@ func Contains(key string) bool {
return ok
}
// Build builds a map to a environment variable slice.
func Build(m map[string]string) []string {
array := make([]string, len(m))
index := 0
for k, v := range m {
array[index] = k + "=" + v
index++
}
return array
}
// Remove deletes one or more environment variables.
func Remove(key ...string) error {
var err error
@ -85,3 +75,38 @@ func Remove(key ...string) error {
}
return nil
}
// GetWithCmd returns the environment value specified <key>.
// If the environment value does not exist, then it retrieves and returns the value from command line options.
// It returns the default value <def> if none of them exists.
//
// Fetching Rules:
// 1. Environment arguments are in uppercase format, eg: GF_<package name>_<variable name>；
// 2. Command line arguments are in lowercase format, eg: gf.<package name>.<variable name>;
func GetWithCmd(key string, def ...interface{}) *gvar.Var {
value := interface{}(nil)
if len(def) > 0 {
value = def[0]
}
envKey := strings.ToUpper(strings.Replace(key, ".", "_", -1))
if v := os.Getenv(envKey); v != "" {
value = v
} else {
cmdKey := strings.ToLower(strings.Replace(key, "_", ".", -1))
if v := gcmd.GetOpt(cmdKey); v != "" {
value = v
}
}
return gvar.New(value)
}
// Build builds a map to a environment variable slice.
func Build(m map[string]string) []string {
array := make([]string, len(m))
index := 0
for k, v := range m {
array[index] = k + "=" + v
index++
}
return array
}

16
os/genv/genv_test.go
View File

@ -1,4 +1,4 @@
// Copyright 2017-2019 gf Author(https://github.com/gogf/gf). All Rights Reserved.
// Copyright GoFrame Author(https://github.com/gogf/gf). All Rights Reserved.
//
// This Source Code Form is subject to the terms of the MIT License.
// If a copy of the MIT was not distributed with this file,
@ -7,6 +7,7 @@
package genv_test
import (
"github.com/gogf/gf/os/gcmd"
"os"
"testing"
@ -85,3 +86,16 @@ func Test_GEnv_Remove(t *testing.T) {
t.AssertEQ(os.Getenv(key), "")
})
}
func Test_GetWithCmd(t *testing.T) {
gtest.C(t, func(t *gtest.T) {
gcmd.Init("-test", "2")
t.Assert(genv.GetWithCmd("TEST"), 2)
})
gtest.C(t, func(t *gtest.T) {
genv.Set("TEST", "1")
defer genv.Remove("TEST")
gcmd.Init("-test", "2")
t.Assert(genv.GetWithCmd("test"), 1)
})
}

4
os/gfile/gfile_cache.go
View File

@ -7,8 +7,8 @@
package gfile
import (
"github.com/gogf/gf/internal/cmdenv"
"github.com/gogf/gf/os/gcache"
"github.com/gogf/gf/os/gcmd"
"github.com/gogf/gf/os/gfsnotify"
"time"
)
@ -20,7 +20,7 @@ const (
var (
// Default expire time for file content caching.
cacheExpire = cmdenv.Get("gf.gfile.cache", gDEFAULT_CACHE_EXPIRE).Duration()
cacheExpire = gcmd.GetWithEnv("gf.gfile.cache", gDEFAULT_CACHE_EXPIRE).Duration()
// internalCache is the memory cache for internal usage.
internalCache = gcache.New()

4
os/glog/glog.go
View File

@ -8,7 +8,7 @@
package glog
import (
"github.com/gogf/gf/internal/cmdenv"
"github.com/gogf/gf/os/gcmd"
"github.com/gogf/gf/os/grpool"
)
@ -26,7 +26,7 @@ var (
)
func init() {
defaultDebug = cmdenv.Get("gf.glog.debug", true).Bool()
defaultDebug = gcmd.GetWithEnv("gf.glog.debug", true).Bool()
SetDebug(defaultDebug)
}

8
os/gtimer/gtimer.go
View File

@ -24,7 +24,7 @@ import (
"math"
"time"
"github.com/gogf/gf/internal/cmdenv"
"github.com/gogf/gf/os/gcmd"
)
const (
@ -42,9 +42,9 @@ const (
)
var (
defaultSlots = cmdenv.Get(fmt.Sprintf("%s.slots", gCMDENV_KEY), gDEFAULT_SLOT_NUMBER).Int()
defaultLevel = cmdenv.Get(fmt.Sprintf("%s.level", gCMDENV_KEY), gDEFAULT_WHEEL_LEVEL).Int()
defaultInterval = cmdenv.Get(fmt.Sprintf("%s.interval", gCMDENV_KEY), gDEFAULT_WHEEL_INTERVAL).Duration() * time.Millisecond
defaultSlots = gcmd.GetWithEnv(fmt.Sprintf("%s.slots", gCMDENV_KEY), gDEFAULT_SLOT_NUMBER).Int()
defaultLevel = gcmd.GetWithEnv(fmt.Sprintf("%s.level", gCMDENV_KEY), gDEFAULT_WHEEL_LEVEL).Int()
defaultInterval = gcmd.GetWithEnv(fmt.Sprintf("%s.interval", gCMDENV_KEY), gDEFAULT_WHEEL_INTERVAL).Duration() * time.Millisecond
defaultTimer = New(defaultSlots, defaultInterval, defaultLevel)
)

4
os/gview/gview.go
View File

@ -16,7 +16,7 @@ import (
"github.com/gogf/gf"
"github.com/gogf/gf/container/garray"
"github.com/gogf/gf/internal/cmdenv"
"github.com/gogf/gf/os/gcmd"
"github.com/gogf/gf/os/gfile"
"github.com/gogf/gf/os/glog"
)
@ -71,7 +71,7 @@ func New(path ...string) *View {
}
} else {
// Customized dir path from env/cmd.
if envPath := cmdenv.Get("gf.gview.path").String(); envPath != "" {
if envPath := gcmd.GetWithEnv("gf.gview.path").String(); envPath != "" {
if gfile.Exists(envPath) {
if err := view.SetPath(envPath); err != nil {
intlog.Error(err)

4
os/gview/gview_error.go
View File

@ -7,7 +7,7 @@
package gview
import (
"github.com/gogf/gf/internal/cmdenv"
"github.com/gogf/gf/os/gcmd"
)
const (
@ -18,5 +18,5 @@ const (
// errorPrint checks whether printing error to stdout.
func errorPrint() bool {
return cmdenv.Get(gERROR_PRINT_KEY, true).Bool()
return gcmd.GetWithEnv(gERROR_PRINT_KEY, true).Bool()
}

4
util/gmode/gmode.go
View File

@ -11,7 +11,7 @@ package gmode
import (
"github.com/gogf/gf/debug/gdebug"
"github.com/gogf/gf/internal/cmdenv"
"github.com/gogf/gf/os/gcmd"
"github.com/gogf/gf/os/gfile"
)
@ -57,7 +57,7 @@ func SetProduct() {
func Mode() string {
// If current mode is not set, do this auto check.
if currentMode == NOT_SET {
if v := cmdenv.Get(gCMDENV_KEY).String(); v != "" {
if v := gcmd.GetWithEnv(gCMDENV_KEY).String(); v != "" {
// Mode configured from command argument of environment.
currentMode = v
} else {