A Discrete-Event Network Simulator
ns3::tests::CommandLineExampleTestCase Class Reference

Run command line example as a test case. More...

+ Inheritance diagram for ns3::tests::CommandLineExampleTestCase:
+ Collaboration diagram for ns3::tests::CommandLineExampleTestCase:

Public Member Functions

 CommandLineExampleTestCase ()
 Default constructor. More...
virtual ~CommandLineExampleTestCase ()
 Destructor. More...
virtual std::string GetPostProcessingCommand (void) const
 Override this function to filter the version string from the command-line-example output. 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="")
 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
TestCaseoperator= (const TestCase &)=delete

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 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...
- 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...

Detailed Description

Run command line example as a test case.

Definition at line 48 of file examples-as-tests-test-suite.cc.

Constructor & Destructor Documentation

◆ CommandLineExampleTestCase()

ns3::tests::CommandLineExampleTestCase::CommandLineExampleTestCase ( )

Default constructor.

Definition at line 72 of file examples-as-tests-test-suite.cc.

◆ ~CommandLineExampleTestCase()

ns3::tests::CommandLineExampleTestCase::~CommandLineExampleTestCase ( )


Definition at line 78 of file examples-as-tests-test-suite.cc.

Member Function Documentation

◆ GetPostProcessingCommand()

std::string ns3::tests::CommandLineExampleTestCase::GetPostProcessingCommand ( void  ) const

Override this function to filter the version string from the command-line-example output.

Since the version changes each time a commit is made it shouldn't be tested as part of the command-line-example output.

The string of post-processing commands.

Reimplemented from ns3::ExampleAsTestCase.

Definition at line 82 of file examples-as-tests-test-suite.cc.

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