framework

Documentation

Index

• Variables
• func CopyFile(sourceFile string, destinationFile string) error
• func GoldenFile(name string) string
• func HTTPGetWithRetry(t *testing.T, endpoint string, expectedStatus int, retryDelay time.Duration, ...) string
• func ParseContainerInspect(stdout string) (*containers.Container, error)
• func SetupExistingCLI() (string, func(), error)
• type E2eCLI
  • func NewE2eCLI(t *testing.T, binDir string) *E2eCLI
  • func NewParallelE2eCLI(t *testing.T, binDir string) *E2eCLI
  • func (c *E2eCLI) MetricsSocket() string
  • func (c *E2eCLI) NewCmd(command string, args ...string) icmd.Cmd
  • func (c *E2eCLI) NewDockerCmd(args ...string) icmd.Cmd
  • func (c *E2eCLI) PathEnvVar() string
  • func (c *E2eCLI) RunDockerCmd(args ...string) *icmd.Result
  • func (c *E2eCLI) RunDockerOrExitError(args ...string) *icmd.Result
• type MockMetricsServer
  • func NewMetricsServer(socket string) *MockMetricsServer
  • func (s *MockMetricsServer) GetUsage() []string
  • func (s *MockMetricsServer) ResetUsage()
  • func (s *MockMetricsServer) Start()
  • func (s *MockMetricsServer) Stop()
• type TestCLI
  • func NewTestCLI(t *testing.T) *TestCLI
  • func (c *TestCLI) Context() context.Context
  • func (c *TestCLI) GetStdOut() string

Variables

var (
	// DockerExecutableName is the OS dependent Docker CLI binary name
	DockerExecutableName = "docker"
)

Functions

func CopyFile

func CopyFile(sourceFile string, destinationFile string) error

CopyFile copies a file from a path to a path setting permissions to 0777

func GoldenFile

func GoldenFile(name string) string

GoldenFile golden file specific to platform

func HTTPGetWithRetry

func HTTPGetWithRetry(t *testing.T, endpoint string, expectedStatus int, retryDelay time.Duration, timeout time.Duration) string

HTTPGetWithRetry performs an HTTP GET on an `endpoint`, using retryDelay also as a request timeout. In the case of an error or the response status is not the expeted one, it retries the same request, returning the response body as a string (empty if we could not reach it)

func ParseContainerInspect

func ParseContainerInspect(stdout string) (*containers.Container, error)

ParseContainerInspect parses the output of a `docker inspect` command for a container

func SetupExistingCLI

func SetupExistingCLI() (string, func(), error)

SetupExistingCLI copies the existing CLI in a temporary directory so that the new CLI can be configured to use it

Types

type E2eCLI

type E2eCLI struct {
	BinDir    string
	ConfigDir string
	// contains filtered or unexported fields
}

E2eCLI is used to wrap the CLI for end to end testing

func NewE2eCLI

func NewE2eCLI(t *testing.T, binDir string) *E2eCLI

NewE2eCLI returns a configured TestE2eCLI

func NewParallelE2eCLI

func NewParallelE2eCLI(t *testing.T, binDir string) *E2eCLI

NewParallelE2eCLI returns a configured TestE2eCLI with t.Parallel() set

func (*E2eCLI) MetricsSocket

func (c *E2eCLI) MetricsSocket() string

MetricsSocket get the path where test metrics will be sent

func (*E2eCLI) NewCmd

func (c *E2eCLI) NewCmd(command string, args ...string) icmd.Cmd

NewCmd creates a cmd object configured with the test environment set

func (*E2eCLI) NewDockerCmd

func (c *E2eCLI) NewDockerCmd(args ...string) icmd.Cmd

NewDockerCmd creates a docker cmd without running it

func (*E2eCLI) PathEnvVar

func (c *E2eCLI) PathEnvVar() string

PathEnvVar returns path (os sensitive) for running test

func (*E2eCLI) RunDockerCmd

func (c *E2eCLI) RunDockerCmd(args ...string) *icmd.Result

RunDockerCmd runs a docker command, expects no error and returns a result

func (*E2eCLI) RunDockerOrExitError

func (c *E2eCLI) RunDockerOrExitError(args ...string) *icmd.Result

RunDockerOrExitError runs a docker command and returns a result

type MockMetricsServer

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

MockMetricsServer a mock registring all metrics POST invocations

func NewMetricsServer

func NewMetricsServer(socket string) *MockMetricsServer

NewMetricsServer instaniate a new MockMetricsServer

func (*MockMetricsServer) GetUsage

func (s *MockMetricsServer) GetUsage() []string

GetUsage get usage

func (*MockMetricsServer) ResetUsage

func (s *MockMetricsServer) ResetUsage()

ResetUsage reset usage

func (*MockMetricsServer) Start

func (s *MockMetricsServer) Start()

Start start the mock server

func (*MockMetricsServer) Stop

func (s *MockMetricsServer) Stop()

Stop stop the mock server

type TestCLI

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

TestCLI is a helper struct for CLI tests.

func NewTestCLI

func NewTestCLI(t *testing.T) *TestCLI

NewTestCLI returns a CLI testing helper.

func (*TestCLI) Context

func (c *TestCLI) Context() context.Context

Context returns a configured context

func (*TestCLI) GetStdOut

func (c *TestCLI) GetStdOut() string

GetStdOut returns the output of the command