...

Package internal

import "github.com/onsi/gomega/internal"
Overview
Index
Subdirectories

Overview ▾

Index ▾

Constants
Variables
type Assertion
    func NewAssertion(actualInput interface{}, g *Gomega, offset int, extra ...interface{}) *Assertion
    func (assertion *Assertion) Error() types.Assertion
    func (assertion *Assertion) NotTo(matcher types.GomegaMatcher, optionalDescription ...interface{}) bool
    func (assertion *Assertion) Should(matcher types.GomegaMatcher, optionalDescription ...interface{}) bool
    func (assertion *Assertion) ShouldNot(matcher types.GomegaMatcher, optionalDescription ...interface{}) bool
    func (assertion *Assertion) To(matcher types.GomegaMatcher, optionalDescription ...interface{}) bool
    func (assertion *Assertion) ToNot(matcher types.GomegaMatcher, optionalDescription ...interface{}) bool
    func (assertion *Assertion) WithOffset(offset int) types.Assertion
type AsyncAssertion
    func NewAsyncAssertion(asyncType AsyncAssertionType, actualInput interface{}, g *Gomega, timeoutInterval time.Duration, pollingInterval time.Duration, mustPassRepeatedly int, ctx context.Context, offset int) *AsyncAssertion
    func (assertion *AsyncAssertion) MustPassRepeatedly(count int) types.AsyncAssertion
    func (assertion *AsyncAssertion) ProbeEvery(interval time.Duration) types.AsyncAssertion
    func (assertion *AsyncAssertion) Should(matcher types.GomegaMatcher, optionalDescription ...interface{}) bool
    func (assertion *AsyncAssertion) ShouldNot(matcher types.GomegaMatcher, optionalDescription ...interface{}) bool
    func (assertion *AsyncAssertion) WithArguments(argsToForward ...interface{}) types.AsyncAssertion
    func (assertion *AsyncAssertion) WithContext(ctx context.Context) types.AsyncAssertion
    func (assertion *AsyncAssertion) WithOffset(offset int) types.AsyncAssertion
    func (assertion *AsyncAssertion) WithPolling(interval time.Duration) types.AsyncAssertion
    func (assertion *AsyncAssertion) WithTimeout(interval time.Duration) types.AsyncAssertion
    func (assertion *AsyncAssertion) Within(timeout time.Duration) types.AsyncAssertion
type AsyncAssertionType
    func (at AsyncAssertionType) String() string
type DurationBundle
    func FetchDefaultDurationBundle() DurationBundle
type Gomega
    func NewGomega(bundle DurationBundle) *Gomega
    func (g *Gomega) ConfigureWithFailHandler(fail types.GomegaFailHandler) *Gomega
    func (g *Gomega) ConfigureWithT(t types.GomegaTestingT) *Gomega
    func (g *Gomega) Consistently(actualOrCtx interface{}, args ...interface{}) types.AsyncAssertion
    func (g *Gomega) ConsistentlyWithOffset(offset int, actualOrCtx interface{}, args ...interface{}) types.AsyncAssertion
    func (g *Gomega) Eventually(actualOrCtx interface{}, args ...interface{}) types.AsyncAssertion
    func (g *Gomega) EventuallyWithOffset(offset int, actualOrCtx interface{}, args ...interface{}) types.AsyncAssertion
    func (g *Gomega) Expect(actual interface{}, extra ...interface{}) types.Assertion
    func (g *Gomega) ExpectWithOffset(offset int, actual interface{}, extra ...interface{}) types.Assertion
    func (g *Gomega) IsConfigured() bool
    func (g *Gomega) SetDefaultConsistentlyDuration(t time.Duration)
    func (g *Gomega) SetDefaultConsistentlyPollingInterval(t time.Duration)
    func (g *Gomega) SetDefaultEventuallyPollingInterval(t time.Duration)
    func (g *Gomega) SetDefaultEventuallyTimeout(t time.Duration)
    func (g *Gomega) Ω(actual interface{}, extra ...interface{}) types.Assertion
type PollingSignalError
type PollingSignalErrorAttachment
type PollingSignalErrorImpl
    func AsPollingSignalError(actual interface{}) (*PollingSignalErrorImpl, bool)
    func (s *PollingSignalErrorImpl) Attach(description string, obj any) PollingSignalError
    func (s *PollingSignalErrorImpl) Error() string
    func (s *PollingSignalErrorImpl) IsStopTrying() bool
    func (s *PollingSignalErrorImpl) IsTryAgainAfter() bool
    func (s *PollingSignalErrorImpl) Now()
    func (s *PollingSignalErrorImpl) TryAgainDuration() time.Duration
    func (s *PollingSignalErrorImpl) Unwrap() error
    func (s *PollingSignalErrorImpl) Wrap(err error) PollingSignalError
