encapsulates test code More...

#include "test.h"

Collaboration diagram for ns3::TestCase:

Classes
struct	Result
	Container for results from a TestCase. More...

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

Public Member Functions
	TestCase (const TestCase &)=delete

virtual	~TestCase ()
	Destructor.

std::string	GetName () const

TestCase &	operator= (const TestCase &)=delete

Static Public Attributes

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

Protected Member Functions
	TestCase (std::string name)
	Constructor.

void	AddTestCase (TestCase *testCase, Duration duration=Duration::QUICK)
	Add an individual child TestCase to this test suite.

TestCase *	GetParent () 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.

Internal Interface
These methods are the interface used by test macros and should not be used directly by normal test code.
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.

Private Member Functions
virtual void	DoRun ()=0
	Implementation to actually run this TestCase.

virtual void	DoSetup ()
	Implementation to do any local setup required for this TestCase.

virtual void	DoTeardown ()
	Implementation to do any local setup required for this TestCase.

bool	IsFailed () const
	Check if any tests failed.

void	Run (TestRunnerImpl *runner)
	Executes DoSetup(), DoRun(), and DoTeardown() for the TestCase.

Private Attributes
std::vector< TestCase * >	m_children
	Vector of my children.

std::string	m_dataDir
	My data directory.

Duration	m_duration
	TestCase duration.

std::string	m_name
	TestCase name.

TestCase *	m_parent
	Pointer to my parent TestCase.

Result *	m_result
	Results data.

TestRunnerImpl *	m_runner
	Pointer to the TestRunner.

Friends
class	TestRunnerImpl
	Needs access to the TestCase data members.

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.

See also: sample-test-suite.cc

Definition at line 1049 of file test.h.

Member Enumeration Documentation

◆ Duration

enum class ns3::TestCase::Duration

strong

How long the test takes to execute.

Enumerator
QUICK	Fast test.
EXTENSIVE	Medium length test.
TAKES_FOREVER	Very long running test.

Definition at line 1053 of file test.h.

Constructor & Destructor Documentation

◆ ~TestCase()

ns3::TestCase::~TestCase ( )

virtual

Destructor.

Definition at line 278 of file test.cc.

References m_children, m_parent, m_result, m_runner, NS_ASSERT, and NS_LOG_FUNCTION.

◆ TestCase() [1/2]

ns3::TestCase::TestCase ( const TestCase & )

delete

References TestCase(), and delete.

Here is the call graph for this function:

◆ TestCase() [2/2]

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

protected

Constructor.

Parameters

[in] name The name of the new TestCase created

Definition at line 267 of file test.cc.

References TestCase(), m_dataDir, m_duration, m_name, m_parent, m_result, m_runner, NS_LOG_FUNCTION, and QUICK.

Here is the call graph for this function:

Member Function Documentation

◆ AddTestCase()

void ns3::TestCase::AddTestCase	(	TestCase *	testCase,
		TestCase::Duration	duration = Duration::QUICK )

protected

Add an individual child TestCase to this test suite.

Parameters

[in]	testCase	Pointer to the TestCase object to be added.
[in]	duration	Amount of time this test takes to execute (defaults to QUICK).

Definition at line 292 of file test.cc.

References TestCase(), m_children, m_duration, m_name, m_parent, NS_LOG_FUNCTION, and NS_LOG_UNCOND.

Here is the call graph for this function:

◆ CreateDataDirFilename()

std::string ns3::TestCase::CreateDataDirFilename ( std::string filename )

protected

Construct the full path to a file in the data directory.

The data directory is configured by SetDataDirectory().

Parameters

[in] filename The bare (no path) file name

Returns: The full path to filename in the data directory

Definition at line 413 of file test.cc.

References TestCase(), ns3::SystemPath::Append(), m_dataDir, m_parent, m_runner, NS_FATAL_ERROR, and NS_LOG_FUNCTION.

Referenced by CreateTempDirFilename(), DiffTestCase::DoRun(), MobilityTraceTestCase::DoRun(), ns3::ExampleAsTestCase::DoRun(), ReadFileTestCase::DoRun(), Ns3TcpLossTestCase::DoSetup(), Ns3TcpStateTestCase::DoSetup(), and operator=().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ CreateTempDirFilename()

std::string ns3::TestCase::CreateTempDirFilename ( std::string filename )

protected

Construct the full path to a file in a temporary directory.

If the TestRunner is invoked with "--update-data", this will be the data directory instead.

Parameters

[in] filename The bare (no path) file name

Returns: The full path to filename in the temporary directory.

Definition at line 432 of file test.cc.

