testtools/source/cliversioning/readme.txt

   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
  29
  30
  31 WINDOWS ONLY, no other platforms
  32
  33
  34
  35
  36 This test checks if the cli assemblies and their policy files are installed in the
  37 GAC and if the policy files are correct. The office must be installed with complete
  38 system integration. That is, one does not use setup /a for starting the
  39 installation.
  40
  41 In OOo 3.0 there was a breanking change so that the test created for previous
  42 version do not work anymore. To use these old tests one needs to install a
  43 version of OOo less than v 3.0. Then one needs to check out the cli_ure module
  44 for that version. The tests are contained in cli_ure/qa/versioning.
  45
  46 In the sub directory version_libs are libraries which are linked with (referencing)
  47 cli_cppuhelper
  48 cli_basetypes
  49 cli_ure
  50 cli_uretypes
  51 cli_oootypes
  52
  53 They are named version_3_0_0 etc, where the name indicates the version of the
  54 office for which they were initially build. If there are only the assemblies
  55 for example OOo2.0.2 installed and a client was build with the assemblies from
  56 OOo2 then the policy assemblies must make the correct redirection.
  57
  58 When calling dmake then the executable runtest.exe and version_current.dll are
  59 build. When runtest runs then it loads all dlls, which names start with
  60 "version", from the same directory and tries to run a particular test code
  61 which is only available in the version_xxx.dll s. The code in the
  62 version_xxx.dlls uses the cli default bootstrap mechanism to find the office
  63 installation and start the office. When running runtest in a build environment
  64 then it may use the wrong libraries for bootstrapping in which case the test
  65 fails. Then one has to set PATH which must point to the program directory of
  66 the office installation. For example:
  67
  68 set PATH=d:\office\program
  69
  70 runtest stops when a test failed to run. It writes error information to the
  71 console which shows which version_xxx.dll failed to run and if this was due to
  72 a referenced assembly that could not be loaded. This would be the case if such
  73 an assembly or the policy assembly is not properly installed or the redirection
  74 in the policy assembly is wrong.
  75
  76 The version_current.dll references the assemblies in the current build
  77 environment. version_current.dll is also executed when runtest is started.
  78
  79 To run the whole test one can either
  80 1. start testools/wntmsci11.pro/bin/runtests.exe in a console where no
  81 environment is set.
  82 2. Call dmake run in testools/qa/cliversions
  83
  84 For a limited test one can call in this directory
  85 dmake run office=d:\office
  86 There must not be an office installed in the system (the assemblies from the GAC
  87 would then be used). Only the test with the version_current.dll will succeed
  88 because there are no policy files installed. This test requires that all
  89 assemblies are copied next to runtests.exe - the makefile will do that.
  90
  91 The parameter office must be a system path to the office installation
  92 directory. The java code calls runtest and also sets PATH so that the test
  93 works in the build environment. It also sets UNO_PATH so that the office will be
  94 found. If the test says that it failed, then one should run runtest directly
  95 because it puts out more information.
  96
  97
  98
  99 Creating a new version_xxx.dll
 100 ==============================
 101 When a version of our assemblies changes then one should provide a new version dll which test exactly the assemblies with the changed version. This is easily done:
 102 1. set the build environment in which the new versions are effectiv.
 103 2  call: dmake name=version_xxx.dll
 104 3. copy the new version dll from the output tree into qa/versioning/version_libs
 105 4. commit the new version.dll using the -kb switch (only when creating the new file : cvs new -kb version_3_1_0.dll)
 106