2 =================================================================
3 Source code structuration and Unit Tests
4 =================================================================
6 You will find here general information on code directories structure,
7 unit tests associated to the different kind of classes, and how to run
10 +-------------------------------------------+
11 | **WORK in PROGRESS, INCOMPLETE DOCUMENT** |
12 +-------------------------------------------+
18 SALOME KERNEL source code structuration
19 =======================================
21 General structure of KERNEL_SRC
22 -------------------------------
25 Some README files and configuration tools for build
28 Part of the configuration files, other modules have a directory with the
29 same name. Not used in KERNEL.
32 Python and shell scripts used at run time.
33 Kit to install a SALOME Application.
36 Kit for KERNEL end user documentation production:
37 public interfaces, Python, CORBA.
38 Integrator and Developper documentation.
41 All CORBA interfaces from KERNEL are regrouped here.
44 Configuration files for servers (examples).
45 Interfaces definitions for KERNEL test components.
48 Configuration files used by autotools (M4 macros & co.)
51 The source code (C++ and Python)
54 Directory src: C++ and Python source code
55 -----------------------------------------
57 Basic services non related to CORBA
58 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
61 A set of general purpose C++ services, not related to CORBA.
62 Some general purpose services that are in Utils directory (CORBA related),
63 are progressivley moved here, as they are not related to CORBA.
67 A multithread trace system that allows message tracing on standard error
71 Exceptions and signal handler.
74 A C++ interface to HDF.
80 A CORBA server that collects the trace messages from differents CORBA
84 A multithread trace system derived from SALOMELocalTrace, that sends messages
85 to Logger server via CORBA.
88 A set of general purpose services related to CORBA, such as basic CORBA
89 exception system. See also Basics directory above.
92 C++ and Python interfaces to name, store and retrieve CORBA objects
95 A generic CORBA interface for CORBA objects, to count distributed references,
96 and to allow destruction by client.
98 Miscellaneous CORBA servers
99 ~~~~~~~~~~~~~~~~~~~~~~~~~~~
102 Implements SALOME_registry.idl.
103 Provides a CORBA server library and a separate server program.
106 Implements SALOME_moduleCatalog.idl.
107 Provide a CORBA server library and separate server and client programs.
110 Tool to generate a module catalog from CORBA idl
113 library included in container server
116 library included in differents servers (container)
121 CORBA Containers for SALOME Modules
122 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
132 STUDY server and related interfaces and tools
133 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
143 Python interface to SALOME
144 ~~~~~~~~~~~~~~~~~~~~~~~~~~
148 Efficient CORBA transfer services
149 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
155 A Parallel container with MPI
156 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
162 Batch interface library
163 ~~~~~~~~~~~~~~~~~~~~~~~
175 Tools and principles used for Unit testing
176 ==========================================
180 Unit Testing rely on cppunit package for C++ testing, and on unittest module
181 for Python. See these products for general principles of unit testing.
183 The cppunit package is optional. When the prerequisite is detected, the unit
186 Unit Tests sources are in directories Test under the src/directories
187 containing the classes to test.
189 Test are ordered following the order of directories given above.
191 Tests can be run as a whole, or for a particular directory. In this case, only
192 a partial test is run (the classes to test, and the classes used, i.e. the
193 preceding test directories).
196 Today, only some tests are written as an example. There are not yet python
197 scripts in KERNEL_SRC, but it's a matter of days, there are working scripts
198 to test LifeCycleCORBA_SWIG interface.