fix: rework environment fetching [IDE-1314]

application/config/automatic_config.go

@@ -25,6 +25,8 @@ import (
 	"runtime"
 	"strings"
 
+	"github.com/adrg/xdg"
+
 	"github.com/snyk/go-application-framework/pkg/envvars"
 )
 
@@ -35,7 +37,7 @@ func (c *Config) determineJavaHome() {
 		envvars.UpdatePath(javaHome+string(os.PathSeparator)+"bin", false)
 		return
 	}
-	foundPath := c.FindBinaryInDirs(getJavaBinaryName())
+	foundPath := c.findBinaryInDirs(getJavaBinaryName())
 	if foundPath == "" {
 		return
 	}
@@ -116,15 +118,15 @@ func (c *Config) findBinary(binaryName string) string {
 	if path != "" {
 		return path
 	}
-	foundPath := c.FindBinaryInDirs(binaryName)
+	foundPath := c.findBinaryInDirs(binaryName)
 	c.Logger().Debug().Str("method", "findBinary").Msgf("found: %s", foundPath)
 	return foundPath
 }
 
-func (c *Config) FindBinaryInDirs(binaryName string) (foundPath string) {
-	method := "FindBinaryInDirs"
+func (c *Config) findBinaryInDirs(binaryName string) (foundPath string) {
+	method := "findBinaryInDirs"
 	var foundFilePaths []string
-	for _, dir := range c.defaultDirs {
+	for _, dir := range c.binarySearchPaths {
 		_, err := os.Stat(dir)
 		if err != nil {
 			continue
@@ -136,12 +138,33 @@ func (c *Config) FindBinaryInDirs(binaryName string) (foundPath string) {
 			}
 			return err
 		})
-		count := len(foundFilePaths)
-		if count > 0 {
-			// take newest, as the dirwalk is lexical
-			foundPath = foundFilePaths[count-1]
-			c.Logger().Debug().Str("method", method).Msgf("using '%s' in '%s'", binaryName, foundPath)
-		}
+	}
+	count := len(foundFilePaths)
+	if count > 0 {
+		// take newest, as the dirwalk is lexical
+		foundPath = foundFilePaths[count-1]
+		c.Logger().Debug().Str("method", method).Msgf("using '%s' in '%s'", binaryName, foundPath)
 	}
 	return foundPath
 }
+
+// getDefaultBinarySearchPaths returns the default system binary search paths based on the OS.
+func getDefaultBinarySearchPaths() []string {
+	//goland:noinspection GoBoolExpressions
+	if runtime.GOOS == "windows" {
+		return []string{
+			"C:\\Program Files",
+			"C:\\Program Files (x86)",
+		}
+	} else {
+		return []string{
+			filepath.Join(xdg.Home, ".sdkman"),
+			"/usr/lib",
+			"/usr/java",
+			"/usr/local/bin",
+			"/opt/homebrew/bin",
+			"/opt",
+			"/Library",
+		}
+	}
+}

application/config/automatic_config_test.go

@@ -19,56 +19,60 @@ package config
 import (
 	"os"
 	"path/filepath"
-	"runtime"
-	"strings"
 	"testing"
 
 	"github.com/adrg/xdg"
 	"github.com/rs/zerolog"
 	"github.com/stretchr/testify/assert"
+	"github.com/stretchr/testify/require"
+
+	"github.com/snyk/snyk-ls/internal/testsupport"
 )
 
 func Test_updatePathWithDefaults(t *testing.T) {
-	t.Run("initialize path from environment", func(t *testing.T) {
-		t.Setenv("PATH", "ORIGINAL_PATH")
-		c := New()
-		assert.Contains(t, c.Path(), "ORIGINAL_PATH")
+	someOriginalPath := "some_original_path"
+	t.Run("initialize keeps path from environment", func(t *testing.T) {
+		t.Setenv("PATH", someOriginalPath)
+		c := New(WithBinarySearchPaths([]string{}))
+		require.NoError(t, c.WaitForDefaultEnv(t.Context()))
+		assert.Contains(t, os.Getenv("PATH"), someOriginalPath)
 	})
 
 	t.Run("automatically add /usr/local/bin on linux and macOS", func(t *testing.T) {
-		if //goland:noinspection GoBoolExpressions
-		runtime.GOOS == windows {
-			t.Skipf("only added to the path on linux and macOS, this is windows")
-		}
-		c := New()
-		assert.Contains(t, c.Path(), pathListSeparator+"/usr/local/bin")
+		testsupport.NotOnWindows(t, "only added to the path on linux and macOS")
+		t.Setenv("PATH", someOriginalPath)
+		c := New(WithBinarySearchPaths([]string{}))
+		require.NoError(t, c.WaitForDefaultEnv(t.Context()))
+		assert.Contains(t, os.Getenv("PATH"), pathListSeparator+"/usr/local/bin")
+		assert.Contains(t, os.Getenv("PATH"), someOriginalPath)
 	})
 
 	t.Run("automatically add /bin on linux and macOS", func(t *testing.T) {
-		if //goland:noinspection GoBoolExpressions
-		runtime.GOOS == windows {
-			t.Skipf("only added to the path on linux and macOS, this is windows")
-		}
-		c := New()
-		assert.Contains(t, c.Path(), pathListSeparator+"/bin")
+		testsupport.NotOnWindows(t, "only added to the path on linux and macOS")
+		t.Setenv("PATH", someOriginalPath)
+		c := New(WithBinarySearchPaths([]string{}))
+		require.NoError(t, c.WaitForDefaultEnv(t.Context()))
+		assert.Contains(t, os.Getenv("PATH"), pathListSeparator+"/bin")
+		assert.Contains(t, os.Getenv("PATH"), someOriginalPath)
 	})
 
 	t.Run("automatically add $HOME/bin on linux and macOS", func(t *testing.T) {
-		if //goland:noinspection GoBoolExpressions
-		runtime.GOOS == windows {
-			t.Skipf("only added to the path on linux and macOS, this is windows")
-		}
-		c := New()
-		assert.Contains(t, c.Path(), pathListSeparator+xdg.Home+"/bin")
+		testsupport.NotOnWindows(t, "only added to the path on linux and macOS")
+		t.Setenv("PATH", someOriginalPath)
+		c := New(WithBinarySearchPaths([]string{}))
+		require.NoError(t, c.WaitForDefaultEnv(t.Context()))
+		assert.Contains(t, os.Getenv("PATH"), pathListSeparator+xdg.Home+"/bin")
+		assert.Contains(t, os.Getenv("PATH"), someOriginalPath)
 	})
 
 	t.Run("automatically add $JAVA_HOME/bin if set", func(t *testing.T) {
 		javaHome := "JAVA_HOME_DUMMY"
 		t.Setenv("JAVA_HOME", javaHome)
-		New()
-		actual := os.Getenv("PATH")
-		prefix := javaHome + string(os.PathSeparator) + "bin"
-		assert.True(t, strings.Contains(actual, prefix), actual+" does not contain "+prefix)
+		t.Setenv("PATH", someOriginalPath)
+		c := New(WithBinarySearchPaths([]string{}))
+		require.NoError(t, c.WaitForDefaultEnv(t.Context()))
+		assert.Contains(t, os.Getenv("PATH"), filepath.Join(javaHome, "bin"))
+		assert.Contains(t, os.Getenv("PATH"), someOriginalPath)
 	})
 }
 
@@ -102,18 +106,21 @@ func Test_FindBinaries(t *testing.T) {
 			t.Fatal(err)
 		}
 
-		c := New()
-		c.AddBinaryLocationsToPath([]string{dir})
+		c := New(WithBinarySearchPaths([]string{dir}))
+		require.NoError(t, c.WaitForDefaultEnv(t.Context()))
 
 		assert.Contains(t, os.Getenv("JAVA_HOME"), javaBaseDir)
 	})
 
-	t.Run("search for binary in default places", func(t *testing.T) {
+	t.Run("search for java binary in binary search paths", func(t *testing.T) {
 		t.Setenv("JAVA_HOME", "")
 		t.Setenv("PATH", "")
 
-		javaHome := t.TempDir()
-		err := os.MkdirAll(javaHome, 0770)
+		javaHome, err := filepath.EvalSymlinks(t.TempDir())
+		if err != nil {
+			t.Fatal(err)
+		}
+		err = os.MkdirAll(javaHome, 0770)
 		if err != nil {
 			t.Fatal(err)
 		}
@@ -134,19 +141,26 @@ func Test_FindBinaries(t *testing.T) {
 		}
 
 		nop := zerolog.Nop()
-		c := &Config{defaultDirs: []string{filepath.Dir(javaHome)}, logger: &nop}
+		c := &Config{binarySearchPaths: []string{filepath.Dir(javaHome)}, logger: &nop}
 
-		java := c.findBinary(getJavaBinaryName())
+		c.determineJavaHome()
 
-		assert.Equal(t, file.Name(), java)
+		assert.Equal(t, javaHome, os.Getenv("JAVA_HOME"))
+		assert.Contains(t, os.Getenv("PATH"), binDir)
 	})
 
-	t.Run("search for maven in path", func(t *testing.T) {
-		dir := t.TempDir()
+	t.Run("search for maven in binary search paths", func(t *testing.T) {
 		t.Setenv("MAVEN_HOME", "")
-		binDir := filepath.Join(dir, "bin")
-		t.Setenv("PATH", binDir)
-		err := os.MkdirAll(binDir, 0700)
+		t.Setenv("PATH", "")
+
+		dir, err := filepath.EvalSymlinks(t.TempDir())
+		if err != nil {
+			t.Fatal(err)
+		}
+
+		mavenBaseDir := filepath.Join(dir, "maven", "somewhere")
+		binDir := filepath.Join(mavenBaseDir, "bin")
+		err = os.MkdirAll(binDir, 0700)
 		if err != nil {
 			t.Fatal(err)
 		}
@@ -157,7 +171,10 @@ func Test_FindBinaries(t *testing.T) {
 		}
 		defer func(file *os.File) { _ = file.Close() }(file)
 
-		New()
+		nop := zerolog.Nop()
+		c := &Config{binarySearchPaths: []string{dir}, logger: &nop}
+
+		c.mavenDefaults()
 
 		assert.Contains(t, os.Getenv("PATH"), binDir)
 	})

application/config/client_settings.go

@@ -34,7 +34,6 @@ func (c *Config) clientSettingsFromEnv() {
 	c.productEnablementFromEnv()
 	c.errorReportsEnablementFromEnv()
 	c.orgFromEnv()
-	c.path = os.Getenv("PATH")
 }
 
 func (c *Config) orgFromEnv() {