xref: /aoo41x/main/ure/source/uretest/README (revision cdf0e10c)
1#*************************************************************************
2#
3# DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4#
5# Copyright 2000, 2010 Oracle and/or its affiliates.
6#
7# OpenOffice.org - a multi-platform office productivity suite
8#
9# This file is part of OpenOffice.org.
10#
11# OpenOffice.org is free software: you can redistribute it and/or modify
12# it under the terms of the GNU Lesser General Public License version 3
13# only, as published by the Free Software Foundation.
14#
15# OpenOffice.org is distributed in the hope that it will be useful,
16# but WITHOUT ANY WARRANTY; without even the implied warranty of
17# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18# GNU Lesser General Public License version 3 for more details
19# (a copy is included in the LICENSE file that accompanied this code).
20#
21# You should have received a copy of the GNU Lesser General Public License
22# version 3 along with OpenOffice.org.  If not, see
23# <http://www.openoffice.org/license.html>
24# for a copy of the LGPLv3 License.
25#
26#*************************************************************************
27
28
29This directory contains test files for the UNO Runtime Environment (URE) as well
30as the Makefile and Makefile.pln makefiles.  To execute the makefiles, you need
31GNU make 3.80 or later.
32
33
34Makefile
35--------
36
37Before you execute Makefile, you need to configure the Software Development Kit
38(SDK) environment to work with a URE installation, a C++ compiler, and a JDK.
39For more information, read the .../docs/install.html file in the SDK
40installation.
41
42NOTE: On Linux x86, if the Makefile accesses a GCC that is incompatible with the
43GCC that was used to build the URE, use the GCCS_COMPAT environment variable as
44a workaround.  For more details, see the UDK README file.
45
46
47Makefile.pln
48------------
49
50You can only run Makefile.pln on Linux x86.  You do not need to configure your
51SDK environment to use this makefile, however, you do need to set the following
52environment variables:
53
54- SDK_HOME
55Points to the base directory of an OpenOffice.org SDK so that you can access UNO
56programming tools and files that are not part of the URE.  For example, idlc,
57cppumaker, javamaker, UNOIDL files, and C++ headers.
58
59- PATH
60Points to a GCC installation (including g++) as well as a JDK installation that
61contains the java, javac, and jar executables.  For the minimum version
62requirements, see the SDK Installation Guide ($SDK_HOME/docs/install.html).
63
64- URE_HOME (optional)
65Overwrites the default URE location, that is, /opt/openoffice.org/ure.
66
67- GXX_INCLUDE_PATH (optional)
68Overwrites the default location of the GCC C++ headers (/usr/include/g++).  This
69information is needed by the STLport included in the URE.
70
71- GCCS_COMPAT (optional)
72Fixes incompatibility issues between the GCC that was used to build the URE and
73the GCC that Makefile.pln accesses.  For more details, see the UDK README file.
74
75
76Tests
77-----
78
79Makefile and Makefile.pln can execute the following tests:
80
81- test-cpptest
82Builds a C++ UNO component, cppmain.uno, and runs the component with the uno
83executable.  The component first attempts to instantiate all the UNO services
84and singletons that are part of the URE installation.  The component then tries
85to instantiate and to call another C++ UNO component (ccptest.uno) as well as a
86Java UNO component (javatest.uno).  The test completes when these components
87throw a special exception that is caught by cppmain.uno.
88
89- test-javatest
90Builds a Java UNO component, javamain.uno, and runs the component with the uno
91executable.  The component tries to instantiate and to call a C++ UNO component
92(cpptest.uno) as well as a Java UNO component (javatest.uno).  The test
93completes when these components throw a special exception that is caught by
94javamain.uno.
95
96- test-javanative
97Builds a Java UNO application, javanative.jar, and runs the application with the
98java executable.  The application bootstraps a native UNO environment, and then
99tries to instantiate and to call a C++ UNO component (cpptest.uno) as well as a
100Java UNO component( javatest.uno).  The test completes when these components
101throw a special exception that is caught by javanative.jar.
102
103- test-clientserver
104Builds a server C++ UNO component, cppserver.uno, and a Java UNO application,
105javaclient.uno.  The uno executable runs the cppserver.uno component which
106listens on a pipe connection.  The java executable runs the javaclient.uno
107component which connects to the server after a five second pause so that the
108server has enough time to start.
109
110- test-regview (Makefile.pln only)
111Checks that the regview executable of the URE installation works reliably.
112
113NOTE: The files that are generated when Makefile and Makefile.pln execute are
114saved to different local directories.  Makefile outputs the generated files to
115./out.sdk whereas Makefile.pln outputs the files to ./out.pln.
116