e2e package - github.com/efficientgo/tools/e2e

e2e package - github.com/efficientgo/tools/e2e - Go Packages

This section is empty.

Equals is an isExpected function for WaitSumMetrics that returns true if given single sum is equals to given value.

EqualsAmongTwo is an isExpected function for WaitSumMetrics that returns true if first sum is equal to the second. NOTE: Be careful on scrapes in between of process that changes two metrics. Those are usually not atomic.

Greater is an isExpected function for WaitSumMetrics that returns true if given single sum is greater than given value.

GreaterAmongTwo is an isExpected function for WaitSumMetrics that returns true if first sum is greater than second. NOTE: Be careful on scrapes in between of process that changes two metrics. Those are usually not atomic.

GreaterOrEqual is an isExpected function for WaitSumMetrics that returns true if given single sum is greater or equal than given value.

Less is an isExpected function for WaitSumMetrics that returns true if given single sum is less than given value.

LessAmongTwo is an isExpected function for WaitSumMetrics that returns true if first sum is smaller than second. NOTE: Be careful on scrapes in between of process that changes two metrics. Those are usually not atomic.

func NetworkContainerHost(networkName, containerName string) string

NetworkContainerHost return the hostname of the container within the network. This is the address a container should use to connect to other containers.

func NetworkContainerHostPort(networkName, containerName string, port int) string

NetworkContainerHostPort return the host:port address of a container within the network.

type CmdReadinessProbe struct {
	
}

CmdReadinessProbe checks readiness by `Exec`ing a command (within container) which returns 0 to consider status being ready.

func NewCmdReadinessProbe(cmd *Command) *CmdReadinessProbe

type CompositeHTTPService struct {
	
}

CompositeHTTPService abstract an higher-level service composed by more than one HTTPService.

func NewCompositeHTTPService(services ...*HTTPService) *CompositeHTTPService

func (s *CompositeHTTPService) Instances() []*HTTPService

func (s *CompositeHTTPService) NumInstances() int

SumMetrics returns the sum of the values of each given metric names.

WaitSumMetrics waits for at least one instance of each given metric names to be present and their sums, returning true when passed to given isExpected(...).

type ConcreteService struct {
	
}

ConcreteService represents microservice with optional ports which will be discoverable from docker with <name>:<port>. For connecting from test, use `Endpoint` method.

ConcreteService can be reused (started and stopped many time), but it can represent only one running container at the time.

func NewConcreteService(
	name string,
	image string,
	command *Command,
	readiness ReadinessProbe,
	networkPorts ...int,
) *ConcreteService

Endpoint returns external (from host perspective) service endpoint (host:port) for given internal port. External means that it will be accessible only from host, but not from docker containers.

If your service is not running, this method returns incorrect `stopped` endpoint.

Exec runs the provided against a the docker container specified by this service. It returns the stdout, stderr, and error response from attempting to run the command.

NetworkEndpoint returns internal service endpoint (host:port) for given internal port. Internal means that it will be accessible only from docker containers within the network that this service is running in. If you configure your local resolver with docker DNS namespace you can access it from host as well. Use `Endpoint` for host access.

If your service is not running, use `NetworkEndpointFor` instead.

NetworkEndpointFor returns internal service endpoint (host:port) for given internal port and network. Internal means that it will be accessible only from docker containers within the given network. If you configure your local resolver with docker DNS namespace you can access it from host as well.

This method return correct endpoint for the service in any state.

func (s *ConcreteService) SetReadinessProbe(probe ReadinessProbe)

func (s *ConcreteService) WaitForRunning() (err error)

func (s *ConcreteService) WaitReady() (err error)

type HTTPReadinessProbe struct {
	
}

HTTPReadinessProbe checks readiness by making HTTP call and checking for expected HTTP status code.

func NewHTTPReadinessProbe(port int, path string, expectedStatusRangeStart, expectedStatusRangeEnd int, expectedContent ...string) *HTTPReadinessProbe

type HTTPService struct {
	*ConcreteService
	
}

HTTPService represents opinionated microservice with at least HTTP port that as mandatory requirement, serves metrics.

func NewHTTPService(
	name string,
	image string,
	command *Command,
	readiness ReadinessProbe,
	httpPort int,
	otherPorts ...int,
) *HTTPService

func (s *HTTPService) HTTPPort() int

func (s *HTTPService) NetworkHTTPEndpoint() string

SumMetrics returns the sum of the values of each given metric names.

WaitRemovedMetric waits until a metric disappear from the list of metrics exported by the service.

WaitSumMetrics waits for at least one instance of each given metric names to be present and their sums, returning true when passed to given isExpected(...).

type LinePrefixLogger struct {
	
}

type MetricsOption func(*metricsOptions)

MetricsOption defined the signature of a function used to manipulate options.

func SkipMissingMetrics() MetricsOption

SkipWaitMissingMetrics is an option to skip/ignore whenever an expected metric is missing.

func WaitMissingMetrics() MetricsOption

WithWaitMissingMetrics is an option to wait whenever an expected metric is missing. If this option is not enabled, will return error on missing metrics.

WithLabelMatchers is an option to filter only matching series.

func WithMetricCount() MetricsOption

WithMetricCount is an option to get the histogram/summary count as metric value.

type ReadinessProbe interface {
	Ready(service *ConcreteService) (err error)
}

Scenario allows to manage deployments for single testing scenario.

func NewScenario(opts ...ScenarioOption) (_ *Scenario, err error)

NewScenario creates new Scenario.

func (s *Scenario) Close()

NetworkName returns the network name that scenario is responsible for.

SharedDir returns the absolute path of the directory on the host that is shared with all services in docker.

func (s *Scenario) Start(services ...Service) error

func (s *Scenario) Stop(services ...Service) error

func (s *Scenario) WaitReady(services ...Service) error

type ScenarioOption func(*scenarioOptions)

ScenarioOption defined the signature of a function used to manipulate options.

WithLogger tells scenario to use custom logger default one (stdout).

func WithNetworkName(networkName string) ScenarioOption

WithNetworkName tells scenario to use custom network name instead of UUID.

Service is unified service interface that Scenario can manage.

type TCPReadinessProbe struct {
	
}

TCPReadinessProbe checks readiness by ensure a TCP connection can be established.

func NewTCPReadinessProbe(port int) *TCPReadinessProbe