This version of ns3::ExampleTestCase is specialized for MPI by accepting the number of ranks as a parameter, then building a --command-template string which invokes mpiexec correctly to execute MPI examples. More...

Inheritance diagram for MpiTestCase:

Collaboration diagram for MpiTestCase:

Public Member Functions
	MpiTestCase (const std::string name, const std::string program, const std::string dataDir, const int ranks, const std::string args="", const bool shouldNotErr=true)
	Constructor.

	~MpiTestCase () override
	Destructor.

std::string	GetCommandTemplate () const override
	Produce the `--command-template` argument which will invoke `mpiexec` with the requested number of ranks.

std::string	GetPostProcessingCommand () const override
	Sort the output from parallel execution.

Public Member Functions inherited from ns3::ExampleAsTestCase
	ExampleAsTestCase (const std::string name, const std::string program, const std::string dataDir, const std::string args="", const bool shouldNotErr=true)
	Constructor.

	~ExampleAsTestCase () override
	Destructor.

void	DoRun () override
	Implementation to actually run this TestCase.

Public Member Functions inherited from ns3::TestCase
	TestCase (const TestCase &)=delete

virtual	~TestCase ()
	Destructor.

std::string	GetName () const

TestCase &	operator= (const TestCase &)=delete

Private Attributes
int	m_ranks
	The number of ranks.

Additional Inherited Members
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::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.

Protected Attributes inherited from ns3::ExampleAsTestCase
std::string	m_args
	Any additional arguments to the program.

std::string	m_dataDir
	The source directory for the test.

std::string	m_program
	The program to run.

bool	m_shouldNotErr
	Whether error return status is a test failure.

Detailed Description

This version of ns3::ExampleTestCase is specialized for MPI by accepting the number of ranks as a parameter, then building a --command-template string which invokes mpiexec correctly to execute MPI examples.

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

Constructor & Destructor Documentation

◆ MpiTestCase()

MpiTestCase::MpiTestCase	(	const std::string	name,
		const std::string	program,
		const std::string	dataDir,
		const int	ranks,
		const std::string	args = "",
		const bool	shouldNotErr = true )

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

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

◆ ~MpiTestCase()

MpiTestCase::~MpiTestCase ( )

inlineoverride

Destructor.

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

Member Function Documentation

◆ GetCommandTemplate()

std::string MpiTestCase::GetCommandTemplate ( ) const

overridevirtual

Produce the --command-template argument which will invoke mpiexec with the requested number of ranks.

Returns: The --command-template string.

Reimplemented from ns3::ExampleAsTestCase.

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

References ns3::ExampleAsTestCase::m_args, and m_ranks.

◆ GetPostProcessingCommand()

std::string MpiTestCase::GetPostProcessingCommand ( ) const

overridevirtual

Sort the output from parallel execution.

stdout from multiple ranks is not ordered.

Returns: Sort command

Reimplemented from ns3::ExampleAsTestCase.

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

Member Data Documentation

◆ m_ranks

int MpiTestCase::m_ranks

private

The number of ranks.

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

Referenced by GetCommandTemplate().

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

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

Public Member Functions

Private Attributes

Additional Inherited Members