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