summaryrefslogtreecommitdiff
path: root/testautomation/framework/optional/includes/scripting_organizers.inc
blob: 60ba71bb500c34632af3ab4818a1113975dcb4b6 (plain)
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
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
'encoding UTF-8  Do not remove or change this line!
'**************************************************************************
'* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
'* 
'* Copyright 2008 by Sun Microsystems, Inc.
'*
'* OpenOffice.org - a multi-platform office productivity suite
'*
'* $RCSfile: scripting_organizers.inc,v $
'*
'* $Revision: 1.1 $
'*
'* last change: $Author: jsi $ $Date: 2008-06-16 12:18:15 $
'*
'* 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@sun.com
'*
'*  short description : Test scripting-organizers / document-attached scripts
'*
'\******************************************************************************

testcase tScriptingOrganizers( iDialog as integer )

    '///<H1>Test scripting-organizers</H1>
    ' 1 = BeanShell (.bsh)
    ' 2 = JavaScript (.js)
    
    const IDOCPOS = 3

    dim cFileName as string
        cFileName = "sftest" & hGetSuffix( "current" )
    dim cCompare as string
        
    dim cFilePath as string
        cFilePath= hGetWorkPath() & cFileName
        cFilePath= convertpath( cFilePath )
        
    dim iPos as integer  ' position of the workdocument in treelist
    dim brc as boolean   ' boolean return code used to determine the status
    
    dim cLibName as string
        cLibName = "TTLib"
    dim cModName as string
        cModName = "TTMod"
    dim cScriptName as string
    
    dim iItemCount as integer

    '///<ul>
    '///+<li>Set macro security level to low</li>
    printlog( "" ) 
    printlog( "Test init: set macro security level to low" )
    hSetMacroSecurityAPI( GC_MACRO_SECURITY_LEVEL_LOW )
    
    '///+<li>For both script organizers (javascript/beanshell) do</li>
    '///<ul>
    '///+<li>Create a script name of type TTMod.(.bsh|js)</li>
    select case iDialog
    case 1 : cScriptName = cModName & ".bsh"
    case 2 : cScriptName = cModName & ".js"
    end select
      
    '///+<li>Delete the workfile in case it has been left over by prior run</li>
    brc = hDeleteFile( cFilePath )
    
    '///+<li>Open a new document</li>
    printlog( "Test init: Create and prepare document" )
    brc =  hCreateDocument()
    
    '///+<li>Modify the document</li>
    call hChangeDoc()
    
    '///+<li>Save the document (Menu File->Save As...)</li>
    brc = hFileSaveAsKill( cFilePath )
    
    '///+<li>Open the ScriptOrganizer</li>
    printlog( "" )
    printlog( "Test 1: ScriptOrganizer/Documents" )
    brc = hOpenScriptOrganizer( iDialog )
    if ( not brc ) then
        warnlog( "Could not open the script Organizer, aborting" )
        brc = hDestroyDocument()
        goto endsub
    endif
    
    '///+<li>Count the objects in the collapsed treelist</li>
    kontext "ScriptOrganizer"
    iItemCount = hGetNodeCount( ScriptTreeList )
    
    '///+<li>Verify that there are exactly three items in the treelist</li>
    if ( ScriptTreeList.getItemCount() <> IDOCPOS ) then
        warnlog( "Incorrect number of documents listed in treelist, aborting" )
        kontext "ScriptOrganizer"
        ScriptOrganizer.cancel()
        brc = hDestroyDocument()
        goto endsub
    endif    
    
    '///+<li>Select the document at pos. 3</li>
    kontext "ScriptOrganizer"
    ScriptTreeList.select( IDOCPOS )
    
    '///+<li>Test status of Buttons</li>
    '///<ul>
    '///+<li>&quot;Create&quot; should be enabled</li>
    if ( not PBCreate.isEnabled() ) then
        warnlog( "Create button should be enabled" )
    endif
    
    '///+<li>&quot;Edit&quot; should be disabled</li>
    if ( PBEdit.isEnabled() ) then
        warnlog( "Edit button should be disabled" )
    endif
    
    '///+<li>&quot;Rename&quot; should be disabled</li>
    if ( PBRename.isEnabled() ) then
        warnlog( "Rename button should be disabled" )
    endif
    
    '///+<li>&quot;Delete&quot; should be disabled</li>
    if ( PBDelete.isEnabled() ) then    
        qaerrorlog( "#i50527# - Delete button should be disabled" )
    endif
    '///</ul>
    

    printlog( "" )
    printlog( "Test 2: Libraries/Scripts create/rename" )
    
    '///+<li>Create a new library</li>
    brc = hCreateScriptingObject( "initial_lib" )
    
    '///+<li>Rename the library</li>
    brc = hRenameScriptingObject( cLibName )
    
    '///+<li>Verify that renaming worked</li>
    brc = hVerifyNodeName( ScriptTreeList , cLibName )
    if ( not brc ) then
        qaerrorlog(  "#i50526# Renaming failed: " & cLibName )
    endif
    
    '///+<li>Remember name of the library, it is deleted later</li>
    cLibName = ScriptTreeList.getSelText()
    
    '///+<li>Test status of Buttons</li>
    '///<ul>
    '///+<li>&quot;Create&quot; should be enabled</li>
    if ( not PBCreate.isEnabled() ) then
        warnlog( "Create button should be enabled" )
    endif
    
    '///+<li>&quot;Edit&quot; should be disabled</li>
    if ( PBEdit.isEnabled() ) then
        warnlog( "Edit button should be disabled" )
    endif
    
    '///+<li>&quot;Rename&quot; should be enabled</li>
    if ( not PBRename.isEnabled() ) then
        warnlog( "Rename button should be enabled" )
    endif
    
    '///+<li>&quot;Delete&quot; should be enabled</li>
    if ( not PBDelete.isEnabled() ) then
        warnlog( "Delete button should be enabled" )
    endif
    '///</ul>
    
    '///+<li>Create a new script</li>
    brc = hCreateScriptingObject( "initial_mod" )
    
    '///+<li>Rename the script</li>
    brc = hRenameScriptingObject( cModName )
    
    '///+<li>Verify that renaming worked</li>
    brc = hVerifyNodeName( ScriptTreeList , cScriptName )
    if ( not brc ) then
        qaerrorlog( "#i50526# Renaming failed: " & cScriptName )
    endif    
    
    '///+<li>Remember the module name, it is deleted later</li>
    cModName = ScriptTreeList.getSelText()
    
    '///+<li>Test status of Buttons</li>
    '///<ul>
    '///+<li>&quot;Create&quot; should be disabled</li>
    if ( PBCreate.isEnabled() ) then
        warnlog( "Create button should not be enabled" )
    endif
    
    '///+<li>&quot;Edit&quot; should be enabled</li>
    if ( not PBEdit.isEnabled() ) then
        warnlog( "Edit button should be enabled" )
    endif

    '///+<li>&quot;Rename&quot; should be enabled</li>
    if ( not PBRename.isEnabled() ) then
        warnlog( "Rename button should be enabled" )
    endif

    '///+<li>&quot;Delete&quot; should be enabled</li>
    if ( not PBDelete.isEnabled() ) then
        warnlog( "Delte button should be enabled" )
    endif
    '///</ul>
    
    '///+<li>Exit the scriptorganizer (cancel)</li>
    kontext "ScriptOrganizer"
    brc = hCloseScriptOrganizer()
    
    '///+<li>Save the file</li>
    printlog( "" )
    printlog( "Test 3: Script storage in documents (save/load)" )
    try
        hFileSave
    catch
        warnlog( "Document Changed status not set" )
        hChangeDoc()
        hFileSave
    endcatch
    
    '///+<li>Close the document</li>
    brc = hDestroyDocument()   
    
    '///+<li>Reload the document.</li>
    brc = hFileOpen( cFilePath )
    
    '///+<li>Open the ScriptOrganizer</li>
    brc = hOpenScriptOrganizer( iDialog )
    
    '///+<li>Select the document</li>
    ScriptTreeList.select( 3 )
    
    '///+<li>Expand the node</li>
    iPos = hExpandNode( ScriptTreeList , 0 )
    
    '///+<li>Select the module</li>
    ScriptTreeList.select( 4 )
    
    '///+<li>Select the script</li>
    iPos = hExpandNode( ScriptTreeList , 0 )
    ScriptTreeList.select( 5 )
    

    printlog( "" )
    
    '///+<li>Delete the script (should work)</li>
    printlog( "Test 4: Script removal / Document changed" )
    brc = hDeleteScript( cModName , true )
    if ( not brc ) then
        warnlog( "Bad rc: hDelteScript()" )
    endif    
    
    '///+<li>Delete the module (should work)</li>
    brc = hDeleteScript( cLibName , true )
    if ( not brc ) then
        warnlog( "Bad rc: hDelteScript()" )
    endif        
    
    '///+<li>Delete the document (which should not work)</li>
    brc = hDeleteScript( cFileName , false )
    if ( not brc ) then
       qaerrorlog( "#i50527# Delete enabled for document object" )
    endif
        
    '///+<li>Exit all dialogs (close the script organizer)</li>
    kontext "ScriptOrganizer"
    brc = hCloseScriptOrganizer()
    
    '///+<li>Save the file via File Save button on standardbar</li>
    try
        hFileSave
    catch
        warnlog( "Document Changed status expected after script deletion" )
        brc = hChangeDoc()
        hFileSave
    endcatch
    
    '///+<li>Close the document</li>
    brc = hDestroyDocument()   
    
    '///+<li>Reload the document.</li>
    printlog( "Reload the document." )
    brc = hFileOpen( cFilePath )
    if ( brc ) then
        qaerrorlog( "#i50530# Macros not completely removed from doc when deleted" )
    endif
    
    '///+<li>Open the ScriptOrganizer, look for the library</li>
    printlog( "" )
    printlog( "Test 5: Verification of script removal" )
    brc = hOpenScriptOrganizer( iDialog )
    kontext "ScriptOrganizer"
    iItemCount = hGetNodeCount( ScriptTreeList )
    if ( iItemCount <> IDOCPOS ) then
        warnlog( "Treelist not populated, the test cannot continue" )
        brc = hCloseScriptOrganizer()
        brc = hDestroyDocument()
        goto endsub
    endif
    
    '///+<li>Verify that all libraries/scripts have been removed</li>
    iPos = hExpandNode( ScriptTreeList , IDOCPOS )
    if ( iPos <> 3 ) then
        warnlog( "Not all libraries/scripts have been deleted" )
    endif
            
    '///+<li>Test Exit: Cleanup - close all dialogs</li>
    brc = hCloseScriptOrganizer()

    '///+<li>Close the navigator if it is open</li>
    brc = hCloseNavigator()
    
    '///+<li>Close the document</li>
    brc = hDestroyDocument()
    
    '///+<li>Delete the workfile</li>
    brc = hDeleteFile( cFilePath )
    if ( not brc ) then
        warnlog( "Could not delete: " & cFilePath & " - do so manually!" )
    endif
    
    '///</ul>
    
    '///+<li>Set macro security level to default</li>
    hSetmacroSecurityAPI( GC_MACRO_SECURITY_LEVEL_DEFAULT )
    
    '///</ul>

endcase