bzltestutil

Documentation

Index

• Constants
• Variables
• func ShouldWrap() bool
• func Wrap(pkg string) error
• type Converter
  • func NewConverter(w io.Writer, pkg string, mode Mode) *Converter
  • func (c *Converter) Close() error
  • func (c *Converter) Exited(err error)
  • func (c *Converter) Write(b []byte) (int, error)
• type Mode

Constants

const TestWrapperAbnormalExit = 6

TestWrapperAbnormalExit is used by Wrap to indicate the child process exitted without an exit code (for example being killed by a signal). We use 6, in line with Bazel's RUN_FAILURE.

Variables

var (
	// Initialized by linker.
	RunDir string
)

Functions

func ShouldWrap

func ShouldWrap() bool

func Wrap

func Wrap(pkg string) error

Types

type Converter

type Converter struct {
	// contains filtered or unexported fields
}

A Converter holds the state of a test-to-JSON conversion. It implements io.WriteCloser; the caller writes test output in, and the converter writes JSON output to w.

func NewConverter

func NewConverter(w io.Writer, pkg string, mode Mode) *Converter

NewConverter returns a "test to json" converter. Writes on the returned writer are written as JSON to w, with minimal delay.

The writes to w are whole JSON events ending in \n, so that it is safe to run multiple tests writing to multiple converters writing to a single underlying output stream w. As long as the underlying output w can handle concurrent writes from multiple goroutines, the result will be a JSON stream describing the relative ordering of execution in all the concurrent tests.

The mode flag adjusts the behavior of the converter. Passing ModeTime includes event timestamps and elapsed times.

The pkg string, if present, specifies the import path to report in the JSON stream.

func (*Converter) Close

func (c *Converter) Close() error

Close marks the end of the go test output. It flushes any pending input and then output (only partial lines at this point) and then emits the final overall package-level pass/fail event.

func (*Converter) Exited

func (c *Converter) Exited(err error)

Exited marks the test process as having exited with the given error.

func (*Converter) Write

func (c *Converter) Write(b []byte) (int, error)

Write writes the test input to the converter.

type Mode

type Mode int

Mode controls details of the conversion.

const (
	Timestamp Mode = 1 << iota // include Time in events
)