ure/source/uretest/README

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