wait

Documentation

Overview

Package wait provides functionalities for mocking testcontainers-go/wait.

Index

• Variables
• type Strategy
  • func (s *Strategy) WaitUntilReady(ctx context.Context, target wait.StrategyTarget) error
• type StrategyMocker
  • func MockStrategy(mocks ...func(s *Strategy)) StrategyMocker
• type StrategyTarget
  • func (s *StrategyTarget) Exec(ctx context.Context, cmd []string) (int, io.Reader, error)
  • func (s *StrategyTarget) Host(ctx context.Context) (string, error)
  • func (s *StrategyTarget) Logs(ctx context.Context) (io.ReadCloser, error)
  • func (s *StrategyTarget) MappedPort(ctx context.Context, port nat.Port) (nat.Port, error)
  • func (s *StrategyTarget) Ports(ctx context.Context) (nat.PortMap, error)
  • func (s *StrategyTarget) State(ctx context.Context) (*types.ContainerState, error)
• type StrategyTargetMocker
  • func MockStrategyTarget(mocks ...func(t *StrategyTarget)) StrategyTargetMocker

Variables

var NoMockStrategy = MockStrategy()

NoMockStrategy is no mock Strategy.

var NoMockStrategyTarget = MockStrategyTarget()

NoMockStrategyTarget is no mock StrategyTarget.

Types

type Strategy

type Strategy struct {
	mock.Mock
}

Strategy is a wait.Strategy.

func (*Strategy) WaitUntilReady

func (s *Strategy) WaitUntilReady(ctx context.Context, target wait.StrategyTarget) error

WaitUntilReady satisfies wait.Strategy interface.

type StrategyMocker

type StrategyMocker func(tb testing.TB) *Strategy

StrategyMocker is Strategy mocker.

func MockStrategy

func MockStrategy(mocks ...func(s *Strategy)) StrategyMocker

MockStrategy creates Strategy mock with cleanup to ensure all the expectations are met.

type StrategyTarget

type StrategyTarget struct {
	mock.Mock
}

StrategyTarget is a wait.StrategyTarget.

func (*StrategyTarget) Exec

func (s *StrategyTarget) Exec(ctx context.Context, cmd []string) (int, io.Reader, error)

Exec satisfies wait.StrategyTarget interface.

func (*StrategyTarget) Host

func (s *StrategyTarget) Host(ctx context.Context) (string, error)

Host satisfies wait.StrategyTarget interface.

func (*StrategyTarget) Logs

func (s *StrategyTarget) Logs(ctx context.Context) (io.ReadCloser, error)

Logs satisfies wait.StrategyTarget interface.

func (*StrategyTarget) MappedPort

func (s *StrategyTarget) MappedPort(ctx context.Context, port nat.Port) (nat.Port, error)

MappedPort satisfies wait.StrategyTarget interface.

func (*StrategyTarget) Ports

func (s *StrategyTarget) Ports(ctx context.Context) (nat.PortMap, error)

Ports satisfies wait.StrategyTarget interface.

func (*StrategyTarget) State

func (s *StrategyTarget) State(ctx context.Context) (*types.ContainerState, error)

State satisfies wait.StrategyTarget interface.

type StrategyTargetMocker

type StrategyTargetMocker func(tb testing.TB) *StrategyTarget

StrategyTargetMocker is StrategyTarget mocker.

func MockStrategyTarget

func MockStrategyTarget(mocks ...func(t *StrategyTarget)) StrategyTargetMocker

MockStrategyTarget creates StrategyTarget mock with cleanup to ensure all the expectations are met.