dsadm.xml revision d6c71e7b06ef8919af4c8186b4ffb08766c20a09
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<!--
! 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
! 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>
<function name="configureDS">
<function-prolog>
This function configures a Directory Server
</function-prolog>
<function-map-args>
<function-required-arg name="dsInstancePort">
Directory Server port number
</function-required-arg>
<function-required-arg name="dsInstanceSuffix">
Directory Server suffix
</function-required-arg>
</function-map-args>
<sequence>
<process name="'Configure DS'">
<location>'%s' % (STAF_REMOTE_HOSTNAME) </location>
<parms>'-p %s -b "%s"' % (dsInstancePort,dsInstanceSuffix)</parms>
<workdir>'%s' % (OPENDS_BINPATH)</workdir>
<envs>
</envs>
<stderr mode="'stdout'"/>
<returnstdout/>
</process>
<call function="'checkRC'">
{ 'returncode' : RC ,
'result' : STAXResult }
</call>
</sequence>
</function>
<function name="startDS">
<function-prolog>
This function starts a Directory Server
</function-prolog>
<function-map-args>
<function-required-arg name="dsbinpath">
location of the Directory Server binaries
</function-required-arg>
</function-map-args>
<sequence>
<process name="'Start DS'">
<location>'%s' % (STAF_REMOTE_HOSTNAME) </location>
<workdir>'%s' % (dsbinpath)</workdir>
<envs>
</envs>
<console use="'same'"/>
<stderr mode="'stdout'"/>
<returnstdout/>
</process>
<call function="'checkRC'">
{ 'returncode' : RC ,
'result' : STAXResult }
</call>
</sequence>
</function>
<function name="stopDS">
<function-prolog>
This function stops a Directory Server
</function-prolog>
<function-map-args>
<function-required-arg name="dsInstancePort">
Directory Server port number
</function-required-arg>
</function-map-args>
<sequence>
<process name="'Stop DS'">
<location>'%s' % (STAF_REMOTE_HOSTNAME) </location>
<parms>'-p %s' % (dsInstancePort)</parms>
<workdir>'%s' % (OPENDS_BINPATH)</workdir>
<envs>
</envs>
<stderr mode="'stdout'"/>
<returnstdout/>
</process>
<call function="'checkRC'">
{ 'returncode' : RC ,
'result' : STAXResult }
</call>
</sequence>
</function>
<function name="genServerJKSCert">
<function-prolog>
This function generates a server jks certificate
</function-prolog>
<sequence>
<process name="'Generate Server JKS Certificate'">
<location>'%s' % (STAF_REMOTE_HOSTNAME) </location>
<parms>'-genkey -alias server-cert -keyalg rsa -dname "cn=client,O=Sun Microsystems,C=US" -keystore "keystore" -storepass "servercert" -keypass "servercert"'</parms>
<envs>
</envs>
<stderr mode="'stdout'"/>
<returnstdout/>
</process>
<call function="'checkRC'">
{ 'returncode' : RC ,
'result' : STAXResult }
</call>
</sequence>
</function>
<function name="genServerPKCS12Cert">
<function-prolog>
This function generates a server PKCS12 certificate
</function-prolog>
<sequence>
<process name="'Generate Server PKCS12 Certificate'">
<location>'%s' % (STAF_REMOTE_HOSTNAME) </location>
<parms>'-genkey -alias server-cert -keyalg rsa -dname "cn=client,O=Sun Microsystems,C=US" -keystore "keystore" -storepass "servercert" -keypass "servercert" -storetype "PKCS12"'</parms>
<envs>
</envs>
<stderr mode="'stdout'"/>
<returnstdout/>
</process>
<call function="'checkRC'">
{ 'returncode' : RC ,
'result' : STAXResult }
</call>
</sequence>
</function>
<function name="selfSignServerJKSCert">
<function-prolog>
This function self-signs a server JKS certificate
</function-prolog>
<sequence>
<process name="'Self-Signs Server JKS Certificate'">
<location>'%s' % (STAF_REMOTE_HOSTNAME) </location>
<parms>'-selfcert -alias server-cert -keystore "keystore" -storepass "servercert"'</parms>
<envs>
</envs>
<stderr mode="'stdout'"/>
<returnstdout/>
</process>
<call function="'checkRC'">
{ 'returncode' : RC ,
'result' : STAXResult }
</call>
</sequence>
</function>
<function name="selfSignServerPKCS12Cert">
<function-prolog>
This function self-signs a server PKCS12 certificate
</function-prolog>
<sequence>
<process name="'Self-Signs Server PKCS12 Certificate'">
<location>'%s' % (STAF_REMOTE_HOSTNAME) </location>
<parms>'-selfcert -alias server-cert -keystore "keystore" -storepass "servercert" -storetype "PKCS12"'</parms>
<envs>
</envs>
<stderr mode="'stdout'"/>
<returnstdout/>
</process>
<call function="'checkRC'">
{ 'returncode' : RC ,
'result' : STAXResult }
</call>
</sequence>
</function>
<!-- Import Function -->
<function name="importLdif">
<function-prolog>
This function performs an offline import of an ldif file
</function-prolog>
<function-map-args>
<function-required-arg name="ldifFile">
The name of the ldif file
</function-required-arg>
<function-optional-arg name="backEnd" default="'userRoot'">
The name of the database backend
</function-optional-arg>
<function-optional-arg name="extraParams" default="' '">
Optional extra parameters for specific test cases
</function-optional-arg>
</function-map-args>
<sequence>
<message>
'import-ldif%s -l %s -n %s %s' % (fileExt,ldifFile,backEnd,extraParams)
</message>
<process name="'Offline Import'">
<location>'%s' % (STAF_REMOTE_HOSTNAME) </location>
<parms>'-l %s -n %s %s' % (ldifFile,backEnd,extraParams)</parms>
<workdir>'%s' % (OPENDS_BINPATH)</workdir>
<envs>
</envs>
<stderr mode="'stdout'"/>
<returnstdout/>
</process>
<script>
importRC=RC
importResult=STAXResult
</script>
<call function="'checkRC'">
{ 'returncode' : importRC ,
'result' : importResult }
</call>
<return>importRC</return>
</sequence>
</function>
<!-- Import Task Function -->
<function name="importLdifTask">
<function-prolog>
This function performs an on line import task of an ldif file
</function-prolog>
<function-map-args>
<function-required-arg name="dsInstanceHost">
Directory Server host name
</function-required-arg>
<function-required-arg name="dsInstancePort">
Directory Server port number
</function-required-arg>
<function-required-arg name="dsInstanceDn">
Directory Server Manager DN
</function-required-arg>
<function-required-arg name="dsInstancePswd">
Directory Server Manager Password
</function-required-arg>
<function-required-arg name="taskID">
The identifier for the task
</function-required-arg>
<function-required-arg name="ldifFile">
The name of the ldif file
</function-required-arg>
<function-optional-arg name="backEnd" default="'userRoot'">
Optional the name of the database backend
</function-optional-arg>
<function-optional-arg name="isCompressed" default="'FALSE'">
Optional imported ldif data file compressed
</function-optional-arg>
<function-optional-arg name="isEncrypted" default="'FALSE'">
Optional imported ldif data file encrypted
</function-optional-arg>
<function-optional-arg name="rejectsFile" default="' '">
Optional name of rejects file
</function-optional-arg>
<function-optional-arg name="overwriteRejectsFile" default="'FALSE'">
Optional name of rejects file
</function-optional-arg>
<function-optional-arg name="append" default="'FALSE'">
Optional append imported ldif data
</function-optional-arg>
<function-optional-arg name="skipSchemaValidation" default="'FALSE'">
Optional don't do schema validation on import
</function-optional-arg>
<function-optional-arg name="replaceExisting" default="'TRUE'">
Optional replace existing data
</function-optional-arg>
<function-optional-arg name="excludeBranches" default="' '">
Optional exclude branches
</function-optional-arg>
<function-optional-arg name="includeBranches" default="' '">
Optional include branches
</function-optional-arg>
<function-optional-arg name="excludeAttributes" default="' '">
Optional exclude attributes
</function-optional-arg>
<function-optional-arg name="includeAttributes" default="' '">
Optional include attributes
</function-optional-arg>
<function-optional-arg name="excludeFilters" default="' '">
Optional exclude filters
</function-optional-arg>
<function-optional-arg name="includeFilters" default="' '">
Optional include filters
</function-optional-arg>
</function-map-args>
<sequence>
<script>
taskDN='ds-task-id=%s,cn=Scheduled Tasks,cn=Tasks' % taskID
</script>
<!-- Build the import task configuration object -->
<script>
ldifLines=[]
ldifLines.append('dn: %s' % taskDN)
ldifLines.append('objectclass: top')
ldifLines.append('objectclass: ds-task')
ldifLines.append('objectclass: ds-task-import')
</script>
<script>
ldifLines.append('ds-task-import-backend-id: %s' % backEnd )
ldifLines.append('ds-task-import-ldif-file: %s' % ldifFile )
ldifLines.append('ds-task-import-is-compressed: %s' % isCompressed )
ldifLines.append('ds-task-import-is-encrypted: %s' % isEncrypted )
</script>
<if expr="rejectsFile != ' '">
<script>
ldifLines.append('ds-task-import-reject-file: %s' % rejectsFile )
</script>
</if>
<script>
ldifLines.append('ds-task-import-overwrite-rejects: %s' % overwriteRejectsFile )
ldifLines.append('ds-task-import-append: %s' % append )
ldifLines.append('ds-task-import-skip-schema-validation: %s' % skipSchemaValidation )
ldifLines.append('ds-task-import-replace-existing: %s' % replaceExisting )
</script>
<iterate var="branch" in="excludeBranches">
<sequence>
<if expr="branch == ' '">
<break/>
</if>
<script>
ldifLines.append('ds-task-import-exclude-branch: %s' % branch )
</script>
</sequence>
</iterate>
<iterate var="branch" in="includeBranches">
<sequence>
<if expr="branch == ' '">
<break/>
</if>
<script>
ldifLines.append('ds-task-import-include-branch: %s' % branch )
</script>
</sequence>
</iterate>
<iterate var="attribute" in="excludeAttributes">
<sequence>
<if expr="attribute == ' '">
<break/>
</if>
<script>
ldifLines.append('ds-task-import-exclude-attribute: %s' % attribute )
</script>
</sequence>
</iterate>
<iterate var="attribute" in="includeAttributes">
<sequence>
<if expr="attribute == ' '">
<break/>
</if>
<script>
ldifLines.append('ds-task-import-include-attribute: %s' % attribute )
</script>
</sequence>
</iterate>
<iterate var="filter" in="excludeFilters">
<sequence>
<if expr="filter == ' '">
<break/>
</if>
<script>
ldifLines.append('ds-task-import-exclude-filter: %s' % filter)
</script>
</sequence>
</iterate>
<iterate var="filter" in="includeFilters">
<sequence>
<if expr="filter == ' '">
<break/>
</if>
<script>
ldifLines.append('ds-task-import-include-filter: %s' % filter)
</script>
</sequence>
</iterate>
<!-- Write out the import-task ldif -->
<script>
outfile = open('%s/import-task.ldif' % TMP_DATA_DIR,"w")
for line in ldifLines:
outfile.write("%s\n" % line)
</script>
<!-- Copy the import-task ldif to remote host -->
<message>'Copy import task ldif file.'</message>
<call function="'copyfile'">
{ 'srcfile' : '%s/import-task.ldif' % TMP_DATA_DIR,
'destfile' : '%s/import-task.ldif' % STAGED_DATA_DIR,
'remotehost' : STAF_REMOTE_HOSTNAME }
</call>
<!-- On line Import Task with ldapmodify -->
<message>
'ldapmodify%s -a -h %s -p %s -D "%s" -w %s' % (fileExt,dsInstanceHost,dsInstancePort,dsInstanceDn,dsInstancePswd)
</message>
<process name="'On line Import Task'">
<location>'%s' % (STAF_REMOTE_HOSTNAME) </location>
<parms>'-a -h %s -p %s -D "%s" -w %s' % (dsInstanceHost,dsInstancePort,dsInstanceDn,dsInstancePswd)</parms>
<workdir>'%s' % (OPENDS_BINPATH)</workdir>
<envs>
</envs>
<stderr mode="'stdout'"/>
<returnstdout/>
</process>
<script>
importTaskRC=RC
importTaskResult=STAXResult
</script>
<call function="'checkRC'">
{ 'returncode' : importTaskRC ,
'result' : importTaskResult }
</call>
<!-- Check that the task is completed -->
<script>
loopRC=1
</script>
<script>
import re
searchre = re.compile('ds-task-state: COMPLETED_SUCCESSFULLY')
</script>
<!-- Wait for the task to be COMPLETED_SUCCESSFULLY -->
<loop from="1" to="5" while="loopRC != 0">
<sequence>
<message>
'ldapsearch%s -h %s -p %s -D "%s" -w %s -s base -b "%s" "objectclass=*" ds-task-state' % (fileExt,dsInstanceHost,dsInstancePort,dsInstanceDn,dsInstancePswd,taskDN)
</message>
<process name="'Search On line Import Task'">
<location>'%s' % (STAF_REMOTE_HOSTNAME) </location>
<parms>'-h %s -p %s -D "%s" -w %s -s base -b "%s" "objectclass=*" ds-task-state' % (dsInstanceHost,dsInstancePort,dsInstanceDn,dsInstancePswd,taskDN)</parms>
<workdir>'%s' % (OPENDS_BINPATH)</workdir>
<envs>
</envs>
<stderr mode="'stdout'"/>
<returnstdout/>
</process>
<script>
searchRC=RC
searchResult=STAXResult
</script>
<script>
result = STAXResult[0][1]
</script>
<if expr='re.search(searchre, result) != None'>
<sequence>
<script>loopRC=0</script>
</sequence>
<else>
<message log="1" level="'Warning'">
'No match on ds-task-state.'
</message>
</else>
</if>
<call function="'checkRC'">
{ 'returncode' : searchRC ,
'result' : searchResult }
</call>
<call function="'Sleep'">
{ 'sleepForMilliSeconds' : '2000' }
</call>
</sequence>
</loop>
<return>loopRC</return>
</sequence>
</function>
<!-- Check Import Function -->
<function name="checkImport">
<function-prolog>
This function verifies an import of an ldif file
</function-prolog>
<function-map-args>
<function-required-arg name="expectedEntries">
Entries expected to be present after import
</function-required-arg>
<function-optional-arg name="missingEntries" default="'NULL'">
Optional entries expected to be present after import
</function-optional-arg>
<function-optional-arg name="expectedAttributes" default="'NULL'">
Optional attributes expected to be present after import
</function-optional-arg>
<function-optional-arg name="missingAttributes" default="'NULL'">
Optional attributes expected to be present after import
</function-optional-arg>
<function-optional-arg name="suffix" default="'dc=com'">
Optional main suffix for the import
</function-optional-arg>
<function-optional-arg name="startDS" default="'yes'">
Optional start the Directory Server after import
</function-optional-arg>
</function-map-args>
<sequence>
<!-- If we don't want to start DS then we don't need to stop it -->
<script>stopDS=startDS</script>
<!-- Do we need to start the DS -->
<if expr="startDS == 'yes'">
<sequence>
<!-- StartDS -->
<call function="'startDS'">
{ 'dsbinpath' : '%s' % (OPENDS_BINPATH) }
</call>
<!-- Wait for DS to start -->
<call function="'isAlive'">
{ 'noOfLoops' : 5 ,
'noOfMilliSeconds' : 2000 }
</call>
</sequence>
</if>
<!-- Search for expected entries -->
<iterate var="expectedEntry" in="expectedEntries">
<sequence>
<call function="'SearchObject'">
{ 'dsInstanceHost' : DIRECTORY_INSTANCE_HOST ,
'dsInstancePort' : DIRECTORY_INSTANCE_PORT ,
'dsInstanceDn' : DIRECTORY_INSTANCE_DN ,
'dsInstancePswd' : DIRECTORY_INSTANCE_PSWD ,
'dsBaseDN' : '%s' % expectedEntry ,
'dsFilter' : 'objectclass=*'
}
</call>
<call function="'checktestRC'">
{ 'returncode' : RC ,
'result' : STAXResult }
</call>
</sequence>
</iterate>
<!-- Search for missing entries -->
<iterate var="missingEntry" in="missingEntries">
<sequence>
<if expr="missingEntry == 'NULL'">
<break/>
</if>
<call function="'SearchObject'">
{ 'dsInstanceHost' : DIRECTORY_INSTANCE_HOST ,
'dsInstancePort' : DIRECTORY_INSTANCE_PORT ,
'dsInstanceDn' : DIRECTORY_INSTANCE_DN ,
'dsInstancePswd' : DIRECTORY_INSTANCE_PSWD ,
'dsBaseDN' : '%s' % missingEntry ,
'dsFilter' : 'objectclass=*'
}
</call>
<call function="'checktestRC'">
{ 'returncode' : RC ,
'result' : STAXResult,
'expected' : 32 }
</call>
</sequence>
</iterate>
<!-- Do we need to stop the Directory Server -->
<if expr="stopDS == 'yes'">
<!-- StopDS -->
<call function="'stopDS'">
{ 'dsInstancePort' : '%s' % (DIRECTORY_INSTANCE_PORT) }
</call>
</if>
</sequence>
</function>
</stax>