encapsulates test code More...

#include <test.h>

Inheritance diagram for ns3::TestCase:

Classes
struct	Result

Public Types
enum	TestDuration { QUICK = 1, EXTENSIVE = 2, TAKES_FOREVER = 3 }
	How long the test takes to execute. More...

Protected Member Functions
	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)

Private Member Functions
	TestCase (TestCase &tc)

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

virtual void	DoSetup (void)
	Implementation to do any local setup required for this test case. More...

virtual void	DoTeardown (void)
	Implementation to do any local setup required for this test case. More...

bool	IsFailed (void) const

TestCase &	operator= (TestCase &tc)

void	Run (TestRunnerImpl *runner)

Private Attributes
std::vector< TestCase * >	m_children

std::string	m_dataDir

enum TestDuration	m_duration

std::string	m_name

TestCase *	m_parent

struct Result *	m_result

TestRunnerImpl *	m_runner

Friends
class	TestRunnerImpl

Detailed Description

encapsulates test code

To allow a new test to be run within the ns-3 test framework, users need to create subclasses of this base class, override the DoRun method, and use the NS_TEST_* macros within DoRun.

Definition at line 834 of file test.h.

Member Enumeration Documentation

enum ns3::TestCase::TestDuration

How long the test takes to execute.

Enumerator
EXTENSIVE	Fast test.
TAKES_FOREVER	Medium length test.

Definition at line 841 of file test.h.

Constructor & Destructor Documentation

ns3::TestCase::TestCase ( std::string name )

protected

Parameters

name	the name of the new test created

Definition at line 147 of file test.cc.

References NS_LOG_FUNCTION.

Member Function Documentation

void ns3::TestCase::AddTestCase ( TestCase * testCase )

protected

Add an individual test case to this test suite.

Parameters

testCase Pointer to the test case object to be added.

Deprecated:: this method will go away in future versions of ns-3. Please use instead AddTestCase (TestCase, TestDuration)

Definition at line 172 of file test.cc.

Referenced by ns3::BuildingsPathlossTestSuite::BuildingsPathlossTestSuite(), ns3::BuildingsShadowingTestSuite::BuildingsShadowingTestSuite(), ns3::EpsGtpuTestSuite::EpsGtpuTestSuite(), ns3::LteDownlinkSinrTestSuite::LteDownlinkSinrTestSuite(), ns3::LteFadingTestSuite::LteFadingTestSuite(), ns3::LteInterferenceTestSuite::LteInterferenceTestSuite(), ns3::LteLinkAdaptationTestSuite::LteLinkAdaptationTestSuite(), ns3::LtePathlossModelTestSuite::LtePathlossModelTestSuite(), ns3::LteRlcAmE2eTestSuite::LteRlcAmE2eTestSuite(), ns3::LteRlcAmTransmitterTestSuite::LteRlcAmTransmitterTestSuite(), ns3::LteRlcUmE2eTestSuite::LteRlcUmE2eTestSuite(), ns3::LteRlcUmTransmitterTestSuite::LteRlcUmTransmitterTestSuite(), and ns3::LteUplinkSinrTestSuite::LteUplinkSinrTestSuite().

void ns3::TestCase::AddTestCase	(	TestCase *	testCase,
		enum TestDuration	duration
	)

protected

Add an individual test case to this test suite.

Parameters

testCase	Pointer to the test case object to be added.
duration	Amount of time this test takes to execute.

Definition at line 178 of file test.cc.

References NS_FATAL_ERROR, and NS_LOG_FUNCTION.

virtual void ns3::TestCase::DoRun ( void )

privatepure virtual

Implementation to actually run this test case.

Subclasses should override this method to conduct their tests.

void ns3::TestCase::DoSetup ( void )

privatevirtual

Implementation to do any local setup required for this test case.

Subclasses should override this method to perform any costly per-test setup before DoRun is invoked.

Reimplemented in ReadFileTestCase, RecordHeaderTestCase, FileHeaderTestCase, NullifyCallbackTestCase, MakeBoundCallbackTestCase, ns3::Ns2MobilityHelperTest, ReadModeCreateTestCase, MakeCallbackTestCase, WriteModeCreateTestCase, Ns3TcpInteroperabilityTestCase, TimesWithSignsTestCase, Ns3TcpLossTestCase, Ns3TcpStateTestCase, ThreadedSimulatorEventsTestCase, BasicCallbackTestCase, and TimeSimpleTestCase.

