A Discrete-Event Network Simulator
API
Loading...
Searching...
No Matches
ns3::tests::CommandLineTestCaseBase Class Reference

A test base class that drives Command Line parsing. More...

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

Public Member Functions

 CommandLineTestCaseBase (std::string description)
 Constructor.
 
 ~CommandLineTestCaseBase () override
 Destructor.
 
void Parse (CommandLine &cmd, int n,...)
 Exercise the CommandLine with the provided arguments.
 
- Public Member Functions inherited from ns3::TestCase
 TestCase (const TestCase &)=delete
 
virtual ~TestCase ()
 Destructor.
 
std::string GetName () const
 
TestCaseoperator= (const TestCase &)=delete
 

Static Public Attributes

static int m_count = 0
 Test iteration counter to give each test a unique name.
 
- 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
 

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...
 
- 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.
 
TestCaseGetParent () 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

A test base class that drives Command Line parsing.

Definition at line 44 of file command-line-test-suite.cc.

Constructor & Destructor Documentation

◆ CommandLineTestCaseBase()

ns3::tests::CommandLineTestCaseBase::CommandLineTestCaseBase ( std::string description)

Constructor.

Parameters
descriptionpurpose of this TestCase

Definition at line 73 of file command-line-test-suite.cc.

◆ ~CommandLineTestCaseBase()

ns3::tests::CommandLineTestCaseBase::~CommandLineTestCaseBase ( )
inlineoverride

Destructor.

Definition at line 55 of file command-line-test-suite.cc.

Member Function Documentation

◆ Parse()

void ns3::tests::CommandLineTestCaseBase::Parse ( CommandLine & cmd,
int n,
... )

Exercise the CommandLine with the provided arguments.

Parameters
cmdthe configured CommandLine
nthe number of arguments

Definition at line 79 of file command-line-test-suite.cc.

References ns3::TestCase::GetName(), ns3::TestCase::GetParent(), and m_count.

Referenced by ns3::tests::CommandLineBooleanTestCase::DoRun(), ns3::tests::CommandLineCharStarTestCase::DoRun(), ns3::tests::CommandLineIntTestCase::DoRun(), ns3::tests::CommandLineInvalidTestCase::DoRun(), ns3::tests::CommandLineNonOptionTestCase::DoRun(), ns3::tests::CommandLineOrderTestCase::DoRun(), ns3::tests::CommandLineStringTestCase::DoRun(), ns3::tests::CommandLineUint8tTestCase::DoRun(), and ns3::tests::CommandLineUnsignedIntTestCase::DoRun().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

Member Data Documentation

◆ m_count

int ns3::tests::CommandLineTestCaseBase::m_count = 0
static

Test iteration counter to give each test a unique name.

Definition at line 68 of file command-line-test-suite.cc.

Referenced by Parse().


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