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