mtest

Documentation

Overview

Package mtest implements functionality useful for testing.

Index

• func Component() *mcmp.Component
• func Env(cmp *mcmp.Component, key, val string)
• func Run(cmp *mcmp.Component, t *testing.T, body func())

Functions

func Component

func Component() *mcmp.Component

Component creates and returns a root Component suitable for testing.

func Env

func Env(cmp *mcmp.Component, key, val string)

Env sets the given environment variable on the given Component, such that it will be used as if it was a real environment variable when the Run function from this package is called.

This function will panic if not called on the root Component.

func Run

func Run(cmp *mcmp.Component, t *testing.T, body func())

Run performs the following using the given Component:

- Calls mrun.Init, which calls mcfg.Populate using any variables set by Env.

- Calls the passed in body callback.

- Calls mrun.Shutdown

The intention is that Run is used within a test on a Component created via this package's Component function, after any instantiation functions have been called (e.g. mnet.InstListener).