controltest

Documentation

Overview

Package controltest provides a controller for use in tests.

Index

• type Controller
  • func New(c *control.Controller) *Controller
  • func (c *Controller) Query(ctx context.Context, compiler flux.Compiler) (flux.Query, error)

Types

type Controller

type Controller struct {
	*control.Controller
}

Controller embeds a control.Controller. It overrides the Query method, to return queries that require Done to be called. It accomplishes this by associating a finalizer with the Query that panics, and then clears the finalizer when Done is called.

This approach is not foolproof: it is possible that garbage collection may not run during a test, and therefore the finalizer will not be invoked.

func New

func New(c *control.Controller) *Controller

New returns a new Controller encapsulating c.

func (*Controller) Query

func (c *Controller) Query(ctx context.Context, compiler flux.Compiler) (flux.Query, error)

Query returns the result of calling Query on the underlying control.Controller, wrapped to ensure that callers call Done on the resulting Query.