type PollingSignalErrorType

Package files

assertion.go async_assertion.go duration_bundle.go gomega.go polling_signal_error.go vetoptdesc.go

Constants

const (
    EventuallyTimeoutEnvVarName         = "GOMEGA_DEFAULT_EVENTUALLY_TIMEOUT"
    EventuallyPollingIntervalEnvVarName = "GOMEGA_DEFAULT_EVENTUALLY_POLLING_INTERVAL"

    ConsistentlyDurationEnvVarName        = "GOMEGA_DEFAULT_CONSISTENTLY_DURATION"
    ConsistentlyPollingIntervalEnvVarName = "GOMEGA_DEFAULT_CONSISTENTLY_POLLING_INTERVAL"
)

Variables

var StopTrying = func(message string) PollingSignalError {
    return &PollingSignalErrorImpl{
        message:                message,
        pollingSignalErrorType: PollingSignalErrorTypeStopTrying,
    }
}
var TryAgainAfter = func(duration time.Duration) PollingSignalError {
    return &PollingSignalErrorImpl{
        message:                fmt.Sprintf("told to try again after %s", duration),
        duration:               duration,
        pollingSignalErrorType: PollingSignalErrorTypeTryAgainAfter,
    }
}

type Assertion

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

func NewAssertion

func NewAssertion(actualInput interface{}, g *Gomega, offset int, extra ...interface{}) *Assertion

func (*Assertion) Error

func (assertion *Assertion) Error() types.Assertion

func (*Assertion) NotTo

func (assertion *Assertion) NotTo(matcher types.GomegaMatcher, optionalDescription ...interface{}) bool

func (*Assertion) Should

func (assertion *Assertion) Should(matcher types.GomegaMatcher, optionalDescription ...interface{}) bool

func (*Assertion) ShouldNot

func (assertion *Assertion) ShouldNot(matcher types.GomegaMatcher, optionalDescription ...interface{}) bool

func (*Assertion) To

func (assertion *Assertion) To(matcher types.GomegaMatcher, optionalDescription ...interface{}) bool

func (*Assertion) ToNot

func (assertion *Assertion) ToNot(matcher types.GomegaMatcher, optionalDescription ...interface{}) bool

func (*Assertion) WithOffset

func (assertion *Assertion) WithOffset(offset int) types.Assertion

type AsyncAssertion

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

func NewAsyncAssertion

func NewAsyncAssertion(asyncType AsyncAssertionType, actualInput interface{}, g *Gomega, timeoutInterval time.Duration, pollingInterval time.Duration, mustPassRepeatedly int, ctx context.Context, offset int) *AsyncAssertion

func (*AsyncAssertion) MustPassRepeatedly

func (assertion *AsyncAssertion) MustPassRepeatedly(count int) types.AsyncAssertion

func (*AsyncAssertion) ProbeEvery

func (assertion *AsyncAssertion) ProbeEvery(interval time.Duration) types.AsyncAssertion

func (*AsyncAssertion) Should

func (assertion *AsyncAssertion) Should(matcher types.GomegaMatcher, optionalDescription ...interface{}) bool

func (*AsyncAssertion) ShouldNot

func (assertion *AsyncAssertion) ShouldNot(matcher types.GomegaMatcher, optionalDescription ...interface{}) bool

func (*AsyncAssertion) WithArguments

func (assertion *AsyncAssertion) WithArguments(argsToForward ...interface{}) types.AsyncAssertion

func (*AsyncAssertion) WithContext

func (assertion *AsyncAssertion) WithContext(ctx context.Context) types.AsyncAssertion

func (*AsyncAssertion) WithOffset

func (assertion *AsyncAssertion) WithOffset(offset int) types.AsyncAssertion

func (*AsyncAssertion) WithPolling

func (assertion *AsyncAssertion) WithPolling(interval time.Duration) types.AsyncAssertion

func (*AsyncAssertion) WithTimeout

func (assertion *AsyncAssertion) WithTimeout(interval time.Duration) types.AsyncAssertion

func (*AsyncAssertion) Within

func (assertion *AsyncAssertion) Within(timeout time.Duration) types.AsyncAssertion

type AsyncAssertionType

type AsyncAssertionType uint
const (
    AsyncAssertionTypeEventually AsyncAssertionType = iota
    AsyncAssertionTypeConsistently
)

