Retain current working directory between steeps (#267)

Make it so that the CWD is preserved between runs similar to how it is
for ENV variables

Author: aamini7

.gitattributes

@@ -0,0 +1,2 @@
+*.md text eol=lf 
+*.sh text eol=lf

.gitignore

@@ -1,9 +1,6 @@
 # Python
 __pycache__
 
-#VS Code
-.vscode
-
 # Ignore all binaries.
 bin/
 

.vscode/launch.json

@@ -0,0 +1,31 @@
+{
+  // Use IntelliSense to learn about possible attributes.
+  // Hover to view descriptions of existing attributes.
+  // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
+  "version": "0.2.0",
+  "configurations": [
+    {
+      "name": "Launch file",
+      "type": "go",
+      "request": "launch",
+      "mode": "debug",
+      "cwd": "${workspaceFolder}",
+      "program": "${workspaceFolder}/cmd/ie/ie.go",
+      "console": "integratedTerminal",
+      "args": [
+        "interactive",
+        "--working-directory",
+        "${workspaceFolder}",
+        "${workspaceFolder}/${input:file}"
+      ]
+    },
+  ],
+  "inputs": [
+    {
+      "id": "file",
+      "type": "promptString",
+      "description": "Enter the path to the file to process",
+      "default": "tutorial.md"
+    }
+  ]
+}

SUPPORT.md

@@ -1,25 +1,25 @@
-# TODO: The maintainer of this repo has not yet edited this file
-
-**REPO OWNER**: Do you want Customer Service & Support (CSS) support for this product/project?
-
-- **No CSS support:** Fill out this template with information about how to file issues and get help.
-- **Yes CSS support:** Fill out an intake form at [aka.ms/onboardsupport](https://aka.ms/onboardsupport). CSS will work with/help you to determine next steps.
-- **Not sure?** Fill out an intake as though the answer were "Yes". CSS will help you decide.
-
-*Then remove this first heading from this SUPPORT.MD file before publishing your repo.*
-
-# Support
-
-## How to file issues and get help  
-
-This project uses GitHub Issues to track bugs and feature requests. Please search the existing 
-issues before filing new issues to avoid duplicates.  For new issues, file your bug or 
-feature request as a new Issue.
-
-For help and questions about using this project, please **REPO MAINTAINER: INSERT INSTRUCTIONS HERE 
-FOR HOW TO ENGAGE REPO OWNERS OR COMMUNITY FOR HELP. COULD BE A STACK OVERFLOW TAG OR OTHER
-CHANNEL. WHERE WILL YOU HELP PEOPLE?**.
-
-## Microsoft Support Policy  
-
-Support for this **PROJECT or PRODUCT** is limited to the resources listed above.
+# TODO: The maintainer of this repo has not yet edited this file
+
+**REPO OWNER**: Do you want Customer Service & Support (CSS) support for this product/project?
+
+- **No CSS support:** Fill out this template with information about how to file issues and get help.
+- **Yes CSS support:** Fill out an intake form at [aka.ms/onboardsupport](https://aka.ms/onboardsupport). CSS will work with/help you to determine next steps.
+- **Not sure?** Fill out an intake as though the answer were "Yes". CSS will help you decide.
+
+*Then remove this first heading from this SUPPORT.MD file before publishing your repo.*
+
+# Support
+
+## How to file issues and get help  
+
+This project uses GitHub Issues to track bugs and feature requests. Please search the existing 
+issues before filing new issues to avoid duplicates.  For new issues, file your bug or 
+feature request as a new Issue.
+
+For help and questions about using this project, please **REPO MAINTAINER: INSERT INSTRUCTIONS HERE 
+FOR HOW TO ENGAGE REPO OWNERS OR COMMUNITY FOR HELP. COULD BE A STACK OVERFLOW TAG OR OTHER
+CHANNEL. WHERE WILL YOU HELP PEOPLE?**.
+
+## Microsoft Support Policy  
+
+Support for this **PROJECT or PRODUCT** is limited to the resources listed above.

internal/engine/execution.go

@@ -316,8 +316,18 @@ func (e *Engine) ExecuteAndRenderSteps(steps []common.Step, env map[string]strin
 			return err
 		}
 
+		logging.GlobalLogger.Info(
+			"Cleaning working directory file located at /tmp/working-dir",
+		)
+		err = lib.DeleteWorkingDirectoryStateFile(lib.DefaultWorkingDirectoryStateFile)
+		if err != nil {
+			logging.GlobalLogger.Errorf("Error cleaning working directory: %s", err.Error())
+			return err
+		}
+
 	default:
 		lib.DeleteEnvironmentStateFile(lib.DefaultEnvironmentStateFile)
+		lib.DeleteWorkingDirectoryStateFile(lib.DefaultWorkingDirectoryStateFile)
 	}
 
 	return nil

internal/lib/env.go

@@ -23,9 +23,10 @@ func GetEnvironmentVariables() map[string]string {
 	return envMap
 }
 
-// Location where the environment state from commands are to be captured
-// and sent to for being able to share state across commands.
+// Location where the environment and working directory state from commands are
+// to be captured and sent to for being able to share state across commands.
 var DefaultEnvironmentStateFile = "/tmp/env-vars"
+var DefaultWorkingDirectoryStateFile = "/tmp/working-dir"
 
 // Loads a file that contains environment variables
 func LoadEnvironmentStateFile(path string) (map[string]string, error) {
@@ -97,3 +98,23 @@ func filterInvalidKeys(envMap map[string]string) map[string]string {
 func DeleteEnvironmentStateFile(path string) error {
 	return os.Remove(path)
 }
+
+// Loads a file that contains the working directory
+func LoadWorkingDirectoryStateFile(path string) (string, error) {
+	if !fs.FileExists(path) {
+		return "", fmt.Errorf("working directory file '%s' does not exist", path)
+	}
+
+	content, err := os.ReadFile(path)
+	if err != nil {
+		return "", fmt.Errorf("failed to read working directory file '%s': %w", path, err)
+	}
+
+	workingDir := strings.TrimSpace(string(content))
+	return workingDir, nil
+}
+
+// Deletes the stored working directory file.
+func DeleteWorkingDirectoryStateFile(path string) error {
+	return os.Remove(path)
+}

internal/shells/bash.go

@@ -59,6 +59,7 @@ func executeBashCommandImpl(
 		command,
 		"IE_LAST_COMMAND_EXIT_CODE=\"$?\"",
 		"env > " + lib.DefaultEnvironmentStateFile,
+		"pwd > " + lib.DefaultWorkingDirectoryStateFile,
 		"exit $IE_LAST_COMMAND_EXIT_CODE",
 	}
 
@@ -82,11 +83,13 @@ func executeBashCommandImpl(
 		commandToExecute.Env = os.Environ()
 	}
 
-	// Sharing environment variable state between isolated shell executions is a
-	// bit tough, but how we handle it is by storing the environment variables
-	// after a command is executed within a file and then loading that file
-	// before executing the next command. This allows us to share state between
-	// isolated command calls.
+	// Sharing environment variables and the working directory between isolated
+	// shell executions is a bit tough, but how we handle it is by storing the
+	// environment variables after a command is executed within a file and then
+	// loading that file before executing the next command. This allows us to
+	// share state between isolated command calls.
+
+	// Restore env variables
 	envFromPreviousStep, err := lib.LoadEnvironmentStateFile(lib.DefaultEnvironmentStateFile)
 	if err == nil {
 		merged := lib.MergeMaps(config.EnvironmentVariables, envFromPreviousStep)
@@ -98,6 +101,13 @@ func executeBashCommandImpl(
 			commandToExecute.Env = append(commandToExecute.Env, fmt.Sprintf("%s=%s", k, v))
 		}
 	}
+	// Restore working directory
+	workingDirFromPreviousStep, err := lib.LoadWorkingDirectoryStateFile(lib.DefaultWorkingDirectoryStateFile)
+	if err == nil {
+		commandToExecute.Dir = workingDirFromPreviousStep
+	} else {
+		commandToExecute.Dir = ""
+	}
 
 	if config.WriteToHistory {