xmerge/source/palmtests/README

   1 The following is an outline of the usage of this test suite.
   2
   3 Requirements
   4 ^^^^^^^^^^^^
   5 The following are required for these qa scripts to run correctly.
   6         1. POSE: the Palm OS Emulator. This is available from the PalmOS website.
   7         2. A Palm pilot rom. Also available from Palm.
   8         3. Compiled xmerge jar files (xmerge.jar, aportisdoc.jar etc.)
   9         4. Xerces.jar: required by the xmerge framework. This is available from org.apache.com.
  10
  11
  12
  13 Test directory Contents
  14 ^^^^^^^^^^^^^^^^^^^^^^^
  15 This test environment consists on 3 directories.
  16         1. bin : This contains some helper scripts that are used by the test environment but can be used in a standalone fashion.
  17         2. qa : This directory contains the files necessary to run the POSE emulator and to compare this results of tests with a set of verified (golden-data) files.
  18         3. qa-wrapper: This directory contains some wrapper scripts and environment files, that allow a user to change the environment settings, without have to change the POSE control code itself.
  19
  20 Setting up the environment
  21 ^^^^^^^^^^^^^^^^^^^^^^^^^^
  22         The environment can be changes to reflect a particular users environment, by editing or creating an environment file. This files are usually kept in the qa-wrapper/env directory. These environment settings can then be used when running the scripts.
  23
  24 Running the Scripts
  25 ^^^^^^^^^^^^^^^^^^^
  26     Once the environment file has been created, the test scripts can be run by executing the "run-convtest" script in the qa-wrapper/bin directory. This file takes the following arguments
  27
  28          run-convtest -env <ENVFILE> [-name RUNNAME]
  29
  30 <ENVFILE> is the environment file to use
  31 optional <RUNNAME> This can be the name of the user running the scripts. This is used to name a directory for the test results to be kept in.
  32
  33         e.g. run-convtest -env ../env/master.env
  34
  35
  36
  37
  38
  39
  40
  41
  42
  43
  44
  45
  46
  47
  48
  49
  50