1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
|
'encoding UTF-8 Do not remove or change this line!
'**************************************************************************
' DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
'
' Copyright 2000, 2010 Oracle and/or its affiliates.
'
' OpenOffice.org - a multi-platform office productivity suite
'
' This file is part of OpenOffice.org.
'
' OpenOffice.org is free software: you can redistribute it and/or modify
' it under the terms of the GNU Lesser General Public License version 3
' only, as published by the Free Software Foundation.
'
' OpenOffice.org is distributed in the hope that it will be useful,
' but WITHOUT ANY WARRANTY; without even the implied warranty of
' MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
' GNU Lesser General Public License version 3 for more details
' (a copy is included in the LICENSE file that accompanied this code).
'
' You should have received a copy of the GNU Lesser General Public License
' version 3 along with OpenOffice.org. If not, see
' <http://www.openoffice.org/license.html>
' for a copy of the LGPLv3 License.
'
'/******************************************************************************
'*
'* owner : joerg.skottke@oracle.com
'*
'* short description : Extensible help
'*
'\******************************************************************************
testcase tExtensibleHelp
'///<h1>Extensible help</h1>
'///<u><pre>Synopsis</pre></u>Beginning with CWS ab38 extensions can extend the help application with index entries and content<br>
'///<u><pre>Specification document</pre></u><a href=http://specs.openoffice.org/appwide/help/ExtensibleHelp.odt>
'///+http://specs.openoffice.org/appwide/help/ExtensibleHelp.odt</a><br>
'///<u><pre>Files used:</pre></u>.../extensions/features/input/extensible_help/*.info, *.oxt<br>
'///<u><pre>Test case specification</pre></u>
' This is the base path to the input directory where all workfiles are located
dim cExtName as string
dim cExtPath as string
cExtPath = gTesttoolPath & "extensions\optional\input\extensible_help\"
cExtPath = convertpath( cExtPath )
' This is the configuration file for the test extensions. This approach was chosen
' because the extensions have a lot in common but not enough to make a general
' routine without any special cases. It is possible to add more extensions easily
' by just configuring them in the config file. Ideally no canges to the test case
' itself are required.
const CONFIG_FILE = "extension.info"
dim cCfgPath as string
cCfgPath = cExtPath
cCfgPath = convertpath( cCfgPath & CONFIG_FILE )
' In this array we store the config file. Always make sure it is large enough
' to hold the entire file
dim cCfgArray( 60 ) as string
' Some returnvalues/status variables, general purpose
dim iStatus as integer
dim bStatus as boolean
' Control variables for the outer loop (actions for each extension)
dim iCurrentExtension as integer
dim iExtensionCount as integer
' Control variables for the inner loop (items to test for an extension)
dim cCurrentHelpItem as string
dim iCurrentHelpItem as integer
dim iHelpItemCount as integer
' Values retrieved from the config file or the help content
dim cItem as string
dim cHead as string
dim cLine as string
' Correct the position within the index list. If we have a main item with
' sub-items we might need to move a few entries down in the list to get the
' sub-items.
dim cMove as string
dim iMove as integer
dim iMoveDown as integer
do while ( getDocumentCount > 0 )
call hCloseDocument()
loop
'///<ul>
'///+<li>Open a writer document (so the help comes up for writer)</li>
gApplication = "WRITER"
call hNewDocument()
if ( getDocumentCount <> 1 ) then
warnlog( "Fatal: Unable to open new writer document" )
sResetTheOffice
goto endsub
endif
'///+<li>Read the config file - determine the number of test-extensions</li>
iStatus = hGetDataFileSection( cCfgPath, cCfgArray(), "files", "", "" )
iExtensionCount = int( hGetValueForKeyAsString( cCfgArray(), "count" ) )
printlog( "Read configuration for " & iExtensionCount & " files." )
'///+<li>Cycle through the configured test-extensions</li>
'///<ul>
for iCurrentExtension = 1 to iExtensionCount
'///+<li>Read the config file - get settings for current extension</li>
hGetDataFileSection( cCfgPath, cCfgArray(), iCurrentExtension, "", "" )
cExtPath = cExtPath & hGetValueForKeyAsString( cCfgArray(), "file" )
cExtName = hGetValueForKeyAsString( cCfgArray(), "name" )
'///+<li>Install the test-extension, cleanup and quit on failure</li>
iStatus = hExtensionAddGUI( cExtPath , "NoUpdate,NoLicense,InstallForUser,Verbose" )
if ( iStatus < 1 ) then
warnlog( "Fatal: Adding extension failed with rc = " & iStatus )
sResetTheOffice
goto endsub
endif
'///+<li>Open the help browser</li>
HelpContents
kontext "StarOfficeHelp"
if ( StarOfficeHelp.exists( 2 ) ) then
'///+<li>Switch to the index tabpage</li>
TabControl.setPage( IndexPage )
else
warnlog( "Unable to open help browser" )
hCloseDocument()
sResetTheOffice()
goto endsub
endif
'///+<li>Search the help index for the items described in the config file</li>
iHelpItemCount = int( hGetValueForKeyAsString( cCfgArray(), "items" ) )
printlog( "Testing " & iHelpItemCount & " items" )
'///<ul>
for iCurrentHelpItem = 1 to iHelpItemCount
printlog( "" )
printlog( "Testing item " & iCurrentHelpItem )
'///+<li>Get the test strings from the config file</li>
cItem = "hindex_" & iCurrentHelpItem
cMove = "h_move_" & iCurrentHelpItem
cHead = "header_" & iCurrentHelpItem
cItem = hGetValueForKeyAsString( cCfgArray(), cItem )
cHead = hGetValueForKeyAsString( cCfgArray(), cHead )
iMove = int( hGetValueForKeyAsString( cCfgArray(), cMove )
'///+<li>Enter the search term into the search field of the index page</li>
kontext "StarOfficeHelp"
SearchIndex.setText( cItem ) : WaitSlot()
for iMoveDown = 1 to iMove
SearchIndex.typeKeys( "<DOWN>" )
next iMoveDown
'///+<li>Display the associated help page (content) by clicking on "Display"</li>
DisplayIndex.click() : WaitSlot()
'///+<li>Get the header from the content</li>
kontext "HelpContent"
HelpContent.typeKeys( "<MOD1 HOME>" )
HelpContent.typeKeys( "<SHIFT RIGHT>" , len( cHead ) )
hUseAsyncSlot( "EditCopy" )
cLine = GetClipBoardText
'///+<li>Compare the config string with the header</li>
if ( cLine <> cHead ) then
if ( iCurrentHelpItem = 1 and gPlatGroup <> "Win95" ) then
qaerrorlog( "Header is incorrect, slower navigation on Unix(like)" )
else
warnlog( "Header is incorrect. Please check." )
endif
printlog( "Found...: " & cLine )
printlog( "Expected: " & cHead )
else
printlog( "The header is correct: " & cLine )
endif
next iCurrentHelpItem
'///</ul>
'///+<li>Close the help browser</li>
kontext "StarOfficeHelp"
StarOfficeHelp.typeKeys( "<MOD1 F4>" )
'///+<li>Remove the extension</li>
hExtensionRemoveGUI( cExtName )
next iCurrentExtension
'///</ul>
'///+<li>Close the writer document</li>
call hCloseDocument()
if ( getDocumentCount <> 0 ) then
warnlog( "Fatal: Failed to close writer document" )
sResetTheOffice
goto endsub
endif
'///</ul>
endcase
|
