xref: /trunk/main/ure/source/uretest/README (revision 78ecfec3)
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 
23 This directory contains test files for the UNO Runtime Environment (URE) as well
24 as the Makefile and Makefile.pln makefiles.  To execute the makefiles, you need
25 GNU make 3.80 or later.
26 
27 
28 Makefile
29 --------
30 
31 Before 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.
33 For more information, read the .../docs/install.html file in the SDK
34 installation.
35 
36 Makefile.pln
37 ------------
38 
39 You can only run Makefile.pln on Linux x86.  You do not need to configure your
40 SDK environment to use this makefile, however, you do need to set the following
41 environment variables:
42 
43 - SDK_HOME
44 Points to the base directory of an OpenOffice.org SDK so that you can access UNO
45 programming tools and files that are not part of the URE.  For example, idlc,
46 cppumaker, javamaker, UNOIDL files, and C++ headers.
47 
48 - PATH
49 Points to a GCC installation (including g++) as well as a JDK installation that
50 contains the java, javac, and jar executables.  For the minimum version
51 requirements, see the SDK Installation Guide ($SDK_HOME/docs/install.html).
52 
53 - URE_HOME (optional)
54 Overwrites the default URE location, that is, /opt/openoffice.org/ure.
55 
56 Tests
57 -----
58 
59 Makefile and Makefile.pln can execute the following tests:
60 
61 - test-cpptest
62 Builds a C++ UNO component, cppmain.uno, and runs the component with the uno
63 executable.  The component first attempts to instantiate all the UNO services
64 and singletons that are part of the URE installation.  The component then tries
65 to instantiate and to call another C++ UNO component (ccptest.uno) as well as a
66 Java UNO component (javatest.uno).  The test completes when these components
67 throw a special exception that is caught by cppmain.uno.
68 
69 - test-javatest
70 Builds a Java UNO component, javamain.uno, and runs the component with the uno
71 executable.  The component tries to instantiate and to call a C++ UNO component
72 (cpptest.uno) as well as a Java UNO component (javatest.uno).  The test
73 completes when these components throw a special exception that is caught by
74 javamain.uno.
75 
76 - test-javanative
77 Builds a Java UNO application, javanative.jar, and runs the application with the
78 java executable.  The application bootstraps a native UNO environment, and then
79 tries to instantiate and to call a C++ UNO component (cpptest.uno) as well as a
80 Java UNO component( javatest.uno).  The test completes when these components
81 throw a special exception that is caught by javanative.jar.
82 
83 - test-clientserver
84 Builds a server C++ UNO component, cppserver.uno, and a Java UNO application,
85 javaclient.uno.  The uno executable runs the cppserver.uno component which
86 listens on a pipe connection.  The java executable runs the javaclient.uno
87 component which connects to the server after a five second pause so that the
88 server has enough time to start.
89 
90 - test-regview (Makefile.pln only)
91 Checks that the regview executable of the URE installation works reliably.
92 
93 NOTE: The files that are generated when Makefile and Makefile.pln execute are
94 saved to different local directories.  Makefile outputs the generated files to
95 ./out.sdk whereas Makefile.pln outputs the files to ./out.pln.
96