workertest

Documentation

Overview

Package workertest provides a framework for declarative definition of worker integration tests.

Index

• func AllOfArtifact(assertions ...func(t *testing.T, a Artifact)) func(t *testing.T, a Artifact)
• func AnyArtifact() func(t *testing.T, a Artifact)
• func ErrorArtifact() func(t *testing.T, a Artifact)
• func GrepArtifact(substring string) func(t *testing.T, a Artifact)
• func LogArtifact() func(t *testing.T, a Artifact)
• func MatchArtifact(body, contentType string) func(t *testing.T, a Artifact)
• func NotGrepArtifact(substring string) func(t *testing.T, a Artifact)
• func ReferenceArtifact() func(t *testing.T, a Artifact)
• func S3Artifact() func(t *testing.T, a Artifact)
• type Artifact
• type ArtifactAssertions
• type Case
  • func (c Case) Test(t *testing.T)
  • func (c Case) TestWithFakeQueue(t *testing.T)
  • func (c Case) TestWithRealQueue(t *testing.T)
• type Environment
• type SetupFunc
• type StatusAssertion
• type Task
• type TasksFunc
  • func Tasks(tasks []Task) TasksFunc

Functions

func AllOfArtifact

func AllOfArtifact(assertions ...func(t *testing.T, a Artifact)) func(t *testing.T, a Artifact)

AllOfArtifact creates an assertion that checks all assertions given

func AnyArtifact

func AnyArtifact() func(t *testing.T, a Artifact)

AnyArtifact creates an assertion that checks matches anything.

func ErrorArtifact

func ErrorArtifact() func(t *testing.T, a Artifact)

ErrorArtifact creates an assertion that holds if the artifact is an error artifact

func GrepArtifact

func GrepArtifact(substring string) func(t *testing.T, a Artifact)

GrepArtifact creates an assertion that holds if the artifact contains the given substring.

func LogArtifact

func LogArtifact() func(t *testing.T, a Artifact)

LogArtifact creates an assetion that logs the artifact, to test log. This is mostly useful when developing integration tests.

func MatchArtifact

func MatchArtifact(body, contentType string) func(t *testing.T, a Artifact)

MatchArtifact creates an assertion that holds if the artifact body matches given body and has the given contentType

func NotGrepArtifact

func NotGrepArtifact(substring string) func(t *testing.T, a Artifact)

NotGrepArtifact creates an assertion that holds if the artifact does not contain the given substring.

func ReferenceArtifact

func ReferenceArtifact() func(t *testing.T, a Artifact)

ReferenceArtifact creates an assertion that holds if the artifact is a reference artifact

func S3Artifact

func S3Artifact() func(t *testing.T, a Artifact)

S3Artifact creates an assertion that holds if the artifact is an S3 artifact

Types

type Artifact

type Artifact struct {
	ContentType     string
	Expires         time.Time
	Name            string
	StorageType     string
	Data            []byte
	ContentEncoding string
}

Artifact contains artifact meta-data.

type ArtifactAssertions

type ArtifactAssertions map[string]func(t *testing.T, a Artifact)

An ArtifactAssertions is a mapping from artifact name to assertion for the artifact. If mapping to nil value, any artifact will be permitted.

type Case

type Case struct {
	Engine            string        // Engine to be used
	EngineConfig      string        // Engine configuration as JSON
	PluginConfig      string        // Configuration of plugins, see plugins.PluginManagerConfigSchema()
	Setup             SetupFunc     // Function to setup local environment, return a cleanup function
	Tasks             TasksFunc     // Function that returns a list of tasks to create and associated assertions
	Concurrency       int           // Worker concurrency, if zero defaulted to 1 and tasks will sequantially dependent
	StoppedGracefully bool          // True, if worker is expected to stop gracefully
	StoppedNow        bool          // True, if worker is expected to stop now
	Timeout           time.Duration // Test timeout, defaults to 8 Minutes
	EnableSuperseding bool          // Enable superseding in the worker
}

Case is a worker test case

func (Case) Test

func (c Case) Test(t *testing.T)

Test runs the test case

func (Case) TestWithFakeQueue

func (c Case) TestWithFakeQueue(t *testing.T)

TestWithFakeQueue runs integration tests against FakeQueue

func (Case) TestWithRealQueue

func (c Case) TestWithRealQueue(t *testing.T)

TestWithRealQueue runs integration tests against production queue

type Environment

type Environment struct {
	Worker   runtime.Stoppable
	Queue    *tcqueue.Queue
	Listener fakequeue.Listener
}

Environment holds values that can be accessed in callbacks

type SetupFunc

type SetupFunc func(t *testing.T, env Environment) func()

A SetupFunc callback can setup the local environment, this includes starting servers running on localhost. The SetupFunc callback returns a cleanup function that will be invoked when tests are done.

type StatusAssertion

type StatusAssertion func(t *testing.T, q *tcqueue.Queue, status tcqueue.TaskStatusStructure)

A StatusAssertion is a function that can make an assertion on a task status

type Task

type Task struct {
	TaskID          string                  // Optional taskID (use slugid.Nice())
	Title           string                  // Optional title (for debugging)
	Scopes          []string                // Task scopes
	Payload         string                  // Task payload as JSON
	IgnoreState     bool                    // Ignore Success and Exception
	Success         bool                    // True, if task should be successfully
	Exception       runtime.ExceptionReason // Reason, if exception is expected
	Artifacts       ArtifactAssertions      // Mapping from artifact name to assertion
	AllowAdditional bool                    // True, if additional artifacts is allowed
	Status          StatusAssertion         // Optional, custom assertion on status and queue
}

A Task to be included in a worker test case

type TasksFunc

type TasksFunc func(t *testing.T, env Environment) []Task

A TasksFunc callback returns the tasks to be created and associated assertions.

For test cases that uses a static list of tasks, Tasks([]task{...}) function can be used to wrap a static []Task list.

func Tasks

func Tasks(tasks []Task) TasksFunc

Tasks is a quick wrapper for constructing a TasksFunc that always returns a static list of tasks.