feat: add suppress_stderr argument to hooks

[paololazzari]

Description

Fixes #3770.

Adds suppress_stderr argument to hooks.

TODOs

Read the Gruntwork contribution guidelines.

• Update the docs.
• Run the relevant tests successfully, including pre-commit checks.
• Ensure any 3rd party code adheres with our license policy or delete this line if its not applicable.
• Include release notes. If this PR is backward incompatible, include a migration guide.

Release Notes (draft)

Added / Removed / Updated [X].

Migration Guide

[paololazzari]

Given hook.sh:

#!/bin/bash

>&1 echo "stdout"
>&2 echo "stderr"

then with the following hook:

terraform {
  after_hook "after_hook" {
    commands     = ["plan"]
    execute      = ["./hook.sh"]
    run_on_error = true
    suppress_stdout = true
    suppress_stderr = false
  }
}

$ go run main.go plan
...
12:21:35.082 INFO   Executing hook: after_hook
stderr

and with the following hook:

terraform {
  after_hook "after_hook" {
    commands     = ["plan"]
    execute      = ["./hook.sh"]
    run_on_error = true
    suppress_stdout = true
    suppress_stderr = true
  }
}

$ go run main.go plan
...
12:22:05.338 INFO   Executing hook: after_hook

[yhakbar]

Hey @paololazzari ,

Thanks for contributing this. Awesome to see you get engaged in the project!

If you don't mind, could you also add tests to confirm that stderr suppression does and doesn't happen when controlled by the new attribute?

[paololazzari]

@yhakbar I added a couple of tests. I had to use a shell script to write to stderr. What do you think?

[yhakbar]

@paololazzari , running the tests now. Thanks for adding those! The more recent docs update did result in a conflict with main, though.

Just FYI, I think Feature flags are a good way of creating fixtures that can be changed dynamically. In this scenario, I would have just created one fixture, then toggled stderr suppression so that there's one test with two test cases.

You don't have to change your test, just wanted to make sure you knew that was available for you.

[paololazzari]

@yhakbar Thanks, I'll look into that. I also updated a couple of existing tests, hopefully I did the right thing there. I'll fix the docs conflict.

[paololazzari]

@yhakbar just rebased against main

[yhakbar]

Hey @paololazzari ,

We're getting linting errors in CI:

test/integration_hooks_test.go:406:21: S1030: should use showStderr.String() instead of string(showStderr.Bytes()) (gosimple)
        assert.Contains(t, string(showStderr.Bytes()), "ERROR MESSAGE")
                           ^
test/integration_hooks_test.go:424:24: S1030: should use showStderr.String() instead of string(showStderr.Bytes()) (gosimple)
        assert.NotContains(t, string(showStderr.Bytes()), "ERROR MESSAGE")
                              ^

Check out our docs on linting if you need help setting that up locally.

[paololazzari]

@yhakbar I've addressed those linting errors