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

al_xipe
24.24.2007 b7e6ddbc774e90cf71059050d8de7e652e6f0467
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
<?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
 !
 !      Portions Copyright 2006-2007 Sun Microsystems, Inc.
 ! -->
<stax>
  <defaultcall function="indexes" />
  <function name="indexes">
    <block name="'indexes'">
      <sequence>
        <script>
          CurrentTestPath={'group':'indexes','suite':'indexes'}
          envAlreadyLoaded='true'
          _setupSteps=['testGroup_Preamble','testSuite_Preamble','indexes_setup']
          _testSteps=['indexes_search','indexes_modify']
        </script>
        <!---
          #@TestSuiteName      Indexes
          #@TestSuitePurpose   test the database index feature from ldap
          #@TestSuiteGroup     indexes
          #@TestScript         indexes.xml
        -->
        
        <try>
          <!-- the pre-requisites are in a separate ite -->
          <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="['indexes_cleanup','testSuite_Postamble','testGroup_Postamble']" var="_cleanupStep">
              <call function="'%s' % _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="'indexes_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="'indexes_modify'">
      <sequence>
        <try>
          <sequence>
            <call function="'loopThroughFilters'">
              { 'filters' : 'before-modify' }
            </call>
            <call function="'runFunction'">
              { 'functionName'      : 'modifyAnAttribute',
                'functionException' : 'LDAP.ModifyException',
                'functionFailureTC' : 'Indexes - Modify' ,
                'functionMessage'   : 'Adding substring index to attribute uid'       ,
                'functionArguments' : { 'dsInstanceHost'    : DIRECTORY_INSTANCE_HOST ,
                                      'dsInstancePort'    : DIRECTORY_INSTANCE_PORT ,
                                      'dsInstanceDn'      : DIRECTORY_INSTANCE_DN   ,
                                      'dsInstancePswd'    : DIRECTORY_INSTANCE_PSWD ,
                                      'DNToModify'        : 'ds-cfg-index-attribute=uid,cn=Index,ds-cfg-backend-id=userRoot,cn=Backends,cn=config' ,
                                      'attributeName'     : 'ds-cfg-index-type'     ,
                                      'newAttributeValue' : 'substring'             ,
                                      'changetype'        : 'add'                   }
              }
            </call>
  
            <call function="'runFunction'">
              { 'functionName'      : 'StopDsWithScript'               ,
                'functionException' : 'CLI.stop-ds'                    ,
                'functionFailureTC' : 'Indexes - Modify' ,
                'functionArguments' : { 'location'  : STAF_LOCAL_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_LOCAL_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_add" scope="local">
  </function>
  
  <function name="indexes_rebuild" scope="local">
  </function>
  
  <function name="indexes_delete" scope="local">
  </function>
 
  <function name="indexes_verify" scope="local">
  </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=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 'COUNT'
            
          def pass(self):
            self.status='pass'
            
          def getStatus(self):
            return self.status
            
          def desc(self):
            description  = 'name=[%s]' % self.name
            description += ' attribute=[%s]' % self.attribute
            description += ' filter=[%s]' % self.filter
            description += ' rc=[%s]' % self.rc
            description += ' indexed=[%s]' % 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]))
          
        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="'Indexes: %d.%s: %03d-%03d.%s: %s%02d' % ( 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]
                srs=searchResultString.split('[')
                srt=srs[1]
                if (str(searchReturnCode) == str(test.getRC())) and srt.startswith(test.getSearchString()):
                  test.pass()
                    
              </script>
              <message level="'trace'">'%s searchReturnCode=[%s] srt=[%s] searchResultString=[%s] string looked for=[%s]' % (test.desc(), searchReturnCode, srt, searchResultString, test.getSearchString())</message>
              <tcstatus result="'%s' % 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>