The testutil package provides shared test helpers for isolating test artifacts and capturing output.
This package is imported only in test files (_test.go). It provides:
- A shared, isolated temporary directory for each test run (outside the git repository).
- Per-test subdirectories that are cleaned up automatically.
- Helpers for capturing
os.Stderroutput during tests. - A helper for stripping YAML comment headers from compiled workflow output.
| Function | Signature | Description |
|---|---|---|
GetTestRunDir |
func() string |
Returns the path to the unique top-level directory for the current test run, created once per process under $TMPDIR/gh-aw-test-runs/<timestamp>-<pid> |
TempDir |
func(t *testing.T, pattern string) string |
Creates a temporary subdirectory inside the test run directory matching pattern; the directory is automatically removed when the test completes via t.Cleanup |
CaptureStderr |
func(t *testing.T, fn func()) string |
Runs fn and returns everything written to os.Stderr during its execution; os.Stderr is restored automatically via t.Cleanup |
StripYAMLCommentHeader |
func(yamlContent string) string |
Removes the leading comment block from a generated YAML file and returns only the non-comment content |
import "github.com/github/gh-aw/pkg/testutil"
func TestMyFunction(t *testing.T) {
// Create an isolated temp directory for test artifacts
dir := testutil.TempDir(t, "my-test-*")
// dir is cleaned up automatically when the test ends
// Capture output written to os.Stderr
output := testutil.CaptureStderr(t, func() {
myFunction() // function that writes to os.Stderr
})
assert.Contains(t, output, "expected message")
}GetTestRunDirusessync.Onceso the directory is created exactly once per process even when multiple test packages run concurrently.TempDirdelegates toos.MkdirTempto generate unique subdirectory names.- Test artifacts placed in the test run directory are outside any git repository, which prevents
gitcommands executed by tests from picking them up as untracked files.
This specification is automatically maintained by the spec-extractor workflow.