testutil

Documentation

Index

• Constants
• func AssertUntil(until time.Duration, test testFn, error errorFn)
• func IsTravis() bool
• func RegisterJob(t testing.T, rpc rpcFn, job *structs.Job)
• func SkipSlow(t testing.T)
• func TestMultiplier() int64
• func Timeout(original time.Duration) time.Duration
• func VaultVersion() (string, error)
• func WaitForLeader(t testing.T, rpc rpcFn)
• func WaitForResult(test testFn, error errorFn)
• func WaitForResultRetries(retries int64, test testFn, error errorFn)
• func WaitForRunning(t testing.T, rpc rpcFn, job *structs.Job) []*structs.AllocListStub
• type ACLConfig
• type Advertise
• type ClientConfig
• type Consul
• type PortsConfig
• type ResponseRecorder
  • func NewResponseRecorder() *ResponseRecorder
  • func (r *ResponseRecorder) Flush()
  • func (r *ResponseRecorder) Flushed() bool
  • func (r *ResponseRecorder) Header() http.Header
  • func (r *ResponseRecorder) HeaderMap() http.Header
  • func (r *ResponseRecorder) Read(p []byte) (int, error)
  • func (r *ResponseRecorder) Write(p []byte) (int, error)
  • func (r *ResponseRecorder) WriteHeader(statusCode int)
• type ServerConfig
• type ServerConfigCallback
• type TestServer
  • func NewTestServer(t testing.T, cb ServerConfigCallback) *TestServer
  • func (s *TestServer) Stop()
• type TestServerConfig
• type TestVault
  • func NewTestVault(t testing.T) *TestVault
  • func NewTestVaultDelayed(t testing.T) *TestVault
  • func NewTestVaultFromPath(t testing.T, binary string) *TestVault
  • func (tv *TestVault) Start() error
  • func (tv *TestVault) Stop()
• type VaultConfig

Constants

const (
	// TravisRunEnv is an environment variable that is set if being run by
	// Travis.
	TravisRunEnv = "CI"
)

Functions

func AssertUntil

func AssertUntil(until time.Duration, test testFn, error errorFn)

AssertUntil asserts the test function passes throughout the given duration. Otherwise error is called on failure.

func IsTravis

func IsTravis() bool

func RegisterJob

func RegisterJob(t testing.T, rpc rpcFn, job *structs.Job)

func SkipSlow

func SkipSlow(t testing.T)

SkipSlow skips a slow test unless the NOMAD_SLOW_TEST environment variable is set.

func TestMultiplier

func TestMultiplier() int64

TestMultiplier returns a multiplier for retries and waits given environment the tests are being run under.

func Timeout

func Timeout(original time.Duration) time.Duration

Timeout takes the desired timeout and increases it if running in Travis

func VaultVersion

func VaultVersion() (string, error)

VaultVersion returns the Vault version as a string or an error if it couldn't be determined

func WaitForLeader

func WaitForLeader(t testing.T, rpc rpcFn)

WaitForLeader blocks until a leader is elected.

func WaitForResult

func WaitForResult(test testFn, error errorFn)

func WaitForResultRetries

func WaitForResultRetries(retries int64, test testFn, error errorFn)

func WaitForRunning

func WaitForRunning(t testing.T, rpc rpcFn, job *structs.Job) []*structs.AllocListStub

WaitForRunning runs a job and blocks until all allocs are out of pending.

Types

type ACLConfig

type ACLConfig struct {
	Enabled bool `json:"enabled"`
}

ACLConfig is used to configure ACLs

type Advertise

type Advertise struct {
	HTTP string `json:"http,omitempty"`
	RPC  string `json:"rpc,omitempty"`
	Serf string `json:"serf,omitempty"`
}

Advertise is used to configure the addresses to advertise

type ClientConfig

type ClientConfig struct {
	Enabled bool `json:"enabled"`
}

ClientConfig is used to configure the client

type Consul

type Consul struct {
	Address string `json:"address,omitempty"`
	Auth    string `json:"auth,omitempty"`
	Token   string `json:"token,omitempty"`
}

Consul is used to configure the communication with Consul

type PortsConfig

type PortsConfig struct {
	HTTP int `json:"http,omitempty"`
	RPC  int `json:"rpc,omitempty"`
	Serf int `json:"serf,omitempty"`
}

PortsConfig is used to configure the network ports we use.

type ResponseRecorder

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

ResponseRecorder implements a ResponseWriter which can be written to and read from concurrently. For use in testing streaming APIs where httptest.ResponseRecorder is unsafe for concurrent access. Uses httptest.ResponseRecorder internally and exposes most of the functionality.

