Upstream
/
harbor
mirror of https://github.com/goharbor/harbor.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

test: use `T.Setenv` to set env vars in tests (#17670) 

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>

Signed-off-by: Eng Zer Jun <engzerjun@gmail.com>
This commit is contained in:
Eng Zer Jun 2022-10-25 10:56:26 +08:00 committed by GitHub
parent 2295c0ac60
commit cd0fa06a32
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
13 changed files with 108 additions and 158 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

109
src/chartserver/utils_test.go
View File

@ -2,7 +2,6 @@ package chartserver
import (
"encoding/json"
"os"
"testing"
)
@ -70,59 +69,61 @@ func TestParseRedisConfig(t *testing.T) {
}
func TestGetCacheConfig(t *testing.T) {
// case 1: no cache set
cacheConf, err := getCacheConfig()
if err != nil || cacheConf != nil {
t.Fatal("expect nil cache config and nil error but got non-nil one when parsing empty cache settings")
}
// case 2: unknown cache type
os.Setenv(cacheDriverENVKey, "unknown")
_, err = getCacheConfig()
if err == nil {
t.Fatal("expect non-nil error but got nil one when parsing unknown cache type")
}
// case 3: in memory cache type
os.Setenv(cacheDriverENVKey, cacheDriverMem)
memCacheConf, err := getCacheConfig()
if err != nil || memCacheConf == nil || memCacheConf.DriverType != cacheDriverMem {
t.Fatal("expect in memory cache driver but got invalid one")
}
// case 4: wrong redis cache conf
os.Setenv(cacheDriverENVKey, cacheDriverRedis)
os.Setenv(redisENVKey, "")
_, err = getCacheConfig()
if err == nil {
t.Fatal("expect non-nil error but got nil one when parsing a invalid redis cache conf")
}
// case 5: redis cache conf
os.Setenv(redisENVKey, ":Passw0rd@redis:6379/1?idle_timeout_seconds=100")
redisConf, err := getCacheConfig()
if err != nil {
t.Fatalf("expect nil error but got non-nil one when parsing valid redis conf")
}
if redisConf == nil || redisConf.DriverType != cacheDriverRedis {
t.Fatal("expect redis cache driver but got invalid one")
}
conf := make(map[string]string)
if err = json.Unmarshal([]byte(redisConf.Config), &conf); err != nil {
t.Fatal(err)
}
if v, ok := conf["conn"]; !ok {
t.Fatal("expect 'conn' filed in the parsed conf but got nothing")
} else {
if v != "redis:6379" {
t.Fatalf("expect %s but got %s", "redis:6379", v)
t.Run("no cache set", func(t *testing.T) {
cacheConf, err := getCacheConfig()
if err != nil || cacheConf != nil {
t.Fatal("expect nil cache config and nil error but got non-nil one when parsing empty cache settings")
}
}
})
// clear
os.Unsetenv(cacheDriverENVKey)
os.Unsetenv(redisENVKey)
t.Run("unknown cache type", func(t *testing.T) {
t.Setenv(cacheDriverENVKey, "unknown")
_, err := getCacheConfig()
if err == nil {
t.Fatal("expect non-nil error but got nil one when parsing unknown cache type")
}
})
t.Run("in memory cache type", func(t *testing.T) {
t.Setenv(cacheDriverENVKey, cacheDriverMem)
memCacheConf, err := getCacheConfig()
if err != nil || memCacheConf == nil || memCacheConf.DriverType != cacheDriverMem {
t.Fatal("expect in memory cache driver but got invalid one")
}
})
t.Run("wrong redis cache conf", func(t *testing.T) {
t.Setenv(cacheDriverENVKey, cacheDriverRedis)
t.Setenv(redisENVKey, "")
_, err := getCacheConfig()
if err == nil {
t.Fatal("expect non-nil error but got nil one when parsing a invalid redis cache conf")
}
})
t.Run("redis cache conf", func(t *testing.T) {
t.Setenv(cacheDriverENVKey, cacheDriverRedis)
t.Setenv(redisENVKey, ":Passw0rd@redis:6379/1?idle_timeout_seconds=100")
redisConf, err := getCacheConfig()
if err != nil {
t.Fatalf("expect nil error but got non-nil one when parsing valid redis conf")
}
if redisConf == nil || redisConf.DriverType != cacheDriverRedis {
t.Fatal("expect redis cache driver but got invalid one")
}
conf := make(map[string]string)
if err = json.Unmarshal([]byte(redisConf.Config), &conf); err != nil {
t.Fatal(err)
}
if v, ok := conf["conn"]; !ok {
t.Fatal("expect 'conn' filed in the parsed conf but got nothing")
} else {
if v != "redis:6379" {
t.Fatalf("expect %s but got %s", "redis:6379", v)
}
}
})
}

2
src/controller/robot/controller_test.go
View File

@ -90,7 +90,7 @@ func (suite *ControllerTestSuite) TestCreate() {
_, err := test.GenerateKey(secretKeyPath)
suite.Nil(err)
defer os.Remove(secretKeyPath)
os.Setenv("KEY_PATH", secretKeyPath)
suite.T().Setenv("KEY_PATH", secretKeyPath)
conf := map[string]interface{}{
common.RobotTokenDuration: "30",

3
src/jobservice/api/handler_test.go
View File

@ -55,7 +55,7 @@ type APIHandlerTestSuite struct {
// SetupSuite prepares test suite
func (suite *APIHandlerTestSuite) SetupSuite() {
_ = os.Setenv(secretKey, fakeSecret)
suite.T().Setenv(secretKey, fakeSecret)
suite.client = &http.Client{
Timeout: 10 * time.Second,
@ -76,7 +76,6 @@ func (suite *APIHandlerTestSuite) SetupSuite() {
// TearDownSuite clears test suite
func (suite *APIHandlerTestSuite) TearDownSuite() {
_ = os.Unsetenv(secretKey)
_ = suite.server.Stop()
suite.cancel()
}

4
src/jobservice/common/utils/utils_test.go
View File

@ -16,7 +16,6 @@
package utils
import (
"os"
"testing"
"github.com/gocraft/work"
@ -51,10 +50,9 @@ func (suite *UtilsTestSuite) TestIsEmptyStr() {
// TestReadEnv tests ReadEnv
func (suite *UtilsTestSuite) TestReadEnv() {
os.Setenv("TEST_EXIST_ENV_VAR", "test")
suite.T().Setenv("TEST_EXIST_ENV_VAR", "test")
assert.Equal(suite.T(), "test", ReadEnv("TEST_EXIST_ENV_VAR"), "env var TEST_EXIST_ENV_VAR should return test value")
assert.Equal(suite.T(), "", ReadEnv("TEST_NOT_EXIST_ENV_VAR"), "env var TEST_NOT_EXIST_ENV_VAR should return empty value")
os.Unsetenv("TEST_EXIST_ENV_VAR")
}
// TestFileExists tests FileExists

52
src/jobservice/config/config_test.go
View File

@ -14,7 +14,6 @@
package config
import (
"os"
"testing"
"github.com/stretchr/testify/assert"
@ -48,16 +47,10 @@ func (suite *ConfigurationTestSuite) TestConfigLoadingSucceed() {
// TestConfigLoadingWithEnv ...
func (suite *ConfigurationTestSuite) TestConfigLoadingWithEnv() {
err := setENV()
require.Nil(suite.T(), err, "set envs: expect nil error but got error '%s'", err)
defer func() {
err := unsetENV()
require.Nil(suite.T(), err, "unset envs: expect nil error but got error '%s'", err)
}()
setENV(suite.T())
cfg := &Configuration{}
err = cfg.Load("../config_test.yml", true)
err := cfg.Load("../config_test.yml", true)
require.Nil(suite.T(), err, "load config from yaml file, expect nil error but got error '%s'", err)
assert.Equal(suite.T(), "https", cfg.Protocol, "expect protocol 'https', but got '%s'", cfg.Protocol)
@ -125,33 +118,16 @@ func (suite *ConfigurationTestSuite) TestDefaultConfig() {
)
}
func setENV() error {
err := os.Setenv("JOB_SERVICE_PROTOCOL", "https")
err = os.Setenv("JOB_SERVICE_PORT", "8989")
err = os.Setenv("JOB_SERVICE_HTTPS_CERT", "../server.crt")
err = os.Setenv("JOB_SERVICE_HTTPS_KEY", "../server.key")
err = os.Setenv("JOB_SERVICE_POOL_BACKEND", "redis")
err = os.Setenv("JOB_SERVICE_POOL_WORKERS", "8")
err = os.Setenv("JOB_SERVICE_POOL_REDIS_URL", "redis://:password@8.8.8.8:6379/2")
err = os.Setenv("JOB_SERVICE_POOL_REDIS_NAMESPACE", "ut_namespace")
err = os.Setenv("JOBSERVICE_SECRET", "js_secret")
err = os.Setenv("CORE_SECRET", "core_secret")
err = os.Setenv("CORE_URL", "core_url")
return err
}
func unsetENV() error {
err := os.Unsetenv("JOB_SERVICE_PROTOCOL")
err = os.Unsetenv("JOB_SERVICE_PORT")
err = os.Unsetenv("JOB_SERVICE_HTTPS_CERT")
err = os.Unsetenv("JOB_SERVICE_HTTPS_KEY")
err = os.Unsetenv("JOB_SERVICE_POOL_BACKEND")
err = os.Unsetenv("JOB_SERVICE_POOL_WORKERS")
err = os.Unsetenv("JOB_SERVICE_POOL_REDIS_URL")
err = os.Unsetenv("JOB_SERVICE_POOL_REDIS_NAMESPACE")
err = os.Unsetenv("JOBSERVICE_SECRET")
err = os.Unsetenv("CORE_SECRET")
return err
func setENV(t *testing.T) {
t.Setenv("JOB_SERVICE_PROTOCOL", "https")
t.Setenv("JOB_SERVICE_PORT", "8989")
t.Setenv("JOB_SERVICE_HTTPS_CERT", "../server.crt")
t.Setenv("JOB_SERVICE_HTTPS_KEY", "../server.key")
t.Setenv("JOB_SERVICE_POOL_BACKEND", "redis")
t.Setenv("JOB_SERVICE_POOL_WORKERS", "8")
t.Setenv("JOB_SERVICE_POOL_REDIS_URL", "redis://:password@8.8.8.8:6379/2")
t.Setenv("JOB_SERVICE_POOL_REDIS_NAMESPACE", "ut_namespace")
t.Setenv("JOBSERVICE_SECRET", "js_secret")
t.Setenv("CORE_SECRET", "core_secret")
t.Setenv("CORE_URL", "core_url")
}

3
src/jobservice/job/impl/gc/garbage_collection_test.go
View File

@ -15,7 +15,6 @@
package gc
import (
"os"
"testing"
"github.com/docker/distribution/manifest/schema2"
@ -380,6 +379,6 @@ func (suite *gcTestSuite) TestSweep() {
}
func TestGCTestSuite(t *testing.T) {
os.Setenv("UTTEST", "true")
t.Setenv("UTTEST", "true")
suite.Run(t, &gcTestSuite{})
}

20
src/jobservice/job/impl/notification/slack_job_test.go
View File

@ -4,7 +4,6 @@ import (
"io/ioutil"
"net/http"
"net/http/httptest"
"os"
"testing"
"github.com/stretchr/testify/assert"
@ -15,16 +14,19 @@ import (
func TestSlackJobMaxFails(t *testing.T) {
rep := &SlackJob{}
// test default max fails
assert.Equal(t, uint(10), rep.MaxFails())
t.Run("default max fails", func(t *testing.T) {
assert.Equal(t, uint(10), rep.MaxFails())
})
// test user defined max fails
_ = os.Setenv(maxFails, "15")
assert.Equal(t, uint(15), rep.MaxFails())
t.Run("user defined max fails", func(t *testing.T) {
t.Setenv(maxFails, "15")
assert.Equal(t, uint(15), rep.MaxFails())
})
// test user defined wrong max fails
_ = os.Setenv(maxFails, "abc")
assert.Equal(t, uint(10), rep.MaxFails())
t.Run("user defined wrong max fails", func(t *testing.T) {
t.Setenv(maxFails, "abc")
assert.Equal(t, uint(10), rep.MaxFails())
})
}
func TestSlackJobShouldRetry(t *testing.T) {

20
src/jobservice/job/impl/notification/webhook_job_test.go
View File

@ -4,7 +4,6 @@ import (
"io/ioutil"
"net/http"
"net/http/httptest"
"os"
"testing"
"github.com/stretchr/testify/assert"
@ -14,16 +13,19 @@ import (
func TestMaxFails(t *testing.T) {
rep := &WebhookJob{}
// test default max fails
assert.Equal(t, uint(10), rep.MaxFails())
t.Run("default max fails", func(t *testing.T) {
assert.Equal(t, uint(10), rep.MaxFails())
})
// test user defined max fails
_ = os.Setenv(maxFails, "15")
assert.Equal(t, uint(15), rep.MaxFails())
t.Run("user defined max fails", func(t *testing.T) {
t.Setenv(maxFails, "15")
assert.Equal(t, uint(15), rep.MaxFails())
})
// test user defined wrong max fails
_ = os.Setenv(maxFails, "abc")
assert.Equal(t, uint(10), rep.MaxFails())
t.Run("user defined wrong max fails", func(t *testing.T) {
t.Setenv(maxFails, "abc")
assert.Equal(t, uint(10), rep.MaxFails())
})
}
func TestShouldRetry(t *testing.T) {

15
src/lib/config/test/userconfig_test.go
View File

@ -59,17 +59,10 @@ func TestConfig(t *testing.T) {
defer os.Remove(secretKeyPath)
assert := assert.New(t)
if err := os.Setenv("KEY_PATH", secretKeyPath); err != nil {
t.Fatalf("failed to set env %s: %v", "KEY_PATH", err)
}
oriKeyPath := os.Getenv("TOKEN_PRIVATE_KEY_PATH")
if err := os.Setenv("TOKEN_PRIVATE_KEY_PATH", ""); err != nil {
t.Fatalf("failed to set env %s: %v", "TOKEN_PRIVATE_KEY_PATH", err)
}
defer os.Setenv("TOKEN_PRIVATE_KEY_PATH", oriKeyPath)
os.Setenv("JOBSERVICE_URL", "http://myjob:8888")
os.Setenv("GC_TIME_WINDOW_HOURS", "0")
t.Setenv("KEY_PATH", secretKeyPath)
t.Setenv("TOKEN_PRIVATE_KEY_PATH", "")
t.Setenv("JOBSERVICE_URL", "http://myjob:8888")
t.Setenv("GC_TIME_WINDOW_HOURS", "0")
Init()
ctx := orm.Context()

9
src/pkg/immutable/manager_test.go
View File

@ -2,7 +2,6 @@ package immutable
import (
"context"
"os"
"testing"
"github.com/stretchr/testify/assert"
@ -29,13 +28,7 @@ func (m *managerTestingSuite) SetupSuite() {
m.assert = assert.New(m.t)
m.require = require.New(m.t)
err := os.Setenv("RUN_MODE", "TEST")
m.require.Nil(err)
}
func (m *managerTestingSuite) TearDownSuite() {
err := os.Unsetenv("RUN_MODE")
m.require.Nil(err)
m.T().Setenv("RUN_MODE", "TEST")
}
func (m *managerTestingSuite) SetupTest() {

9
src/pkg/joblog/managet_test.go
View File

@ -2,7 +2,6 @@ package joblog
import (
"context"
"os"
"testing"
"time"
@ -28,13 +27,7 @@ func (m *managerTestingSuite) SetupSuite() {
m.assert = assert.New(m.t)
m.require = require.New(m.t)
err := os.Setenv("RUN_MODE", "TEST")
m.require.Nil(err)
}
func (m *managerTestingSuite) TearDownSuite() {
err := os.Unsetenv("RUN_MODE")
m.require.Nil(err)
m.T().Setenv("RUN_MODE", "TEST")
}
func (m *managerTestingSuite) SetupTest() {

11
src/registryctl/config/config_test.go
View File

@ -15,7 +15,6 @@
package config
import (
"os"
"testing"
_ "github.com/docker/distribution/registry/storage/driver/filesystem"
@ -29,9 +28,9 @@ func TestConfigDoesNotExists(t *testing.T) {
}
func TestConfigLoadingWithEnv(t *testing.T) {
os.Setenv("REGISTRYCTL_PROTOCOL", "https")
os.Setenv("PORT", "1000")
os.Setenv("LOG_LEVEL", "DEBUG")
t.Setenv("REGISTRYCTL_PROTOCOL", "https")
t.Setenv("PORT", "1000")
t.Setenv("LOG_LEVEL", "DEBUG")
cfg := &Configuration{}
err := cfg.Load("../config_test.yml", true)
@ -60,11 +59,11 @@ func TestGetLogLevel(t *testing.T) {
}
func TestGetJobAuthSecret(t *testing.T) {
os.Setenv("JOBSERVICE_SECRET", "test_job_secret")
t.Setenv("JOBSERVICE_SECRET", "test_job_secret")
assert.Equal(t, "test_job_secret", GetJobAuthSecret())
}
func TestGetUIAuthSecret(t *testing.T) {
os.Setenv("CORE_SECRET", "test_core_secret")
t.Setenv("CORE_SECRET", "test_core_secret")
assert.Equal(t, "test_core_secret", GetUIAuthSecret())
}

9
src/server/registry/handler_test.go
View File

@ -16,7 +16,6 @@ package registry
import (
"net/http"
"os"
"testing"
"github.com/stretchr/testify/assert"
@ -28,12 +27,8 @@ func direct(req *http.Request) {
func TestBasicAuthDirector(t *testing.T) {
req, _ := http.NewRequest(http.MethodGet, "127.0.0.1", nil)
os.Setenv("REGISTRY_CREDENTIAL_USERNAME", "testuser")
os.Setenv("REGISTRY_CREDENTIAL_PASSWORD", "testpassword")
defer func() {
os.Unsetenv("REGISTRY_CREDENTIAL_USERNAME")
os.Unsetenv("REGISTRY_CREDENTIAL_PASSWORD")
}()
t.Setenv("REGISTRY_CREDENTIAL_USERNAME", "testuser")
t.Setenv("REGISTRY_CREDENTIAL_PASSWORD", "testpassword")
d := basicAuthDirector(direct)
d(req)