opensource/grafana
1
0
Fork 0
mirror of https://github.com/grafana/grafana.git synced 2025-08-03 01:32:13 +08:00
Code Issues Packages Projects Releases Wiki Activity

Tests: use t.Setenv to set env vars (#69516)

Browse Source 
This commit replaces `os.Setenv` with `t.Setenv` in tests. The
environment variable is automatically restored to its original value
when the test and all its subtests complete.

Reference: https://pkg.go.dev/testing#T.Setenv

Signed-off-by: Eng Zer Jun <engzerjun@gmail.com>
This commit is contained in:
Eng Zer Jun
2023-06-05 17:31:03 +08:00
committed by GitHub
parent 4c794fe8b9
commit cf1945d0c3
13 changed files with 35 additions and 98 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
pkg/setting/dynamic_settings_test.go
View File

@ -1,7 +1,6 @@
package setting
import (
"os"
"testing"
"github.com/stretchr/testify/require"
@ -14,12 +13,7 @@ func TestDynamicSettingsSupport_Override(t *testing.T) {
keyName := "bar"
expected := "dynamic value"
err := os.Setenv(envKey, expected)
require.NoError(t, err)
defer func() {
err := os.Unsetenv(envKey)
require.NoError(t, err)
}()
t.Setenv(envKey, expected)
value := cfg.SectionWithEnvOverrides(sectionName).Key(keyName).MustString("default value")
require.Equal(t, expected, value)

3
pkg/setting/expanders_test.go
View File

@ -14,8 +14,7 @@ import (
func TestExpandVar_EnvSuccessful(t *testing.T) {
const key = "GF_TEST_SETTING_EXPANDER_ENV"
const expected = "aurora borealis"
err := os.Setenv(key, expected)
require.NoError(t, err)
t.Setenv(key, expected)
// expanded format
{

33
pkg/setting/setting_test.go
View File

@ -64,11 +64,10 @@ func TestLoadingSettings(t *testing.T) {
})
t.Run("Should be able to override via environment variables", func(t *testing.T) {
err := os.Setenv("GF_SECURITY_ADMIN_USER", "superduper")
require.NoError(t, err)
t.Setenv("GF_SECURITY_ADMIN_USER", "superduper")
cfg := NewCfg()
err = cfg.Load(CommandLineArgs{HomePath: "../../"})
err := cfg.Load(CommandLineArgs{HomePath: "../../"})
require.Nil(t, err)
require.Equal(t, "superduper", cfg.AdminUser)
@ -77,22 +76,20 @@ func TestLoadingSettings(t *testing.T) {
})
t.Run("Should replace password when defined in environment", func(t *testing.T) {
err := os.Setenv("GF_SECURITY_ADMIN_PASSWORD", "supersecret")
require.NoError(t, err)
t.Setenv("GF_SECURITY_ADMIN_PASSWORD", "supersecret")
cfg := NewCfg()
err = cfg.Load(CommandLineArgs{HomePath: "../../"})
err := cfg.Load(CommandLineArgs{HomePath: "../../"})
require.Nil(t, err)
require.Contains(t, appliedEnvOverrides, "GF_SECURITY_ADMIN_PASSWORD=*********")
})
t.Run("Should replace password in URL when url environment is defined", func(t *testing.T) {
err := os.Setenv("GF_DATABASE_URL", "mysql://user:secret@localhost:3306/database")
require.NoError(t, err)
t.Setenv("GF_DATABASE_URL", "mysql://user:secret@localhost:3306/database")
cfg := NewCfg()
err = cfg.Load(CommandLineArgs{HomePath: "../../"})
err := cfg.Load(CommandLineArgs{HomePath: "../../"})
require.Nil(t, err)
require.Contains(t, appliedEnvOverrides, "GF_DATABASE_URL=mysql://user:xxxxx@localhost:3306/database")
@ -208,10 +205,9 @@ func TestLoadingSettings(t *testing.T) {
t.Run("Can use environment variables in config values", func(t *testing.T) {
if runtime.GOOS == windows {
err := os.Setenv("GF_DATA_PATH", `c:\tmp\env_override`)
require.NoError(t, err)
t.Setenv("GF_DATA_PATH", `c:\tmp\env_override`)
cfg := NewCfg()
err = cfg.Load(CommandLineArgs{
err := cfg.Load(CommandLineArgs{
HomePath: "../../",
Args: []string{"cfg:paths.data=${GF_DATA_PATH}"},
})
@ -219,10 +215,9 @@ func TestLoadingSettings(t *testing.T) {
require.Equal(t, `c:\tmp\env_override`, cfg.DataPath)
} else {
err := os.Setenv("GF_DATA_PATH", "/tmp/env_override")
require.NoError(t, err)
t.Setenv("GF_DATA_PATH", "/tmp/env_override")
cfg := NewCfg()
err = cfg.Load(CommandLineArgs{
err := cfg.Load(CommandLineArgs{
HomePath: "../../",
Args: []string{"cfg:paths.data=${GF_DATA_PATH}"},
})
@ -282,12 +277,10 @@ func TestLoadingSettings(t *testing.T) {
})
t.Run("grafana.com API URL can be set separately from grafana.com URL", func(t *testing.T) {
err := os.Setenv("GF_GRAFANA_NET_URL", "https://grafana-dev.com")
require.NoError(t, err)
err = os.Setenv("GF_GRAFANA_COM_API_URL", "http://grafana-dev.internal/api")
require.NoError(t, err)
t.Setenv("GF_GRAFANA_NET_URL", "https://grafana-dev.com")
t.Setenv("GF_GRAFANA_COM_API_URL", "http://grafana-dev.internal/api")
cfg := NewCfg()
err = cfg.Load(CommandLineArgs{HomePath: "../../", Config: "../../conf/defaults.ini"})
err := cfg.Load(CommandLineArgs{HomePath: "../../", Config: "../../conf/defaults.ini"})
require.Nil(t, err)
require.Equal(t, "https://grafana-dev.com", cfg.GrafanaComURL)
require.Equal(t, "http://grafana-dev.internal/api", cfg.GrafanaComAPIURL)