Fix integration test not properly sandboxed

Author: Naatan

internal/testhelpers/e2e/session.go

@@ -66,7 +66,6 @@ type Session struct {
 	ignoreLogErrors bool
 	cfg             *config.Instance
 	cache           keyCache
-	cfg             *config.Instance
 }
 
 type keyCache map[string]string
@@ -769,13 +768,27 @@ func (s *Session) SetupRCFile() {
 	if runtime.GOOS == "windows" {
 		return
 	}
-	s.T.Setenv("HOME", s.Dirs.HomeDir)
-	defer s.T.Setenv("HOME", os.Getenv("HOME"))
-
-	cfg, err := config.New()
-	require.NoError(s.T, err)
+	s.WithEnv(func() {
+		s.SetupRCFileCustom(subshell.New(s.cfg))
+	})
+}
 
-	s.SetupRCFileCustom(subshell.New(cfg))
+func (s *Session) WithEnv(do func()) {
+	env := osutils.EnvSliceToMap(s.Env)
+	for k, v := range env {
+		_, exists := os.LookupEnv(k)
+		if exists {
+			defer s.T.Setenv(k, os.Getenv(k))
+		} else {
+			defer func() {
+				if err := os.Unsetenv(k); err != nil {
+					s.T.Logf("Failed to unset env var %s: %v", k, err)
+				}
+			}()
+		}
+		s.T.Setenv(k, v)
+	}
+	do()
 }
 
 func (s *Session) SetupRCFileCustom(subshell subshell.SubShell) {
@@ -791,7 +804,11 @@ func (s *Session) SetupRCFileCustom(subshell subshell.SubShell) {
 	} else {
 		err = fileutils.Touch(filepath.Join(s.Dirs.HomeDir, filepath.Base(rcFile)))
 	}
-	require.NoError(s.T, err)
+	require.NoError(s.T, err, errs.JoinMessage(err))
+}
+
+func (s *Session) Config() *config.Instance {
+	return s.cfg
 }
 
 func (s *Session) SetConfig(key string, value interface{}) {

test/integration/shell_int_test.go

@@ -193,20 +193,25 @@ func (suite *ShellIntegrationTestSuite) TestUseShellUpdates() {
 	ts := e2e.New(suite.T(), false)
 	defer ts.Close()
 
-	suite.SetupRCFile(ts)
+	if runtime.GOOS != "windows" {
+		ts.SetupRCFileCustom(&bash.SubShell{})
+		ts.SetupRCFileCustom(&zsh.SubShell{})
+	}
 
 	cp := ts.Spawn("checkout", "ActiveState-CLI/Empty")
 	cp.Expect("Checked out project")
 	cp.ExpectExitCode(0)
 
 	// Create a zsh RC file
 	var zshRcFile string
-	var err error
-	if runtime.GOOS != "windows" {
-		zsh := &zsh.SubShell{}
-		zshRcFile, err = zsh.RcFile()
-		suite.NoError(err)
-	}
+	ts.WithEnv(func() {
+		var err error
+		if runtime.GOOS != "windows" {
+			zsh := &zsh.SubShell{}
+			zshRcFile, err = zsh.RcFile()
+			suite.NoError(err)
+		}
+	})
 
 	cp = ts.SpawnWithOpts(
 		e2e.OptArgs("use", "ActiveState-CLI/Empty"),
@@ -216,13 +221,12 @@ func (suite *ShellIntegrationTestSuite) TestUseShellUpdates() {
 	cp.ExpectExitCode(0)
 
 	// Ensure both bash and zsh RC files are updated
-	cfg, err := config.New()
-	suite.NoError(err)
-	rcfile, err := subshell.New(cfg).RcFile()
+	rcfile, err := subshell.New(ts.Config()).RcFile()
+	rcfile = filepath.Join(ts.Dirs.HomeDir, filepath.Base(rcfile))
 	if runtime.GOOS != "windows" && fileutils.FileExists(rcfile) {
 		suite.NoError(err)
-		suite.Contains(string(fileutils.ReadFileUnsafe(rcfile)), ts.Dirs.DefaultBin, "PATH does not have your project in it")
-		suite.Contains(string(fileutils.ReadFileUnsafe(zshRcFile)), ts.Dirs.DefaultBin, "PATH does not have your project in it")
+		suite.Contains(string(fileutils.ReadFileUnsafe(rcfile)), ts.Dirs.DefaultBin, rcfile+": PATH does not have your project in it")
+		suite.Contains(string(fileutils.ReadFileUnsafe(zshRcFile)), ts.Dirs.DefaultBin, zshRcFile+": PATH does not have your project in it")
 	}
 }
 
@@ -237,15 +241,6 @@ func (suite *ShellIntegrationTestSuite) TestJSON() {
 	AssertValidJSON(suite.T(), cp)
 }
 
-func (suite *ShellIntegrationTestSuite) SetupRCFile(ts *e2e.Session) {
-	if runtime.GOOS == "windows" {
-		return
-	}
-
-	ts.SetupRCFile()
-	ts.SetupRCFileCustom(&zsh.SubShell{})
-}
-
 func (suite *ShellIntegrationTestSuite) TestRuby() {
 	suite.OnlyRunForTags(tagsuite.Shell)
 	ts := e2e.New(suite.T(), false)