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

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

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

Public Member Functions

def setUp (self)
 Reuse cleaning/release configuration from NS3BaseTestCase if flag is cleaned Here examples, tests and documentation are also enabled. More...
 
def test_01_BuildProject (self)
 Try to build the project. More...
 
def test_02_BuildAndRunExistingExecutableTarget (self)
 Try to build and run test-runner. More...
 
def test_03_BuildAndRunExistingLibraryTarget (self)
 Try to build and run a library. More...
 
def test_04_BuildAndRunNonExistingTarget (self)
 Try to build and run an unknown target. More...
 
def test_05_RunNoBuildExistingExecutableTarget (self)
 Try to run test-runner without building. More...
 
def test_06_RunNoBuildExistingLibraryTarget (self)
 Test ns3 fails to run a library. More...
 
def test_07_RunNoBuildNonExistingExecutableTarget (self)
 Test ns3 fails to run an unknown program. More...
 
def test_08_RunNoBuildGdb (self)
 Test if scratch simulator is executed through gdb and lldb. More...
 
def test_09_RunNoBuildValgrind (self)
 Test if scratch simulator is executed through valgrind. More...
 
def test_10_DoxygenWithBuild (self)
 Test the doxygen target that does trigger a full build. More...
 
def test_11_DoxygenWithoutBuild (self)
 Test the doxygen target that doesn't trigger a full build. More...
 
def test_12_SphinxDocumentation (self)
 Test every individual target for Sphinx-based documentation. More...
 
def test_13_Documentation (self)
 Test the documentation target that builds both doxygen and sphinx based documentation. More...
 
def test_14_EnableSudo (self)
 Try to set ownership of scratch-simulator from current user to root, and change execution permissions. More...
 
def test_15_CommandTemplate (self)
 Check if command template is working. More...
 
def test_16_ForwardArgumentsToRunTargets (self)
 Check if all flavors of different argument passing to executable targets are working. More...
 
def test_17_RunNoBuildLldb (self)
 Test if scratch simulator is executed through lldb. 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_modules
 ns3_modules holds a list to the modules enabled stored in .lock-ns3 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 usage in more realistic scenarios.

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

Member Function Documentation

◆ setUp()

def test-ns3.NS3ExpectedUseTestCase.setUp (   self)

Reuse cleaning/release configuration from NS3BaseTestCase if flag is cleaned Here examples, tests and documentation are also enabled.

Returns
None

Reimplemented from test-ns3.NS3BaseTestCase.

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

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

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

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

◆ test_01_BuildProject()

def test-ns3.NS3ExpectedUseTestCase.test_01_BuildProject (   self)

Try to build the project.

Returns
None

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

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

+ Here is the call graph for this function:

◆ test_02_BuildAndRunExistingExecutableTarget()

def test-ns3.NS3ExpectedUseTestCase.test_02_BuildAndRunExistingExecutableTarget (   self)

Try to build and run test-runner.

Returns
None

Definition at line 1754 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_03_BuildAndRunExistingLibraryTarget()

def test-ns3.NS3ExpectedUseTestCase.test_03_BuildAndRunExistingLibraryTarget (   self)

Try to build and run a library.

Returns
None

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

References test-ns3.run_ns3().

+ Here is the call graph for this function:

◆ test_04_BuildAndRunNonExistingTarget()

def test-ns3.NS3ExpectedUseTestCase.test_04_BuildAndRunNonExistingTarget (   self)

Try to build and run an unknown target.

Returns
None

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

References test-ns3.run_ns3().

+ Here is the call graph for this function:

◆ test_05_RunNoBuildExistingExecutableTarget()

def test-ns3.NS3ExpectedUseTestCase.test_05_RunNoBuildExistingExecutableTarget (   self)

Try to run test-runner without building.

Returns
None

Definition at line 1782 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_06_RunNoBuildExistingLibraryTarget()

def test-ns3.NS3ExpectedUseTestCase.test_06_RunNoBuildExistingLibraryTarget (   self)

Test ns3 fails to run a library.

Returns
None

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

References test-ns3.run_ns3().

+ Here is the call graph for this function:

◆ test_07_RunNoBuildNonExistingExecutableTarget()

def test-ns3.NS3ExpectedUseTestCase.test_07_RunNoBuildNonExistingExecutableTarget (   self)

Test ns3 fails to run an unknown program.

Returns
None

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

References test-ns3.run_ns3().

+ Here is the call graph for this function:

◆ test_08_RunNoBuildGdb()

def test-ns3.NS3ExpectedUseTestCase.test_08_RunNoBuildGdb (   self)

Test if scratch simulator is executed through gdb and lldb.

Returns
None

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

References test-ns3.run_ns3().

+ Here is the call graph for this function:

◆ test_09_RunNoBuildValgrind()

def test-ns3.NS3ExpectedUseTestCase.test_09_RunNoBuildValgrind (   self)

Test if scratch simulator is executed through valgrind.

Returns
None

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

References test-ns3.run_ns3().

+ Here is the call graph for this function:

◆ test_10_DoxygenWithBuild()

def test-ns3.NS3ExpectedUseTestCase.test_10_DoxygenWithBuild (   self)

Test the doxygen target that does trigger a full build.

Returns
None

Definition at line 1836 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_11_DoxygenWithoutBuild()

def test-ns3.NS3ExpectedUseTestCase.test_11_DoxygenWithoutBuild (   self)

Test the doxygen target that doesn't trigger a full build.

Returns
None

Definition at line 1862 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_SphinxDocumentation()

def test-ns3.NS3ExpectedUseTestCase.test_12_SphinxDocumentation (   self)

Test every individual target for Sphinx-based documentation.

Returns
None

Definition at line 1881 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_13_Documentation()

def test-ns3.NS3ExpectedUseTestCase.test_13_Documentation (   self)

Test the documentation target that builds both doxygen and sphinx based documentation.

Returns
None

Definition at line 1915 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_14_EnableSudo()

def test-ns3.NS3ExpectedUseTestCase.test_14_EnableSudo (   self)

Try to set ownership of scratch-simulator from current user to root, and change execution permissions.

Returns
None

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

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

+ Here is the call graph for this function:

◆ test_15_CommandTemplate()

def test-ns3.NS3ExpectedUseTestCase.test_15_CommandTemplate (   self)

Check if command template is working.

Returns
None

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

References test-ns3.run_ns3().

+ Here is the call graph for this function:

◆ test_16_ForwardArgumentsToRunTargets()

def test-ns3.NS3ExpectedUseTestCase.test_16_ForwardArgumentsToRunTargets (   self)

Check if all flavors of different argument passing to executable targets are working.

Returns
None

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

References test-ns3.run_ns3().

+ Here is the call graph for this function:

◆ test_17_RunNoBuildLldb()

def test-ns3.NS3ExpectedUseTestCase.test_17_RunNoBuildLldb (   self)

Test if scratch simulator is executed through lldb.

Returns
None

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

when cleaned_once is False, clean up build artifacts and reconfigure

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

◆ ns3_executables

◆ ns3_modules


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