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

Test ns3 configuration options. More...

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

Public Member Functions

def setUp (self)
 Reuse cleaning/release configuration from NS3BaseTestCase if flag is cleaned. More...
 
def test_01_Examples (self)
 Test enabling and disabling examples. More...
 
def test_02_Tests (self)
 Test enabling and disabling tests. More...
 
def test_03_EnableModules (self)
 Test enabling specific modules. More...
 
def test_04_DisableModules (self)
 Test disabling specific modules. More...
 
def test_05_EnableModulesComma (self)
 Test enabling comma-separated (waf-style) examples. More...
 
def test_06_DisableModulesComma (self)
 Test disabling comma-separated (waf-style) examples. More...
 
def test_07_Ns3rc (self)
 Test loading settings from the ns3rc config file. More...
 
def test_08_DryRun (self)
 Test dry-run (printing commands to be executed instead of running them) More...
 
def test_09_PropagationOfReturnCode (self)
 Test if ns3 is propagating back the return code from the executables called with the run command. More...
 
def test_10_CheckConfig (self)
 Test passing 'show config' argument to ns3 to get the configuration table. More...
 
def test_11_CheckProfile (self)
 Test passing 'show profile' argument to ns3 to get the build profile. More...
 
def test_12_CheckVersion (self)
 Test passing 'show version' argument to ns3 to get the build version. More...
 
def test_13_Scratches (self)
 Test if CMake target names for scratches and ns3 shortcuts are working correctly. More...
 
def test_14_MpiCommandTemplate (self)
 Test if ns3 is inserting additional arguments by MPICH and OpenMPI to run on the CI. More...
 
def test_15_InvalidLibrariesToLink (self)
 Test if CMake and ns3 fail in the expected ways when: More...
 
def test_16_LibrariesContainingLib (self)
 Test if CMake can properly handle modules containing "lib", which is used internally as a prefix for module libraries. More...
 
def test_17_CMakePerformanceTracing (self)
 Test if CMake performance tracing works and produces the cmake_performance_trace.log file. 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...
 

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...
 

Additional Inherited Members

- 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...
 

Detailed Description

Test ns3 configuration options.

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

Member Function Documentation

◆ setUp()

def test-ns3.NS3ConfigureTestCase.setUp (   self)

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

Returns
None

Reimplemented from test-ns3.NS3BaseTestCase.

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

References test-ns3.NS3ConfigureTestCase.setUp().

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

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

◆ test_01_Examples()

def test-ns3.NS3ConfigureTestCase.test_01_Examples (   self)

◆ test_02_Tests()

def test-ns3.NS3ConfigureTestCase.test_02_Tests (   self)

Test enabling and disabling tests.

Returns
None

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

References test-ns3.NS3BaseTestCase.config_ok(), and test-ns3.run_ns3().

+ Here is the call graph for this function:

◆ test_03_EnableModules()

def test-ns3.NS3ConfigureTestCase.test_03_EnableModules (   self)

Test enabling specific modules.

Returns
None

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

References test-ns3.NS3BaseTestCase.config_ok(), test-ns3.get_enabled_modules(), test-ns3.NS3BaseTestCase.ns3_modules, test-ns3.NS3ExpectedUseTestCase.ns3_modules, and test-ns3.run_ns3().

+ Here is the call graph for this function:

◆ test_04_DisableModules()

def test-ns3.NS3ConfigureTestCase.test_04_DisableModules (   self)

Test disabling specific modules.

Returns
None

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

References test-ns3.NS3BaseTestCase.config_ok(), test-ns3.get_enabled_modules(), test-ns3.NS3BaseTestCase.ns3_modules, test-ns3.NS3ExpectedUseTestCase.ns3_modules, and test-ns3.run_ns3().

+ Here is the call graph for this function:

◆ test_05_EnableModulesComma()

def test-ns3.NS3ConfigureTestCase.test_05_EnableModulesComma (   self)

Test enabling comma-separated (waf-style) examples.

Returns
None

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

