MpiTestSuite Class Reference

MPI specialization of ns3::ExampleTestSuite. More...

Inheritance diagram for MpiTestSuite:

Collaboration diagram for MpiTestSuite:

Public Member Functions
	MpiTestSuite (const std::string name, const std::string program, const std::string dataDir, const int ranks, const std::string args="", const Duration duration=Duration::QUICK, const bool shouldNotErr=true)
	Constructor.
Public Member Functions inherited from ns3::TestSuite
	TestSuite (std::string name, Type type=Type::UNIT)
	Construct a new test suite.
TestSuite::Type	GetTestType ()
	get the kind of test this test suite implements
Public Member Functions inherited from ns3::TestCase
	TestCase (const TestCase &)=delete
virtual	~TestCase ()
	Destructor.
std::string	GetName () const
TestCase &	operator= (const TestCase &)=delete

Additional Inherited Members
Public Types inherited from ns3::TestSuite
enum class	Type {   ALL = 0 , UNIT , SYSTEM , EXAMPLE ,   PERFORMANCE }
	Type of test. More...
Public Types inherited from ns3::TestCase
enum class	Duration { QUICK = 1 , EXTENSIVE = 2 , TAKES_FOREVER = 3 }
	How long the test takes to execute. More...
Static Public Attributes inherited from ns3::TestSuite
static constexpr auto	ALL = Type::ALL
	Deprecated test type simple enums.
static constexpr auto	UNIT = Type::UNIT
static constexpr auto	SYSTEM = Type::SYSTEM
static constexpr auto	EXAMPLE = Type::EXAMPLE
static constexpr auto	PERFORMANCE = Type::PERFORMANCE
Static Public Attributes inherited from ns3::TestCase
static constexpr auto	QUICK = Duration::QUICK
	Deprecated test duration simple enums.
static constexpr auto	EXTENSIVE = Duration::EXTENSIVE
static constexpr auto	TAKES_FOREVER = Duration::TAKES_FOREVER
Protected Member Functions inherited from ns3::TestCase
	TestCase (std::string name)
	Constructor.
void	AddTestCase (TestCase *testCase, Duration duration=Duration::QUICK)
	Add an individual child TestCase to this test suite.
TestCase *	GetParent () const
	Get the parent of this TestCase.
bool	IsStatusFailure () const
	Check if any tests failed.
bool	IsStatusSuccess () const
	Check if all tests passed.
void	SetDataDir (std::string directory)
	Set the data directory where reference trace files can be found.
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.
bool	MustAssertOnFailure () const
	Check if this run should assert on failure.
bool	MustContinueOnFailure () const
	Check if this run should continue on failure.
std::string	CreateDataDirFilename (std::string filename)
	Construct the full path to a file in the data directory.
std::string	CreateTempDirFilename (std::string filename)
	Construct the full path to a file in a temporary directory.

Detailed Description

MPI specialization of ns3::ExampleTestSuite.

Definition at line 94 of file mpi-test-suite.cc.

Constructor & Destructor Documentation

MpiTestSuite()

MpiTestSuite::MpiTestSuite ( const std::string name, const std::string program, const std::string dataDir, const int ranks, const std::string args = "", const Duration duration = Duration::QUICK, const bool shouldNotErr = true )

inline

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.
[in]	shouldNotErr	Whether an error return status should be considered a test failure. This is useful when testing error detection which might return a non-zero status. The output (on std::cout and std::cerr) will be compared to the reference logs as normal.
[in]	ranks	The number of ranks to use
[in]	duration	Amount of time this test takes to execute (defaults to QUICK).

Definition at line 103 of file mpi-test-suite.cc.

References ns3::TestCase::AddTestCase().

Here is the call graph for this function:

---

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

• src/mpi/test/mpi-test-suite.cc