ns3::ExampleAsTestCase Class Reference

Execute an example program as a test, by comparing the output to a reference file. More...

#include "example-as-test.h"

Inheritance diagram for ns3::ExampleAsTestCase:

Collaboration diagram for ns3::ExampleAsTestCase:

Public Member Functions
	ExampleAsTestCase (const std::string name, const std::string program, const std::string dataDir, const std::string args="")
	Constructor. More...
virtual	~ExampleAsTestCase (void)
	Destructor. More...
virtual void	DoRun (void)
	Implementation to actually run this TestCase. More...
virtual std::string	GetCommandTemplate (void) const
	Customization point for more complicated patterns to invoke the example program. More...
virtual std::string	GetPostProcessingCommand (void) const
	Customization point for tests requiring post-processing of stdout. More...
Public Member Functions inherited from ns3::TestCase
	TestCase (const TestCase &)=delete
virtual	~TestCase ()
	Destructor. More...
std::string	GetName (void) const
TestCase &	operator= (const TestCase &)=delete

Protected Attributes
std::string	m_args
	Any additional arguments to the program. More...
std::string	m_dataDir
	The source directory for the test. More...
std::string	m_program
	The program to run. More...

Additional Inherited Members
Public Types inherited from ns3::TestCase
enum	TestDuration { QUICK = 1 , EXTENSIVE = 2 , TAKES_FOREVER = 3 }
	How long the test takes to execute. More...
Protected Member Functions inherited from ns3::TestCase
	TestCase (std::string name)
	Constructor. More...
void	AddTestCase (TestCase *testCase, TestDuration duration=QUICK)
	Add an individual child TestCase to this test suite. More...
TestCase *	GetParent () const
	Get the parent of this TestCsse. More...
bool	IsStatusFailure (void) const
	Check if any tests failed. More...
bool	IsStatusSuccess (void) const
	Check if all tests passed. More...
void	SetDataDir (std::string directory)
	Set the data directory where reference trace files can be found. More...
void	ReportTestFailure (std::string cond, std::string actual, std::string limit, std::string message, std::string file, int32_t line)
	Log the failure of this TestCase. More...
bool	MustAssertOnFailure (void) const
	Check if this run should assert on failure. More...
bool	MustContinueOnFailure (void) const
	Check if this run should continue on failure. More...
std::string	CreateDataDirFilename (std::string filename)
	Construct the full path to a file in the data directory. More...
std::string	CreateTempDirFilename (std::string filename)
	Construct the full path to a file in a temporary directory. More...

Detailed Description

Execute an example program as a test, by comparing the output to a reference file.

User can subclass and override the GetCommandTemplate and GetPostProcessingCommand methods if more complex example invocation patterns are required.

See also

examples-as-tests-test-suite.cc

Definition at line 49 of file example-as-test.h.

Constructor & Destructor Documentation

ExampleAsTestCase()

ns3::ExampleAsTestCase::ExampleAsTestCase	(	const std::string	name,
		const std::string	program,
		const std::string	dataDir,
		const std::string	args = ""
	)

Constructor.

Parameters

[in]	name	The test case name, typically the program name and summary of the arguments, such as my-example-foo
[in]	program	The actual example program names, such as my-example
[in]	dataDir	The location of the reference file. This is normally provided by the symbol NS_TEST_SOURCEDIR in the module-examples-test-suite.cc file. The reference file should be named after the test case name, for example my-example-foo.log. If you use the --update argument to test.py or test-runner the reference file will be created with the correct name.
[in]	args	Any additional arguments to the program.

~ExampleAsTestCase()

virtual ns3::ExampleAsTestCase::~ExampleAsTestCase ( void  )

virtual

Destructor.

Member Function Documentation

DoRun()

virtual void ns3::ExampleAsTestCase::DoRun ( void  )

virtual

Implementation to actually run this TestCase.

Subclasses should override this method to conduct their tests.

Implements ns3::TestCase.

GetCommandTemplate()

virtual std::string ns3::ExampleAsTestCase::GetCommandTemplate ( void  ) const

virtual

Customization point for more complicated patterns to invoke the example program.

Returns

The string to be given to the ns3 --command-template= argument.

Reimplemented in MpiTestCase.

GetPostProcessingCommand()

virtual std::string ns3::ExampleAsTestCase::GetPostProcessingCommand ( void  ) const

virtual

Customization point for tests requiring post-processing of stdout.

For example to sort return "| sort"

Default is "", no processing step.

Returns

The string of post-processing commands

Reimplemented in MpiTestCase, and ns3::tests::CommandLineExampleTestCase.

Member Data Documentation

m_args

std::string ns3::ExampleAsTestCase::m_args

protected

Any additional arguments to the program.

Definition at line 102 of file example-as-test.h.

Referenced by MpiTestCase::GetCommandTemplate().

m_dataDir

std::string ns3::ExampleAsTestCase::m_dataDir

protected

The source directory for the test.

Definition at line 101 of file example-as-test.h.

m_program

std::string ns3::ExampleAsTestCase::m_program

protected

The program to run.

Definition at line 100 of file example-as-test.h.

---

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

• src/core/model/example-as-test.h