merge the formfield patch from ooo-build
[ooovba.git] / testautomation / global / hid / readme.txt
blob7d786f27ba1a4b915bfeb77a334b049c8bf37ac9
1 Introduction
2 ------------
4 This is the former location of the file: hid.lst
5 It is intended, that after a fresh checkout from svn you will not find it here anymore.
6 There will be no hid.lst anymore in source code repository for testautomation.
8 But the file hid.lst is essential for running automated tests with VCL
9 TestTool: Your OOo installation may already contain it at:
10 <OOo installation directory>/basis-link/program/hid.lst
11 (Depending on your installation you need to install the 'testtool' package)
13 As a fallback you will find the file hid.lst online at:
14 http://quaste.services.openoffice.org/index.php?option=com_quaste&task=tests_overview&workspace=DEV300&milestone=m51&download=2
15 (Please substitute DEV300 and m51 with the respective version numbers from your used OOo installation)
16 See announcement on QUASTe: http://quaste.services.openoffice.org/index.php?option=com_content&task=view&id=14&Itemid=1
18 As another fallback, the testautomation archives from Maho Nakata will already contain the hid.lst from QUASTe:
19 http://ooopackages.good-day.net/pub/OpenOffice.org/qa/testautomation/
20 Announcement is here: http://qa.openoffice.org/servlets/ReadMsg?list=dev&msgNo=12515
22 Action needed for tests with VCL TestTool? It depends;
24 Ideal processing
25 ----------------
27 When checking out the VCL TestTool environment from svn;
28 OOo is already installed and the installation path is set
29 in the VCL TestTool seetings;
30 > http://wiki.services.openoffice.org/wiki/VCLTesttool
32 The first test run will recognize the absence of hid.lst in the directory
33 testautomation/global/hid, but finds hid.lst file in OOo
34 installation directory;
35 Then VCL TestTool will copy it from OOo installation to testautomation
36 directory - the test can start;
38 When using the testautomation archives from Nakata Maho,
39 > http://ooopackages.good-day.net/pub/OpenOffice.org/qa/testautomation/
40 there will still be already a hid.lst file in the testautomation
41 directory.
43 --------------------------------------------------------------------
45 Longer description to this change
46 ---------------------------------
48 The change was necessarry since there were always several conflicts on
49 integration of several CWS's modifying the hid.lst file into one master.
50 The hid.lst is refused to checked in by Release Engineering after
51 building OOo, since they claim it is too late then and all files are
52 tagged then already in svn.
53 The file changes when new UI is put into, or removed from OOo;
54 It matches the number of an UI element known by OOo to a speaking name,
55 used in VCL TestTool test scripts.
56 There were always two hid.lst files in OOo:
57 - The first one, that is also the source for the second one, is
58 generated during building OOo;
59 - The second one, the one found in 'testautomation' was run through
60 several scripts to make it useable for testautomation and always
61 verified manually for errors;
63 With some fixes in DEV300m42/m45 and issue i101284 the generation of
64 hid.lst was changed during building of OOo, to use the resulting hid.lst
65 at the end also for testautomation;
66 This makes the second hid.lst now superfluous, since the hid.lst is also
67 delivered with every OOo installation;
69 The locations of the hid.lst:
70 - After an OOo build it is found at: solver/300/unxmacxp.pro/bin/hid.lst
71   (due to a bug in deliver this one might be the wrong one, then you find
72    it in: instsetoo_native/unxmacxi.pro/bin/hid.lst)
73   To get the hid.lst build, you need to use 'configure' with the switch: --enable-hids
74 - In an installed OOo:
75   Win32:  Program Files\Sun\StarOffice 9\Basis\program\hid.lst
76   Mac OS: StarOffice.app/Contents/basis-link/program/hid.lst
77   Linux: /opt/openoffice.org/basis3.2/program/hid.lst
78 - Online at http://quaste.services.openoffice.org/index.php?option=com_quaste&task=tests_overview&workspace=DEV300&milestone=m51&download=2
79   With the respected values for the version replaced.
81 The file is finaly needed at: testautomation/global/hid/hid.lst
83 When using testautomation packages from:
84 > http://ooopackages.good-day.net/pub/OpenOffice.org/qa/testautomation/
85 No additional action should be required, since a hid.lst will be at the
86 needed location.
88 When checking out testautomation from svn, hid.lst is tried to find and 
89 copied by VCL TestTool on first test run.
91 When manual action is required
92 ------------------------------
94 In case the target directory for hid.lst is not writeable by the user
95 who is running the test, manual action is required:
96 Open your VCL TestTool settings and change the hid directory path
97 to the basis program directory of your OOo installation; E.g.:
98 openoffice.org3/basis-link/program
99 > http://wiki.services.openoffice.org/wiki/VCLTesttool
101 There is also some output in the resultfile of the test, that should
102 give some hint, about the hid.lst; Either it was already there, got
103 copied from OOo or simply just not found.
105 If no hid.lst file is found, or could not be copied a messagebox comes up,
106 telling the reason and testing is aborted. Then please read the 
107 additional messages in the resultfile.
109 There might also be the case where the version of the hid.lst does not match the
110 version of the used OOo. Then there is an informal message shown.
111 The version should not differ, please check and correct the location of
112 the hid.lst file. Some reasons might be:
113 - the build was not done with configure switch  --enable-hids;
114   then the hid.lst comes from helpcontent2/helpers/hid.lst, which
115   is a constant one, which is far too old.
116 As for the VCL TestTool environment, the hid.lst file is also version dependant to OOo.
118 Current warnings in results
119 ---------------------------
121 There are currenty about 99 warnings in the beginning, which are already 
122 fixed in CWS dba32e: i103219, butis not yet integrated into the master.
124 Getting help
125 ------------
127 If nothing helps, do not hesitate to ask on maling list: 
128 dev@qa.openoffice.org
129 Start your subject with '[automation]: '