A Discrete-Event Network Simulator
API
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
ns3::TestSuite Class Reference

A suite of tests to run. More...

#include <test.h>

+ Inheritance diagram for ns3::TestSuite:

Public Types

enum  Type {
  ALL = 0, BVT = 1, UNIT, SYSTEM,
  EXAMPLE, PERFORMANCE
}
 Type of test. More...
 
- Public Types inherited from ns3::TestCase
enum  TestDuration { QUICK = 1, EXTENSIVE = 2, TAKES_FOREVER = 3 }
 How long the test takes to execute. More...
 

Public Member Functions

 TestSuite (std::string name, Type type=UNIT)
 Constuct a new test suite. More...
 
TestSuite::Type GetTestType (void)
 get the kind of test this test suite implements More...
 

Private Member Functions

virtual void DoRun (void)
 Implementation to actually run this test case. More...
 

Private Attributes

TestSuite::Type m_type
 

Additional Inherited Members

- Protected Member Functions inherited from ns3::TestCase
 TestCase (std::string name)
 
void AddTestCase (TestCase *testCase) NS_DEPRECATED
 Add an individual test case to this test suite. More...
 
void AddTestCase (TestCase *testCase, enum TestDuration duration)
 Add an individual test case to this test suite. More...
 
std::string CreateDataDirFilename (std::string filename)
 
std::string CreateTempDirFilename (std::string filename)
 
bool GetErrorStatus (void) const NS_DEPRECATED
 
std::string GetName (void) const
 
bool IsStatusFailure (void) const
 
bool IsStatusSuccess (void) const
 
bool MustAssertOnFailure (void) const
 
bool MustContinueOnFailure (void) const
 
void ReportTestFailure (std::string cond, std::string actual, std::string limit, std::string message, std::string file, int32_t line)
 
void SetDataDir (std::string directory)
 

Detailed Description

A suite of tests to run.

Definition at line 962 of file test.h.

Member Enumeration Documentation

Type of test.

Enumerator
BVT 

This test suite implements a Build Verification Test

UNIT 

This test suite implements a Unit Test

SYSTEM 

This test suite implements a System Test

EXAMPLE 

This test suite implements an Example Test

PERFORMANCE 

This test suite implements a Performance Test

Definition at line 969 of file test.h.

Constructor & Destructor Documentation

ns3::TestSuite::TestSuite ( std::string  name,
TestSuite::Type  type = UNIT 
)

Constuct a new test suite.

Parameters
nameThe name of the test suite.
typeThe TestType of the test suite (defaults to UNIT test).

Definition at line 354 of file test.cc.

References NS_LOG_FUNCTION.

Member Function Documentation

void ns3::TestSuite::DoRun ( void  )
privatevirtual

Implementation to actually run this test case.

Subclasses should override this method to conduct their tests.

Implements ns3::TestCase.

Definition at line 370 of file test.cc.

References NS_LOG_FUNCTION.

TestSuite::Type ns3::TestSuite::GetTestType ( void  )

get the kind of test this test suite implements

Returns
the Type of the suite.

Definition at line 363 of file test.cc.

References NS_LOG_FUNCTION.


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