References TestCase(), ns3::SystemPath::Append(), CreateDataDirFilename(), ns3::SystemPath::CreateValidSystemPath(), ns3::SystemPath::Join(), m_name, m_parent, m_runner, ns3::SystemPath::MakeDirectories(), and NS_LOG_FUNCTION.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ DoRun()

virtual void ns3::TestCase::DoRun ( )

privatepure virtual

Implementation to actually run this TestCase.

Subclasses should override this method to conduct their tests.

References DoRun(), DoTeardown(), IsFailed(), Run(), and TestRunnerImpl.

Referenced by DoRun(), and Run().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ DoSetup()

void ns3::TestCase::DoSetup ( )

privatevirtual

Implementation to do any local setup required for this TestCase.

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

Reimplemented in AidAssignmentTest, AmpduAggregationTest, BackoffGenerationTest, BarAfterDroppedMpduTest, BasicCallbackTestCase, BridgeTest, CallbackEqualityTestCase, EmlOmnExchangeTest, EmlsrCcaBusyTest, EmlsrCheckNavAndCcaLastPifsTest, EmlsrDlTxopTest, EmlsrIcfSentDuringMainPhySwitchTest, EmlsrLinkSwitchTest, EmlsrOperationsTestBase, EmlsrSwitchMainPhyBackTest, EmlsrUlOfdmaTest, EmlsrUlTxopTest, FileHeaderTestCase, GcrTestBase, LanTest, LinkRenameTestCase, LinkTest, LookupTimeTestCase, MakeBoundCallbackTestCase, MakeCallbackTestCase, MLOTestCase, MultiLinkMuTxTest, MultiLinkOperationsTestBase, MultiLinkSetupTest, MultiLinkTxTest, Ns2MobilityHelperTest, Ns3TcpLossTestCase, Ns3TcpStateTestCase, NullifyCallbackTestCase, OrigBlockAckWindowStalled, PhyChannelSettingsToOperatingChannelTest, PingTestCase, ProbeExchTest, ReadFileTestCase, ReadModeCreateTestCase, RecordHeaderTestCase, ReleaseSeqNoAfterCtsTimeoutTest, SendOnePacketTestCase, SingleLinkEmlsrTest, SpectrumWifiPhy80Plus80Test, SpectrumWifiPhyBasicTest, SpectrumWifiPhyFilterTest, SpectrumWifiPhyGetBandTest, SpectrumWifiPhyListenerTest, SpectrumWifiPhyMultipleInterfacesTest, SpectrumWifiPhyTrackedBandsTest, StartSeqNoUpdateAfterAddBaTimeoutTest, TestAmpduReception, TestDlMuMimoPhyTransmission, TestDlOfdmaPhyPuncturing, TestDlOfdmaPhyTransmission< LatestPhyEntityType >, TestMultipleCtsResponsesFromMuRts, TestMultipleHeTbPreambles, TestNonHtDuplicatePhyReception, TestPhyDropDueToTx, TestPhyPaddingExclusion, TestPrimary20CoveredByPpdu, TestSimpleFrameCaptureModel, TestSpectrumChannelWithBandwidthFilter, TestThresholdPreambleDetectionWithFrameCapture, TestThresholdPreambleDetectionWithoutFrameCapture, TestUlMuMimoPhyTransmission, TestUlOfdmaPhyTransmission< LatestPhyEntityType >, TestUlOfdmaPowerControl, TestUlOfdmaPpduUid, TestUnsupportedBandwidthReception, TestWifiPhyRxTraceHelper, TestWifiPhyRxTraceHelperMloStr, TestWifiPhyRxTraceHelperYans, ThreadedSimulatorEventsTestCase, TidToLinkMappingElementTest, TimeSimpleTestCase, TimeWithSignTestCase, TwoBridgeTest, TwoLanTest, TwoLinkTest, WifiFilsFrameTest, WifiMloUdpTest, WifiOfdmMaskSlopesTestCase, WifiPhyCcaIndicationTest, WifiPhyCcaThresholdsTest, WifiPhyReceptionTest, WifiPhyThresholdsTest, WifiPrimaryChannelsTest, WifiRetransmitTest, WifiTxStatsHelperTest, and WriteModeCreateTestCase.

Definition at line 479 of file test.cc.

References NS_LOG_FUNCTION.

Referenced by Run(), and TestRunnerImpl.

Here is the caller graph for this function:

◆ DoTeardown()

void ns3::TestCase::DoTeardown ( )

privatevirtual

Implementation to do any local setup required for this TestCase.

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

Definition at line 485 of file test.cc.

References NS_LOG_FUNCTION.

Referenced by DoRun(), and Run().

Here is the caller graph for this function:

◆ GetName()

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

