A Discrete-Event Network Simulator
API
test-ns3.NS3BuildBaseTestCase Class Reference

Tests ns3 regarding building the project. More...

+ Inheritance diagram for test-ns3.NS3BuildBaseTestCase:
+ Collaboration diagram for test-ns3.NS3BuildBaseTestCase:

Public Member Functions

def setUp (self)
 Reuse cleaning/release configuration from NS3BaseTestCase if flag is cleaned. More...
 
def test_01_BuildExistingTargets (self)
 Try building the core library. More...
 
def test_02_BuildNonExistingTargets (self)
 Try building core-test library without tests enabled. More...
 
def test_03_BuildProject (self)
 Try building the project: More...
 
def test_04_BuildProjectNoTaskLines (self)
 Try hiding task lines. More...
 
def test_05_BreakBuild (self)
 Try removing an essential file to break the build. More...
 
def test_06_TestVersionFile (self)
 Test if changing the version file affects the library names. More...
 
def test_07_OutputDirectory (self)
 Try setting a different output directory and if everything is in the right place and still working correctly. More...
 
def test_08_InstallationAndUninstallation (self)
 Tries setting a ns3 version, then installing it. More...
 
def test_09_Scratches (self)
 Tries to build scratch-simulator and subdir/scratch-simulator-subdir. More...
 
def test_10_PybindgenBindings (self)
 Test if cmake is calling pybindgen through modulegen to generate the bindings source files correctly. More...
 
def test_11_AmbiguityCheck (self)
 Test if ns3 can alert correctly in case a shortcut collision happens. More...
 
def test_12_StaticBuilds (self)
 Test if we can build a static ns-3 library and link it to static programs. More...
 
- Public Member Functions inherited from test-ns3.NS3BaseTestCase
def config_ok (self, return_code, stdout)
 Check if configuration for release mode worked normally. More...
 
def setUp (self)
 Clean configuration/build artifacts before testing configuration and build settings After configuring the build as release, check if configuration worked and check expected output files. More...
 

Public Attributes

 ns3_executables
 ns3_executables holds a list of executables in .lock-ns3 More...
 
 ns3_libraries
 ns3_libraries holds a list of built module libraries More...
 
- Public Attributes inherited from test-ns3.NS3BaseTestCase
 ns3_executables
 ns3_executables holds a list of executables in .lock-ns3 More...
 
 ns3_modules
 ns3_modules holds a list to the modules enabled stored in .lock-ns3 More...
 

Static Public Attributes

bool cleaned_once = False
 when cleaned_once is False, clean up build artifacts and reconfigure More...
 
- Static Public Attributes inherited from test-ns3.NS3BaseTestCase
bool cleaned_once = False
 when cleaned_once is False, clean up build artifacts and reconfigure More...
 

Detailed Description

Tests ns3 regarding building the project.

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

Member Function Documentation

◆ setUp()

def test-ns3.NS3BuildBaseTestCase.setUp (   self)

Reuse cleaning/release configuration from NS3BaseTestCase if flag is cleaned.

Returns
None

Reimplemented from test-ns3.NS3BaseTestCase.

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

References test-ns3.NS3BuildBaseTestCase.setUp().

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

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ test_01_BuildExistingTargets()

def test-ns3.NS3BuildBaseTestCase.test_01_BuildExistingTargets (   self)

Try building the core library.

Returns
None

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

References test-ns3.run_ns3().

+ Here is the call graph for this function:

◆ test_02_BuildNonExistingTargets()

def test-ns3.NS3BuildBaseTestCase.test_02_BuildNonExistingTargets (   self)

Try building core-test library without tests enabled.

Returns
None

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

References test-ns3.run_ns3().

+ Here is the call graph for this function:

◆ test_03_BuildProject()

def test-ns3.NS3BuildBaseTestCase.test_03_BuildProject (   self)

Try building the project:

Returns
None

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

References test-ns3.get_programs_list(), and test-ns3.run_ns3().

+ Here is the call graph for this function:

◆ test_04_BuildProjectNoTaskLines()

def test-ns3.NS3BuildBaseTestCase.test_04_BuildProjectNoTaskLines (   self)

Try hiding task lines.

Returns
None

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

References test-ns3.run_ns3().

+ Here is the call graph for this function:

◆ test_05_BreakBuild()

def test-ns3.NS3BuildBaseTestCase.test_05_BreakBuild (   self)

Try removing an essential file to break the build.

Returns
None

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

References test-ns3.run_ns3().

+ Here is the call graph for this function:

◆ test_06_TestVersionFile()

def test-ns3.NS3BuildBaseTestCase.test_06_TestVersionFile (   self)

◆ test_07_OutputDirectory()

def test-ns3.NS3BuildBaseTestCase.test_07_OutputDirectory (   self)

Try setting a different output directory and if everything is in the right place and still working correctly.

Returns
None

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

References test-ns3.get_libraries_list(), test-ns3.NS3BuildBaseTestCase.ns3_libraries, and test-ns3.run_ns3().

+ Here is the call graph for this function:

◆ test_08_InstallationAndUninstallation()

def test-ns3.NS3BuildBaseTestCase.test_08_InstallationAndUninstallation (   self)

Tries setting a ns3 version, then installing it.

After that, tries searching for ns-3 with CMake's find_package(ns3). Finally, tries using core library in a 3rd-party project

Returns
None

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

References test-ns3.NS3BaseTestCase.config_ok(), test-ns3.get_headers_list(), test-ns3.get_libraries_list(), list, conf.project, test-ns3.run_ns3(), and test-ns3.run_program().

+ Here is the call graph for this function:

◆ test_09_Scratches()

def test-ns3.NS3BuildBaseTestCase.test_09_Scratches (   self)

Tries to build scratch-simulator and subdir/scratch-simulator-subdir.

Returns
None

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

References test-ns3.run_ns3().

+ Here is the call graph for this function:

◆ test_10_PybindgenBindings()

def test-ns3.NS3BuildBaseTestCase.test_10_PybindgenBindings (   self)

Test if cmake is calling pybindgen through modulegen to generate the bindings source files correctly.

Returns
None

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

References list, test-ns3.read_lock_entry(), test-ns3.run_ns3(), and test-ns3.run_program().

+ Here is the call graph for this function:

◆ test_11_AmbiguityCheck()

def test-ns3.NS3BuildBaseTestCase.test_11_AmbiguityCheck (   self)

Test if ns3 can alert correctly in case a shortcut collision happens.

Returns
None

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

References test-ns3.cmake_build_target_command, and test-ns3.run_ns3().

+ Here is the call graph for this function:

◆ test_12_StaticBuilds()

def test-ns3.NS3BuildBaseTestCase.test_12_StaticBuilds (   self)

Test if we can build a static ns-3 library and link it to static programs.

Returns
None

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

References test-ns3.run_ns3().

+ Here is the call graph for this function:

Member Data Documentation

◆ cleaned_once

bool test-ns3.NS3BuildBaseTestCase.cleaned_once = False
static

when cleaned_once is False, clean up build artifacts and reconfigure

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

◆ ns3_executables

◆ ns3_libraries

test-ns3.NS3BuildBaseTestCase.ns3_libraries

ns3_libraries holds a list of built module libraries

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

Referenced by test-ns3.NS3BuildBaseTestCase.test_06_TestVersionFile(), and test-ns3.NS3BuildBaseTestCase.test_07_OutputDirectory().


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