robottestutils

Documentation

Overview

Package robottestutils provides helper functions in testing

Index

• func Connect(port int) (*grpc.ClientConn, error)
• func CreateBaseOptionsAndListener(tb testing.TB) (weboptions.Options, net.Listener, string)
• func MakeTempConfig(t *testing.T, cfg *config.Config, logger logging.Logger) (string, error)
• func NewRobotClient(tb testing.TB, logger logging.Logger, addr string, dur time.Duration) *client.RobotClient
• func ServerAsSeparateProcess(t *testing.T, cfgFileName string, logger logging.Logger) pexec.ManagedProcess
• func WaitForServing(observer *observer.ObservedLogs, port int) bool

Functions

func Connect

func Connect(port int) (*grpc.ClientConn, error)

Connect creates a new grpc.ClientConn server running on localhost:port.

func CreateBaseOptionsAndListener

func CreateBaseOptionsAndListener(tb testing.TB) (weboptions.Options, net.Listener, string)

CreateBaseOptionsAndListener creates a new web options with random port as listener.

func MakeTempConfig

func MakeTempConfig(t *testing.T, cfg *config.Config, logger logging.Logger) (string, error)

MakeTempConfig writes a config.Config object to a temporary file for testing.

func NewRobotClient

func NewRobotClient(tb testing.TB, logger logging.Logger, addr string, dur time.Duration) *client.RobotClient

NewRobotClient creates a new robot client with a certain address.

func ServerAsSeparateProcess

func ServerAsSeparateProcess(t *testing.T, cfgFileName string, logger logging.Logger) pexec.ManagedProcess

ServerAsSeparateProcess builds the viam server and returns an unstarted ManagedProcess for the built binary.

func WaitForServing

func WaitForServing(observer *observer.ObservedLogs, port int) bool

WaitForServing will scan the logs in the `observer` input until seeing a "serving" or "error serving web" message. For added accuracy, it also checks that the port a test is expecting to start a server on matches the one in the log message.

WaitForServing will return true if the server has started successfully in the allotted time, and false otherwise. nolint