3 \page UnitTests Source code structuration and Unit Tests
5 <b>WORK in PROGRESS, INCOMPLETE DOCUMENT</b>
7 You will find here general information on code directories structure,
8 unit tests associated to the different kind of classes, and how to run
11 \section S1_unit SALOME KERNEL source code structuration
13 \subsection sub11 General structure of KERNEL_SRC
16 Some README files and configuration tools for build
18 - KERNEL_SRC/adm_local :\n
19 Part of the configuration files, other modules have a directory with the
20 same name. Not used in KERNEL.
23 Python and shell scripts used at run time.
24 Kit to install a %SALOME Application.
27 Kit for KERNEL end user documentation production:
28 public interfaces, Python, CORBA.
29 Integrator and Developper documentation.
32 All CORBA interfaces from KERNEL are regrouped here.
34 - KERNEL_SRC/resources :\n
35 Configuration files for servers (examples).
36 Interfaces definitions for KERNEL test components.
38 - KERNEL_SRC/salome_adm :\n
39 Configuration files used by autotools (M4 macros & co.)
42 The source code (C++ and Python)
44 \subsection sub12 Directory src: C++ and Python source code
48 <b>Basic services non related to CORBA</b>
51 %A set of general purpose C++ services, not related to CORBA.
52 Some general purpose services that are in Utils directory (CORBA related),
53 are progressivley moved here, as they are not related to CORBA.
57 %A multithread trace system that allows message tracing on standard error
61 Exceptions and signal handler.
64 %A C++ interface to HDF.
69 <b>Basic CORBA services</b>
72 %A CORBA %server that collects the trace messages from differents CORBA
75 - SALOMETraceCollector :\n
76 %A multithread trace system derived from SALOMELocalTrace, that sends messages
77 to Logger %server via CORBA.
80 %A set of general purpose services related to CORBA, such as basic CORBA
81 exception system. See also Basics directory above.
84 C++ and Python interfaces to name, store and retrieve CORBA objects
87 %A generic CORBA interface for CORBA objects, to count distributed references,
88 and to allow destruction by client.
92 <b>Miscellaneous CORBA servers</b>
95 Implements SALOME_registry.idl.
96 Provides a CORBA %server library and a separate %server program.
99 Implements SALOME_moduleCatalog.idl.
100 Provide a CORBA %server library and separate %server and client programs.
102 - ModuleGenerator :\n
103 Tool to generate a module catalog from CORBA idl
105 - ResourcesManager :\n
106 library included in container %server
109 library included in differents servers (container)
116 <b>CORBA Containers for %SALOME Modules</b>
124 - LifeCycleCORBA_SWIG
129 <b>STUDY %server and related interfaces and tools</b>
141 <b>Python interface to %SALOME</b>
147 <b>Efficient CORBA transfer services</b>
155 <b>%A Parallel container with MPI</b>
163 <b>Batch interface library</b>
180 \section S2_unit Tools and principles used for Unit testing
182 <b>TO BE COMPLETED</b>
184 Unit Testing rely on cppunit package for C++ testing, and on unittest module
185 for Python. See these products for general principles of unit testing.
187 The cppunit package is optional. When the prerequisite is detected, the unit
190 Unit Tests sources are in directories Test under the src/directories
191 containing the classes to test.
193 Test are ordered following the order of directories given above.
195 Tests can be run as a whole, or for a particular directory. In this case, only
196 a partial test is run (the classes to test, and the classes used, i.e. the
197 preceding test directories).
200 Today, only some tests are written as an example. There are not yet python
201 scripts in KERNEL_SRC, but it's a matter of days, there are working scripts
202 to test LifeCycleCORBA_SWIG interface.