genericapi

Documentation

Index

• type Container
  • func CreateContainer(ctx context.Context, req ContainerRequest) (*Container, error)
  • func (c Container) GetLogs(ctx context.Context) (string, error)
  • func (c Container) HostAndPort(ctx context.Context) (string, nat.Port, error)
  • func (c Container) Shutdown(ctx context.Context) error
  • func (c Container) URL(ctx context.Context) (string, error)
  • func (c Container) URLForNetwork(ctx context.Context, network string) (string, error)
• type ContainerRequest
  • func (req ContainerRequest) WithNetworkAlias(network, alias string) ContainerRequest

Types

type Container

type Container struct {
	Container testcontainers.Container
	// contains filtered or unexported fields
}

Container represents a container for an HTTP API

func CreateContainer

func CreateContainer(ctx context.Context, req ContainerRequest) (*Container, error)

CreateContainer creates and starts a container and assumes it contains an HTTP API

func (Container) GetLogs

func (c Container) GetLogs(ctx context.Context) (string, error)

GetLogs retrieves all logs from the container

func (Container) HostAndPort

func (c Container) HostAndPort(ctx context.Context) (string, nat.Port, error)

HostAndPort retrieves the external host and port of the container

func (Container) Shutdown

func (c Container) Shutdown(ctx context.Context) error

Shutdown terminates the container

func (Container) URL

func (c Container) URL(ctx context.Context) (string, error)

URL builds an URL that can be used to interact with the container's HTTP API

func (Container) URLForNetwork

func (c Container) URLForNetwork(ctx context.Context, network string) (string, error)

URLForNetwork builds an URL that can be used to interact with the container's HTTP API inside the specified network

type ContainerRequest

type ContainerRequest struct {
	testcontainers.GenericContainerRequest
	Image            string
	LivenessEndpoint string
	Port             nat.Port
}

ContainerRequest a container request specification

func (ContainerRequest) WithNetworkAlias

func (req ContainerRequest) WithNetworkAlias(network, alias string) ContainerRequest

WithNetworkAlias adds a network alias to the container request