refactor(env): simplify package to only contain constant definitions

Author: jremy42

internal/env/env.go

@@ -1,85 +1,16 @@
-// Package env provides utilities for reading environment variables with defaults and type safety.
+// Package env contains a list of environment variables used to modify the behaviour of the CLI.
 package env
 
-import (
-	"os"
-	"strconv"
-	"time"
-)
-
-// GetBool reads a boolean environment variable.
-// Returns defaultValue if the variable is not set or invalid.
-func GetBool(key string, defaultValue bool) bool {
-	value := os.Getenv(key)
-	if value == "" {
-		return defaultValue
-	}
-
-	switch value {
-	case "1", "true", "TRUE", "True", "yes", "YES", "Yes":
-		return true
-	case "0", "false", "FALSE", "False", "no", "NO", "No":
-		return false
-	default:
-		return defaultValue
-	}
-}
-
-// GetString reads a string environment variable.
-// Returns defaultValue if the variable is not set.
-func GetString(key string, defaultValue string) string {
-	value := os.Getenv(key)
-	if value == "" {
-		return defaultValue
-	}
-	return value
-}
-
-// GetInt reads an integer environment variable.
-// Returns defaultValue if the variable is not set or invalid.
-func GetInt(key string, defaultValue int) int {
-	value := os.Getenv(key)
-	if value == "" {
-		return defaultValue
-	}
+const (
+	// RunBenchmarks if set to "true" will enable benchmark execution
+	RunBenchmarks = "CLI_RUN_BENCHMARKS"
 
-	intValue, err := strconv.Atoi(value)
-	if err != nil {
-		return defaultValue
-	}
+	// BenchTrace if set to "true" will enable detailed benchmark statistics (min, median, mean, p95, max)
+	BenchTrace = "CLI_BENCH_TRACE"
 
-	return intValue
-}
+	// UpdateCassettes if set to "true" will trigger the cassettes to be recorded
+	UpdateCassettes = "CLI_UPDATE_CASSETTES"
 
-// GetDuration reads a duration environment variable.
-// Accepts values like "5s", "10m", "1h30m".
-// Returns defaultValue if the variable is not set or invalid.
-func GetDuration(key string, defaultValue time.Duration) time.Duration {
-	value := os.Getenv(key)
-	if value == "" {
-		return defaultValue
-	}
-
-	duration, err := time.ParseDuration(value)
-	if err != nil {
-		return defaultValue
-	}
-
-	return duration
-}
-
-// IsSet returns true if the environment variable is set (even if empty).
-func IsSet(key string) bool {
-	_, exists := os.LookupEnv(key)
-	return exists
-}
-
-// MustGetString reads a string environment variable and panics if not set.
-// Use this for required configuration values.
-func MustGetString(key string) string {
-	value := os.Getenv(key)
-	if value == "" {
-		panic("environment variable " + key + " is required but not set")
-	}
-	return value
-}
+	// UpdateGoldens if set to "true" will update golden files during tests
+	UpdateGoldens = "CLI_UPDATE_GOLDENS"
+)

internal/env/env_test.go

@@ -95,7 +95,7 @@ type benchmarkStats struct {
 
 func newBenchmarkStats() *benchmarkStats {
 	return &benchmarkStats{
-		enabled: env.GetBool("CLI_BENCH_TRACE", false),
+		enabled: os.Getenv(env.BenchTrace) == "true",
 		timings: make([]time.Duration, 0, 1000),
 	}
 }
@@ -248,7 +248,7 @@ func cleanupSharedInstance() {
 }
 
 func BenchmarkInstanceGet(b *testing.B) {
-	if !env.GetBool("CLI_RUN_BENCHMARKS", false) {
+	if os.Getenv(env.RunBenchmarks) != "true" {
 		b.Skip("Skipping benchmark. Set CLI_RUN_BENCHMARKS=true to run.")
 	}
 
@@ -284,7 +284,7 @@ func BenchmarkInstanceGet(b *testing.B) {
 }
 
 func BenchmarkBackupGet(b *testing.B) {
-	if !env.GetBool("CLI_RUN_BENCHMARKS", false) {
+	if os.Getenv(env.RunBenchmarks) != "true" {
 		b.Skip("Skipping benchmark. Set CLI_RUN_BENCHMARKS=true to run.")
 	}
 
@@ -353,7 +353,7 @@ func BenchmarkBackupGet(b *testing.B) {
 }
 
 func BenchmarkBackupList(b *testing.B) {
-	if !env.GetBool("CLI_RUN_BENCHMARKS", false) {
+	if os.Getenv(env.RunBenchmarks) != "true" {
 		b.Skip("Skipping benchmark. Set CLI_RUN_BENCHMARKS=true to run.")
 	}
 
@@ -435,7 +435,7 @@ func BenchmarkBackupList(b *testing.B) {
 }
 
 func BenchmarkDatabaseList(b *testing.B) {
-	if !env.GetBool("CLI_RUN_BENCHMARKS", false) {
+	if os.Getenv(env.RunBenchmarks) != "true" {
 		b.Skip("Skipping benchmark. Set CLI_RUN_BENCHMARKS=true to run.")
 	}