Use stepenv.Repository instead of custom env setter/getter

Author: lpusok

oldcache/cache.go

@@ -1,11 +1,8 @@
 package oldcache
 
 import (
-	"os"
 	"strings"
 
-	"github.com/bitrise-io/go-steputils/v2/export"
-	"github.com/bitrise-io/go-utils/v2/command"
 	"github.com/bitrise-io/go-utils/v2/env"
 )
 
@@ -15,81 +12,18 @@ const CacheIncludePathsEnvKey = "BITRISE_CACHE_INCLUDE_PATHS"
 // CacheExcludePathsEnvKey ...
 const CacheExcludePathsEnvKey = "BITRISE_CACHE_EXCLUDE_PATHS"
 
-// VariableSetter ...
-type VariableSetter interface {
-	Set(key, value string) error
-}
-
-// OSVariableSetter ...
-type OSVariableSetter struct{}
-
-// NewOSVariableSetter ...
-func NewOSVariableSetter() VariableSetter {
-	return OSVariableSetter{}
-}
-
-// Set ...
-func (e OSVariableSetter) Set(key, value string) error {
-	return os.Setenv(key, value)
-}
-
-// EnvmanVariableSetter ...
-type EnvmanVariableSetter struct {
-}
-
-// NewEnvmanVariableSetter ...
-func NewEnvmanVariableSetter() VariableSetter {
-	return EnvmanVariableSetter{}
-}
-
-// Set ...
-func (e EnvmanVariableSetter) Set(key, value string) error {
-	exporter := export.NewExporter(command.NewFactory(env.NewRepository()))
-	return exporter.ExportOutput(key, value)
-}
-
-// VariableGetter ...
-type VariableGetter interface {
-	Get(key string) (string, error)
-}
-
-// OSVariableGetter ...
-type OSVariableGetter struct{}
-
-// NewOSVariableGetter ...
-func NewOSVariableGetter() VariableGetter {
-	return OSVariableGetter{}
-}
-
-// Get ...
-func (e OSVariableGetter) Get(key string) (string, error) {
-	return os.Getenv(key), nil
-}
-
 // Cache ...
 type Cache struct {
-	variableGetter  VariableGetter
-	variableSetters []VariableSetter
+	envRepository env.Repository
 
 	include []string
 	exclude []string
 }
 
-// Config ...
-type Config struct {
-	VariableGetter  VariableGetter
-	VariableSetters []VariableSetter
-}
-
-// NewCache ...
-func (c Config) NewCache() Cache {
-	return Cache{variableGetter: c.VariableGetter, variableSetters: c.VariableSetters}
-}
-
 // New ...
