testutil

testutil Package

Shared test helpers for isolated temporary directories, stderr capture, and YAML comment stripping in Go test files.

The testutil package provides shared test helpers for isolating test artifacts and capturing output.

Overview

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.Stderr output during tests.
• A helper for stripping YAML comment headers from compiled workflow output.

Public API

Functions

Usage Examples

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")
}

Dependencies

Internal:

• github.com/github/gh-aw/pkg/constants — shared filesystem permission constants for temp directory creation

Design Decisions

• GetTestRunDir uses sync.Once so the directory is created exactly once per process even when multiple test packages run concurrently.
• TempDir delegates to os.MkdirTemp to generate unique subdirectory names.
• Test artifacts placed in the test run directory are outside any git repository, which prevents git commands executed by tests from picking them up as untracked files.

Thread Safety

GetTestRunDir is safe to call concurrently from multiple goroutines; the underlying sync.Once ensures the directory is created exactly once. TempDir and CaptureStderr require a valid *testing.T and MUST be called from a single test goroutine only (as required by the testing package).

This specification is automatically maintained by the spec-extractor workflow.