class TestMain A helper class for test programs. More... Definition #include <test_main.hh> List of all Methods

Annotated List Files Globals Hierarchy Index

Public Types

• enum { SUCCESS = 0, FAILURE = 1}

Public Methods

•  TestMain (int argc, char **argv)
• string  get_optional_args (const string &short_form, const string &long_form, const string &description)
• bool  get_optional_flag (const string &short_form, const string &long_form, const string &description)
• void  complete_args_parsing ()
• void  run (string test_name, XorpCallback1<int, TestInfo&>::RefPtr cb)
• const string  usage ()
• void  failed (string error)
• int  exit ()

Detailed Description

A helper class for test programs.

This class is used to parse the command line arguments, enable the xlog_ framework and return the exit status from the test functions/methods. An example of how to use this class can be found in test_test_main.cc.

A test function/method should return one of these values.

Start the parsing of command line arguments and enable xlog_*.

Get an optional argument from the command line.

Parameters:

short_form	The short form of the argument e.g. "-t".
long_form	The long form of the argument e.g. "--testing".
description	The description of this argument that will be used in the usage message.

Returns: the argument or "" if not found or an error occured in previous parsing of the arguments.

Get an optional flag from the command line.

Parameters:

short_form	The short form of the argument e.g. "-t".
long_form	The long form of the argument e.g. "--testing".
description	The description of this argument that will be used in the usage message.

Returns: true if the flag is present or false found or an error occured in previous parsing of the arguments.

Complete parsing the arguments.

Process generic arguments and verify that there are no arguments left unprocessed.

Run a test function/method. The test function/method is passed a TestInfo. The test function/method should return "TestMain::SUCCESS" for sucess and "TestMain::FAILURE" for failure.

To run a function call "test": run("test", callback(test));

Parameters:

test_name	The name of the test.
cb	Callback object.

Returns: The usage string.

Mark the tests as having failed. Used for setting an error condition from outside a test.

Parameters:

error

Error string.

Must be called at the end of the tests.

Returns: The status of the tests. Should be passed to exit().