testutil

package
v1.6.5 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Dec 13, 2023 License: MPL-2.0 Imports: 32 Imported by: 202

Documentation

Index

Constants

View Source 
const (
	// BusyboxImageEnvName is always used, if set, by TestBusyboxImage()
	BusyboxImageEnvName = "BUSYBOX_IMAGE"
)

Variables

This section is empty.

Functions

func AssertUntil added in v0.6.0 

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 FilesExist added in v1.1.2 

func FilesExist(files []string) (bool, error)

FilesExist verifies all files in the slice are present

func IsAppVeyor added in v0.9.0 

func IsAppVeyor() bool

func IsCI added in v0.9.0 

func IsCI() bool

func IsTravis added in v0.3.0 

func IsTravis() bool

func IsValidCertificate added in v1.4.5 

func IsValidCertificate(t *testing.T, caPath string) *x509.Certificate

Assert CA file exists and is a valid CA Returns the CA

func IsValidSigner added in v1.4.5 

func IsValidSigner(t *testing.T, keyPath string) bool

Assert key file exists and is a valid signer returns a bool

func RegisterJob added in v0.9.0 

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

func RegisterJobWithToken added in v0.9.2 

func RegisterJobWithToken(t testing.TB, rpc rpcFn, job *structs.Job, token string)

RegisterJobWithToken registers a job and uses the job's Region and Namespace.

func TestBusyboxImage added in v1.4.11 

func TestBusyboxImage() string

func TestDockerImage added in v1.4.11 

func TestDockerImage(name, tag string) string

func TestMultiplier added in v0.3.0 

func TestMultiplier() int64

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

func Timeout added in v0.8.0 

func Timeout(original time.Duration) time.Duration

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

func VaultVersion added in v0.5.3 

func VaultVersion() (string, error)

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

func Wait added in v1.4.0 

func Wait(t *testing.T, test testFn)

func WaitForClient added in v1.0.0 

func WaitForClient(t testing.TB, rpc rpcFn, nodeID string, region string)

WaitForClient blocks until the client can be found

func WaitForClientStatus added in v1.3.10 

func WaitForClientStatus(t testing.TB, rpc rpcFn, nodeID string, region string, status string)

WaitForClientStatus blocks until the client is in the expected status.

func WaitForFiles added in v1.0.0 

func WaitForFiles(t testing.TB, files []string)

WaitForFiles blocks until all the files in the slice are present

func WaitForFilesUntil added in v1.1.2 

func WaitForFilesUntil(t testing.TB, files []string, until time.Duration)

WaitForFilesUntil blocks until duration or all the files in the slice are present

func WaitForJobAllocStatus added in v1.3.10 

func WaitForJobAllocStatus(t testing.TB, rpc rpcFn, job *structs.Job, allocStatus map[string]int)

WaitforJobAllocStatus blocks until the ClientStatus of allocations for a job match the expected map of <ClientStatus>: <count>.

func WaitForJobAllocStatusWithToken added in v1.3.10 

func WaitForJobAllocStatusWithToken(t testing.TB, rpc rpcFn, job *structs.Job, allocStatus map[string]int, token string) []*structs.AllocListStub

WaitForJobAllocStatusWithToken behaves the same way as WaitForJobAllocStatus but is used for clusters with ACL enabled.

func WaitForLeader 

func WaitForLeader(t testing.TB, rpc rpcFn)

WaitForLeader blocks until a leader is elected.

func WaitForLeaders added in v1.3.12 

func WaitForLeaders(t testing.TB, rpcs ...rpcFn) string

WaitForLeaders blocks until each rpcs knows the leader.

func WaitForResult 

func WaitForResult(test testFn, error errorFn)

func WaitForResultRetries added in v0.3.0 

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

func WaitForResultUntil added in v1.1.2 

func WaitForResultUntil(until time.Duration, test testFn, errorFunc errorFn)

WaitForResultUntil waits the duration for the test to pass. Otherwise error is called after the deadline expires.

func WaitForRunning added in v0.8.5 

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

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

func WaitForRunningWithToken added in v0.9.2 

func WaitForRunningWithToken(t testing.TB, rpc rpcFn, job *structs.Job, token string) []*structs.AllocListStub

func WaitForVotingMembers added in v0.10.0 

func WaitForVotingMembers(t testing.TB, rpc rpcFn, nPeers int)

WaitForVotingMembers blocks until autopilot promotes all server peers to be voting members.

Useful for tests that change cluster topology (e.g. kill a node) that should wait until cluster is stable.

Types

type ACLConfig added in v0.7.0 

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

ACLConfig is used to configure ACLs 

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 CallCounter added in v1.4.14 

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

func NewCallCounter added in v1.4.14 

func NewCallCounter() *CallCounter

func (*CallCounter) AssertCalled added in v1.4.14 

func (c *CallCounter) AssertCalled(t testing.T, name string)

func (*CallCounter) Get added in v1.4.14 

func (c *CallCounter) Get() map[string]int

func (*CallCounter) Inc added in v1.4.14 

func (c *CallCounter) Inc(name string)

type ClientConfig 

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

ClientConfig is used to configure the client

type Consul added in v0.8.0 

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 added in v0.9.0 

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 added in v0.9.0 

func NewResponseRecorder() *ResponseRecorder

func (*ResponseRecorder) Flush added in v0.9.0 

func (r *ResponseRecorder) Flush()

Flush sets Flushed=true.

func (*ResponseRecorder) Flushed added in v0.9.0 

func (r *ResponseRecorder) Flushed() bool

Flushed returns true if Flush has been called.

func (*ResponseRecorder) Header added in v0.9.0 

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 added in v0.9.0 

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

HeaderMap returns the HTTP headers written before WriteHeader was called.

func (*ResponseRecorder) Read added in v0.9.0 

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

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

func (*ResponseRecorder) Write added in v0.9.0 

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

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

func (*ResponseRecorder) WriteHeader added in v0.9.0 

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 added in v0.5.0 

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 added in v0.5.0 

func NewTestVault(t testing.T) *TestVault

NewTestVault returns a new TestVault instance that is ready for API calls

func NewTestVaultDelayed added in v0.6.0 

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 added in v0.8.6 

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

func (*TestVault) Start added in v0.5.0 

func (tv *TestVault) Start() error

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

func (*TestVault) Stop added in v0.5.0 

func (tv *TestVault) Stop()

Stop stops the test Vault server

type VaultConfig added in v0.5.0 

type VaultConfig struct {
	Enabled              bool   `json:"enabled"`
	Address              string `json:"address"`
	AllowUnauthenticated bool   `json:"allow_unauthenticated"`
	Token                string `json:"token"`
	Role                 string `json:"role"`
}

VaultConfig is used to configure Vault

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.