fix: temp folder path (#28)

Resolves a bug where temp folder path is not correctly mapped to
outstanding commands in certain scenarios.

---------

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Matt White <16320656+matt-FFFFFF@users.noreply.github.com>

Author: 3 people

.golangci.yml

@@ -35,7 +35,7 @@ linters:
     - unparam
     - unused
     - wrapcheck
-    - wsl
+    - wsl_v5
 
   exclusions:
     rules:

DEVELOPER.md

@@ -118,6 +118,36 @@ Contributions are welcome! Here's how to get started:
 
 6. **Open a Pull Request**
 
+### Debugging
+
+- Most example commands are bash based, so make sure you are running in an environment that supports bash. E.g. on Windows open VSCode from WSL
+- Create a launch.json file like this:
+
+   ```json
+   {
+      "version": "0.2.0",
+      "configurations": [
+         {
+               "name": "Launch Package",
+               "type": "go",
+               "request": "launch",
+               "mode": "debug",
+               "program": "${workspaceRoot}/cmd/porch/main.go",
+               "env": { "AVM_TEST_TYPE": "integration" },
+               "args": [ "run", "-f", "${workspaceRoot}/examples/terraform-test-unit.yaml", "-config-timeout", "10000"],
+               "cwd": "${workspaceRoot}/../terraform-azurerm-lz-vending"
+         }
+      ]
+   }
+   ```
+
+   - `args`: The is the porch config you want to debug
+   - `cwd`: This the target folder structure you want to run the command against
+   - `env`: This is any environment variables needed by your porch config
+- Set your break points and Run the VSCode debugger
+
+>NOTE: If you see a Delve related issue, try installing the latest version from trunk: `go install -v github.com/go-delve/delve/cmd/dlv@master`
+
 ### Development Guidelines
 
 - Write comprehensive tests for new features

cmd/porch/main.go

@@ -54,6 +54,7 @@ flow control, parallel processing, and comprehensive error handling.`,
 func main() {
 	ctx, cancel := context.WithCancel(context.Background())
 	ctx = ctxlog.New(ctx, ctxlog.DefaultLogger)
+
 	defer cancel()
 
 	sigCh := signalbroker.New(ctx)

cmd/porch/run/run.go

@@ -24,16 +24,17 @@ import (
 )
 
 const (
-	fileFlag                 = "file"
-	outFlag                  = "out"
-	noOutputStdErrFlag       = "no-output-stderr"
-	outputStdOutFlag         = "output-stdout"
-	outputSuccessDetailsFlag = "output-success-details"
-	parallelismFlag          = "parallelism"
-	tuiFlag                  = "tui"
-	writeFlag                = "write"
-	configTimeoutSeconds     = 30
-	cliExitStr               = ""
+	fileFlag                    = "file"
+	outFlag                     = "out"
+	noOutputStdErrFlag          = "no-output-stderr"
+	outputStdOutFlag            = "output-stdout"
+	outputSuccessDetailsFlag    = "output-success-details"
+	parallelismFlag             = "parallelism"
+	tuiFlag                     = "tui"
+	writeFlag                   = "write"
+	configTimeoutFlag           = "config-timeout"
+	configTimeoutSecondsDefault = 30
+	cliExitStr                  = ""
 )
 
 var (
@@ -116,6 +117,13 @@ To save the results to a file, specify the output file name as an argument.
 			TakesFile:   false,
 			OnlyOnce:    true,
 		},
+		&cli.IntFlag{
+			Name:    configTimeoutFlag,
+			Aliases: []string{"timeout"},
+			Usage: "Set the maximum time in seconds to wait for configuration building. " +
+				"Defaults to 30 seconds.",
+			Value: configTimeoutSecondsDefault,
+		},
 	},
 	Action: actionFunc,
 }
@@ -138,7 +146,7 @@ func actionFunc(ctx context.Context, cmd *cli.Command) error {
 	factory := ctx.Value(commands.FactoryContextKey{}).(commands.CommanderFactory)
 
 	// Create a timeout context for configuration building
-	configCtx, configCancel := context.WithTimeout(ctx, configTimeoutSeconds*time.Second)
+	configCtx, configCancel := context.WithTimeout(ctx, time.Duration(cmd.Int(configTimeoutFlag))*time.Second)
 	defer configCancel()
 
 	runnables := make([]runbatch.Runnable, len(url))

examples/terraform-test-unit.yaml

@@ -1,54 +1,87 @@
-name: Terraform unit test
-description: Terraform unit tests for root module and submodules
+name: Terraform test
+description: |
+  Terraform tests for root module and submodules, please set $AVM_TEST_TYPE to "unit" to run unit tests.
+  Set $AVM_TEST_TYPE to "integration" to run integration tests.
 command_groups:
-  - name: terraform_unit_tests
-    description: Run Terraform unit tests for root module and submodules
+  - name: terraform_tests
+    description: Run Terraform tests for root module and submodules
     commands:
+      - type: copycwdtotemp
+        name: Copy current working directory to temp
+        cwd: "."
+
+      - type: shell
+        name: Clean Terraform
+        command_line: |
+          echo $(pwd) && \
+          find . -type d -name .terraform | xargs -n1 rm -rf && \
+          find . -type f -name .terraform.lock.hcl | xargs -n1 rm -f && \
+          find . -type f -name *.tfstate* | xargs -n1 rm -f
+
       - type: shell
-        name: Check for unit tests
+        name: Check for AVM_TEST_TYPE env
         command_line: |
-          if [ ! -d ./tests/unit ]; then
-            echo "No unit tests found in $(pwd)"
+          if [ -z "$AVM_TEST_TYPE" ]; then
+            echo "AVM_TEST_TYPE is not set. Please set AVM_TEST_TYPE to 'unit' or 'integration'." 1>&2
+            echo "E.g. AVM_TEST_TYPE=\"unit\" # ... rest of your command" 1>&2
+            exit 1
+          fi
+
+      - type: shell
+        name: Check for tests
+        command_line: |
+          if [ ! -d ./tests/$AVM_TEST_TYPE ]; then
+            echo "No $AVM_TEST_TYPE tests found in $(pwd)"
             exit 99
           fi
         skip_exit_codes: [99]
+
+      - type: shell
+        name: Check and Run setup.sh
+        command_line: |
+          if [ -f ./tests/$AVM_TEST_TYPE/setup.sh ]; then
+            if [ ! -x ./tests/$AVM_TEST_TYPE/setup.sh ]; then
+              echo "Making setup.sh executable"
+              chmod +x ./tests/$AVM_TEST_TYPE/setup.sh
+            fi
+            echo "Running setup.sh"
+            ./tests/$AVM_TEST_TYPE/setup.sh
+          fi
+
       - type: shell
         name: "Terraform Init"
-        command_line: "terraform init -test-directory ./tests/unit"
+        command_line: "terraform init -test-directory ./tests/$AVM_TEST_TYPE"
+
       - type: shell
         name: "Terraform Test"
-        command_line: "terraform test -test-directory ./tests/unit"
+        command_line: "terraform test -test-directory ./tests/$AVM_TEST_TYPE"
 
-commands:
-  - type: copycwdtotemp
-    name: Copy current working directory to temp
-    cwd: "."
+      - type: shell
+        name: Clean up
+        command_line: |
+          rm -fr $(pwd)
+        runs_on_condition: always
 
+commands:
   - type: shell
-    name: Clean Terraform
-    command_line: |
-      echo $(pwd) && \
-      find . -type d -name .terraform | xargs -n1 rm -rf && \
-      find . -type f -name .terraform.lock.hcl | xargs -n1 rm -f && \
-      find . -type f -name *.tfstate* | xargs -n1 rm -f
+    name: install terraform
+    command_line: terraform -version
+    cwd: "."
 
   - type: parallel
-    name: Unit tests
+    name: Terraform tests
     env:
       TF_IN_AUTOMATION: "1"
     commands:
       - type: foreachdirectory
         name: submodules
+        depth: 1
         working_directory: "./modules"
         mode: parallel
-        command_group: terraform_unit_tests
+        skip_on_not_exist: true
+        command_group: terraform_tests
+        working_directory_strategy: item_relative
 
       - type: serial
         name: root module
-        command_group: terraform_unit_tests
-
-  - type: shell
-    name: Clean up
-    command_line: |
-      rm -fr $(pwd)
-    runs_on_condition: always
+        command_group: terraform_tests

internal/commandregistry/registry.go

@@ -150,6 +150,7 @@ func (r *Registry) resolveCommandGroupWithDepth(
 	// Check if we're currently visiting this group (circular dependency)
 	if visiting[groupName] {
 		cyclePath := append(path, groupName)
+
 		return nil, fmt.Errorf("%w: %s", ErrCircularDependency,
 			formatCircularDependencyPath(cyclePath))
 	}

internal/commands/command.go

@@ -86,7 +86,6 @@ func (d *BaseDefinition) ToBaseCommand(
 		d.WorkingDirectory,
 		parent.GetCwd(),
 	)
-
 	if err != nil {
 		return nil, errors.Join(ErrPath, err)
 	}
@@ -130,7 +129,6 @@ func HclCommandToBaseCommand(
 		hclCommand.WorkingDirectory,
 		parent.GetCwd(),
 	)
-
 	if err != nil {
 		return nil, err
 	}

internal/commands/copycwdtotemp/copyCwdToTemp.go

@@ -105,7 +105,6 @@ func New(base *runbatch.BaseCommand) *runbatch.FunctionCommand {
 					return afero.WriteFile(fs, dstPath, srcFile, info.Mode().Perm())
 				}
 			})
-
 			if err != nil {
 				return runbatch.FunctionCommandReturn{
 					Err: err,

internal/commands/copycwdtotemp/copyCwdToTemp_test.go

@@ -152,6 +152,7 @@ func TestCopyCwdToTemp_ErrorHandling(t *testing.T) {
 			setupFS: func() afero.Fs {
 				baseFs := afero.NewMemMapFs()
 				errPath := filepath.Join(tmpDir, "porch_testrun")
+
 				return &errorFS{fs: baseFs, errorPath: errPath}
 			},
 			testFunc: func(t *testing.T, fs afero.Fs) {
@@ -197,8 +198,10 @@ func TestCopyCwdToTemp_ErrorHandling(t *testing.T) {
 				if err != nil {
 					panic(err)
 				}
+
 				testFilePath := filepath.Join(srcDir, "file1.txt")
 				_ = afero.WriteFile(baseFs, testFilePath, []byte("content"), 0644)
+
 				return &errorFS{fs: baseFs, errorPath: testFilePath}
 			},
 			testFunc: func(t *testing.T, fs afero.Fs) {
@@ -272,7 +275,6 @@ func TestCopyCwdToTemp_ErrorHandling(t *testing.T) {
 				require.Len(t, results, 1)
 				assert.Equal(t, -1, results[0].ExitCode) // FunctionCommand.Run returns -1 for errors
 				assert.Equal(t, ctx.Err(), results[0].Error)
-
 			},
 		},
 	}

internal/commands/foreachdirectory/commander_hcl_test.go

@@ -83,13 +83,14 @@ type mockRunnable struct {
 func (m *mockRunnable) Run(ctx context.Context) runbatch.Results {
 	return runbatch.Results{}
 }
-func (m *mockRunnable) GetLabel() string                   { return m.label }
-func (m *mockRunnable) GetCwd() string                     { return "/" }
-func (m *mockRunnable) SetCwd(cwd string) error            { return nil }
-func (m *mockRunnable) GetCwdRel() string                  { return "" }
-func (m *mockRunnable) InheritEnv(env map[string]string)   {}
-func (m *mockRunnable) SetParent(parent runbatch.Runnable) {}
-func (m *mockRunnable) GetParent() runbatch.Runnable       { return nil }
+func (m *mockRunnable) GetLabel() string                          { return m.label }
+func (m *mockRunnable) GetCwd() string                            { return "/" }
+func (m *mockRunnable) SetCwd(cwd string) error                   { return nil }
+func (m *mockRunnable) SetCwdToSpecificAbsolute(cwd string) error { return nil }
+func (m *mockRunnable) GetCwdRel() string                         { return "" }
+func (m *mockRunnable) InheritEnv(env map[string]string)          {}
+func (m *mockRunnable) SetParent(parent runbatch.Runnable)        {}
+func (m *mockRunnable) GetParent() runbatch.Runnable              { return nil }
 func (m *mockRunnable) ShouldRun(state runbatch.PreviousCommandStatus) runbatch.ShouldRunAction {
 	return runbatch.ShouldRunActionRun
 }