func NewResponseRecorder

func NewResponseRecorder() *ResponseRecorder

func (*ResponseRecorder) Flush

func (r *ResponseRecorder) Flush()

Flush sets Flushed=true.

func (*ResponseRecorder) Flushed

func (r *ResponseRecorder) Flushed() bool

Flushed returns true if Flush has been called.

func (*ResponseRecorder) Header

func (r *ResponseRecorder) Header() http.Header

Header returns the response headers. Readers should call HeaderMap() to avoid races due to the server concurrently mutating headers.

func (*ResponseRecorder) HeaderMap

func (r *ResponseRecorder) HeaderMap() http.Header

HeaderMap returns the HTTP headers written before WriteHeader was called.

func (*ResponseRecorder) Read

func (r *ResponseRecorder) Read(p []byte) (int, error)

Read available response bytes. Safe to call concurrently with Write().

func (*ResponseRecorder) Write

func (r *ResponseRecorder) Write(p []byte) (int, error)

Write to the underlying response buffer. Safe to call concurrent with Read.

func (*ResponseRecorder) WriteHeader

func (r *ResponseRecorder) WriteHeader(statusCode int)

WriteHeader sets the response code and freezes the headers returned by HeaderMap. Safe to call concurrent with Read and HeaderMap.

type ServerConfig

type ServerConfig struct {
	Enabled         bool `json:"enabled"`
	BootstrapExpect int  `json:"bootstrap_expect"`
	RaftProtocol    int  `json:"raft_protocol,omitempty"`
}

ServerConfig is used to configure the nomad server.

type ServerConfigCallback

type ServerConfigCallback func(c *TestServerConfig)

ServerConfigCallback is a function interface which can be passed to NewTestServerConfig to modify the server config.

type TestServer

type TestServer struct {
	Config *TestServerConfig

	HTTPAddr   string
	SerfAddr   string
	HTTPClient *http.Client
	// contains filtered or unexported fields
}

TestServer is the main server wrapper struct.

func NewTestServer

func NewTestServer(t testing.T, cb ServerConfigCallback) *TestServer

NewTestServer creates a new TestServer, and makes a call to an optional callback function to modify the configuration.

func (*TestServer) Stop

func (s *TestServer) Stop()

Stop stops the test Nomad server, and removes the Nomad data directory once we are done.

type TestServerConfig

type TestServerConfig struct {
	NodeName          string        `json:"name,omitempty"`
	DataDir           string        `json:"data_dir,omitempty"`
	Region            string        `json:"region,omitempty"`
	DisableCheckpoint bool          `json:"disable_update_check"`
	LogLevel          string        `json:"log_level,omitempty"`
	Consul            *Consul       `json:"consul,omitempty"`
	AdvertiseAddrs    *Advertise    `json:"advertise,omitempty"`
	Ports             *PortsConfig  `json:"ports,omitempty"`
	Server            *ServerConfig `json:"server,omitempty"`
	Client            *ClientConfig `json:"client,omitempty"`
	Vault             *VaultConfig  `json:"vault,omitempty"`
	ACL               *ACLConfig    `json:"acl,omitempty"`
	DevMode           bool          `json:"-"`
	Stdout, Stderr    io.Writer     `json:"-"`
}

TestServerConfig is the main server configuration struct.

type TestVault

type TestVault struct {
	Addr      string
	HTTPAddr  string
	RootToken string
	Config    *config.VaultConfig
	Client    *vapi.Client
	// contains filtered or unexported fields
}

TestVault wraps a test Vault server launched in dev mode, suitable for testing.

func NewTestVault

func NewTestVault(t testing.T) *TestVault

NewTestVault returns a new TestVault instance that has yet to be started

func NewTestVaultDelayed

func NewTestVaultDelayed(t testing.T) *TestVault

NewTestVaultDelayed returns a test Vault server that has not been started. Start must be called and it is the callers responsibility to deal with any port conflicts that may occur and retry accordingly.

func NewTestVaultFromPath

func NewTestVaultFromPath(t testing.T, binary string) *TestVault

func (*TestVault) Start

func (tv *TestVault) Start() error

Start starts the test Vault server and waits for it to respond to its HTTP API

func (*TestVault) Stop

func (tv *TestVault) Stop()

Stop stops the test Vault server

type VaultConfig

type VaultConfig struct {
	Enabled bool `json:"enabled"`
}

VaultConfig is used to configure Vault