TestHarness Interface Reference

Collection of suites and main interface of the Testing framework. More...

Inheritance diagram for TestHarness:

Static Public Member Functions
static proto int	GetNSuites ()
	Returns number of default test suites.
static proto TestSuite	GetSuite (int handle)
	Returns default test suite.
static proto TestSuite	ActiveSuite ()
	Returns currently active TestSuite or null when none is active.
static proto bool	Finished ()
	Returns true when all tests and suites finished.
static proto void	Begin (array< ref TestSuite > suites=null)
	Starts up the testing process and initializes the structures.
static proto bool	Run ()
	Starts the testing process.
static proto void	End ()
	Finalizes the testing process.
static proto string	Report (bool omitSkipped=false)
	Generates a xml report.
static proto string	EscapeForXml (string text)
	Replaces characters with special meaning in XML so that result can be used in XML attribute value or XML element body.
static proto void	GetTestTypes (notnull out array< TypeName > outTypes)
	Obtain all types derived from TestBase which are decorated with Test attribute.

Additional Inherited Members
Public Member Functions inherited from Managed
proto external ref Managed	Clone ()
	Return shallow copy of object, or null if it is not allowed (not public constructor)

Detailed Description

Collection of suites and main interface of the Testing framework.

Member Function Documentation

ActiveSuite()

static proto TestSuite TestHarness.ActiveSuite ( )

static

Returns currently active TestSuite or null when none is active.

Begin()

static proto void TestHarness.Begin ( array< ref TestSuite > suites = null )

static

Starts up the testing process and initializes the structures.

End()

static proto void TestHarness.End ( )

static

Finalizes the testing process.

EscapeForXml()

static proto string TestHarness.EscapeForXml ( string text )

static

Replaces characters with special meaning in XML so that result can be used in XML attribute value or XML element body.

Replacement is done as follows:

special character	escape sequence
<	&lt;
>	&gt;
&	&amp;
'	&apos;
"	&quot;

Finished()

static proto bool TestHarness.Finished ( )

static

Returns true when all tests and suites finished.

GetNSuites()

static proto int TestHarness.GetNSuites ( )

static

Returns number of default test suites.

GetSuite()

static proto TestSuite TestHarness.GetSuite ( int handle )

static

Returns default test suite.

GetTestTypes()

static proto void TestHarness.GetTestTypes ( notnull out array< TypeName > outTypes )

static

Obtain all types derived from TestBase which are decorated with Test attribute.

Report()

static proto string TestHarness.Report ( bool omitSkipped = false )

static

Generates a xml report.

Run()

static proto bool TestHarness.Run ( )

static

Starts the testing process.

Returns true when all tests have finished. If some of them are still in progress false is reported.

---

The documentation for this interface was generated from the following file:

• GameLib/generated/ScriptTestingFramework/TestHarness.c