runner

Documentation

Index

• Constants
• func UniqueName() string
• type CouchDB
  • func (c *CouchDB) Address() string
  • func (c *CouchDB) ContainerAddress() string
  • func (c *CouchDB) ContainerID() string
  • func (c *CouchDB) HostAddress() string
  • func (c *CouchDB) Run(sigCh <-chan os.Signal, ready chan<- struct{}) error
  • func (c *CouchDB) Start() error
  • func (c *CouchDB) Stop() error
• type Kafka
  • func (k *Kafka) Run(sigCh <-chan os.Signal, ready chan<- struct{}) error
  • func (k *Kafka) Start() error
  • func (k *Kafka) Stop() error
• type NameFunc
• type ZooKeeper
  • func (z *ZooKeeper) ContainerAddress() string
  • func (z *ZooKeeper) ContainerID() string
  • func (z *ZooKeeper) Run(sigCh <-chan os.Signal, ready chan<- struct{}) error
  • func (z *ZooKeeper) Start() error
  • func (z *ZooKeeper) Stop() error

Constants

const (
	CouchDBDefaultImage = "couchdb:3.2.2"
	CouchDBUsername     = "admin"
	CouchDBPassword     = "adminpw"
)

const DefaultStartTimeout = 45 * time.Second

const KafkaDefaultImage = "confluentinc/cp-kafka:5.3.1"

const ZooKeeperDefaultImage = "confluentinc/cp-zookeeper:5.3.1"

Functions

func UniqueName

func UniqueName() string

UniqueName generates base-32 enocded strings for container names.

Types

type CouchDB

type CouchDB struct {
	Client        *docker.Client
	Image         string
	HostIP        string
	HostPort      int
	ContainerPort docker.Port
	Name          string
	StartTimeout  time.Duration
	Binds         []string

	ErrorStream  io.Writer
	OutputStream io.Writer
	// contains filtered or unexported fields
}

CouchDB manages the execution of an instance of a dockerized CounchDB for tests.

func (*CouchDB) Address

func (c *CouchDB) Address() string

Address returns the address successfully used by the readiness check.

func (*CouchDB) ContainerAddress

func (c *CouchDB) ContainerAddress() string

ContainerAddress returns the container address where this CouchDB instance is available.

func (*CouchDB) ContainerID

func (c *CouchDB) ContainerID() string

ContainerID returns the container ID of this CouchDB

func (*CouchDB) HostAddress

func (c *CouchDB) HostAddress() string

HostAddress returns the host address where this CouchDB instance is available.

func (*CouchDB) Run

func (c *CouchDB) Run(sigCh <-chan os.Signal, ready chan<- struct{}) error

Run runs a CouchDB container. It implements the ifrit.Runner interface

func (*CouchDB) Start

func (c *CouchDB) Start() error

Start starts the CouchDB container using an ifrit runner

func (*CouchDB) Stop

func (c *CouchDB) Stop() error

Stop stops and removes the CouchDB container

type Kafka

type Kafka struct {
	Client        *docker.Client
	Image         string
	HostIP        string
	HostPort      int
	ContainerPort docker.Port
	Name          string
	NetworkName   string
	StartTimeout  time.Duration

	MessageMaxBytes              int
	ReplicaFetchMaxBytes         int
	UncleanLeaderElectionEnable  bool
	DefaultReplicationFactor     int
	MinInsyncReplicas            int
	BrokerID                     int
	ZooKeeperConnect             string
	ReplicaFetchResponseMaxBytes int
	AdvertisedListeners          string

	ErrorStream  io.Writer
	OutputStream io.Writer

	ContainerID      string
	HostAddress      string
	ContainerAddress string
	Address          string
	// contains filtered or unexported fields
}

Kafka manages the execution of an instance of a dockerized CouchDB for tests.

func (*Kafka) Run

func (k *Kafka) Run(sigCh <-chan os.Signal, ready chan<- struct{}) error

Run runs a Kafka container. It implements the ifrit.Runner interface

func (*Kafka) Start

func (k *Kafka) Start() error

Start starts the Kafka container using an ifrit runner

func (*Kafka) Stop

func (k *Kafka) Stop() error

Stop stops and removes the Kafka container

type NameFunc

type NameFunc func() string

A NameFunc is used to generate container names.

var DefaultNamer NameFunc = UniqueName

DefaultNamer is the default naming function.

type ZooKeeper

type ZooKeeper struct {
	Client         *docker.Client
	Image          string
	HostIP         string
	HostPort       []int
	ContainerPorts []docker.Port
	Name           string
	StartTimeout   time.Duration

	NetworkName string
	ClientPort  docker.Port
	LeaderPort  docker.Port
	PeerPort    docker.Port
	ZooMyID     int
	ZooServers  string

	ErrorStream  io.Writer
	OutputStream io.Writer
	// contains filtered or unexported fields
}

func (*ZooKeeper) ContainerAddress

func (z *ZooKeeper) ContainerAddress() string

func (*ZooKeeper) ContainerID

func (z *ZooKeeper) ContainerID() string

func (*ZooKeeper) Run

func (z *ZooKeeper) Run(sigCh <-chan os.Signal, ready chan<- struct{}) error

func (*ZooKeeper) Start

func (z *ZooKeeper) Start() error

func (*ZooKeeper) Stop

func (z *ZooKeeper) Stop() error