harness

Documentation

Overview

Package harness manages the setup and teardown of various Swarming bot resources for running lab tasks, like results directories and host info.

Index

• type DUTHarness
  • func (dh *DUTHarness) Close(ctx context.Context) error
• type Info
  • func Open(ctx context.Context, b *swmbot.Info, o ...Option) (i *Info, err error)
  • func (i *Info) Close(ctx context.Context) error
• type Option
  • func UpdateInventory(name string) Option

Types

type DUTHarness

type DUTHarness struct {
	BotInfo     *swmbot.Info
	DUTID       string
	DUTHostname string
	ResultsDir  string
	LocalState  *swmbot.LocalDUTState
	// contains filtered or unexported fields
}

DUTHarness holds information about a DUT's harness

func (*DUTHarness) Close

func (dh *DUTHarness) Close(ctx context.Context) error

Close closes and flushes out the harness resources. This is safe to call multiple times.

type Info

type Info struct {
	*swmbot.Info

	TaskResultsDir *resultsdir.Dir
	DUTs           []*DUTHarness
	// contains filtered or unexported fields
}

Info holds information about the Swarming bot harness.

func Open

func Open(ctx context.Context, b *swmbot.Info, o ...Option) (i *Info, err error)

Open opens and sets up the bot and task harness needed for Autotest jobs. An Info struct is returned with necessary fields, which must be closed.

func (*Info) Close

func (i *Info) Close(ctx context.Context) error

Close closes and flushes out the harness resources. This is safe to call multiple times.

type Option

type Option interface {
	// contains filtered or unexported methods
}

Option is passed to Open to configure the harness. There can be two level of options, one directly applies to Info while another one will applies to each DUTHarness.

func UpdateInventory

func UpdateInventory(name string) Option

UpdateInventory returns an updateInventoryOpt that enables inventory updates. A task name to be associated with the inventory update should be provided.