A suite of tests to run. More...

#include "test.h"

Collaboration diagram for ns3::TestSuite:

Public Types
enum class	Type { ALL = 0 , UNIT , SYSTEM , EXAMPLE , PERFORMANCE }
	Type of test. More...

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

Public Member Functions
	TestSuite (std::string name, Type type=Type::UNIT)
	Construct a new test suite.

TestSuite::Type	GetTestType ()
	get the kind of test this test suite implements

Public Member Functions inherited from ns3::TestCase
	TestCase (const TestCase &)=delete

virtual	~TestCase ()
	Destructor.

std::string	GetName () const

TestCase &	operator= (const TestCase &)=delete

Static Public Attributes

static constexpr auto	ALL = Type::ALL
	Deprecated test type simple enums.

static constexpr auto	UNIT = Type::UNIT

static constexpr auto	SYSTEM = Type::SYSTEM

static constexpr auto	EXAMPLE = Type::EXAMPLE

static constexpr auto	PERFORMANCE = Type::PERFORMANCE

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

Private Member Functions
void	DoRun () override
	Implementation to actually run this TestCase.

Private Attributes
TestSuite::Type	m_type
	Type of this TestSuite.

Additional Inherited Members
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.

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.

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 suite of tests to run.

See also: sample-test-suite.cc

Definition at line 1266 of file test.h.

Member Enumeration Documentation

◆ Type

enum class ns3::TestSuite::Type

strong

Type of test.

Enumerator
ALL	Token to represent all tests.
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 1273 of file test.h.

Constructor & Destructor Documentation

◆ TestSuite()

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

Construct a new test suite.

Parameters

[in]	name	The name of the test suite.
[in]	type	The TestType of the test suite (defaults to UNIT test).

Definition at line 490 of file test.cc.

References ns3::TestRunnerImpl::AddTestSuite(), ns3::Singleton< TestRunnerImpl >::Get(), and NS_LOG_FUNCTION.

Here is the call graph for this function:

Member Function Documentation

◆ DoRun()

void ns3::TestSuite::DoRun ( )

overrideprivatevirtual

Implementation to actually run this TestCase.

Subclasses should override this method to conduct their tests.

Implements ns3::TestCase.

Definition at line 506 of file test.cc.

References NS_LOG_FUNCTION.

◆ GetTestType()

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

get the kind of test this test suite implements

Returns: The Type of the suite.

Definition at line 499 of file test.cc.

References m_type, and NS_LOG_FUNCTION.

Member Data Documentation

◆ ALL

auto ns3::TestSuite::ALL = Type::ALL

staticconstexpr

Deprecated test type simple enums.

Use the TestSuite::Type enum class symbols instead.

Deprecated: "Deprecated in ns-3.42: " "Use Type::ALL instead"

Definition at line 1289 of file test.h.

◆ EXAMPLE

auto ns3::TestSuite::EXAMPLE = Type::EXAMPLE

staticconstexpr

Deprecated: "Deprecated in ns-3.42: " "Use Type::EXAMPLE instead"

Definition at line 1295 of file test.h.

◆ m_type

TestSuite::Type ns3::TestSuite::m_type

private

Type of this TestSuite.

Definition at line 1319 of file test.h.

Referenced by GetTestType().

◆ PERFORMANCE

auto ns3::TestSuite::PERFORMANCE = Type::PERFORMANCE

staticconstexpr

Deprecated: "Deprecated in ns-3.42: " "Use Type::PERFORMANCE instead"

Definition at line 1297 of file test.h.

◆ SYSTEM

auto ns3::TestSuite::SYSTEM = Type::SYSTEM

staticconstexpr

Deprecated: "Deprecated in ns-3.42: " "Use Type::SYSTEM instead"

Definition at line 1293 of file test.h.

◆ UNIT

auto ns3::TestSuite::UNIT = Type::UNIT

staticconstexpr

Deprecated: "Deprecated in ns-3.42: " "Use Type::UNIT instead"

Definition at line 1291 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

Public Types

Public Member Functions

Static Public Attributes

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ Type

Constructor & Destructor Documentation

◆ TestSuite()

Member Function Documentation

◆ DoRun()

◆ GetTestType()

Member Data Documentation

◆ ALL

◆ EXAMPLE

◆ m_type

◆ PERFORMANCE

◆ SYSTEM

◆ UNIT