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

Christophe Sovant
28.36.2008 36bd1964cc60fdff15d79b243404b68f343bb0e1
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
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<!DOCTYPE stax SYSTEM "../../../shared/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-2008 Sun Microsystems, Inc.
 ! -->
<stax>
  <defaultcall function="main_indexes" />
  <function name="main_indexes">
    <block name="'indexes'">
      <sequence>
        <script>
          CurrentTestPath={'group':'indexes','suite':'indexes'}
          envAlreadyLoaded='true'
          _setupSteps=['testGroup_Preamble','testSuite_Preamble',
                       'indexes_setup']
          _testSteps=['indexes_search', 'indexes_dynamic_modify',
                      'indexes_dynamic_add', 'indexes_remove', 'indexes_add']
          _cleanupSteps=['indexes_cleanup','testSuite_Postamble',
                         'testGroup_Postamble']
        </script>
        <!---
          #@TestSuiteName      Indexes
          #@TestSuitePurpose   test the database index feature from ldap
          #@TestSuiteGroup     indexes
          #@TestScript         indexes.xml
        -->
        
        <try>
          <!-- the pre-requisites are in a separate iteration -->
          <sequence>
            <iterate in="_setupSteps" var="_setupStep">
              <call function="_setupStep" />
            </iterate>
            <iterate in="_testSteps" var="_testStep" indexvar="_testStepNumber">
              <call function="_testStep" />
            </iterate>
          </sequence>
          <catch exception="'STAXException.Topology.CreationException'">
            <message log="1" level="'fatal'">
              'Could not create the topology. Bailing out.'
            </message>
          </catch>
          <catch exception="'STAXException.Topology.StartException'">
            <message log="1" level="'fatal'">
              'Could not start at least one server in the topology.Bailing out.'
            </message>
          </catch>
          <finally>
            <iterate in="_cleanupSteps" var="_cleanupStep">
              <call function="_cleanupStep" />
            </iterate>
          </finally>
        </try>
      </sequence>
    </block>
  </function>
  
  <function name="indexes_search" scope="local">
    <!---
      This set of tests loop through a set of search filters to verify that
      the default indexes behave as expected
      #@TestMarker                indexes
      #@TestName                  indexes_search
      #@TestIssue                 TODO: look up the issue in issue tracker
      #@TestPurpose               harden the default indexes
      #@TestPreamble              none
      #@TestStep                  iterate through file search.filters
      #@TestPostamble             none
      #@TestResult                Success if entry are indexed correctly
    -->
    <block name="'Search'">
      <sequence>
        <message log="1" level="'info'">
          'starting the search tests'
        </message>
        <call function="'loopThroughFilters'">
          { 'filters' : 'search' }
        </call>
      </sequence>
    </block>
  </function>
 
  
  <function name="indexes_modify" scope="local">
    <!--
      This test alters the uid default index so that it does subString search
      and then verifies that it worked
      #@TestMarker                indexes
      #@TestName                  indexes_search
      #@TestIssue                 TODO: look up the issue in issue tracker
      #@TestPurpose               harden the default indexes
      #@TestPreamble              none
      #@TestStep                  iterate through file search.filters
      #@TestPostamble             none
      #@TestResult                Success if entry are indexed correctly
    -->
    <block name="'Modify'">
      <sequence>
        <try>
          <sequence>
            <call function="'loopThroughFilters'">
              { 'filters' : 'before-modify' }
            </call>
            <call function="'runFunction'">
              { 'functionName'      : 'modifyIndex',
                'functionException' : 'LDAP.ModifyException',
                'functionFailureTC' : '%s: %s: %s' % (CurrentTestPath['group'],
                                                      CurrentTestPath['suite'], 
                                                      STAXCurrentBlock ) ,
                'functionMessage'   : 'Adding substring index to attribute uid',
                'functionArguments' : { 'operation'          : 'add',
                                        'indexAttribute'     : 'uid',
                                        'indexProperty'      : 'index-type',
                                        'indexPropertyValue' : 'substring'
                                      }
              }
            </call>
            <call function="'runFunction'">
              { 'functionName'      : 'StopDsWithScript',
                'functionException' : 'CLI.stop-ds',
                'functionFailureTC' : 'Indexes - Modify' ,
                'functionArguments' : { 'location'  : STAF_REMOTE_HOSTNAME,
                                        'dsHost'    : DIRECTORY_INSTANCE_HOST,
                                        'dsPort'    : DIRECTORY_INSTANCE_PORT,
                                        'dsBindDN'  : DIRECTORY_INSTANCE_DN  ,
                                        'dsBindPwd' : DIRECTORY_INSTANCE_PSWD }
              }
            </call>
            <call function="'runFunction'">
              { 'functionName'      : 'CLI_rebuild-index' ,
                'functionException' : 'CLI.RebuildIndex'  ,
                'functionFailureTC' : 'Indexes - Modify'  ,
                'functionArguments' : { 'baseDN'     : DIRECTORY_INSTANCE_SFX ,
                                        'attributes' : [ 'uid' ]
                                      }
              }
            </call>
            <call function="'runFunction'">
              { 'functionName'      : 'StartDsWithScript',
                'functionException' : 'CLI.start-ds',
                'functionFailureTC' : 'Indexes - Modify' ,
                'functionArguments' : { 'location' : STAF_REMOTE_HOSTNAME }
              }
            </call>
            <call function="'loopThroughFilters'">
              { 'filters' : 'after-modify' }
            </call>
          </sequence>
          <catch exception="'STAXException.LDAP.ModifyException'">
            <message log="1" level="'fatal'">
              'Fatal Error: Failed to alter index for attribute uid'
            </message>
          </catch>
          <catch exception="'STAXException.CLI.RebuildIndex'">
            <message log="1" level="'fatal'">
              'Fatal Error: Failed to rebuild index for attribute uid'
            </message>
          </catch>
        </try>
      </sequence>
    </block>
  </function>
 
 
 
  <function name="indexes_dynamic_modify" scope="local">
    <!--
      This test alters dynamically the uid default index so that it does 
      subString search and then verifies that it worked
      #@TestMarker                indexes
      #@TestName                  indexes_dynamic_modify
      #@TestIssue                 1480
      #@TestPurpose               harden the default indexes
      #@TestPreamble              none
      #@TestStep                  iterate through file search.filters
      #@TestPostamble             none
      #@TestResult                Success if entry are indexed correctly
    -->
    <block name="'Modify'">
      <sequence>
        <try>
          <sequence>
            <call function="'loopThroughFilters'">
              { 'filters' : 'before-modify' }
            </call>
            <call function="'runFunction'">
              { 'functionName'      : 'modifyIndex',
                'functionException' : 'LDAP.ModifyException',
                'functionFailureTC' : '%s: %s: %s' % (CurrentTestPath['group'],
                                                      CurrentTestPath['suite'], 
                                                      STAXCurrentBlock ) ,
                'functionMessage'   : 'Adding substring index to attribute uid',
                'functionArguments' : { 'operation'          : 'add',
                                        'indexAttribute'     : 'uid',
                                        'indexProperty'      : 'index-type',
                                        'indexPropertyValue' : 'substring'
                                      }
              }
            </call>
            <call function="'runFunction'">
              { 'functionName'      : 'rebuildIndexTask' ,
                'functionException' : 'CLI.RebuildIndex'  ,
                'functionFailureTC' : 'Indexes - Dynamic Modify'  ,
                'functionArguments' : 
                  { 'location'       : STAF_REMOTE_HOSTNAME,
                    'dsInstanceHost' : DIRECTORY_INSTANCE_HOST,
                    'dsInstancePort' : DIRECTORY_INSTANCE_PORT,
                    'dsInstanceDn'   : DIRECTORY_INSTANCE_DN,
                    'dsInstancePswd' : DIRECTORY_INSTANCE_PSWD,
                    'taskID'         : 'rebuild uid index task',
                    'baseDN'         : DIRECTORY_INSTANCE_SFX ,
                    'attributes'     : [ 'uid' ]
                  }
              }
            </call>
            <call function="'loopThroughFilters'">
              { 'filters' : 'after-modify' }
            </call>
          </sequence>
          <catch exception="'STAXException.LDAP.ModifyException'">
            <message log="1" level="'fatal'">
              'Fatal Error: Failed to alter index for attribute uid'
            </message>
          </catch>
          <catch exception="'STAXException.CLI.RebuildIndex'">
            <message log="1" level="'fatal'">
              'Fatal Error: Failed to rebuild index for attribute uid'
            </message>
          </catch>
        </try>
      </sequence>
    </block>
  </function>
 
    
                
  <function name="indexes_add" scope="local">
    <!--
      This test adds a new presence and equality index for l attribute
      and then verifies that it worked
      #@TestMarker              indexes
      #@TestName                indexes_add
      #@TestIssue               TODO: look up the issue in issue tracker
      #@TestPurpose             check if the user can add her own indexes
      #@TestPreamble            none
      #@TestStep                iterate through filters prior to adding indexes
      #@TestStep                add the indexes
      #@TestStep                iterate through filters after to adding indexes
      #@TestPostamble           none
      #@TestResult              Success if entry are indexed correctly
    -->
    <block name="'Add'">
      <sequence>
        <try>
          <sequence>
            <call function="'loopThroughFilters'">
              { 'filters' : 'before-add' }
            </call>
            <call function="'runFunction'">
              { 'functionName'      : 'addIndex',
                'functionException' : 'LDAP.AddIndexException',
                'functionFailureTC' : 'Indexes - Add',
                'functionMessage'   : 'Adding presence and equality index to \
                                       attribute l',
                'functionArguments' : { 'indexAttribute'    : 'l',
                                        'indexTypes'        : [ 'presence', 
                                                                'equality' ]
                                      }
              }
            </call>
  
            <call function="'runFunction'">
              { 'functionName'      : 'StopDsWithScript',
                'functionException' : 'CLI.stop-ds',
                'functionFailureTC' : '%s: %s: %s' % (CurrentTestPath['group'], 
                                                      CurrentTestPath['suite'], 
                                                      STAXCurrentBlock ) ,
                'functionArguments' : { 'location'  : STAF_REMOTE_HOSTNAME,
                                        'dsHost'    : DIRECTORY_INSTANCE_HOST,
                                        'dsPort'    : DIRECTORY_INSTANCE_PORT,
                                        'dsBindDN'  : DIRECTORY_INSTANCE_DN  ,
                                        'dsBindPwd' : DIRECTORY_INSTANCE_PSWD 
                                      }
              }
            </call>
            <call function="'runFunction'">
              { 'functionName'      : 'CLI_rebuild-index' ,
                'functionException' : 'CLI.RebuildIndex'  ,
                'functionFailureTC' : 'Indexes - Modify'  ,
                'functionArguments' : { 'baseDN'     : DIRECTORY_INSTANCE_SFX ,
                                        'attributes' : [ 'l' ]  
                                      }
              }
            </call>
            <call function="'runFunction'">
              { 'functionName'      : 'StartDsWithScript',
                'functionException' : 'CLI.start-ds',
                'functionFailureTC' : '%s: %s:  ' ,
                'functionArguments' : { 'location' : STAF_REMOTE_HOSTNAME }
              }
            </call>
            <call function="'loopThroughFilters'">
              { 'filters' : 'after-add' }
            </call>
          </sequence>
          <catch exception="'STAXException.LDAP.AddIndexException'">
            <message log="1" level="'fatal'">
              'Fatal Error: Failed to add index for attribute l'
            </message>
          </catch>
          <catch exception="'STAXException.CLI.RebuildIndex'">
            <message log="1" level="'fatal'">
              'Fatal Error: Failed to rebuild index for attribute l'
            </message>
          </catch>
        </try>
      </sequence>
    </block>
  </function>
 
 
 
  <function name="indexes_dynamic_add" scope="local">
    <!--
      This test adds dynamically a new presence and equality index for l 
      attribute and then verifies that it worked
      #@TestMarker              indexes
      #@TestName                indexes_dynamic_add
      #@TestIssue               1480
      #@TestPurpose             check if the user can add her own indexes
                                dynamically
      #@TestPreamble            none
      #@TestStep                iterate through filters prior to adding indexes
      #@TestStep                add the indexes
      #@TestStep                iterate through filters after to adding indexes
      #@TestPostamble           none
      #@TestResult              Success if entry are indexed correctly
    -->
    <block name="'Add'">
      <sequence>
        <try>
          <sequence>
            <call function="'loopThroughFilters'">
              { 'filters' : 'before-add' }
            </call>
            <call function="'runFunction'">
              { 'functionName'      : 'addIndex',
                'functionException' : 'LDAP.AddIndexException',
                'functionFailureTC' : 'Indexes - Add',
                'functionMessage'   : 'Adding presence and equality index to \
                                       attribute l',
                'functionArguments' : { 'indexAttribute'    : 'l',
                                        'indexTypes'        : [ 'presence', 
                                                                'equality' ]
                                      }
              }
            </call>
            <call function="'runFunction'">
              { 'functionName'      : 'rebuildIndexTask' ,
                'functionException' : 'CLI.RebuildIndex'  ,
                'functionFailureTC' : 'Indexes - Dynamic Add'  ,
                'functionArguments' : 
                  { 'location'       : STAF_REMOTE_HOSTNAME,
                    'dsInstanceHost' : DIRECTORY_INSTANCE_HOST,
                    'dsInstancePort' : DIRECTORY_INSTANCE_PORT,
                    'dsInstanceDn'   : DIRECTORY_INSTANCE_DN,
                    'dsInstancePswd' : DIRECTORY_INSTANCE_PSWD,
                    'taskID'         : 'rebuild l index task',
                    'baseDN'         : DIRECTORY_INSTANCE_SFX ,
                    'attributes'     : [ 'l' ]
                  }
              }
            </call>  
            <call function="'loopThroughFilters'">
              { 'filters' : 'after-add' }
            </call>
          </sequence>
          <catch exception="'STAXException.LDAP.AddIndexException'">
            <message log="1" level="'fatal'">
              'Fatal Error: Failed to add index for attribute l'
            </message>
          </catch>
          <catch exception="'STAXException.CLI.RebuildIndex'">
            <message log="1" level="'fatal'">
              'Fatal Error: Failed to rebuild index for attribute l'
            </message>
          </catch>            
        </try>
      </sequence>
    </block>
  </function>
            
  
  <function name="indexes_remove" scope="local">
    <!--
      This test does a bunch of searches on the 
      and then verifies that it worked
      #@TestMarker              indexes
      #@TestName                indexes_remove
      #@TestIssue               TODO: look up the issue in issue tracker
      #@TestPurpose             Check if the user can remove indexes
      #@TestPreamble            none
      #@TestStep                iterate through filters prior to removing index
      #@TestStep                remove index
      #@TestStep                iterate through filters after to removing index
      #@TestPostamble           none
      #@TestResult              Success if entry are indexed as expected
    -->
    <block name="'Remove'">
      <sequence>
        <try>
          <sequence>
            <call function="'loopThroughFilters'">
              { 'filters' : 'before-remove' }
            </call>
            <call function="'runFunction'">
              { 'functionName'      : 'removeIndex',
                'functionException' : 'LDAP.RemoveIndexException',
                'functionFailureTC' : '%s: %s: %s' % (CurrentTestPath['group'],
                                                      CurrentTestPath['suite'],
                                                      STAXCurrentBlock),
                'functionMessage'   : 'Removing index on attribute l' ,
                'functionArguments' : { 'indexAttribute'    : 'l' }
              }
            </call>
            <call function="'loopThroughFilters'">
              { 'filters' : 'after-remove' }
            </call>
          </sequence>
          <catch exception="'STAXException.LDAP.RemoveIndexException'">
            <message log="1" level="'fatal'">
              'Fatal Error: Failed to remove index for attribute l'
            </message>
          </catch>
        </try>
      </sequence>
    </block>
  </function>
 
  <function name="indexes_entry_limit">
    <!--
      This test does a bunch of searches on the 
      and then verifies that it worked
      #@TestMarker              indexes
      #@TestName                indexes_remove
      #@TestIssue               TODO: look up the issue in issue tracker
      #@TestPurpose             Check if the user can remove indexes
      #@TestPreamble            none
      #@TestStep                iterate through filters prior to removing index
      #@TestStep                remove index
      #@TestStep                iterate through filters after to removing index
      #@TestPostamble           none
      #@TestResult              Success if entry are indexed as expected
    -->
    <block name="'Entry_Limit'">
      <sequence>
        <try>
          <sequence>
            <call function="'loopThroughFilters'">
              { 'filters' : 'before-entry-limit' }
            </call>
            <call function="'runFunction'">
              { 'functionName'      : 'modifyIndex',
                'functionException' : 'LDAP.ModifyIndexException',
                'functionFailureTC' : '%s: %s: %s' % (CurrentTestPath['group'],
                                                      CurrentTestPath['suite'],
                                                      STAXCurrentBlock),
                'functionMessage'   : 'Modify index entry limit on attribute \
                                       uid'  ,
                'functionArguments' : { 'operation'          : 'set',
                                        'indexAttribute'     : 'uid',
                                        'indexProperty'  : 'index-entry-limit',
                                        'indexPropertyValue' : '3'
                                      }
              }
            </call>
            <call function="'loopThroughFilters'">
              { 'filters' : 'after-entry-limit' }
            </call>
          </sequence>
          <catch exception="'STAXException.LDAP.RemoveIndexException'">
            <message log="1" level="'fatal'">
              'Fatal Error: Failed to remove index for attribute l'
            </message>
          </catch>
        </try>
      </sequence>
    </block>
  </function>
 
  <function name="indexes_vlv_add">
    <!--
      This test does a bunch of searches on the 
      and then verifies that it worked
      #@TestMarker              indexes
      #@TestName                indexes_vlv_add
      #@TestIssue               TODO: look up the issue in issue tracker
      #@TestPurpose             Check if the user can remove indexes
      #@TestPreamble            none
      #@TestStep                iterate through filters prior to removing index
      #@TestStep                remove index
      #@TestStep                iterate through filters after to removing index
      #@TestPostamble           none
      #@TestResult              Success if entry are indexed as expected
    -->
    <block name="'Entry_Limit'">
      <sequence>
        <try>
          <sequence>
            <call function="'loopThroughFilters'">
              { 'filters' : 'before-entry-limit' }
            </call>
            <call function="'runFunction'">
              { 'functionName'      : 'modifyIndex',
                'functionException' : 'LDAP.ModifyIndexException',
                'functionFailureTC' : '%s: %s: %s' % (CurrentTestPath['group'],
                                                      CurrentTestPath['suite'],
                                                      STAXCurrentBlock),
                'functionMessage'   : 'Modify index entry limit on attribute \
                                       uid'  ,
                'functionArguments' : { 'operation'          : 'set',
                                        'indexAttribute'     : 'uid',
                                        'indexProperty'  : 'index-entry-limit' ,
                                        'indexPropertyValue' : '3'
                                      }
              }
            </call>
            <call function="'loopThroughFilters'">
              { 'filters' : 'after-entry-limit' }
            </call>
          </sequence>
          <catch exception="'STAXException.LDAP.RemoveIndexException'">
            <message log="1" level="'fatal'">
              'Fatal Error: Failed to remove index for attribute l'
            </message>
          </catch>
        </try>
      </sequence>
    </block>
  </function>
 
  
  <function name="loopThroughFilters" scope="local">
    <function-map-args>
      <function-arg-def name="filters" type="required" />
    </function-map-args>
    <sequence>
      <script>
        class indexTest:
          "Describes an index test with indexed attribute, filter to test with \
           and expected behaviour"
          def __init__(self, attribute,testName,filter,expectedValue,isIndexed):
            self.attribute = attribute
            self.name = testName
            self.filter = filter
            self.rc = expectedValue
            self.isIndexed=re.compile(r'[\r\n]').sub('',isIndexed)
            self.status='fail'
          
          def getAttribute(self):
            return self.attribute
            
          def getName(self):
            return self.name
            
          def getFilter(self):
            return self.filter
          
          def getRC(self):
            return self.rc
            
          def getSearchString(self):
            if self.isIndexed.startswith('NOT'):
              return 'NOT'
            else:
              return 'INDEX:%s' % (self.attribute)
            
          def pass(self):
            self.status='pass'
            
          def getStatus(self):
            return self.status
            
          def desc(self):
            description  = 'test:: name=[%s]\n' % self.name
            description += 'test:: attribute=[%s]\n' % self.attribute
            description += 'test:: filter=[%s]\n' % self.filter
            description += 'test:: rc=[%s]\n' % self.rc
            description += 'test:: indexed=[%s]\n' % self.isIndexed
            return description
            
        indexTests = []
        
        f = open('%s/testcases/indexes/%s.filters' % (TESTS_DIR,filters),'r')
        for line in f.readlines():
          if line.startswith('#'):
            continue
          else: 
            testLine = line.split(' ')
            indexTests.append(indexTest(testLine[0], testLine[1], testLine[2], 
                              testLine[3], testLine[4]))
        f.close()
          
        indexTestNumber=0
        previousTestName=''
        testNumber=0
      </script>
      <iterate var="test" in="indexTests">
        <sequence>
          <script>
          indexTestNumber=indexTestNumber+1
          if previousTestName != test.getName():
            previousTestName=test.getName()
            testNumber=0
            
          </script>
          <testcase name="'%s: %d.%s: %03d-%03d.%s: %s%02d' 
            % ( CurrentTestPath['group'], len(_testSteps)-_testStepNumber, 
                filters, len(indexTests)-indexTestNumber, indexTestNumber, 
                test.getAttribute(), test.getName(), testNumber)" >
            <sequence>
              <call function="'testCase_Preamble'" />
              <message log="1" level="'trace'">
                'Searching attribute [%s] with filter[%s]' \
                 % (test.getAttribute(),test.getFilter())
              </message>
              <call function="'SearchObject'">
                { 'dsInstanceHost'   : DIRECTORY_INSTANCE_HOST,
                  'dsInstancePort'   : DIRECTORY_INSTANCE_PORT,
                  'dsInstanceDn'     : DIRECTORY_INSTANCE_DN,
                  'dsInstancePswd'   : DIRECTORY_INSTANCE_PSWD,
                  'dsBaseDN'         : 'ou=People,dc=example,%s' \
                                        % DIRECTORY_INSTANCE_SFX ,
                  'dsFilter'         : '%s' % test.getFilter(),
                  'attributes'       : 'debugsearchindex',
                  'expectedRC'       : 'noCheck'
                }
              </call>
              <script>
                searchReturnCode, searchResultString = STAXResult[0]
                # chop off the first line that contains the dn
                searchResultString = re.compile(r'^dn:.*\n?').sub('',
                                                             searchResultString)
                # join multiple lines into a single one
                searchResultString = re.compile(r'[ \t]*\r?\n[ \t]*').sub('',
                                                             searchResultString)
                srt=searchResultString.split('[')[1]
                if (str(searchReturnCode) == str(test.getRC())) and \
                    srt.startswith(test.getSearchString()):
                  test.pass()
              </script>
              <message level="'trace'">
                '%s\nsearchReturnCode=[%s]\nldapsearch return \
                 string=[%s]\nchunk to parse=[%s]\nstring looked for=[%s]' \
                 % (test.desc(), searchReturnCode, searchResultString, srt, 
                    test.getSearchString())
              </message>
              <tcstatus result="test.getStatus()" />
              <call function="'testCase_Postamble'" />
              <script>
                testNumber=testNumber+1
              </script>
            </sequence>
          </testcase>
        </sequence>
      </iterate>
    </sequence>
  </function>
  
  <!-- Setup the instance for indexes tests -->
  <function name="indexes_setup">
    <sequence>
      <call function="'runFunction'">
        { 'functionName'      : 'createTopology',
          'functionMessage'   : 'Create DS topology as described in config.py',
          'functionException' : 'Topology.CreationException',
          'functionArguments' : { 'initialiseInstance' : True }
        }
      </call>
      <call function="'runFunction'">
        { 'functionName'      : 'StartDsWithScript'                                      ,
          'functionMessage'   : 'Start DS to run on port %s' \
                                 % (DIRECTORY_INSTANCE_PORT) ,
          'functionArguments' : { 'location' : STAF_REMOTE_HOSTNAME }
        }
      </call>
      <call function="'runFunction'">
        { 'functionName'      : 'isAlive',
          'functionMessage'   : 'Checking if the server is available',
          'functionException' : 'Topology.StartException',
          'functionArguments' : { 'noOfLoops'        : 5,
                                  'noOfMilliSeconds' : 2000 
                                }
        }
      </call>
    </sequence>
  </function>
  
  <!-- cleanup after the tests -->
  <function name="indexes_cleanup">
    <sequence>
      <call function="'runFunction'">
        { 'functionName'      : 'StopDsWithScript' ,
          'functionMessage'   : 'Stop DS running on port %s' \
                                 % (DIRECTORY_INSTANCE_PORT),
          'functionArguments' : { 'location'  : STAF_REMOTE_HOSTNAME,
                                  'dsHost'    : DIRECTORY_INSTANCE_HOST,
                                  'dsPort'    : DIRECTORY_INSTANCE_PORT,
                                  'dsBindDN'  : DIRECTORY_INSTANCE_DN,
                                  'dsBindPwd' : DIRECTORY_INSTANCE_PSWD }
        }
      </call>
      <call function="'runFunction'">
        { 'functionName'    : 'removeTopology',
          'functionMessage' : 'Remove DS topology created for the Test Suite'
        }
      </call>
    </sequence>
  </function>
</stax>