-func New() Cache {
-	defaultConfig := Config{NewOSVariableGetter(), []VariableSetter{NewOSVariableSetter(), NewEnvmanVariableSetter()}}
-	return defaultConfig.NewCache()
+func New(envRepository env.Repository) Cache {
+	// defaultConfig := Config{NewOSVariableGetter(), []VariableSetter{NewOSVariableSetter(), NewEnvmanVariableSetter()}}
+	return Cache{envRepository: envRepository}
 }
 
 // IncludePath ...
@@ -105,32 +39,20 @@ func (cache *Cache) ExcludePath(item ...string) {
 // Commit ...
 func (cache *Cache) Commit() error {
 	commitCachePath := func(key string, values []string) error {
-		content, err := cache.variableGetter.Get(key)
-		if err != nil {
-			return err
-		}
-
+		content := cache.envRepository.Get(key)
 		if content != "" {
 			content += "\n"
 		}
 
 		content += strings.Join(values, "\n")
 		content += "\n"
 
-		for _, setter := range cache.variableSetters {
-			if err := setter.Set(key, content); err != nil {
-				return err
-			}
-		}
-		return nil
+		return cache.envRepository.Set(key, content)
 	}
 
 	if err := commitCachePath(CacheIncludePathsEnvKey, cache.include); err != nil {
 		return err
 	}
 
-	if err := commitCachePath(CacheExcludePathsEnvKey, cache.exclude); err != nil {
-		return err
-	}
-	return nil
+	return commitCachePath(CacheExcludePathsEnvKey, cache.exclude)
 }

oldcache/cache_test.go

@@ -7,6 +7,7 @@ import (
 	"testing"
 
 	cache "github.com/bitrise-io/go-steputils/v2/oldcache"
+	"github.com/bitrise-io/go-steputils/v2/stepenv"
 	"github.com/bitrise-io/go-utils/v2/command"
 	"github.com/bitrise-io/go-utils/v2/env"
 	"github.com/bitrise-io/go-utils/v2/fileutil"
@@ -20,13 +21,13 @@ type MockGetterSetter struct {
 }
 
 // NewMockGetterSetter ...
-func NewMockGetterSetter() MockGetterSetter {
+func NewMockGetterSetter() env.Repository {
 	return MockGetterSetter{values: map[string]string{}}
 }
 
 // Get ...
-func (g MockGetterSetter) Get(key string) (string, error) {
-	return g.values[key], nil
+func (g MockGetterSetter) Get(key string) string {
+	return g.values[key]
 }
 
 // Set ...
@@ -35,6 +36,21 @@ func (g MockGetterSetter) Set(key, value string) error {
 	return nil
 }
 
+// List ...
+func (g MockGetterSetter) List() []string {
+	var envs []string
+	for k, v := range g.values {
+		envs = append(envs, fmt.Sprintf("%s=%s", k, v))
+	}
+	return envs
+}
+
+// Unset ...
+func (g MockGetterSetter) Unset(key string) error {
+	delete(g.values, key)
+	return nil
+}
+
 const testEnvVarContent = `/tmp/mypath -> /tmp/mypath/cachefile
 /tmp/otherpath
 /tmp/anotherpath
@@ -59,6 +75,7 @@ const testThirdCommitIgnoreEnvVarContent = `/*.log
 func TestCacheFunctions(t *testing.T) {
 	filemanager := fileutil.NewFileManager()
 	pathmodifier := pathutil.NewPathModifier()
+	cacheEnvRepository := stepenv.NewRepository(env.NewRepository())
 
 	t.Log("Init envman")
 	{
@@ -85,7 +102,7 @@ func TestCacheFunctions(t *testing.T) {
 
 	t.Log("Test - cache")
 	{
-		c := cache.New()
+		c := cache.New(cacheEnvRepository)
 		c.IncludePath("/tmp/mypath -> /tmp/mypath/cachefile")
 		c.IncludePath("/tmp/otherpath")
 		c.IncludePath("/tmp/anotherpath")
@@ -105,12 +122,12 @@ func TestCacheFunctions(t *testing.T) {
 		require.NoError(t, err)
 		require.Equal(t, testIgnoreEnvVarContent, content)
 
-		c = cache.New()
+		c = cache.New(cacheEnvRepository)
 		c.ExcludePath("/*.lock")
 		err = c.Commit()
 		require.NoError(t, err)
 
-		c = cache.New()
+		c = cache.New(cacheEnvRepository)
 		c.ExcludePath("/*.lock")
 		err = c.Commit()
 		require.NoError(t, err)

oldcache/example_test.go

@@ -4,6 +4,7 @@ import (
 	"fmt"
 
 	cache "github.com/bitrise-io/go-steputils/v2/oldcache"
+	"github.com/bitrise-io/go-utils/v2/env"
 )
 
 // Create ItemCollectors for listing Bitrise cache include and exclude patterns.
@@ -17,8 +18,7 @@ func (c SampleItemCollector) Collect(dir string, cacheLevel cache.Level) ([]stri
 func Example() {
 	// Create a cache, usually using cache.New()
 	getterSetter := NewMockGetterSetter()
-	testConfig := cache.Config{getterSetter, []cache.VariableSetter{getterSetter}}
-	c := testConfig.NewCache()
+	c := cache.New(getterSetter)
 
 	for _, collector := range []cache.ItemCollector{SampleItemCollector{}} {
 		// Run some Cache ItemCollectors
@@ -42,16 +42,10 @@ func Example() {
 	// exclude_me.txt
 }
 
-func printIncludeAndExcludeEnvs(getterSetter MockGetterSetter) {
-	includePaths, err := getterSetter.Get(cache.CacheIncludePathsEnvKey)
-	if err != nil {
-		panic(err)
-	}
+func printIncludeAndExcludeEnvs(getterSetter env.Repository) {
+	includePaths := getterSetter.Get(cache.CacheIncludePathsEnvKey)
 	fmt.Println(includePaths)
 
-	excludePaths, err := getterSetter.Get(cache.CacheExcludePathsEnvKey)
-	if err != nil {
-		panic(err)
-	}
+	excludePaths := getterSetter.Get(cache.CacheExcludePathsEnvKey)
 	fmt.Println(excludePaths)
 }