testlog

Documentation

Overview

Package testlog provides utilities for logging test output.

Index

• func LogCommand(t *testing.T, msg string, cmd *exec.Cmd)
• func LogEndSeparator(t *testing.T, args ...any)
• func LogEndSeparatorf(t *testing.T, s string, args ...any)
• func LogRedEndSeparator(t *testing.T, args ...any)
• func LogRedEndSeparatorf(t *testing.T, s string, args ...any)
• func LogStartSeparator(t *testing.T, args ...any)
• func LogStartSeparatorf(t *testing.T, s string, args ...any)
• func RunWithTiming(t *testing.T, msg string, cmd *exec.Cmd, options ...RunWithTimingOption) error
• type RunWithTimingOption
  • func DoNotSetStdoutAndStderr() RunWithTimingOption
  • func OnlyPrintStdoutAndStderrOnError() RunWithTimingOption

Functions

func LogCommand

func LogCommand(t *testing.T, msg string, cmd *exec.Cmd)

LogCommand logs the given command to stderr.

func LogEndSeparator

func LogEndSeparator(t *testing.T, args ...any)

LogEndSeparator logs a separator to stderr with the given message.

func LogEndSeparatorf

func LogEndSeparatorf(t *testing.T, s string, args ...any)

LogEndSeparatorf logs a separator to stderr with the given formatted message.

func LogRedEndSeparator

func LogRedEndSeparator(t *testing.T, args ...any)

LogRedEndSeparator logs a separator to stderr with the given message in red.

func LogRedEndSeparatorf

func LogRedEndSeparatorf(t *testing.T, s string, args ...any)

LogRedEndSeparatorf logs a separator to stderr with the given formatted message in red.

func LogStartSeparator

func LogStartSeparator(t *testing.T, args ...any)

LogStartSeparator logs a separator to stderr with the given message.

func LogStartSeparatorf

func LogStartSeparatorf(t *testing.T, s string, args ...any)

LogStartSeparatorf logs a separator to stderr with the given formatted message.

func RunWithTiming

func RunWithTiming(t *testing.T, msg string, cmd *exec.Cmd, options ...RunWithTimingOption) error

RunWithTiming runs the given command while logging its duration with the provided message.

Types

type RunWithTimingOption

type RunWithTimingOption func(options *runWithTimingOptions)

RunWithTimingOption is a function that configures the RunWithTiming function.

func DoNotSetStdoutAndStderr

func DoNotSetStdoutAndStderr() RunWithTimingOption

DoNotSetStdoutAndStderr prevents RunWithTiming from setting the stdout and stderr of the given command. By default, RunWithTiming sets stdout and stderr to the test's output.

func OnlyPrintStdoutAndStderrOnError

func OnlyPrintStdoutAndStderrOnError() RunWithTimingOption

OnlyPrintStdoutAndStderrOnError makes RunWithTiming only print the stdout and stderr of the given command if it fails.