Returns: The name of this test

Definition at line 367 of file test.cc.

References m_name, and NS_LOG_FUNCTION.

◆ GetParent()

TestCase * ns3::TestCase::GetParent ( ) const

protected

Get the parent of this TestCase.

Returns: A pointer to the parent of this test.

Definition at line 374 of file test.cc.

References m_parent.

Here is the caller graph for this function:

◆ IsFailed()

bool ns3::TestCase::IsFailed ( ) const

private

Check if any tests failed.

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

Definition at line 333 of file test.cc.

References m_result, and NS_LOG_FUNCTION.

Referenced by DoRun(), and Run().

Here is the caller graph for this function:

◆ IsStatusFailure()

bool ns3::TestCase::IsStatusFailure ( ) const

protected

Check if any tests failed.

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

Definition at line 458 of file test.cc.

References IsStatusSuccess(), and NS_LOG_FUNCTION.

Referenced by Ns2MobilityHelperTest::CheckInitialPositions(), and operator=().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ IsStatusSuccess()

bool ns3::TestCase::IsStatusSuccess ( ) const

protected

Check if all tests passed.

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

Definition at line 465 of file test.cc.

References m_result, and NS_LOG_FUNCTION.

Referenced by Ns3TcpLossTestCase::Ipv4L3Tx(), Ns3TcpStateTestCase::Ipv4L3Tx(), IsStatusFailure(), and operator=().

Here is the caller graph for this function:

◆ MustAssertOnFailure()

bool ns3::TestCase::MustAssertOnFailure ( ) const

protected

Check if this run should assert on failure.

Returns: true if we should assert on failure.

Definition at line 399 of file test.cc.

References m_runner, and NS_LOG_FUNCTION.

Referenced by operator=().

Here is the caller graph for this function:

◆ MustContinueOnFailure()

bool ns3::TestCase::MustContinueOnFailure ( ) const

protected

Check if this run should continue on failure.

Returns: true if we should continue on failure.

Definition at line 406 of file test.cc.

References m_runner, and NS_LOG_FUNCTION.

Referenced by operator=().

Here is the caller graph for this function:

◆ operator=()

TestCase & ns3::TestCase::operator= ( const TestCase & )

delete

References TestCase(), AddTestCase(), CreateDataDirFilename(), CreateTempDirFilename(), delete, GetName(), GetParent(), IsStatusFailure(), IsStatusSuccess(), MustAssertOnFailure(), MustContinueOnFailure(), private, QUICK, ReportTestFailure(), and SetDataDir().

Here is the call graph for this function:

◆ ReportTestFailure()

void ns3::TestCase::ReportTestFailure	(	std::string	cond,
		std::string	actual,
		std::string	limit,
		std::string	message,
		std::string	file,
		int32_t	line )

protected

Log the failure of this TestCase.

Parameters

[in]	cond	The test condition.
[in]	actual	Actual value of the test.
[in]	limit	Expected value of the test.
[in]	message	Message indicating the type of failure.
[in]	file	The file where the test failed.
[in]	line	The line number in file where the test failed.

Definition at line 380 of file test.cc.

References TestCase(), ns3::TestCase::Result::childrenFailed, m_parent, m_result, and NS_LOG_FUNCTION.

Referenced by operator=().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Run()

void ns3::TestCase::Run ( TestRunnerImpl * runner )

private

Executes DoSetup(), DoRun(), and DoTeardown() for the TestCase.

Config::Reset() is called at both the beginning and end of this method so that any changes to attribute default values (Config::SetDefault(...)) or global values (e.g., RngRun) that are made within the test case's DoRun() method do not propagate beyond the scope of running the TestCase.

Parameters

[in] runner The test runner implementation.

Definition at line 340 of file test.cc.

References TestCase(), DoRun(), DoSetup(), DoTeardown(), IsFailed(), m_children, m_result, m_runner, NS_LOG_FUNCTION, ns3::Config::Reset(), ns3::RngSeedManager::ResetNextStreamIndex(), and TestRunnerImpl.

Referenced by DoRun().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SetDataDir()

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

protected

Set the data directory where reference trace files can be found.

Parameters

[in] 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/CMakeLists.txt for each module

Definition at line 472 of file test.cc.

References m_dataDir, and NS_LOG_FUNCTION.

