integration

Documentation

Index

• Variables
• func InitContainerdWorker()
• func InitDockerdWorker()
• func InitOCIWorker()
• func NewRegistry(dir string) (url string, cl func() error, err error)
• func OfficialImages(names ...string) map[string]string
• func Register(w Worker)
• func Run(t *testing.T, testCases []Test, opt ...TestOpt)
• type Backend
• type BackendConfig
• type ConfigUpdater
• type Sandbox
• type Test
  • func TestFuncs(funcs ...func(t *testing.T, sb Sandbox)) []Test
• type TestOpt
  • func WithMatrix(key string, m map[string]interface{}) TestOpt
  • func WithMirroredImages(m map[string]string) TestOpt
• type Worker
  • func List() []Worker

Variables

var ErrRequirements = errors.Errorf("missing requirements")

Functions

func InitContainerdWorker

func InitContainerdWorker()

func InitDockerdWorker

func InitDockerdWorker()

InitDockerdWorker registers a dockerd worker with the global registry.

func InitOCIWorker

func InitOCIWorker()

func NewRegistry

func NewRegistry(dir string) (url string, cl func() error, err error)

func OfficialImages

func OfficialImages(names ...string) map[string]string

func Register

func Register(w Worker)

func Run

func Run(t *testing.T, testCases []Test, opt ...TestOpt)

Types

type Backend

type Backend interface {
	Address() string
	ContainerdAddress() string
	Rootless() bool
	Snapshotter() string
}

Backend is the minimal interface that describes a testing backend.

type BackendConfig

type BackendConfig struct {
	Logs       map[string]*bytes.Buffer
	ConfigFile string
}

BackendConfig is used to configure backends created by a worker.

type ConfigUpdater

type ConfigUpdater interface {
	UpdateConfigFile(string) string
}

type Sandbox

type Sandbox interface {
	Backend

	Context() context.Context
	Cmd(...string) *exec.Cmd
	PrintLogs(*testing.T)
	NewRegistry() (string, error)
	Value(string) interface{} // chosen matrix value
	Name() string
}

type Test

type Test interface {
	Name() string
	Run(t *testing.T, sb Sandbox)
}

func TestFuncs

func TestFuncs(funcs ...func(t *testing.T, sb Sandbox)) []Test

type TestOpt

type TestOpt func(*testConf)

TestOpt is an option that can be used to configure a set of integration tests.

func WithMatrix

func WithMatrix(key string, m map[string]interface{}) TestOpt

func WithMirroredImages

func WithMirroredImages(m map[string]string) TestOpt

type Worker

type Worker interface {
	New(context.Context, *BackendConfig) (Backend, func() error, error)
	Name() string
}

func List

func List() []Worker