xref: /aoo4110/main/xmerge/source/palmtests/README (revision b1cdbd2c)
1*b1cdbd2cSJim JagielskiThe following is an outline of the usage of this test suite.
2*b1cdbd2cSJim Jagielski
3*b1cdbd2cSJim JagielskiRequirements
4*b1cdbd2cSJim Jagielski^^^^^^^^^^^^
5*b1cdbd2cSJim JagielskiThe following are required for these qa scripts to run correctly.
6*b1cdbd2cSJim Jagielski	1. POSE: the Palm OS Emulator. This is available from the PalmOS website.
7*b1cdbd2cSJim Jagielski	2. A Palm pilot rom. Also available from Palm.
8*b1cdbd2cSJim Jagielski	3. Compiled xmerge jar files (xmerge.jar, aportisdoc.jar etc.)
9*b1cdbd2cSJim Jagielski	4. Xerces.jar: required by the xmerge framework. This is available from org.apache.com.
10*b1cdbd2cSJim Jagielski
11*b1cdbd2cSJim Jagielski
12*b1cdbd2cSJim Jagielski
13*b1cdbd2cSJim JagielskiTest directory Contents
14*b1cdbd2cSJim Jagielski^^^^^^^^^^^^^^^^^^^^^^^
15*b1cdbd2cSJim JagielskiThis test environment consists on 3 directories.
16*b1cdbd2cSJim Jagielski	1. bin : This contains some helper scripts that are used by the test environment but can be used in a standalone fashion.
17*b1cdbd2cSJim Jagielski	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*b1cdbd2cSJim Jagielski	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*b1cdbd2cSJim Jagielski
20*b1cdbd2cSJim JagielskiSetting up the environment
21*b1cdbd2cSJim Jagielski^^^^^^^^^^^^^^^^^^^^^^^^^^
22*b1cdbd2cSJim Jagielski	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*b1cdbd2cSJim Jagielski
24*b1cdbd2cSJim JagielskiRunning the Scripts
25*b1cdbd2cSJim Jagielski^^^^^^^^^^^^^^^^^^^
26*b1cdbd2cSJim Jagielski    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*b1cdbd2cSJim Jagielski
28*b1cdbd2cSJim Jagielski	 run-convtest -env <ENVFILE> [-name RUNNAME]
29*b1cdbd2cSJim Jagielski
30*b1cdbd2cSJim Jagielski<ENVFILE> is the environment file to use
31*b1cdbd2cSJim Jagielskioptional <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*b1cdbd2cSJim Jagielski
33*b1cdbd2cSJim Jagielski	e.g. run-convtest -env ../env/master.env
34*b1cdbd2cSJim Jagielski
35*b1cdbd2cSJim Jagielski
36*b1cdbd2cSJim Jagielski
37*b1cdbd2cSJim Jagielski
38*b1cdbd2cSJim Jagielski
39*b1cdbd2cSJim Jagielski
40*b1cdbd2cSJim Jagielski
41*b1cdbd2cSJim Jagielski
42*b1cdbd2cSJim Jagielski
43*b1cdbd2cSJim Jagielski
44*b1cdbd2cSJim Jagielski
45*b1cdbd2cSJim Jagielski
46*b1cdbd2cSJim Jagielski
47*b1cdbd2cSJim Jagielski
48*b1cdbd2cSJim Jagielski
49*b1cdbd2cSJim Jagielski
50*b1cdbd2cSJim Jagielski
51