Referenced by ns3::aodv::AodvLoopbackTestSuite::AodvLoopbackTestSuite(), AodvRegressionTestSuite::AodvRegressionTestSuite(), Dot11sRegressionSuite::Dot11sRegressionSuite(), FlameRegressionSuite::FlameRegressionSuite(), Ns2MobilityHelperTestSuite::Ns2MobilityHelperTestSuite(), Ns3TcpLossTestSuite::Ns3TcpLossTestSuite(), Ns3TcpStateTestSuite::Ns3TcpStateTestSuite(), PcapFileTestSuite::PcapFileTestSuite(), RegressionTestSuite::RegressionTestSuite(), MobilityTraceTestCase::DoRun(), ns3::ExampleAsTestCase::DoRun(), and operator=().

Here is the caller graph for this function:

Friends And Related Symbol Documentation

◆ TestRunnerImpl

friend class TestRunnerImpl

friend

Needs access to the TestCase data members.

Definition at line 1202 of file test.h.

References DoSetup(), and TestRunnerImpl.

Referenced by DoRun(), Run(), and TestRunnerImpl.

Member Data Documentation

◆ EXTENSIVE

auto ns3::TestCase::EXTENSIVE = Duration::EXTENSIVE

staticconstexpr

Deprecated: "Deprecated in ns-3.42: " "Use Duration::EXTENSIVE instead"

Definition at line 1069 of file test.h.

◆ m_children

std::vector<TestCase*> ns3::TestCase::m_children

private

Vector of my children.

Definition at line 1251 of file test.h.

Referenced by ~TestCase(), AddTestCase(), and Run().

◆ m_dataDir

std::string ns3::TestCase::m_dataDir

private

My data directory.

Definition at line 1252 of file test.h.

Referenced by TestCase(), CreateDataDirFilename(), and SetDataDir().

◆ m_duration

Duration ns3::TestCase::m_duration

private

TestCase duration.

Definition at line 1256 of file test.h.

Referenced by TestCase(), AddTestCase(), and ns3::TestRunnerImpl::FilterTests().

◆ m_name

std::string ns3::TestCase::m_name

private

TestCase name.

Definition at line 1255 of file test.h.

Referenced by TestCase(), AddTestCase(), CreateTempDirFilename(), and GetName().

◆ m_parent

TestCase* ns3::TestCase::m_parent

private

Pointer to my parent TestCase.

Definition at line 1250 of file test.h.

Referenced by TestCase(), ~TestCase(), AddTestCase(), CreateDataDirFilename(), CreateTempDirFilename(), GetParent(), and ReportTestFailure().

◆ m_result

Result* ns3::TestCase::m_result

private

Results data.

Definition at line 1254 of file test.h.

Referenced by TestCase(), ~TestCase(), IsFailed(), IsStatusSuccess(), ReportTestFailure(), and Run().

◆ m_runner

TestRunnerImpl* ns3::TestCase::m_runner

private

Pointer to the TestRunner.

Definition at line 1253 of file test.h.

Referenced by TestCase(), ~TestCase(), CreateDataDirFilename(), CreateTempDirFilename(), MustAssertOnFailure(), MustContinueOnFailure(), and Run().

◆ QUICK

auto ns3::TestCase::QUICK = Duration::QUICK

staticconstexpr

Deprecated test duration simple enums.

Use the TestCase::Duration enum class symbols instead.

Deprecated: "Deprecated in ns-3.42: " "Use Duration::QUICK instead"

Definition at line 1067 of file test.h.

Referenced by TestCase(), and operator=().

◆ TAKES_FOREVER

auto ns3::TestCase::TAKES_FOREVER = Duration::TAKES_FOREVER

staticconstexpr

Deprecated: "Deprecated in ns-3.42: " "Use Duration::TAKES_FOREVER instead"

Definition at line 1071 of file test.h.

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

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

Classes

Public Types

Public Member Functions

Static Public Attributes

Protected Member Functions

Private Member Functions

Private Attributes

Friends

Detailed Description

Member Enumeration Documentation

◆ Duration

Constructor & Destructor Documentation

◆ ~TestCase()

◆ TestCase() [1/2]

◆ TestCase() [2/2]

Member Function Documentation

◆ AddTestCase()

◆ CreateDataDirFilename()

◆ CreateTempDirFilename()

◆ DoRun()

◆ DoSetup()

◆ DoTeardown()

◆ GetName()

◆ GetParent()

◆ IsFailed()

◆ IsStatusFailure()

◆ IsStatusSuccess()

◆ MustAssertOnFailure()

◆ MustContinueOnFailure()

◆ operator=()

◆ ReportTestFailure()

◆ Run()

◆ SetDataDir()

Friends And Related Symbol Documentation

◆ TestRunnerImpl

Member Data Documentation

◆ EXTENSIVE

◆ m_children

◆ m_dataDir

◆ m_duration

◆ m_name

◆ m_parent

◆ m_result

◆ m_runner

◆ QUICK

◆ TAKES_FOREVER