Definition at line 343 of file test.cc.

References NS_LOG_FUNCTION.

void ns3::TestCase::DoTeardown ( void )

privatevirtual

Implementation to do any local setup required for this test case.

Subclasses should override this method to perform any costly per-test teardown

Reimplemented in ReadFileTestCase, AlternateFindTestCase, RelativeFindTestCase, FullyQualifiedFindTestCase, StringContextFindTestCase, RecordHeaderTestCase, BasicFindTestCase, FindPathTestCase, RelativeRenameTestCase, FullyQualifiedRenameTestCase, FileHeaderTestCase, StringContextRenameTestCase, BasicRenameTestCase, RelativeAddTestCase, AddressCollisionTestCase, ns3::Ns2MobilityHelperTest, AddressCollision6TestCase, FullyQualifiedAddTestCase, ReadModeCreateTestCase, ExampleAddressGeneratorTestCase, IpAddressHelperTestCasev4, ExampleAddress6GeneratorTestCase, StringContextAddTestCase, NetworkAndAddressTestCase, NetworkAndAddress6TestCase, ResetAllocatorHelperTestCase, TimerTemplateTestCase, WriteModeCreateTestCase, Ns3TcpInteroperabilityTestCase, TimesWithSignsTestCase, AddressAllocatorTestCase, AddressAllocatorHelperTestCase, AddressAllocator6TestCase, BasicAddTestCase, TcpTestCase, Ns3TcpLossTestCase, Ns3TcpStateTestCase, ThreadedSimulatorEventsTestCase, DualStackTestCase, ns3::WaypointMobilityModelNotifyTest, ns3::SteadyStateRandomWaypointTest, IpAddressHelperTestCasev6, RttTestCase, TimeSimpleTestCase, NetworkAllocatorHelperTestCase, NetworkNumber6AllocatorTestCase, and NetworkNumberAllocatorTestCase.

Definition at line 348 of file test.cc.

References NS_LOG_FUNCTION.

bool ns3::TestCase::GetErrorStatus ( void ) const

protected

This method is deprecated. IsStatusFailure replaces it.

Definition at line 317 of file test.cc.

References IsStatusFailure(), and NS_LOG_FUNCTION.

std::string ns3::TestCase::GetName ( void ) const

protected

Returns: name of this test

Definition at line 241 of file test.cc.

References NS_LOG_FUNCTION.

Referenced by ns3::LenaMimoTestCase::DoRun(), ns3::LteRrcConnectionEstablishmentTestCase::DoRun(), ns3::LenaPssFfMacSchedulerTestCase1::DoRun(), ns3::LteInterferenceTestCase::DoRun(), ns3::LteFadingTestCase::DoRun(), ns3::LteEpcE2eDataTestCase::DoRun(), and ns3::LteRrcConnectionEstablishmentTestCase::LteRrcConnectionEstablishmentTestCase().

bool ns3::TestCase::IsStatusFailure ( void ) const

protected

Returns: true if the tests have failed, false otherwise.

Definition at line 323 of file test.cc.

References IsStatusSuccess(), and NS_LOG_FUNCTION.

Referenced by ns3::Ns2MobilityHelperTest::CheckInitialPositions(), and GetErrorStatus().

bool ns3::TestCase::IsStatusSuccess ( void ) const

protected

Returns: true if the tests have succeeded, false otherwise.

Definition at line 329 of file test.cc.

References NS_LOG_FUNCTION.

Referenced by IsStatusFailure().

void ns3::TestCase::SetDataDir ( std::string directory )

protected

Parameters

directory the directory where the test data is located

In general, this method is invoked as SetDataDir (NS_TEST_SOURCEDIR); However, if a module contains a test directory with subdirectories (e.g. src/mesh/test), and the test data (e.g. pcap traces) is located in one of these subdirectories, then the variable NS_TEST_SOURCEDIR may not work and the user may want to explicitly pass in a directory string.

Note that NS_TEST_SOURCEDIR is set in src/wscript for each module

Definition at line 336 of file test.cc.

References NS_LOG_FUNCTION.

Referenced by MobilityTraceTestCase::DoRun().

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

src/core/model/test.h
src/core/model/test.cc

Classes

Public Types

Protected Member Functions

Private Member Functions

Private Attributes

Friends

Detailed Description

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation