Classes
class	DockerContainerManager
	Python-on-whales wrapper for Docker-based ns-3 tests. More...

class	NS3BaseTestCase
	Generic test case with basic function inherited by more complex tests. More...

class	NS3BuildBaseTestCase
	Tests ns3 regarding building the project. More...

class	NS3CommonSettingsTestCase
	ns3 tests related to generic options More...

class	NS3ConfigureBuildProfileTestCase
	ns3 tests related to build profiles More...

class	NS3ConfigureTestCase
	Test ns3 configuration options. More...

class	NS3DependenciesTestCase
	ns-3 tests related to dependencies More...

class	NS3ExpectedUseTestCase
	Tests ns3 usage in more realistic scenarios. More...

class	NS3QualityControlTestCase
	ns-3 tests to control the quality of the repository over time, by checking the state of URLs listed and more More...

class	NS3StyleTestCase
	ns-3 tests to check if the source code, whitespaces and CMake formatting are according to the coding style More...

class	NS3UnusedSourcesTestCase
	ns-3 tests related to checking if source files were left behind, not being used by CMake More...

Functions
def	get_enabled_modules ()

def	get_headers_list (outdir=usual_outdir)
	Gets a list of header files.

def	get_libraries_list (lib_outdir=usual_lib_outdir)
	Gets a list of built libraries.

def	get_programs_list ()
	Extracts the programs list from .lock-ns3.

def	get_test_enabled ()
	Check if tests are enabled in the .lock-ns3.

def	read_lock_entry (entry)
	Read interesting entries from the .lock-ns3 file.

def	run_ns3 (args, env=None, generator=platform_makefiles)
	Runs the ns3 wrapper script with arguments.

def	run_program (program, args, python=False, cwd=ns3_path, env=None)
	Runs a program with the given arguments and returns a tuple containing (error code, stdout and stderr)

Variables
str	cmake_build_project_command

partial	cmake_build_target_command

str	ext = ".exe" if win32 else ""

os	ns3_lock_filename = os.path.join(ns3_path, ".lock-ns3_%s_build" % sys.platform)

os	ns3_path = os.path.dirname(os.path.abspath(os.sep.join([__file__, "../../"])))

os	ns3_script = os.sep.join([ns3_path, "ns3"])

os	ns3rc_script = os.sep.join([ns3_path, ".ns3rc"])

max	num_threads = max(1, os.cpu_count() - 1)

str	platform_makefiles = "MinGW Makefiles" if win32 else "Unix Makefiles"

os	usual_lib_outdir = os.sep.join([usual_outdir, "lib"])

os	usual_outdir = os.sep.join([ns3_path, "build"])

sys	win32 = "win32"

Function Documentation

◆ get_enabled_modules()

def test-ns3.get_enabled_modules ( )

Check if tests are enabled in the .lock-ns3
@return list of enabled modules (prefixed with 'ns3-').

Definition at line 187 of file test-ns3.py.

References read_lock_entry().

Referenced by test-ns3.NS3ExpectedUseTestCase.test_01_BuildProject(), test-ns3.NS3ConfigureTestCase.test_03_EnableModules(), test-ns3.NS3ConfigureTestCase.test_04_DisableModules(), test-ns3.NS3ConfigureTestCase.test_05_EnableModulesComma(), test-ns3.NS3ConfigureTestCase.test_06_DisableModulesComma(), and test-ns3.NS3ConfigureTestCase.test_19_FilterModuleExamplesAndTests().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ get_headers_list()

def test-ns3.get_headers_list ( outdir = usual_outdir )

Gets a list of header files.

Parameters

outdir path containing headers

Returns: list of headers.

Definition at line 158 of file test-ns3.py.

Referenced by test-ns3.NS3BuildBaseTestCase.test_08_InstallationAndUninstallation().

Here is the caller graph for this function:

◆ get_libraries_list()

def test-ns3.get_libraries_list ( lib_outdir = usual_lib_outdir )

Gets a list of built libraries.

Parameters

lib_outdir path containing libraries

Returns: list of built libraries.

Definition at line 148 of file test-ns3.py.

References list.

Referenced by test-ns3.NS3ExpectedUseTestCase.test_01_BuildProject(), test-ns3.NS3ConfigureBuildProfileTestCase.test_01_Debug(), test-ns3.NS3ConfigureBuildProfileTestCase.test_03_Optimized(), test-ns3.NS3BuildBaseTestCase.test_06_TestVersionFile(), test-ns3.NS3BuildBaseTestCase.test_07_OutputDirectory(), and test-ns3.NS3BuildBaseTestCase.test_08_InstallationAndUninstallation().

Here is the caller graph for this function:

◆ get_programs_list()

def test-ns3.get_programs_list ( )

Extracts the programs list from .lock-ns3.

Returns: list of programs.

Definition at line 131 of file test-ns3.py.

References list.

Referenced by test-ns3.NS3ExpectedUseTestCase.test_01_BuildProject(), test-ns3.NS3ConfigureTestCase.test_01_Examples(), test-ns3.NS3BuildBaseTestCase.test_03_BuildProject(), test-ns3.NS3BuildBaseTestCase.test_06_TestVersionFile(), test-ns3.NS3ConfigureTestCase.test_08_DryRun(), test-ns3.NS3ConfigureTestCase.test_14_MpiCommandTemplate(), and test-ns3.NS3ConfigureTestCase.test_19_FilterModuleExamplesAndTests().

Here is the caller graph for this function:

◆ get_test_enabled()

def test-ns3.get_test_enabled ( )

Check if tests are enabled in the .lock-ns3.

Returns: bool.

Definition at line 179 of file test-ns3.py.

References read_lock_entry().

