testutil

Documentation

Overview

Package testutil contains common utilities to test Kythe libraries.

Index

• func DeepEqual[T any](expected, got T, opts ...cmp.Option) error
• func Errorf(t testing.TB, msg string, err error, args ...any)
• func Fatalf(t testing.TB, msg string, err error, args ...any)
• func JSONEqual(expected, got []byte) error
• func RandBytes(bytes []byte)
• func RandStr(size int) string
• func SetFlag(t testing.TB, flagName string, value string)
• func TestFilePath(t *testing.T, path string) string
• func TrimmedEqual(got, want []byte) (bool, string)
• func YAMLEqual(expected, got []byte) error

Functions

func DeepEqual

func DeepEqual[T any](expected, got T, opts ...cmp.Option) error

DeepEqual determines if expected is deeply equal to got, returning a detailed error if not. It is okay for expected and got to be protobuf message values.

func Errorf

func Errorf(t testing.TB, msg string, err error, args ...any)

Errorf is equivalent to t.Errorf(msg, err, args...) if err != nil.

func Fatalf

func Fatalf(t testing.TB, msg string, err error, args ...any)

Fatalf is equivalent to t.Fatalf(msg, err, args...) if err != nil.

func JSONEqual

func JSONEqual(expected, got []byte) error

JSONEqual compares two bytes assuming they are json, using encoding/json and DeepEqual.

func RandBytes

func RandBytes(bytes []byte)

RandBytes fills the given slice with random bytes

func RandStr

func RandStr(size int) string

RandStr returns a random string of the given length

func SetFlag

func SetFlag(t testing.TB, flagName string, value string)

SetFlag sets a flag to a value for the duration of the test, resetting it to the flag's default value during cleanup.

func TestFilePath

func TestFilePath(t *testing.T, path string) string

TestFilePath takes a path and resolves it based on the testdir. If it cannot successfully do so, it calls t.Fatal and abandons.

func TrimmedEqual

func TrimmedEqual(got, want []byte) (bool, string)

TrimmedEqual compares two strings after collapsing irrelevant whitespace at the beginning or end of lines. It returns both a boolean indicating equality, as well as any relevant diff.

func YAMLEqual

func YAMLEqual(expected, got []byte) error

YAMLEqual compares two bytes assuming they are yaml, by converting to json and doing an ordering-agnostic comparison. Note this carries some restrictions because yaml->json conversion fails for nil or binary map keys.