xref: /trunk/main/ure/source/uretest/README (revision 78ecfec3)
1*e76eebc6SAndrew Rist#**************************************************************
2*e76eebc6SAndrew Rist#
3*e76eebc6SAndrew Rist#  Licensed to the Apache Software Foundation (ASF) under one
4*e76eebc6SAndrew Rist#  or more contributor license agreements.  See the NOTICE file
5*e76eebc6SAndrew Rist#  distributed with this work for additional information
6*e76eebc6SAndrew Rist#  regarding copyright ownership.  The ASF licenses this file
7*e76eebc6SAndrew Rist#  to you under the Apache License, Version 2.0 (the
8*e76eebc6SAndrew Rist#  "License"); you may not use this file except in compliance
9*e76eebc6SAndrew Rist#  with the License.  You may obtain a copy of the License at
10*e76eebc6SAndrew Rist#
11*e76eebc6SAndrew Rist#    http://www.apache.org/licenses/LICENSE-2.0
12*e76eebc6SAndrew Rist#
13*e76eebc6SAndrew Rist#  Unless required by applicable law or agreed to in writing,
14*e76eebc6SAndrew Rist#  software distributed under the License is distributed on an
15*e76eebc6SAndrew Rist#  "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16*e76eebc6SAndrew Rist#  KIND, either express or implied.  See the License for the
17*e76eebc6SAndrew Rist#  specific language governing permissions and limitations
18*e76eebc6SAndrew Rist#  under the License.
19*e76eebc6SAndrew Rist#
20*e76eebc6SAndrew Rist#**************************************************************
21cdf0e10cSrcweir
22cdf0e10cSrcweir
23cdf0e10cSrcweirThis directory contains test files for the UNO Runtime Environment (URE) as well
24cdf0e10cSrcweiras the Makefile and Makefile.pln makefiles.  To execute the makefiles, you need
25cdf0e10cSrcweirGNU make 3.80 or later.
26cdf0e10cSrcweir
27cdf0e10cSrcweir
28cdf0e10cSrcweirMakefile
29cdf0e10cSrcweir--------
30cdf0e10cSrcweir
31cdf0e10cSrcweirBefore you execute Makefile, you need to configure the Software Development Kit
32cdf0e10cSrcweir(SDK) environment to work with a URE installation, a C++ compiler, and a JDK.
33cdf0e10cSrcweirFor more information, read the .../docs/install.html file in the SDK
34cdf0e10cSrcweirinstallation.
35cdf0e10cSrcweir
36cdf0e10cSrcweirMakefile.pln
37cdf0e10cSrcweir------------
38cdf0e10cSrcweir
39cdf0e10cSrcweirYou can only run Makefile.pln on Linux x86.  You do not need to configure your
40cdf0e10cSrcweirSDK environment to use this makefile, however, you do need to set the following
41cdf0e10cSrcweirenvironment variables:
42cdf0e10cSrcweir
43cdf0e10cSrcweir- SDK_HOME
44cdf0e10cSrcweirPoints to the base directory of an OpenOffice.org SDK so that you can access UNO
45cdf0e10cSrcweirprogramming tools and files that are not part of the URE.  For example, idlc,
46cdf0e10cSrcweircppumaker, javamaker, UNOIDL files, and C++ headers.
47cdf0e10cSrcweir
48cdf0e10cSrcweir- PATH
49cdf0e10cSrcweirPoints to a GCC installation (including g++) as well as a JDK installation that
50cdf0e10cSrcweircontains the java, javac, and jar executables.  For the minimum version
51cdf0e10cSrcweirrequirements, see the SDK Installation Guide ($SDK_HOME/docs/install.html).
52cdf0e10cSrcweir
53cdf0e10cSrcweir- URE_HOME (optional)
54cdf0e10cSrcweirOverwrites the default URE location, that is, /opt/openoffice.org/ure.
55cdf0e10cSrcweir
56cdf0e10cSrcweirTests
57cdf0e10cSrcweir-----
58cdf0e10cSrcweir
59cdf0e10cSrcweirMakefile and Makefile.pln can execute the following tests:
60cdf0e10cSrcweir
61cdf0e10cSrcweir- test-cpptest
62cdf0e10cSrcweirBuilds a C++ UNO component, cppmain.uno, and runs the component with the uno
63cdf0e10cSrcweirexecutable.  The component first attempts to instantiate all the UNO services
64cdf0e10cSrcweirand singletons that are part of the URE installation.  The component then tries
65cdf0e10cSrcweirto instantiate and to call another C++ UNO component (ccptest.uno) as well as a
66cdf0e10cSrcweirJava UNO component (javatest.uno).  The test completes when these components
67cdf0e10cSrcweirthrow a special exception that is caught by cppmain.uno.
68cdf0e10cSrcweir
69cdf0e10cSrcweir- test-javatest
70cdf0e10cSrcweirBuilds a Java UNO component, javamain.uno, and runs the component with the uno
71cdf0e10cSrcweirexecutable.  The component tries to instantiate and to call a C++ UNO component
72cdf0e10cSrcweir(cpptest.uno) as well as a Java UNO component (javatest.uno).  The test
73cdf0e10cSrcweircompletes when these components throw a special exception that is caught by
74cdf0e10cSrcweirjavamain.uno.
75cdf0e10cSrcweir
76cdf0e10cSrcweir- test-javanative
77cdf0e10cSrcweirBuilds a Java UNO application, javanative.jar, and runs the application with the
78cdf0e10cSrcweirjava executable.  The application bootstraps a native UNO environment, and then
79cdf0e10cSrcweirtries to instantiate and to call a C++ UNO component (cpptest.uno) as well as a
80cdf0e10cSrcweirJava UNO component( javatest.uno).  The test completes when these components
81cdf0e10cSrcweirthrow a special exception that is caught by javanative.jar.
82cdf0e10cSrcweir
83cdf0e10cSrcweir- test-clientserver
84cdf0e10cSrcweirBuilds a server C++ UNO component, cppserver.uno, and a Java UNO application,
85cdf0e10cSrcweirjavaclient.uno.  The uno executable runs the cppserver.uno component which
86cdf0e10cSrcweirlistens on a pipe connection.  The java executable runs the javaclient.uno
87cdf0e10cSrcweircomponent which connects to the server after a five second pause so that the
88cdf0e10cSrcweirserver has enough time to start.
89cdf0e10cSrcweir
90cdf0e10cSrcweir- test-regview (Makefile.pln only)
91cdf0e10cSrcweirChecks that the regview executable of the URE installation works reliably.
92cdf0e10cSrcweir
93cdf0e10cSrcweirNOTE: The files that are generated when Makefile and Makefile.pln execute are
94cdf0e10cSrcweirsaved to different local directories.  Makefile outputs the generated files to
95cdf0e10cSrcweir./out.sdk whereas Makefile.pln outputs the files to ./out.pln.
96