Here is the call graph for this function:

◆ read_lock_entry()

def test-ns3.read_lock_entry ( entry )

Read interesting entries from the .lock-ns3 file.

Parameters

entry entry to read from .lock-ns3

Returns: value of the requested entry.

Definition at line 167 of file test-ns3.py.

Referenced by get_enabled_modules(), get_test_enabled(), and test-ns3.NS3ExpectedUseTestCase.test_14_EnableSudo().

Here is the caller graph for this function:

◆ run_ns3()

def test-ns3.run_ns3	(	args,
		env = `None`,
		generator = `platform_makefiles`
	)

Runs the ns3 wrapper script with arguments.

Parameters

args	string containing arguments that will get split before calling ns3
env	environment variables dictionary
generator	CMake generator

Returns: tuple containing (error code, stdout and stderr)

Definition at line 59 of file test-ns3.py.

References run_program().

Here is the call graph for this function:

◆ run_program()

def test-ns3.run_program	(	program,
		args,
		python = `False`,
		cwd = `ns3_path`,
		env = `None`
	)

Runs a program with the given arguments and returns a tuple containing (error code, stdout and stderr)

Parameters

program	program to execute (or python script)
args	string containing arguments that will get split before calling the program
python	flag indicating whether the program is a python script
cwd	the working directory used that will be the root folder for the execution
env	environment variables dictionary

Returns: tuple containing (error code, stdout and stderr)

Definition at line 82 of file test-ns3.py.

Referenced by run_ns3(), test-ns3.NS3QualityControlTestCase.test_02_MemoryCheckWithSanitizers(), test-ns3.NS3BuildBaseTestCase.test_08_InstallationAndUninstallation(), test-ns3.NS3BuildBaseTestCase.test_12_CppyyBindings(), and test-ns3.NS3ConfigureTestCase.test_13_Scratches().

Here is the caller graph for this function:

Variable Documentation

◆ cmake_build_project_command

str test-ns3.cmake_build_project_command

Initial value:

=  "cmake --build {cmake_cache} -j".format(
    ns3_path=ns3_path, cmake_cache=os.path.abspath(os.path.join(ns3_path, "cmake-cache"))
)

Definition at line 46 of file test-ns3.py.

◆ cmake_build_target_command

partial test-ns3.cmake_build_target_command

Initial value:

=  partial(
    "cmake --build {cmake_cache} -j {jobs} --target {target}".format,
    jobs=num_threads,
    cmake_cache=os.path.abspath(os.path.join(ns3_path, "cmake-cache")),
)

Definition at line 49 of file test-ns3.py.

Referenced by test-ns3.NS3ExpectedUseTestCase.test_02_BuildAndRunExistingExecutableTarget(), test-ns3.NS3ExpectedUseTestCase.test_05_RunNoBuildExistingExecutableTarget(), test-ns3.NS3ConfigureTestCase.test_08_DryRun(), test-ns3.NS3BuildBaseTestCase.test_10_AmbiguityCheck(), test-ns3.NS3ExpectedUseTestCase.test_10_DoxygenWithBuild(), test-ns3.NS3ExpectedUseTestCase.test_11_DoxygenWithoutBuild(), test-ns3.NS3ExpectedUseTestCase.test_12_SphinxDocumentation(), test-ns3.NS3ExpectedUseTestCase.test_13_Documentation(), test-ns3.NS3ExpectedUseTestCase.test_14_EnableSudo(), and test-ns3.NS3ConfigureTestCase.test_16_LibrariesContainingLib().

◆ ext

str test-ns3.ext = ".exe" if win32 else ""

Definition at line 56 of file test-ns3.py.

◆ ns3_lock_filename

os test-ns3.ns3_lock_filename = os.path.join(ns3_path, ".lock-ns3_%s_build" % sys.platform)

Definition at line 35 of file test-ns3.py.

◆ ns3_path

os test-ns3.ns3_path = os.path.dirname(os.path.abspath(os.sep.join([__file__, "../../"])))

Definition at line 34 of file test-ns3.py.

◆ ns3_script

os test-ns3.ns3_script = os.sep.join([ns3_path, "ns3"])

Definition at line 36 of file test-ns3.py.

◆ ns3rc_script

os test-ns3.ns3rc_script = os.sep.join([ns3_path, ".ns3rc"])

Definition at line 37 of file test-ns3.py.

◆ num_threads

max test-ns3.num_threads = max(1, os.cpu_count() - 1)

Definition at line 45 of file test-ns3.py.

◆ platform_makefiles

str test-ns3.platform_makefiles = "MinGW Makefiles" if win32 else "Unix Makefiles"

Definition at line 55 of file test-ns3.py.

◆ usual_lib_outdir

os test-ns3.usual_lib_outdir = os.sep.join([usual_outdir, "lib"])

Definition at line 39 of file test-ns3.py.

◆ usual_outdir

os test-ns3.usual_outdir = os.sep.join([ns3_path, "build"])

Definition at line 38 of file test-ns3.py.

◆ win32

sys test-ns3.win32 = "win32"

Definition at line 54 of file test-ns3.py.

Classes

Functions

Variables

Function Documentation

◆ get_enabled_modules()

◆ get_headers_list()

◆ get_libraries_list()

◆ get_programs_list()

◆ get_test_enabled()

◆ read_lock_entry()

◆ run_ns3()

◆ run_program()

Variable Documentation

◆ cmake_build_project_command

◆ cmake_build_target_command

◆ ext

◆ ns3_lock_filename

◆ ns3_path

◆ ns3_script

◆ ns3rc_script

◆ num_threads

◆ platform_makefiles

◆ usual_lib_outdir

◆ usual_outdir

◆ win32