func (AsyncAssertionType) String

func (at AsyncAssertionType) String() string

type DurationBundle

type DurationBundle struct {
    EventuallyTimeout           time.Duration
    EventuallyPollingInterval   time.Duration
    ConsistentlyDuration        time.Duration
    ConsistentlyPollingInterval time.Duration
}

func FetchDefaultDurationBundle

func FetchDefaultDurationBundle() DurationBundle

type Gomega

type Gomega struct {
    Fail           types.GomegaFailHandler
    THelper        func()
    DurationBundle DurationBundle
}

func NewGomega

func NewGomega(bundle DurationBundle) *Gomega

func (*Gomega) ConfigureWithFailHandler

func (g *Gomega) ConfigureWithFailHandler(fail types.GomegaFailHandler) *Gomega

func (*Gomega) ConfigureWithT

func (g *Gomega) ConfigureWithT(t types.GomegaTestingT) *Gomega

func (*Gomega) Consistently

func (g *Gomega) Consistently(actualOrCtx interface{}, args ...interface{}) types.AsyncAssertion

func (*Gomega) ConsistentlyWithOffset

func (g *Gomega) ConsistentlyWithOffset(offset int, actualOrCtx interface{}, args ...interface{}) types.AsyncAssertion

func (*Gomega) Eventually

func (g *Gomega) Eventually(actualOrCtx interface{}, args ...interface{}) types.AsyncAssertion

func (*Gomega) EventuallyWithOffset

func (g *Gomega) EventuallyWithOffset(offset int, actualOrCtx interface{}, args ...interface{}) types.AsyncAssertion

func (*Gomega) Expect

func (g *Gomega) Expect(actual interface{}, extra ...interface{}) types.Assertion

func (*Gomega) ExpectWithOffset

func (g *Gomega) ExpectWithOffset(offset int, actual interface{}, extra ...interface{}) types.Assertion

func (*Gomega) IsConfigured

func (g *Gomega) IsConfigured() bool

func (*Gomega) SetDefaultConsistentlyDuration

func (g *Gomega) SetDefaultConsistentlyDuration(t time.Duration)

func (*Gomega) SetDefaultConsistentlyPollingInterval

func (g *Gomega) SetDefaultConsistentlyPollingInterval(t time.Duration)

func (*Gomega) SetDefaultEventuallyPollingInterval

func (g *Gomega) SetDefaultEventuallyPollingInterval(t time.Duration)

func (*Gomega) SetDefaultEventuallyTimeout

func (g *Gomega) SetDefaultEventuallyTimeout(t time.Duration)

func (*Gomega) Ω

func (g *Gomega) Ω(actual interface{}, extra ...interface{}) types.Assertion

type PollingSignalError

type PollingSignalError interface {
    error
    Wrap(err error) PollingSignalError
    Attach(description string, obj any) PollingSignalError
    Now()
}

type PollingSignalErrorAttachment

type PollingSignalErrorAttachment struct {
    Description string
    Object      any
}

type PollingSignalErrorImpl

type PollingSignalErrorImpl struct {
    Attachments []PollingSignalErrorAttachment
    // contains filtered or unexported fields
}

func AsPollingSignalError

func AsPollingSignalError(actual interface{}) (*PollingSignalErrorImpl, bool)

func (*PollingSignalErrorImpl) Attach

func (s *PollingSignalErrorImpl) Attach(description string, obj any) PollingSignalError

func (*PollingSignalErrorImpl) Error

func (s *PollingSignalErrorImpl) Error() string

func (*PollingSignalErrorImpl) IsStopTrying

func (s *PollingSignalErrorImpl) IsStopTrying() bool

func (*PollingSignalErrorImpl) IsTryAgainAfter

func (s *PollingSignalErrorImpl) IsTryAgainAfter() bool

func (*PollingSignalErrorImpl) Now

func (s *PollingSignalErrorImpl) Now()

func (*PollingSignalErrorImpl) TryAgainDuration

func (s *PollingSignalErrorImpl) TryAgainDuration() time.Duration

func (*PollingSignalErrorImpl) Unwrap

func (s *PollingSignalErrorImpl) Unwrap() error

func (*PollingSignalErrorImpl) Wrap

func (s *PollingSignalErrorImpl) Wrap(err error) PollingSignalError

type PollingSignalErrorType

type PollingSignalErrorType int
const (
    PollingSignalErrorTypeStopTrying PollingSignalErrorType = iota
    PollingSignalErrorTypeTryAgainAfter
)

Subdirectories

Name Synopsis
..