e2eutil

Documentation

Index

• func AgentRestart(client *api.Client, nodeID string) (string, error)
• func AllocIDsFromAllocationListStubs(allocs []*api.AllocationListStub) []string
• func CheckServicesPassing(t *testing.T, agentAPI *consulapi.Agent, allocIDs []string)
• func DeploymentsForJob(t *testing.T, nomadClient *api.Client, jobID string) []*api.Deployment
• func ListLinuxClientNodes(client *api.Client) ([]string, error)
• func ListWindowsClientNodes(client *api.Client) ([]string, error)
• func RegisterAllocs(t *testing.T, nomadClient *api.Client, jobFile, jobID, cToken string) []*api.AllocationListStub
• func RegisterAndWaitForAllocs(t *testing.T, nomadClient *api.Client, jobFile, jobID, cToken string) []*api.AllocationListStub
• func RequireConsulDeregistered(require *require.Assertions, client *capi.Client, serviceName string)
• func RequireConsulStatus(require *require.Assertions, client *capi.Client, ...)
• func WaitForAllocNotPending(t *testing.T, nomadClient *api.Client, allocID string)
• func WaitForAllocRunning(t *testing.T, nomadClient *api.Client, allocID string)
• func WaitForAllocStopped(t *testing.T, nomadClient *api.Client, allocID string)
• func WaitForAllocsNotPending(t *testing.T, nomadClient *api.Client, allocIDs []string)
• func WaitForAllocsRunning(t *testing.T, nomadClient *api.Client, allocIDs []string)
• func WaitForDeployment(t *testing.T, nomadClient *api.Client, deployID string, status string, ...)
• func WaitForJobStopped(t *testing.T, nomadClient *api.Client, job string)
• func WaitForLeader(t *testing.T, nomadClient *api.Client)
• func WaitForNodesReady(t *testing.T, nomadClient *api.Client, nodes int)

Functions

func AgentRestart

func AgentRestart(client *api.Client, nodeID string) (string, error)

AgentRestart is a test helper function that restarts a client node running under systemd using a raw_exec job. Returns the job ID of the restart job so that callers can clean it up.

func AllocIDsFromAllocationListStubs

func AllocIDsFromAllocationListStubs(allocs []*api.AllocationListStub) []string

func CheckServicesPassing

func CheckServicesPassing(t *testing.T, agentAPI *consulapi.Agent, allocIDs []string)

CheckServicesPassing scans for passing agent checks via the given agent API client.

Deprecated: not useful in e2e, where more than one node exists and Nomad jobs are placed non-deterministically. The Consul agentAPI only knows about what is registered on its node, and cannot be used to query for cluster wide state.

func DeploymentsForJob

func DeploymentsForJob(t *testing.T, nomadClient *api.Client, jobID string) []*api.Deployment

func ListLinuxClientNodes

func ListLinuxClientNodes(client *api.Client) ([]string, error)

ListLinuxClientNodes returns a list of Linux client IDs, so that tests can skip operating-specific tests if there are no Linux clients available Returns an error only on client errors.

func ListWindowsClientNodes

func ListWindowsClientNodes(client *api.Client) ([]string, error)

ListWindowsClientNodes returns a list of Windows client IDs, so that tests can skip operating-specific tests if there are no Windows clients available. Returns an error only on client errors.

func RegisterAllocs

func RegisterAllocs(t *testing.T, nomadClient *api.Client, jobFile, jobID, cToken string) []*api.AllocationListStub

func RegisterAndWaitForAllocs

func RegisterAndWaitForAllocs(t *testing.T, nomadClient *api.Client, jobFile, jobID, cToken string) []*api.AllocationListStub

RegisterAndWaitForAllocs wraps RegisterAllocs but blocks until Evals successfully create Allocs.

func RequireConsulDeregistered

func RequireConsulDeregistered(require *require.Assertions,
	client *capi.Client, serviceName string)

RequireConsulDeregistered asserts that the service eventually is deregistered from Consul

func RequireConsulStatus

func RequireConsulStatus(require *require.Assertions,
	client *capi.Client, serviceName, expectedStatus string)

RequireConsulStatus asserts the aggregate health of the service converges to the expected status

func WaitForAllocNotPending

func WaitForAllocNotPending(t *testing.T, nomadClient *api.Client, allocID string)

func WaitForAllocRunning

func WaitForAllocRunning(t *testing.T, nomadClient *api.Client, allocID string)

func WaitForAllocStopped

func WaitForAllocStopped(t *testing.T, nomadClient *api.Client, allocID string)

func WaitForAllocsNotPending

func WaitForAllocsNotPending(t *testing.T, nomadClient *api.Client, allocIDs []string)

func WaitForAllocsRunning

func WaitForAllocsRunning(t *testing.T, nomadClient *api.Client, allocIDs []string)

func WaitForDeployment

func WaitForDeployment(t *testing.T, nomadClient *api.Client, deployID string, status string, statusDesc string)

func WaitForJobStopped

func WaitForJobStopped(t *testing.T, nomadClient *api.Client, job string)

WaitForJobStopped stops a job and waits for all of its allocs to terminate.

func WaitForLeader

func WaitForLeader(t *testing.T, nomadClient *api.Client)

func WaitForNodesReady

func WaitForNodesReady(t *testing.T, nomadClient *api.Client, nodes int)

WaitForNodesReady waits until at least `nodes` number of nodes are ready or fails the test.