xref: /aoo42x/main/ure/source/uretest/README (revision e76eebc6)
1#**************************************************************
2#
3#  Licensed to the Apache Software Foundation (ASF) under one
4#  or more contributor license agreements.  See the NOTICE file
5#  distributed with this work for additional information
6#  regarding copyright ownership.  The ASF licenses this file
7#  to you under the Apache License, Version 2.0 (the
8#  "License"); you may not use this file except in compliance
9#  with the License.  You may obtain a copy of the License at
10#
11#    http://www.apache.org/licenses/LICENSE-2.0
12#
13#  Unless required by applicable law or agreed to in writing,
14#  software distributed under the License is distributed on an
15#  "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16#  KIND, either express or implied.  See the License for the
17#  specific language governing permissions and limitations
18#  under the License.
19#
20#**************************************************************
21
22
23This directory contains test files for the UNO Runtime Environment (URE) as well
24as the Makefile and Makefile.pln makefiles.  To execute the makefiles, you need
25GNU make 3.80 or later.
26
27
28Makefile
29--------
30
31Before you execute Makefile, you need to configure the Software Development Kit
32(SDK) environment to work with a URE installation, a C++ compiler, and a JDK.
33For more information, read the .../docs/install.html file in the SDK
34installation.
35
36NOTE: On Linux x86, if the Makefile accesses a GCC that is incompatible with the
37GCC that was used to build the URE, use the GCCS_COMPAT environment variable as
38a workaround.  For more details, see the UDK README file.
39
40
41Makefile.pln
42------------
43
44You can only run Makefile.pln on Linux x86.  You do not need to configure your
45SDK environment to use this makefile, however, you do need to set the following
46environment variables:
47
48- SDK_HOME
49Points to the base directory of an OpenOffice.org SDK so that you can access UNO
50programming tools and files that are not part of the URE.  For example, idlc,
51cppumaker, javamaker, UNOIDL files, and C++ headers.
52
53- PATH
54Points to a GCC installation (including g++) as well as a JDK installation that
55contains the java, javac, and jar executables.  For the minimum version
56requirements, see the SDK Installation Guide ($SDK_HOME/docs/install.html).
57
58- URE_HOME (optional)
59Overwrites the default URE location, that is, /opt/openoffice.org/ure.
60
61- GXX_INCLUDE_PATH (optional)
62Overwrites the default location of the GCC C++ headers (/usr/include/g++).  This
63information is needed by the STLport included in the URE.
64
65- GCCS_COMPAT (optional)
66Fixes incompatibility issues between the GCC that was used to build the URE and
67the GCC that Makefile.pln accesses.  For more details, see the UDK README file.
68
69
70Tests
71-----
72
73Makefile and Makefile.pln can execute the following tests:
74
75- test-cpptest
76Builds a C++ UNO component, cppmain.uno, and runs the component with the uno
77executable.  The component first attempts to instantiate all the UNO services
78and singletons that are part of the URE installation.  The component then tries
79to instantiate and to call another C++ UNO component (ccptest.uno) as well as a
80Java UNO component (javatest.uno).  The test completes when these components
81throw a special exception that is caught by cppmain.uno.
82
83- test-javatest
84Builds a Java UNO component, javamain.uno, and runs the component with the uno
85executable.  The component tries to instantiate and to call a C++ UNO component
86(cpptest.uno) as well as a Java UNO component (javatest.uno).  The test
87completes when these components throw a special exception that is caught by
88javamain.uno.
89
90- test-javanative
91Builds a Java UNO application, javanative.jar, and runs the application with the
92java executable.  The application bootstraps a native UNO environment, and then
93tries to instantiate and to call a C++ UNO component (cpptest.uno) as well as a
94Java UNO component( javatest.uno).  The test completes when these components
95throw a special exception that is caught by javanative.jar.
96
97- test-clientserver
98Builds a server C++ UNO component, cppserver.uno, and a Java UNO application,
99javaclient.uno.  The uno executable runs the cppserver.uno component which
100listens on a pipe connection.  The java executable runs the javaclient.uno
101component which connects to the server after a five second pause so that the
102server has enough time to start.
103
104- test-regview (Makefile.pln only)
105Checks that the regview executable of the URE installation works reliably.
106
107NOTE: The files that are generated when Makefile and Makefile.pln execute are
108saved to different local directories.  Makefile outputs the generated files to
109./out.sdk whereas Makefile.pln outputs the files to ./out.pln.
110