References test-ns3.NS3BaseTestCase.config_ok(), test-ns3.get_enabled_modules(), test-ns3.NS3BaseTestCase.ns3_modules, test-ns3.NS3ExpectedUseTestCase.ns3_modules, and test-ns3.run_ns3().

+ Here is the call graph for this function:

◆ test_06_DisableModulesComma()

def test-ns3.NS3ConfigureTestCase.test_06_DisableModulesComma (   self)

Test disabling comma-separated (waf-style) examples.

Returns
None

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

References test-ns3.NS3BaseTestCase.config_ok(), test-ns3.get_enabled_modules(), test-ns3.NS3BaseTestCase.ns3_modules, test-ns3.NS3ExpectedUseTestCase.ns3_modules, and test-ns3.run_ns3().

+ Here is the call graph for this function:

◆ test_07_Ns3rc()

◆ test_08_DryRun()

def test-ns3.NS3ConfigureTestCase.test_08_DryRun (   self)

Test dry-run (printing commands to be executed instead of running them)

Returns
None

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

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

+ Here is the call graph for this function:

◆ test_09_PropagationOfReturnCode()

def test-ns3.NS3ConfigureTestCase.test_09_PropagationOfReturnCode (   self)

Test if ns3 is propagating back the return code from the executables called with the run command.

Returns
None

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

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

+ Here is the call graph for this function:

◆ test_10_CheckConfig()

def test-ns3.NS3ConfigureTestCase.test_10_CheckConfig (   self)

Test passing 'show config' argument to ns3 to get the configuration table.

Returns
None

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

References test-ns3.run_ns3().

+ Here is the call graph for this function:

◆ test_11_CheckProfile()

def test-ns3.NS3ConfigureTestCase.test_11_CheckProfile (   self)

Test passing 'show profile' argument to ns3 to get the build profile.

Returns
None

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

References test-ns3.run_ns3().

+ Here is the call graph for this function:

◆ test_12_CheckVersion()

def test-ns3.NS3ConfigureTestCase.test_12_CheckVersion (   self)

Test passing 'show version' argument to ns3 to get the build version.

Returns
None

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

References test-ns3.run_ns3().

+ Here is the call graph for this function:

◆ test_13_Scratches()

def test-ns3.NS3ConfigureTestCase.test_13_Scratches (   self)

Test if CMake target names for scratches and ns3 shortcuts are working correctly.

Returns
None

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

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

+ Here is the call graph for this function:

◆ test_14_MpiCommandTemplate()

def test-ns3.NS3ConfigureTestCase.test_14_MpiCommandTemplate (   self)

Test if ns3 is inserting additional arguments by MPICH and OpenMPI to run on the CI.

Returns
None

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

References list, test-ns3.NS3BaseTestCase.ns3_executables, test-ns3.NS3BuildBaseTestCase.ns3_executables, test-ns3.NS3ExpectedUseTestCase.ns3_executables, and test-ns3.run_ns3().

+ Here is the call graph for this function:

◆ test_15_InvalidLibrariesToLink()

def test-ns3.NS3ConfigureTestCase.test_15_InvalidLibrariesToLink (   self)

Test if CMake and ns3 fail in the expected ways when:

  • examples from modules or general examples fail if they depend on a library with a name shorter than 4 characters or are disabled when a library is non-existant
  • a module library passes the configuration but fails to build due to a missing library
    Returns
    None

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

References test-ns3.run_ns3().

+ Here is the call graph for this function:

◆ test_16_LibrariesContainingLib()

def test-ns3.NS3ConfigureTestCase.test_16_LibrariesContainingLib (   self)

Test if CMake can properly handle modules containing "lib", which is used internally as a prefix for module libraries.

Returns
None

Definition at line 1096 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_17_CMakePerformanceTracing()

def test-ns3.NS3ConfigureTestCase.test_17_CMakePerformanceTracing (   self)

Test if CMake performance tracing works and produces the cmake_performance_trace.log file.

Returns
None

Definition at line 1138 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.NS3ConfigureTestCase.cleaned_once = False
static

when cleaned_once is False, clean up build artifacts and reconfigure

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


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