ure/source/uretest/README

   1 #
   2 # This file is part of the LibreOffice project.
   3 #
   4 # This Source Code Form is subject to the terms of the Mozilla Public
   5 # License, v. 2.0. If a copy of the MPL was not distributed with this
   6 # file, You can obtain one at http://mozilla.org/MPL/2.0/.
   7 #
   8 # This file incorporates work covered by the following license notice:
   9 #
  10 #   Licensed to the Apache Software Foundation (ASF) under one or more
  11 #   contributor license agreements. See the NOTICE file distributed
  12 #   with this work for additional information regarding copyright
  13 #   ownership. The ASF licenses this file to you under the Apache
  14 #   License, Version 2.0 (the "License"); you may not use this file
  15 #   except in compliance with the License. You may obtain a copy of
  16 #   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  17 #
  18
  19 This directory contains test files for the UNO Runtime Environment (URE) as well
  20 as the Makefile and Makefile.pln makefiles.  To execute the makefiles, you need
  21 GNU make 3.80 or later.
  22
  23
  24 Makefile
  25 --------
  26
  27 Before you execute Makefile, you need to configure the Software Development Kit
  28 (SDK) environment to work with a URE installation, a C++ compiler, and a JDK.
  29 For more information, read the .../docs/install.html file in the SDK
  30 installation.
  31
  32 NOTE: On Linux x86, if the Makefile accesses a GCC that is incompatible with the
  33 GCC that was used to build the URE, use the GCCS_COMPAT environment variable as
  34 a workaround.  For more details, see the UDK README file.
  35
  36
  37 Makefile.pln
  38 ------------
  39
  40 You can only run Makefile.pln on Linux x86.  You do not need to configure your
  41 SDK environment to use this makefile, however, you do need to set the following
  42 environment variables:
  43
  44 - SDK_HOME
  45 Points to the base directory of an OpenOffice.org SDK so that you can access UNO
  46 programming tools and files that are not part of the URE.  For example, idlc,
  47 cppumaker, javamaker, UNOIDL files, and C++ headers.
  48
  49 - PATH
  50 Points to a GCC installation (including g++) as well as a JDK installation that
  51 contains the java, javac, and jar executables.  For the minimum version
  52 requirements, see the SDK Installation Guide ($SDK_HOME/docs/install.html).
  53
  54 - URE_HOME (optional)
  55 Overwrites the default URE location, that is, /opt/libreoffice.
  56
  57 - GCCS_COMPAT (optional)
  58 Fixes incompatibility issues between the GCC that was used to build the URE and
  59 the GCC that Makefile.pln accesses.  For more details, see the UDK README file.
  60
  61
  62 Tests
  63 -----
  64
  65 Makefile and Makefile.pln can execute the following tests:
  66
  67 - test-cpptest
  68 Builds a C++ UNO component, cppmain.uno, and runs the component with the uno
  69 executable.  The component first attempts to instantiate all the UNO services
  70 and singletons that are part of the URE installation.  The component then tries
  71 to instantiate and to call another C++ UNO component (cpptest.uno) as well as a
  72 Java UNO component (javatest.uno).  The test completes when these components
  73 throw a special exception that is caught by cppmain.uno.
  74
  75 - test-javatest
  76 Builds a Java UNO component, javamain.uno, and runs the component with the uno
  77 executable.  The component tries to instantiate and to call a C++ UNO component
  78 (cpptest.uno) as well as a Java UNO component (javatest.uno).  The test
  79 completes when these components throw a special exception that is caught by
  80 javamain.uno.
  81
  82 - test-javanative
  83 Builds a Java UNO application, javanative.jar, and runs the application with the
  84 java executable.  The application bootstraps a native UNO environment, and then
  85 tries to instantiate and to call a C++ UNO component (cpptest.uno) as well as a
  86 Java UNO component( javatest.uno).  The test completes when these components
  87 throw a special exception that is caught by javanative.jar.
  88
  89 - test-clientserver
  90 Builds a server C++ UNO component, cppserver.uno, and a Java UNO application,
  91 javaclient.uno.  The uno executable runs the cppserver.uno component which
  92 listens on a pipe connection.  The java executable runs the javaclient.uno
  93 component which connects to the server after a five second pause so that the
  94 server has enough time to start.
  95
  96 - test-regview (Makefile.pln only)
  97 Checks that the regview executable of the URE installation works reliably.
  98
  99 NOTE: The files that are generated when Makefile and Makefile.pln execute are
 100 saved to different local directories.  Makefile outputs the generated files to
 101 ./out.sdk whereas Makefile.pln outputs the files to ./out.pln.