dut

Documentation

Overview

Package dut provides common definitions and utilities to be shared by DUTs.

Index

• Constants
• func Run(dut DUT) error
• func WaitForServer(output io.Reader) error
• type DUT
• type Ifaces
  • func Init(fs *flag.FlagSet) (Ifaces, error)

Constants

const (

	// PosixServerPort is the port the posix server should listen on.
	PosixServerPort = 54321
	// CtrlIface is the command switch name for passing name of the control interface.
	CtrlIface = "ctrl_iface"
	// TestIface is the command switch name for passing name of the test interface.
	TestIface = "test_iface"
)

Functions

func Run

func Run(dut DUT) error

Run is the provided function that calls dut's Bootstrap and Cleanup methods and returns the DUT information to the parent through the pipe.

func WaitForServer

func WaitForServer(output io.Reader) error

WaitForServer waits for a pattern to occur in posix_server's logs.

Types

type DUT

type DUT interface {
	// Bootstrap starts a DUT and returns the collected DUTInfo and a function
	// for the caller to call to wait for the completion of the DUT.
	Bootstrap(ctx context.Context) (testbench.DUTInfo, func() error, error)
	// Cleanup stops the DUT and cleans up the resources being used.
	Cleanup()
}

DUT is an interface for different platforms of DUTs.

type Ifaces

type Ifaces struct {
	// Ctrl is the name of the control interface.
	Ctrl string
	// Test is the name of the test interface.
	Test string
}

Ifaces describe the names of the interfaces on DUT.

func Init

func Init(fs *flag.FlagSet) (Ifaces, error)

Init puts the current process into the target network namespace, the user of this library should call this function in the beginning.