mirror of https://github.com/OpenIdentityPlatform/OpenDJ.git

ugaston
22.55.2010 09670254d836e1613803ebd65afe774edbd99b05
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
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<!DOCTYPE stax SYSTEM "../stax.dtd">
<!--
 ! CDDL HEADER START
 !
 ! The contents of this file are subject to the terms of the
 ! Common Development and Distribution License, Version 1.0 only
 ! (the "License").  You may not use this file except in compliance
 ! with the License.
 !
 ! You can obtain a copy of the license at
 ! trunk/opends/resource/legal-notices/OpenDS.LICENSE
 ! or https://OpenDS.dev.java.net/OpenDS.LICENSE.
 ! See the License for the specific language governing permissions
 ! and limitations under the License.
 !
 ! When distributing Covered Code, include this CDDL HEADER in each
 ! file and include the License file at
 ! trunk/opends/resource/legal-notices/OpenDS.LICENSE.  If applicable,
 ! add the following below this CDDL HEADER, with the fields enclosed
 ! by brackets "[]" replaced with your own identifying information:
 !      Portions Copyright [yyyy] [name of copyright owner]
 !
 ! CDDL HEADER END
 !
 !      Copyright 2007-2009 Sun Microsystems, Inc.
 ! -->
<stax>
  
  <function name="importSharedLibraries">
    <function-prolog>
    This function imports the shared function xml libraries.
  </function-prolog>       
    
  <sequence>
    
      <!--- Import all the shared xml libraries -->
      <import machine="STAF_LOCAL_HOSTNAME"
        file="'%s/baselib.xml' % (TESTS_FUNCTIONS_DIR)" />
              
      <import machine="STAF_LOCAL_HOSTNAME"
        file="'%s/utils.xml' % (TESTS_FUNCTIONS_DIR)" />
 
      <import machine="STAF_LOCAL_HOSTNAME"
        file="'%s/stafcmd.xml' % (TESTS_FUNCTIONS_DIR)" />
 
      <import machine="STAF_LOCAL_HOSTNAME"
        file="'%s/staxcmd.xml' % (TESTS_FUNCTIONS_DIR)" />
 
      <import machine="STAF_LOCAL_HOSTNAME"
        file="'%s/dsadm.xml' % (TESTS_FUNCTIONS_DIR)" />
 
      <import machine="STAF_LOCAL_HOSTNAME"
        file="'%s/dsconfig.xml' % (TESTS_FUNCTIONS_DIR)" />
 
      <import machine="STAF_LOCAL_HOSTNAME"
        file="'%s/ldap.xml' % (TESTS_FUNCTIONS_DIR)" />
 
      <import machine="STAF_LOCAL_HOSTNAME"
        file="'%s/security.xml' % (TESTS_FUNCTIONS_DIR)" />
    
      <import machine="STAF_LOCAL_HOSTNAME"
        file="'%s/topology.xml' % (TESTS_FUNCTIONS_DIR)" />
        
      <import machine="STAF_LOCAL_HOSTNAME"
        file="'%s/signals.xml' % (TESTS_FUNCTIONS_DIR)" />
 
      <import machine="STAF_LOCAL_HOSTNAME"
        file="'%s/tools.xml' % (TESTS_FUNCTIONS_DIR)" />
        
      <import machine="STAF_LOCAL_HOSTNAME"
        file="'%s/webcontainer.xml' % (TESTS_FUNCTIONS_DIR)" />
 
      <import machine="STAF_LOCAL_HOSTNAME"
        file="'%s/snmp.xml' % (TESTS_FUNCTIONS_DIR)" />
        
  </sequence>  
      
  </function>
 
  
  
  
  <function name="importPythonLibraries">
    <function-prolog>
    This function imports the Python libraries and objects, 
    both starndard and local shared ones.
  </function-prolog>    
   
    <sequence>
    
      <!-- Load in any standard python libraries -->
      <script>
        import re
        import os
        import sys
      </script>
 
      <!-- Load in any additional Java classes -->
      <script>
        import java.io.FileNotFoundException
      </script>
 
      <!-- Load in any standard python functions -->
      <script>
        from time import localtime,strftime
      </script> 
 
      <!-- Load in the local shared python objects from libraries -->
      <script>
        sys.path.append("%s/shared/python" % TESTS_ROOT )
        from common import *
        from security import *
        from replication import *
        from snmp import *
        from schema import *
      </script>     
                        
    
  </sequence>
  </function>  
  
  
  
    
 
  <function name="initialiseGlobalVariables">
    <function-prolog>
      This function initialises a set of global variables.
    </function-prolog>
    
    <sequence>
 
      <!-- fixMe: this needs some cleanup -->
      <script>
        STAXLogMessage = 1 
        OPENDS_BINPATH ='%s/%s/bin' % (DIRECTORY_INSTANCE_DIR,OPENDSNAME)
        if is_windows_platform(STAF_REMOTE_HOSTNAME):
          fileExt='.bat'
          scriptExt='.bat'
          fileFolder='bat'
          pathSeparator=';'
          newLine='\r\n'
        else:
          fileExt=''
          scriptExt='.sh'
          fileFolder='bin'
          pathSeparator=':'
          newLine='\n'
      </script>
 
      <!-- Default LDAP Server Object -->
      <script>
        server=directory_server()
        server.location   = STAF_REMOTE_HOSTNAME
        server.host       = DIRECTORY_INSTANCE_HOST
        server.port       = DIRECTORY_INSTANCE_PORT
        server.adminport  = DIRECTORY_INSTANCE_ADMIN_PORT
        server.dn         = DIRECTORY_INSTANCE_DN
        server.password   = DIRECTORY_INSTANCE_PSWD
        server.suffix     = DIRECTORY_INSTANCE_SFX
        server.backend    = DIRECTORY_INSTANCE_BE
      </script>
      
      <!-- Default LDAP Server Object -->
      <script>
        server=directory_server()
        server.location   = STAF_REMOTE_HOSTNAME
        server.host       = DIRECTORY_INSTANCE_HOST
        server.port       = DIRECTORY_INSTANCE_PORT
        server.adminport  = DIRECTORY_INSTANCE_ADMIN_PORT
        server.dn         = DIRECTORY_INSTANCE_DN
        server.password   = DIRECTORY_INSTANCE_PSWD
        server.suffix     = DIRECTORY_INSTANCE_SFX
        server.backend    = DIRECTORY_INSTANCE_BE
      </script>
 
      <!-- Set the signal handlers -->
      <call function="'signals'"/>
      
      <!-- Initialize any global variables -->
      <script>
        CurrentTestPath={}
        DSInfoServersDict={}
        True = 1
        False = 0
        # threshold set so that functions such as getFile may not cause staf
        # process to run out of memory (value in bytes)
        MAX_READABLE_SIZE = 104800
 
        # this function return a well-formatted testcase name
        def getTestCaseName(name):
          return '%s: %s: %s' % (CurrentTestPath['group'],CurrentTestPath['suite'],name)
 
        DSCONFIG = 'dsconfig'       
        DSREPLICATION = 'dsreplication'   
          
        AdminUID = 'admin'
        AdminPswd = 'admin'
          
        # Replication configuration default names
        MultimasterSync = 'Multimaster Synchronization'
        MultimasterType = 'multimaster'
 
        # Replication execution mode variables: if not defined, set random value
        import random
        
        if REPLICATION_SPLIT_SERVERS == '':
          REPLICATION_SPLIT_SERVERS = random.choice(['true', 'false'])
        
        if REPLICATION_ECL_MODE == '':
          REPLICATION_ECL_MODE = random.choice(['opends', 'draft'])
 
        # Create staf objects
        LOCAL_STAF_ROOT  = test_env.staf(STAF_LOCAL_HOSTNAME).root
        REMOTE_STAF_ROOT = test_env.staf(STAF_REMOTE_HOSTNAME).root
      </script>
 
  </sequence>     
  </function>
 
  <function name="GetDirectoryServerInformation">
    <function-prolog>
      This function gets information about the Directory Server  
    </function-prolog>
 
     <try>
         
      <sequence>
        
        <script>
          InstanceInstallDir= '%s/%s' % (DIRECTORY_INSTANCE_DIR,OPENDSNAME)
        </script>
            
        <!-- Copy DS zip archive to remote host-->
        <message>
          'Copy DS zip archive to %s %s.zip.' % (STAF_REMOTE_HOSTNAME,InstanceInstallDir)
        </message>
        <call function="'copyFile'">
          { 'srcfile'    : '%s/%s' % (ZIPPATH,ZIPNAME),
            'destfile'   : '%s.zip' % InstanceInstallDir,
            'remotehost' : STAF_REMOTE_HOSTNAME }
        </call>
 
        <if expr="RC != 0">
          <return>RC</return>
        </if>
                        
        <!-- Install DS into temporary folder -->
        <message>
          'Extract temporary DS zip archive to %s %s.' % (STAF_REMOTE_HOSTNAME,DIRECTORY_INSTANCE_DIR)
        </message>
        <call function="'unZipFile'">
          { 'location' : STAF_REMOTE_HOSTNAME, 
            'zipfile'  : '%s.zip' % InstanceInstallDir, 
            'unzipdir' : '%s' % DIRECTORY_INSTANCE_DIR }
        </call>
 
        <if expr="RC != 0">
          <return>RC</return>
        </if>
                                
        <!-- Get Directory Server Variables -->
        <call function="'GetDirectoryServerVars'">
          { 'location'  : STAF_REMOTE_HOSTNAME,
            'dsPath'    : '%s/%s' % (DIRECTORY_INSTANCE_BIN,OPENDSNAME)  }
        </call>
 
        <if expr="RC != 0">
          <throw exception="'TestExceptionResultFailed'">
            'Invalid Result %s' % RC
          </throw>
        </if>
                
        <!-- Set Directory Server Variables -->
        <call function="'SetVar'">
          { 'location'  : STAF_REMOTE_HOSTNAME,
            'type'      : 'shared',
            'variable'  : 'Job%s_ServerInfo=%s' % (STAXJobID,DSInfoServersDict) }
        </call>
 
        <if expr="RC != 0">
          <throw exception="'TestExceptionResultFailed'">
            'Invalid Result %s' % RC
          </throw>
        </if>
                      
        <!-- Uninstall DS from temporary folder -->
        <message>
          'Remove temporary DS zip archive from %s %s' % (STAF_REMOTE_HOSTNAME,InstanceInstallDir)
        </message>
        
        <call function="'deleteFolder'">
          { 'location'   : STAF_REMOTE_HOSTNAME ,
            'foldername' : '%s' % InstanceInstallDir }
        </call>
        
        <call function="'deleteFile'">
          { 'location'   : STAF_REMOTE_HOSTNAME ,
            'filename'   : '%s.zip' % InstanceInstallDir }
        </call>
                  
      </sequence>
 
    <catch exception="'TestExceptionResultFailed'" typevar="eType" var="eInfo">
      <sequence>
        <message>'caught %s with %s' % (eType,eInfo)</message>
        <message>
          'Remove temporary DS zip archive from %s %s' % (STAF_REMOTE_HOSTNAME,InstanceInstallDir)
        </message>
        <call function="'deleteFolder'">
          { 'location'   : STAF_REMOTE_HOSTNAME ,
            'foldername' : '%s' % InstanceInstallDir }
        </call>
        
        <call function="'deleteFile'">
          { 'location'   : STAF_REMOTE_HOSTNAME ,
            'filename'   : '%s.zip' % InstanceInstallDir }
        </call>
                 
      </sequence>
    </catch>
 
    </try>
        
  </function>
 
  <function name="SetFolders">
    <function-prolog>
      This function sets the folders to which test data are written.  
    </function-prolog>
    <function-map-args>
      <function-arg-def name="sourceDir" type="required">
        <function-arg-description>
          A locally accessable directory to the tests source
        </function-arg-description>
        <function-arg-property name="type" value="structure"/>
      </function-arg-def>
      <function-arg-def name="localDir" type="required">
        <function-arg-description>
          A locally accessable directory to write test information 
        </function-arg-description>
        <function-arg-property name="type" value="structure"/>
      </function-arg-def>
      <function-arg-def name="remoteDir" type="required">
        <function-arg-description>
          A remotely accessable directory to write test information 
        </function-arg-description>
        <function-arg-property name="type" value="structure"/>
      </function-arg-def>
    </function-map-args>
 
    <sequence>
    
      <script>
        logs   = test_env.logs(localDir)
        source = test_env.source(sourceDir,TESTS_TYPE)
        local  = test_env.data(localDir)
        remote = test_env.data(remoteDir)                
      </script>
 
      <message>'source.directory = %s' % source.directory</message>
      <message>'local.directory  = %s' % local.directory</message>
      <message>'remote.directory = %s' % remote.directory</message>
      <message>'logs.directory   = %s' % logs.directory</message>
                  
      <return>
        local.directory
      </return>
 
    </sequence>
 
  </function>
  
  <function name="CreateFolders" scope="local">
    <function-prolog>
      This function sets the folders to which logs are written  
    </function-prolog>
 
    <sequence>
        
      <!-- Create folders -->
      <message>'Create local folder %s' % logs.reports</message>      
      <call function="'createFolder'">
        { 'location' : STAF_LOCAL_HOSTNAME, 
          'foldername' : '%s' % logs.reports }
      </call> 
 
      <message>'Create local folder %s' % local.temp</message>            
      <call function="'createFolder'">
        { 'location' : STAF_LOCAL_HOSTNAME, 
          'foldername' : '%s' % local.temp }
      </call>   
 
      <message>'Create local folder %s' % logs.sut</message>
      <call function="'createFolder'">
        { 'location' : STAF_LOCAL_HOSTNAME, 
          'foldername' : '%s' % logs.sut }
      </call>   
 
      <message>'Create local folder %s' % logs.tests</message>
      <call function="'createFolder'">
        { 'location' : STAF_LOCAL_HOSTNAME, 
          'foldername' : '%s' % logs.tests }
      </call>   
      
      <message>'Create local folder %s' % local.testdata</message>
      <call function="'createFolder'">
        { 'location' : STAF_LOCAL_HOSTNAME, 
          'foldername' : '%s' % local.testdata }
      </call>
 
      <message>'Create remote folder %s' % remote.temp</message>
      <call function="'createFolder'">
        { 'location' : STAF_REMOTE_HOSTNAME, 
          'foldername' : '%s' % remote.temp }
      </call>
                                            
    </sequence>
        
  </function>  
  
  <function name="loadGlobalEnvironment">
    <function-prolog>
      This function loads the environment (libraries, functions, variables)
      needed by the global test job farmer.
    </function-prolog>
    
    <sequence>
 
      <message>
        'Load environment for test suite execution.'  
      </message>    
  
      <call function="'importSharedLibraries'"/>
      
      <call function="'importPythonLibraries'"/>
      
      <call function="'initialiseGlobalVariables'"/>
 
      <message>
        'Remove files from previous runs under %s.' % DIRECTORY_INSTANCE_DIR
      </message>
      <call function="'deleteFolder'">
        { 'location'   : STAF_REMOTE_HOSTNAME ,
          'foldername' : '%s/%s' % (DIRECTORY_INSTANCE_DIR,OPENDSNAME) }
      </call>
      <call function="'createFolder'">
        { 'location'   : STAF_REMOTE_HOSTNAME ,
          'foldername' : '%s/%s' % (DIRECTORY_INSTANCE_DIR,OPENDSNAME) }
      </call>
 
      <call function="'GetDirectoryServerInformation'"/>
 
      <!-- Set variables to build unique path to store data -->
      <script>
        # Private
        logsArch=\
          DSInfo.getServerArch(DSInfo.ServerDict['system os'])
        logsOSName=\
          DSInfo.getServerOSName(DSInfo.ServerDict['system os'])
        logsOS='%s-%s' % (logsOSName,logsArch)
        logsJvm=\
          DSInfo.getServerJavaMajorMinor(DSInfo.ServerDict['java version'])        
      </script>  
 
      <call function="'SetFolders'">
        { 'sourceDir'  : '%s' % TESTS_ROOT,
          'localDir'  : '%s/%s-jvm%s' % (LOGS_ROOT,logsOS,logsJvm),
          'remoteDir' : DIRECTORY_INSTANCE_DIR }
      </call>
            
      <call function="'SetVar'">
        { 'location'  : STAF_REMOTE_HOSTNAME,
          'type'      : 'shared',
          'variable'  : 'Job%s_LogsDir=%s' % (STAXJobID,local.directory) }
      </call>
 
      <!-- Create the local folders to store data -->      
      <call function="'CreateFolders'"/>
 
      <!-- Create folders -->
      <message>'Copy OpenDS css and png files under %s' % logs.reports</message>
      <call function="'copyFile'">
        {
        'srcfile'    : '%s/opends.css' % TESTS_RESOURCE_DIR,
        'destfile'   : '%s/opends.css' % logs.reports
        }
      </call>
      <call function="'copyFile'">
        {
        'srcfile'    : '%s/opends_logo_sm.png' % TESTS_RESOURCE_DIR,
        'destfile'   : '%s/opends_logo_sm.png' % logs.reports
        }
      </call>
    </sequence>  
    
  </function>  
  
  <function name="loadJobEnvironment">
    <function-prolog>
      This function loads the environment (libraries, functions, variables)
      needed by the test jobs.
    </function-prolog>
    <function-map-args>
      <function-arg-def name="parent" type="optional" default="''">
        <function-arg-description>
          Location of target host
      </function-arg-description>
      <function-arg-property name="type" value="integer"/>
      </function-arg-def>   
    </function-map-args>
     
    <sequence>
 
      <message>
        'Load environment for test suite execution.'  
      </message>    
 
      <!-- All exceptions are logged to user log -->
      <script>
        STAXLogMessage = 1
      </script>
  
      <call function="'importSharedLibraries'"/>
      
      <call function="'importPythonLibraries'"/>
      
      <call function="'initialiseGlobalVariables'"/>
 
      <call function="'GetVar'">
        { 'location'  : STAF_REMOTE_HOSTNAME,
          'type'      : 'shared',
          'variable'  : 'Job%s_LogsDir' % parent }
      </call>
 
      <!-- TODO: defend against mangled STAFResult -->
      <script>
        parentsLogDir=STAFResult
      </script>
 
      <message>'%s' %  parentsLogDir</message>
           
      <call function="'SetFolders'">
        { 'sourceDir'  : '%s' % TESTS_ROOT,
          'localDir'  : '%s' % parentsLogDir,
          'remoteDir' : DIRECTORY_INSTANCE_DIR }
      </call>
    
    </sequence>  
    
  </function>
 
    
</stax>