termitest

./termitest

Golden file testing for terminal output, inspired by testify

Installation

go get github.com/dottermi/termitest@latest

Usage

termitest provides two packages following the testify pattern:

• assert - Non-fatal assertions (test continues on failure)
• require - Fatal assertions (test stops on failure)

Basic Example

package myapp_test

import (
    "testing"

    "github.com/dottermi/termitest/assert"
)

func TestOutput(t *testing.T) {
    output := runMyProgram()
    assert.Golden(t, output)
}

Golden files are stored in testdata/{TestName}.golden and created automatically on first run.

Custom Messages

assert.Golden(t, output, "should match expected output")
assert.Golden(t, output, "user %s should see welcome message", username)

With Options

Use New() to create assertions with pre-configured options:

import (
    "github.com/dottermi/termitest"
    "github.com/dottermi/termitest/assert"
)

func TestTerminalOutput(t *testing.T) {
    a := assert.New(termitest.WithSize(80, 24))
    a.Golden(t, output)
}

func TestMultipleOutputs(t *testing.T) {
    simple := assert.New(termitest.WithName("simple"))
    simple.Golden(t, output1)

    fancy := assert.New(termitest.WithName("fancy"))
    fancy.Golden(t, output2)
}

Text Only (strip ANSI)

Use GoldenText to compare text without ANSI escape codes:

func TestColoredOutput(t *testing.T) {
    output := "\033[31mError:\033[0m something failed\n"
    assert.GoldenText(t, output)  // Compares: "Error: something failed\n"
}

Debugging Golden Files

Use PrintGolden to inspect the expected content during test development:

func TestOutput(t *testing.T) {
    termitest.PrintGolden(t)           // prints testdata/TestOutput.golden
    termitest.PrintGolden(t, "fancy")  // prints testdata/TestOutput_fancy.golden
}

Updating Golden Files

Use the -update flag to regenerate golden files:

go test -update              # Update all golden files
go test -run TestOutput -update  # Update specific test

API

Functions

Options

License