summaryrefslogtreecommitdiff
path: root/pkg/env
diff options
context:
space:
mode:
authorIshita Sequeira <46771830+ishitasequeira@users.noreply.github.com>2024-12-19 19:51:50 +0530
committerGitHub <noreply@github.com>2024-12-19 09:21:50 -0500
commit736f12f55a73d17dbedc040b4f559a2cd33bbff4 (patch)
treed7e31aba857641a20da7bffa5d9c29e3c5c230e4 /pkg/env
parent03203db49b047f03a8e99b26ef8554942c2513d6 (diff)
Update references of cache, env, health to use modules from registry-scanner (#972)
Signed-off-by: Ishita Sequeira <ishiseq29@gmail.com>
Diffstat (limited to 'pkg/env')
-rw-r--r--pkg/env/env.go66
-rw-r--r--pkg/env/env_test.go65
2 files changed, 0 insertions, 131 deletions
diff --git a/pkg/env/env.go b/pkg/env/env.go
deleted file mode 100644
index f000aa2..0000000
--- a/pkg/env/env.go
+++ /dev/null
@@ -1,66 +0,0 @@
-package env
-
-import (
- "math"
- "os"
- "strconv"
- "strings"
-
- "github.com/argoproj-labs/argocd-image-updater/registry-scanner/pkg/log"
-)
-
-// Package env provides some utility functions to interact with the environment
-// of the process.
-
-// GetBoolVal retrieves a boolean value from given environment envVar.
-// Returns default value if envVar is not set.
-func GetBoolVal(envVar string, defaultValue bool) bool {
- if val := os.Getenv(envVar); val != "" {
- if strings.ToLower(val) == "true" {
- return true
- } else if strings.ToLower(val) == "false" {
- return false
- }
- }
- return defaultValue
-}
-
-// GetStringVal retrieves a string value from given environment envVar
-// Returns default value if envVar is not set.
-func GetStringVal(envVar string, defaultValue string) string {
- if val := os.Getenv(envVar); val != "" {
- return val
- } else {
- return defaultValue
- }
-}
-
-// Helper function to parse a number from an environment variable. Returns a
-// default if env is not set, is not parseable to a number, exceeds max (if
-// max is greater than 0) or is less than min.
-//
-// nolint:unparam
-func ParseNumFromEnv(env string, defaultValue, min, max int) int {
- str := os.Getenv(env)
- if str == "" {
- return defaultValue
- }
- num, err := strconv.ParseInt(str, 10, 0)
- if err != nil {
- log.Warnf("Could not parse '%s' as a number from environment %s", str, env)
- return defaultValue
- }
- if num > math.MaxInt || num < math.MinInt {
- log.Warnf("Value in %s is %d is outside of the min and max %d allowed values. Using default %d", env, num, min, defaultValue)
- return defaultValue
- }
- if int(num) < min {
- log.Warnf("Value in %s is %d, which is less than minimum %d allowed", env, num, min)
- return defaultValue
- }
- if int(num) > max {
- log.Warnf("Value in %s is %d, which is greater than maximum %d allowed", env, num, max)
- return defaultValue
- }
- return int(num)
-}
diff --git a/pkg/env/env_test.go b/pkg/env/env_test.go
deleted file mode 100644
index 41ccaf9..0000000
--- a/pkg/env/env_test.go
+++ /dev/null
@@ -1,65 +0,0 @@
-package env
-
-import (
- "os"
- "testing"
-
- "github.com/stretchr/testify/assert"
-)
-
-func Test_GetBoolVal(t *testing.T) {
- t.Run("Get 'true' value from existing env var", func(t *testing.T) {
- _ = os.Setenv("TEST_BOOL_VAL", "true")
- defer os.Setenv("TEST_BOOL_VAL", "")
- assert.True(t, GetBoolVal("TEST_BOOL_VAL", false))
- })
- t.Run("Get 'false' value from existing env var", func(t *testing.T) {
- _ = os.Setenv("TEST_BOOL_VAL", "false")
- defer os.Setenv("TEST_BOOL_VAL", "")
- assert.False(t, GetBoolVal("TEST_BOOL_VAL", true))
- })
- t.Run("Get default value from non-existing env var", func(t *testing.T) {
- _ = os.Setenv("TEST_BOOL_VAL", "")
- assert.True(t, GetBoolVal("TEST_BOOL_VAL", true))
- })
-}
-
-func Test_GetStringVal(t *testing.T) {
- t.Run("Get string value from existing env var", func(t *testing.T) {
- _ = os.Setenv("TEST_STRING_VAL", "test")
- defer os.Setenv("TEST_STRING_VAL", "")
- assert.Equal(t, "test", GetStringVal("TEST_STRING_VAL", "invalid"))
- })
- t.Run("Get default value from non-existing env var", func(t *testing.T) {
- _ = os.Setenv("TEST_STRING_VAL", "")
- defer os.Setenv("TEST_STRING_VAL", "")
- assert.Equal(t, "invalid", GetStringVal("TEST_STRING_VAL", "invalid"))
- })
-}
-
-func Test_ParseNumFromEnv(t *testing.T) {
- t.Run("Get number from existing env var within range", func(t *testing.T) {
- _ = os.Setenv("TEST_NUM_VAL", "5")
- defer os.Setenv("TEST_NUM_VAL", "")
- assert.Equal(t, 5, ParseNumFromEnv("TEST_NUM_VAL", 0, 1, 10))
- })
- t.Run("Get default value from non-existing env var", func(t *testing.T) {
- _ = os.Setenv("TEST_NUM_VAL", "")
- assert.Equal(t, 10, ParseNumFromEnv("TEST_NUM_VAL", 10, 1, 20))
- })
- t.Run("Get default value from env var with non-numeric value", func(t *testing.T) {
- _ = os.Setenv("TEST_NUM_VAL", "abc")
- defer os.Setenv("TEST_NUM_VAL", "")
- assert.Equal(t, 10, ParseNumFromEnv("TEST_NUM_VAL", 10, 1, 20))
- })
- t.Run("Get default value from env var with value less than min", func(t *testing.T) {
- _ = os.Setenv("TEST_NUM_VAL", "0")
- defer os.Setenv("TEST_NUM_VAL", "")
- assert.Equal(t, 10, ParseNumFromEnv("TEST_NUM_VAL", 10, 1, 20))
- })
- t.Run("Get default value from env var with value greater than max", func(t *testing.T) {
- _ = os.Setenv("TEST_NUM_VAL", "30")
- defer os.Setenv("TEST_NUM_VAL", "")
- assert.Equal(t, 10, ParseNumFromEnv("TEST_NUM_VAL", 10, 1, 20))
- })
-}