testutil

Documentation

Index

• Variables
• func IfCI[T any](t T) ifExpr[T]
• func IfTesting[T any](t T) ifExpr[T]
• func MergeCoverProfiles(filenames []string, output io.Writer, opts ...ProfileOption) error
• func Must[T any](t T, err ...error) T
• func NewTestLogger() logr.Logger
• func PortForward(ctx context.Context, service types.NamespacedName, servicePorts []string, ...) ([]portforward.ForwardedPort, error)
• func ProtoEqual(expected proto.Message) types.GomegaMatcher
• type ProfileOption
  • func WithExcludePatterns(excludePatterns ...string) ProfileOption
  • func WithKeepMergedProfiles(keep bool) ProfileOption
• type ProfileOptions
• type ProtoMatcher
  • func (matcher *ProtoMatcher) FailureMessage(actual any) (message string)
  • func (matcher *ProtoMatcher) Match(actual any) (success bool, err error)
  • func (matcher *ProtoMatcher) NegatedFailureMessage(actual any) (message string)
• type Session
  • func StartCmd(cmd *exec.Cmd) (Session, error)

Variables

var (
	IsTesting       = strings.HasSuffix(os.Args[0], ".test")
	IsGithubActions = os.Getenv("GITHUB_ACTIONS") == "true"
	IsDrone         = os.Getenv("DRONE") == "true"
	StdoutWriter    = lo.Ternary[io.Writer](IsTesting, ginkgo.GinkgoWriter, os.Stdout)
	StderrWriter    = lo.Ternary[io.Writer](IsTesting, ginkgo.GinkgoWriter, os.Stderr)
)

var EncoderConfig = zapcore.EncoderConfig{
	MessageKey:       "M",
	LevelKey:         "L",
	TimeKey:          "T",
	NameKey:          "N",
	CallerKey:        "C",
	FunctionKey:      "",
	StacktraceKey:    "S",
	ConsoleSeparator: " ",
	EncodeLevel:      zapcore.CapitalColorLevelEncoder,
	EncodeCaller: func(ec zapcore.EntryCaller, enc zapcore.PrimitiveArrayEncoder) {
		enc.AppendString(chalk.Dim.TextStyle(ec.TrimmedPath()))
	},
	EncodeName: func(name string, enc zapcore.PrimitiveArrayEncoder) {
		enc.AppendString(chalk.Dim.TextStyle(
			strings.Replace(name, "controller-runtime.manager.", "", 1)))
	},
	EncodeTime: func(t time.Time, enc zapcore.PrimitiveArrayEncoder) {
		enc.AppendString(t.Format("[15:04:05]"))
	},
	EncodeDuration: zapcore.SecondsDurationEncoder,
}

Functions

func IfCI

func IfCI[T any](t T) ifExpr[T]

func IfTesting

func IfTesting[T any](t T) ifExpr[T]

func MergeCoverProfiles

func MergeCoverProfiles(filenames []string, output io.Writer, opts ...ProfileOption) error

func Must

func Must[T any](t T, err ...error) T

func NewTestLogger

func NewTestLogger() logr.Logger

func PortForward

func PortForward(
	ctx context.Context,
	service types.NamespacedName,
	servicePorts []string,
	restConfig *rest.Config,
	scheme *runtime.Scheme,
) ([]portforward.ForwardedPort, error)

func ProtoEqual

func ProtoEqual(expected proto.Message) types.GomegaMatcher

Types

type ProfileOption

type ProfileOption func(*ProfileOptions)

func WithExcludePatterns

func WithExcludePatterns(excludePatterns ...string) ProfileOption

func WithKeepMergedProfiles

func WithKeepMergedProfiles(keep bool) ProfileOption

type ProfileOptions

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

type ProtoMatcher

type ProtoMatcher struct {
	Expected proto.Message
}

func (*ProtoMatcher) FailureMessage

func (matcher *ProtoMatcher) FailureMessage(actual any) (message string)

func (*ProtoMatcher) Match

func (matcher *ProtoMatcher) Match(actual any) (success bool, err error)

func (*ProtoMatcher) NegatedFailureMessage

func (matcher *ProtoMatcher) NegatedFailureMessage(actual any) (message string)

type Session

type Session interface {
	G() (*gexec.Session, bool)
	Wait() error
}

func StartCmd

func StartCmd(cmd *exec.Cmd) (Session, error)