A Discrete-Event Network Simulator
API

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. More...
 
 ~MpiTestCase () override
 Destructor. More...
 
std::string GetCommandTemplate () const override
 Produce the --command-template argument which will invoke mpiexec with the requested number of ranks. More...
 
std::string GetPostProcessingCommand () const override
 Sort the output from parallel execution. More...
 
- 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. More...
 
 ~ExampleAsTestCase () override
 Destructor. More...
 
void DoRun () override
 Implementation to actually run this TestCase. More...
 
- Public Member Functions inherited from ns3::TestCase
 TestCase (const TestCase &)=delete
 
virtual ~TestCase ()
 Destructor. More...
 
std::string GetName () const
 
TestCaseoperator= (const TestCase &)=delete
 

Private Attributes

int m_ranks
 The number of ranks. 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...
 
TestCaseGetParent () const
 Get the parent of this TestCase. More...
 
bool IsStatusFailure () const
 Check if any tests failed. More...
 
bool IsStatusSuccess () 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 () const
 Check if this run should assert on failure. More...
 
bool MustContinueOnFailure () 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...
 
- Protected Attributes inherited from ns3::ExampleAsTestCase
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...
 
bool m_shouldNotErr
 Whether error return status is a test failure. More...
 

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 34 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]nameThe test case name, typically the program name and summary of the arguments, such as my-example-foo
[in]programThe actual example program names, such as my-example
[in]dataDirThe 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]argsAny additional arguments to the program.
[in]shouldNotErrWhether 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]ranksThe number of ranks to use

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

◆ ~MpiTestCase()

MpiTestCase::~MpiTestCase ( )
inlineoverride

Destructor.

Definition at line 50 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 87 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 95 of file mpi-test-suite.cc.

Member Data Documentation

◆ m_ranks

int MpiTestCase::m_ranks
private

The number of ranks.

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

Referenced by GetCommandTemplate().


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