1 =================================================================
2 Source code structuration and Unit Tests
3 =================================================================
5 *html version of this document is produced with docutils*::
7 rst2html < doc.txt > doc.html
9 *This document corresponds to SALOME2 3.2.0*
14 +-------------------------------------------+
15 | **WORK in PROGRESS, INCOMPLETE DOCUMENT** |
16 +-------------------------------------------+
18 -------------------------------------------------------------------------------
20 You will find here general information on code directories structure,
21 unit tests associated to the different kind of classes, and how to run
24 SALOME KERNEL source code structuration
25 =======================================
27 General structure of KERNEL_SRC
28 -------------------------------
31 Some README files and configuration tools for build
34 Python and shell scripts used at run time.
35 Kit to install a SALOME Application.
38 Kit for KERNEL end user documentation production:
39 public interfaces, Python, CORBA.
40 Integrator and Developper documentation.
43 All CORBA interfaces from KERNEL are regrouped here.
46 Configuration files for servers (examples).
47 Interfaces definitions for KERNEL test components.
50 Configuration files used by autotools (M4 macros & co.)
53 The source code (C++ and Python)
56 Directory src: C++ and Python source code
57 -----------------------------------------
59 Basic services non related to CORBA
60 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
63 A set of general purpose C++ services, not related to CORBA.
64 Some general purpose services that are in Utils directory (CORBA related),
65 are progressivley moved here, as they are not related to CORBA.
69 A multithread trace system that allows message tracing on standard error
73 Exceptions and signal handler.
76 A C++ interface to HDF.
82 A CORBA server that collects the trace messages from differents CORBA
86 A multithread trace system derived from SALOMELocalTrace, that sends messages
87 to Logger server via CORBA.
90 A set of general purpose services related to CORBA, such as basic CORBA
91 exception system. See also Basics directory above.
94 C++ and Python interfaces to name, store and retrieve CORBA objects
97 A generic CORBA interface for CORBA objects, to count distributed references,
98 and to allow destruction by client.
100 Miscellaneous CORBA servers
101 ~~~~~~~~~~~~~~~~~~~~~~~~~~~
104 Implements SALOME_registry.idl.
105 Provides a CORBA server library and a separate server program.
108 Implements SALOME_moduleCatalog.idl.
109 Provide a CORBA server library and separate server and client programs.
112 Tool to generate a module catalog from CORBA idl
115 library included in container server
118 library included in differents servers (container)
123 CORBA Containers for SALOME Modules
124 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
134 STUDY server and related interfaces and tools
135 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
145 Python interface to SALOME
146 ~~~~~~~~~~~~~~~~~~~~~~~~~~
150 Efficient CORBA transfer services
151 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
157 A Parallel container with MPI
158 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
164 Batch interface library
165 ~~~~~~~~~~~~~~~~~~~~~~~
177 Tools and principles used for Unit testing
178 ==========================================
182 Unit Testing rely on cppunit package for C++ testing, and on unittest module
183 for Python. See these products for general principles of unit testing.
185 The cppunit package is optional. When the prerequisite is detected, the unit
188 Unit Tests sources are in directories Test under the src/directories
189 containing the classes to test.
191 Test are ordered following the order of directories given above.
193 Tests can be run as a whole, or for a particular directory. In this case, only
194 a partial test is run (the classes to test, and the classes used, i.e. the
195 preceding test directories).
198 Today, only some tests are written as an example. There are not yet python
199 scripts in KERNEL_SRC, but it's a matter of days, there are working scripts
200 to test LifeCycleCORBA_SWIG interface.
206 -------------------------------------------------------------------------------
208 +----------------------------------+------------------------------------------+
209 | `General KERNEL documentation`_ | `End User KERNEL Doxygen documentation`_ |
210 +----------------------------------+------------------------------------------+
212 .. _`General KERNEL documentation`: ./index.html
213 .. _`End User KERNEL Doxygen documentation`: ./tui/KERNEL/index.html