<?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
|
!
|
! Portions Copyright 2006-2007 Sun Microsystems, Inc.
|
! -->
|
<stax>
|
|
<!-- This function configures DS using the configure-ds script -->
|
<function name="ConfigureDsWithScript">
|
<function-prolog>
|
This function configures a Directory Server using a script
|
</function-prolog>
|
|
<function-map-args>
|
<function-arg-def name="location" type="optional" default="'%s' % STAXServiceMachine">
|
<function-arg-description>
|
Location of target host
|
</function-arg-description>
|
<function-arg-property name="type" value="filepath"/>
|
</function-arg-def>
|
<function-arg-def name="dsPath" type="optional" default="'%s/%s' % (DIRECTORY_INSTANCE_DIR,OPENDSNAME)">
|
<function-arg-description>
|
Pathname to installation root
|
</function-arg-description>
|
<function-arg-property name="type" value="hostname"/>
|
</function-arg-def>
|
<function-arg-def name="dsPort" type="optional" default="''">
|
<function-arg-description>
|
Directory server port number
|
</function-arg-description>
|
<function-arg-property name="type" value="integer"/>
|
</function-arg-def>
|
<function-arg-def name="dsBaseDN" type="optional" default="''">
|
<function-arg-description>
|
Base DN (only single base DN supported).
|
</function-arg-description>
|
<function-arg-property name="type" value="DN"/>
|
</function-arg-def>
|
<function-arg-def name="dsBindDN" type="optional" default="''">
|
<function-arg-description>
|
Bind DN
|
</function-arg-description>
|
<function-arg-property name="type" value="integer"/>
|
</function-arg-def>
|
<function-arg-def name="dsBindPwd" type="optional" default="''">
|
<function-arg-description>
|
Bind password
|
</function-arg-description>
|
<function-arg-property name="type" value="integer"/>
|
</function-arg-def>
|
<function-arg-def name="dsBindPwdFile" type="optional" default="''">
|
<function-arg-description>
|
Bind password file
|
</function-arg-description>
|
<function-arg-property name="type" value="filename"/>
|
</function-arg-def>
|
<function-arg-def name="dsHelp" type="optional" default="''">
|
<function-arg-description>
|
Help option
|
</function-arg-description>
|
<function-arg-property name="type" value="filename"/>
|
</function-arg-def>
|
</function-map-args>
|
|
<sequence>
|
|
<!-- Build the Command -->
|
<script>
|
STAFCmdParamsList=[]
|
|
if dsPath:
|
STAFCmd='%s/bin/configure-ds%s' % (dsPath,fileExt)
|
|
if dsPort:
|
STAFCmdParamsList.append('-p %s' % dsPort)
|
|
if dsBaseDN:
|
STAFCmdParamsList.append('-b "%s"' % dsBaseDN)
|
|
if dsBindDN:
|
STAFCmdParamsList.append('-D "%s"' % dsBindDN)
|
|
if dsBindPwd:
|
STAFCmdParamsList.append('-w "%s"' % dsBindPwd)
|
|
if dsBindPwdFile:
|
STAFCmdParamsList.append('-W "%s"' % dsBindPwdFile)
|
|
if dsHelp:
|
STAFCmdParamsList.append('-H')
|
|
STAFCmdParams=' '.join(STAFCmdParamsList)
|
</script>
|
|
<message>
|
'%s %s' % (STAFCmd, STAFCmdParams)
|
</message>
|
|
<process name="'Configure DS Script'">
|
<location>'%s' % location</location>
|
<command>'%s' % STAFCmd</command>
|
<parms>'%s' % STAFCmdParams</parms>
|
<workdir>'%s/bin' % dsPath</workdir>
|
<envs>
|
['PATH=/bin:/usr/bin:%s/bin' % dsPath, 'JAVA_HOME=%s' % JAVA_HOME]
|
</envs>
|
<console use="'same'"/>
|
<stderr mode="'stdout'"/>
|
<returnstdout/>
|
</process>
|
<call function="'checkRC'">
|
{ 'returncode' : RC ,
|
'result' : STAXResult }
|
</call>
|
</sequence>
|
</function>
|
|
<!-- This function starts DS using the start-ds script -->
|
<function name="StartDsWithScript">
|
<function-prolog>
|
This function starts a Directory Server
|
</function-prolog>
|
|
<function-map-args>
|
<function-arg-def name="location" type="optional" default="'%s' % STAXServiceMachine">
|
<function-arg-description>
|
Location of target host
|
</function-arg-description>
|
<function-arg-property name="type" value="hostname"/>
|
</function-arg-def>
|
<function-arg-def name="dsPath" type="optional" default="'%s/%s' % (DIRECTORY_INSTANCE_DIR,OPENDSNAME)">
|
<function-arg-description>
|
Pathname to installation root
|
</function-arg-description>
|
<function-arg-property name="type" value="hostname"/>
|
</function-arg-def>
|
<function-arg-def name="dsPort" type="optional" default="''">
|
<function-arg-description>
|
Directory server port number
|
</function-arg-description>
|
<function-arg-property name="type" value="integer"/>
|
</function-arg-def>
|
<function-arg-def name="dsVersion" type="optional" default="''">
|
<function-arg-description>
|
Directory server version
|
</function-arg-description>
|
<function-arg-property name="type" value="option"/>
|
</function-arg-def>
|
<function-arg-def name="dsSystemInfo" type="optional" default="''">
|
<function-arg-description>
|
Directory server system info
|
</function-arg-description>
|
<function-arg-property name="type" value="option"/>
|
</function-arg-def>
|
<function-arg-def name="dsNoDetach" type="optional" default="''">
|
<function-arg-description>
|
Do not detach directory server from process
|
</function-arg-description>
|
<function-arg-property name="type" value="option"/>
|
</function-arg-def>
|
<function-arg-def name="dsHelp" type="optional" default="''">
|
<function-arg-description>
|
Help option
|
</function-arg-description>
|
<function-arg-property name="type" value="option"/>
|
</function-arg-def>
|
</function-map-args>
|
|
<sequence>
|
|
<!-- Build the Command -->
|
<script>
|
STAFCmdParamsList=[]
|
|
if dsPath:
|
STAFCmd='%s/bin/start-ds%s' % (dsPath,fileExt)
|
|
if dsVersion:
|
STAFCmdParamsList.append('-v')
|
|
if dsSystemInfo:
|
STAFCmdParamsList.append('-s')
|
|
if dsNoDetach:
|
STAFCmdParamsList.append('-N')
|
|
if dsHelp:
|
STAFCmdParamsList.append('-H')
|
|
STAFCmdParams=' '.join(STAFCmdParamsList)
|
</script>
|
|
<message>
|
'%s %s' % (STAFCmd, STAFCmdParams)
|
</message>
|
|
<process name="'Start DS Script'">
|
<location>'%s' % location</location>
|
<command>'%s' % STAFCmd</command>
|
<parms>'%s' % STAFCmdParams</parms>
|
<workdir>'%s/bin' % dsPath</workdir>
|
<envs>
|
['PATH=/bin:/usr/bin:%s/bin' % dsPath, 'JAVA_HOME=%s' % JAVA_HOME]
|
</envs>
|
<console use="'same'"/>
|
<stderr mode="'stdout'"/>
|
<returnstdout/>
|
</process>
|
|
<call function="'checkRC'">
|
{ 'returncode' : RC ,
|
'result' : STAXResult }
|
</call>
|
|
</sequence>
|
|
</function>
|
|
<!-- This function stops DS using the stop-ds script -->
|
<function name="StopDsWithScript">
|
<function-prolog>
|
This function starts a Directory Server using the script
|
</function-prolog>
|
|
<function-map-args>
|
|
<function-arg-def name="location" type="optional" default="'%s' % STAXServiceMachine">
|
<function-arg-description>
|
Location of target host
|
</function-arg-description>
|
<function-arg-property name="type" value="hostname"/>
|
</function-arg-def>
|
<function-arg-def name="dsPath" type="optional" default="'%s/%s' % (DIRECTORY_INSTANCE_DIR,OPENDSNAME)">
|
<function-arg-description>
|
Pathname to installation root
|
</function-arg-description>
|
<function-arg-property name="type" value="hostname"/>
|
</function-arg-def>
|
<function-arg-def name="dsHost" type="optional" default="''">
|
<function-arg-description>
|
Directory server hostname or IP address
|
</function-arg-description>
|
<function-arg-property name="type" value="hostname"/>
|
</function-arg-def>
|
<function-arg-def name="dsPort" type="optional" default="''">
|
<function-arg-description>
|
Directory server port number
|
</function-arg-description>
|
<function-arg-property name="type" value="integer"/>
|
</function-arg-def>
|
<function-arg-def name="dsUseSSL" type="optional" default="''">
|
<function-arg-description>
|
Use SSL for secure communication with the server
|
</function-arg-description>
|
<function-arg-property name="type" value="option"/>
|
</function-arg-def>
|
<function-arg-def name="dsUseStartTLS" type="optional" default="''">
|
<function-arg-description>
|
Use StartTLS for secure communication with the server
|
</function-arg-description>
|
<function-arg-property name="type" value="option"/>
|
</function-arg-def>
|
<function-arg-def name="dsBindDN" type="optional" default="''">
|
<function-arg-description>
|
Bind DN
|
</function-arg-description>
|
<function-arg-property name="type" value="DN"/>
|
</function-arg-def>
|
<function-arg-def name="dsBindPwd" type="optional" default="''">
|
<function-arg-description>
|
Bind password
|
</function-arg-description>
|
<function-arg-property name="type" value="string"/>
|
</function-arg-def>
|
<function-arg-def name="dsBindPwdFile" type="optional" default="''">
|
<function-arg-description>
|
Bind password file
|
</function-arg-description>
|
<function-arg-property name="type" value="filepath"/>
|
</function-arg-def>
|
<function-arg-def name="dsSaslOption" type="optional" default="''">
|
<function-arg-description>
|
SASL bind options
|
</function-arg-description>
|
<function-arg-property name="type" value="option"/>
|
</function-arg-def>
|
<function-arg-def name="dsProxyAuthZID" type="optional" default="''">
|
<function-arg-description>
|
Use the proxied authorization control with the given authorization ID
|
</function-arg-description>
|
<function-arg-property name="type" value="option"/>
|
</function-arg-def>
|
<function-arg-def name="dsStopReason" type="optional" default="''">
|
<function-arg-description>
|
Reason the server is being stopped or restarted
|
</function-arg-description>
|
<function-arg-property name="type" value="string"/>
|
</function-arg-def>
|
<function-arg-def name="dsRestart" type="optional" default="''">
|
<function-arg-description>
|
Attempt to automatically restart the server once it has stopped
|
</function-arg-description>
|
<function-arg-property name="type" value="option"/>
|
</function-arg-def>
|
<function-arg-def name="dsStopTime" type="optional" default="''">
|
<function-arg-description>
|
Time to begin the shutdown in YYYYMMDDhhmmss format (local time)
|
</function-arg-description>
|
<function-arg-property name="type" value="timestamp"/>
|
</function-arg-def>
|
<function-arg-def name="dsTrustAll" type="optional" default="''">
|
<function-arg-description>
|
Trust all server SSL certificates
|
</function-arg-description>
|
<function-arg-property name="type" value="option"/>
|
</function-arg-def>
|
<function-arg-def name="dsKeyStoreFile" type="optional" default="''">
|
<function-arg-description>
|
Certificate keystore path
|
</function-arg-description>
|
<function-arg-property name="type" value="filename"/>
|
</function-arg-def>
|
<function-arg-def name="dsKeyStorePwd" type="optional" default="''">
|
<function-arg-description>
|
Certificate keystore PIN
|
</function-arg-description>
|
<function-arg-property name="type" value="string"/>
|
</function-arg-def>
|
<function-arg-def name="dsKeyStorePwdFile" type="optional" default="''">
|
<function-arg-description>
|
Certificate keystore PIN file
|
</function-arg-description>
|
<function-arg-property name="type" value="filename"/>
|
</function-arg-def>
|
<function-arg-def name="dsTrustStoreFile" type="optional" default="''">
|
<function-arg-description>
|
Certificate trust store path
|
</function-arg-description>
|
<function-arg-property name="type" value="filename"/>
|
</function-arg-def>
|
<function-arg-def name="dsTrustStorePwd" type="optional" default="''">
|
<function-arg-description>
|
Certificate trust store PIN
|
</function-arg-description>
|
<function-arg-property name="type" value="string"/>
|
</function-arg-def>
|
<function-arg-def name="dsTrustStorePwdFile" type="optional" default="''">
|
<function-arg-description>
|
Certificate trust store PIN file
|
</function-arg-description>
|
<function-arg-property name="type" value="filename"/>
|
</function-arg-def>
|
<function-arg-def name="dsHelp" type="optional" default="''">
|
<function-arg-description>
|
Help option
|
</function-arg-description>
|
<function-arg-property name="type" value="option"/>
|
</function-arg-def>
|
</function-map-args>
|
|
<sequence>
|
|
<!-- Build the Command -->
|
<script>
|
STAFCmdParamsList=[]
|
|
if dsPath:
|
STAFCmd='%s/bin/stop-ds%s' % (dsPath,fileExt)
|
|
if dsHost:
|
STAFCmdParamsList.append('-h %s' % dsHost)
|
|
if dsPort:
|
STAFCmdParamsList.append('-p %s' % dsPort)
|
|
if dsUseSSL:
|
STAFCmdParamsList.append('-Z')
|
|
if dsUseStartTLS:
|
STAFCmdParamsList.append('-q')
|
|
if dsBindDN:
|
STAFCmdParamsList.append('-D "%s"' % dsBindDN)
|
|
if dsBindPwd:
|
STAFCmdParamsList.append('-w "%s"' % dsBindPwd)
|
|
if dsBindPwdFile:
|
STAFCmdParamsList.append('-j "%s"' % dsBindPwdFile)
|
|
if dsSaslOption:
|
STAFCmdParamsList.append('-o "%s"' % dsSaslOption)
|
|
if dsProxyAuthZID:
|
STAFCmdParamsList.append('-Y "%s"' % dsProxyAuthZID)
|
|
if dsStopReason:
|
STAFCmdParamsList.append('-r "%s"' % dsStopReason)
|
|
if dsRestart:
|
STAFCmdParamsList.append('-R')
|
|
if dsStopTime:
|
STAFCmdParamsList.append('-t "%s"' % dsStopTime)
|
|
if dsTrustAll:
|
STAFCmdParamsList.append('-X')
|
|
if dsKeyStoreFile:
|
STAFCmdParamsList.append('-K "%s"' % dsKeyStoreFile)
|
|
if dsKeyStorePwd:
|
STAFCmdParamsList.append('-W "%s"' % dsKeyStorePwd)
|
|
if dsKeyStorePwdFile:
|
STAFCmdParamsList.append('-u "%s"' % dsKeyStorePwdFile)
|
|
if dsTrustStoreFile:
|
STAFCmdParamsList.append('-P "%s"' % dsTrustStoreFile)
|
|
if dsTrustStorePwd:
|
STAFCmdParamsList.append('-T "%s"' % dsTrustStorePwd)
|
|
if dsTrustStorePwdFile:
|
STAFCmdParamsList.append('-U "%s"' % dsTrustStorePwdFile)
|
|
if dsHelp:
|
STAFCmdParamsList.append('-H')
|
|
STAFCmdParams=' '.join(STAFCmdParamsList)
|
</script>
|
|
<message>
|
'%s %s' % (STAFCmd, STAFCmdParams)
|
</message>
|
|
<process name="'Stop DS Script'">
|
<location>'%s' % (location)</location>
|
<command>'%s' % (STAFCmd)</command>
|
<parms>'%s' % (STAFCmdParams)</parms>
|
<workdir>'%s/bin' % dsPath</workdir>
|
<envs>
|
['PATH=/bin:/usr/bin:%s/bin' % dsPath, 'JAVA_HOME=%s' % JAVA_HOME]
|
</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>
|
<command>'%s/bin/keytool' % JAVA_HOME</command>
|
<parms>'-genkey -alias server-cert -keyalg rsa -dname "cn=client,O=Sun Microsystems,C=US" -keystore "keystore" -storepass "servercert" -keypass "servercert"'</parms>
|
<workdir>'%s/../config' % (OPENDS_BINPATH)</workdir>
|
<envs>
|
['PATH=/bin:/usr/bin:%s' % (OPENDS_BINPATH), 'JAVA_HOME=%s' % (JAVA_HOME)]
|
</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>
|
<command>'%s/bin/keytool' % JAVA_HOME</command>
|
<parms>'-genkey -alias server-cert -keyalg rsa -dname "cn=client,O=Sun Microsystems,C=US" -keystore "keystore" -storepass "servercert" -keypass "servercert" -storetype "PKCS12"'</parms>
|
<workdir>'%s/../config' % (OPENDS_BINPATH)</workdir>
|
<envs>
|
['PATH=/bin:/usr/bin:%s' % (OPENDS_BINPATH), 'JAVA_HOME=%s' % (JAVA_HOME)]
|
</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>
|
<command>'%s/bin/keytool' % JAVA_HOME</command>
|
<parms>'-selfcert -alias server-cert -keystore "keystore" -storepass "servercert"'</parms>
|
<workdir>'%s/../config' % (OPENDS_BINPATH)</workdir>
|
<envs>
|
['PATH=/bin:/usr/bin:%s' % (OPENDS_BINPATH), 'JAVA_HOME=%s' % (JAVA_HOME)]
|
</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>
|
<command>'%s/bin/keytool' % JAVA_HOME</command>
|
<parms>'-selfcert -alias server-cert -keystore "keystore" -storepass "servercert" -storetype "PKCS12"'</parms>
|
<workdir>'%s/../config' % (OPENDS_BINPATH)</workdir>
|
<envs>
|
['PATH=/bin:/usr/bin:%s' % (OPENDS_BINPATH), 'JAVA_HOME=%s' % (JAVA_HOME)]
|
</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="'%s' % DIRECTORY_INSTANCE_BE">
|
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>
|
<command>'%s/import-ldif%s' % (OPENDS_BINPATH,fileExt)</command>
|
<parms>'-l %s -n %s %s' % (ldifFile,backEnd,extraParams)</parms>
|
<workdir>'%s' % (OPENDS_BINPATH)</workdir>
|
<envs>
|
['PATH=/bin:/usr/bin:%s' % (OPENDS_BINPATH), 'JAVA_HOME=%s' % (JAVA_HOME)]
|
</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="'%s' % DIRECTORY_INSTANCE_BE">
|
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')
|
ldifLines.append('ds-task-class-name: org.opends.server.tasks.ImportTask')
|
</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)
|
|
outfile.close()
|
</script>
|
|
|
<!-- Copy the import-task ldif to remote host -->
|
<message>'Copy import task ldif (import-task.ldif) file from %s to %s' % (TMP_DATA_DIR,STAGED_DATA_DIR)</message>
|
<call function="'copyFile'">
|
{ 'location' : STAXServiceMachine,
|
'srcfile' : '%s/import-task.ldif' % TMP_DATA_DIR,
|
'destfile' : '%s/import-task.ldif' % STAGED_DATA_DIR,
|
'remotehost' : STAF_REMOTE_HOSTNAME }
|
</call>
|
|
<!-- Online Import Task with ldapmodify -->
|
<message>
|
'ldapmodify%s -a -h %s -p %s -D "%s" -w %s' % (fileExt,dsInstanceHost,dsInstancePort,dsInstanceDn,dsInstancePswd)
|
</message>
|
<process name="'Online Import Task'">
|
<location>'%s' % (STAF_REMOTE_HOSTNAME) </location>
|
<command>'%s/ldapmodify%s' % (OPENDS_BINPATH,fileExt)</command>
|
<parms>'-a -h %s -p %s -D "%s" -w %s' % (dsInstanceHost,dsInstancePort,dsInstanceDn,dsInstancePswd)</parms>
|
<workdir>'%s' % (OPENDS_BINPATH)</workdir>
|
<envs>
|
['PATH=/bin:/usr/bin:%s' % (OPENDS_BINPATH), 'JAVA_HOME=%s' % (JAVA_HOME)]
|
</envs>
|
<stdin>'%s/import-task.ldif' % STAGED_DATA_DIR</stdin>
|
<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>
|
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>
|
<command>'%s/ldapsearch%s' % (OPENDS_BINPATH,fileExt)</command>
|
<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>
|
['PATH=/bin:/usr/bin:%s' % (OPENDS_BINPATH), 'JAVA_HOME=%s' % (JAVA_HOME)]
|
</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="'%s' % DIRECTORY_INSTANCE_SFX">
|
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="'StartDsWithScript'">
|
{ 'location' : STAF_REMOTE_HOSTNAME }
|
</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="'StopDsWithScript'">
|
{ 'location' : STAF_REMOTE_HOSTNAME,
|
'dsHost' : DIRECTORY_INSTANCE_HOST,
|
'dsPort' : DIRECTORY_INSTANCE_PORT,
|
'dsBindDN' : DIRECTORY_INSTANCE_DN,
|
'dsBindPwd' : DIRECTORY_INSTANCE_PSWD }
|
</call>
|
</if>
|
</sequence>
|
</function>
|
|
|
<!-- Export Function -->
|
<function name="exportLdif">
|
<function-prolog>
|
This function performs an export to an ldif file on or off line
|
</function-prolog>
|
|
<function-map-args>
|
<function-required-arg name="ldifFile">
|
The name of the ldif file to be written
|
</function-required-arg>
|
<function-optional-arg name="backEnd" default="'%s' % DIRECTORY_INSTANCE_BE">
|
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>
|
'export-ldif%s -l %s -n %s %s' % (fileExt,ldifFile,backEnd,extraParams)
|
</message>
|
<process name="'Ldif Export'">
|
<location>'%s' % (STAF_REMOTE_HOSTNAME) </location>
|
<command>'%s/export-ldif%s' % (OPENDS_BINPATH,fileExt)</command>
|
<parms>'-l %s -n %s %s' % (ldifFile,backEnd,extraParams)</parms>
|
<workdir>'%s' % (OPENDS_BINPATH)</workdir>
|
<envs>
|
['PATH=/bin:/usr/bin:%s' % (OPENDS_BINPATH), 'JAVA_HOME=%s' % (JAVA_HOME)]
|
</envs>
|
<stderr mode="'stdout'"/>
|
<returnstdout/>
|
</process>
|
<script>
|
exportRC=RC
|
exportResult=STAXResult
|
</script>
|
<call function="'checkRC'">
|
{ 'returncode' : exportRC ,
|
'result' : exportResult }
|
</call>
|
<return>exportRC</return>
|
</sequence>
|
</function>
|
|
<!-- Export Task Function -->
|
<function name="exportLdifTask">
|
<function-prolog>
|
This function performs an on line export 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="'%s' % DIRECTORY_INSTANCE_BE">
|
Optional the name of the database backend
|
</function-optional-arg>
|
<function-optional-arg name="Compress" default="'FALSE'">
|
Optional exported ldif data file compressed
|
</function-optional-arg>
|
<function-optional-arg name="Encrypt" default="'FALSE'">
|
Optional exported ldif data file encrypted
|
</function-optional-arg>
|
<function-optional-arg name="append" default="'FALSE'">
|
Optional append exported ldif 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-optional-arg name="signHash" default="'FALSE'">
|
Optional generate a signed hash of the export data
|
</function-optional-arg>
|
</function-map-args>
|
|
<sequence>
|
<script>
|
taskDN='ds-task-id=%s,cn=Scheduled Tasks,cn=Tasks' % taskID
|
</script>
|
<!-- Build the export task configuration object -->
|
<script>
|
ldifLines=[]
|
ldifLines.append('dn: %s' % taskDN)
|
ldifLines.append('objectclass: top')
|
ldifLines.append('objectclass: ds-task')
|
ldifLines.append('objectclass: ds-task-export')
|
ldifLines.append('ds-task-class-name: org.opends.server.tasks.ExportTask')
|
ldifLines.append('ds-task-id: %s' % taskID)
|
</script>
|
<script>
|
ldifLines.append('ds-task-export-backend-id: %s' % backEnd )
|
ldifLines.append('ds-task-export-ldif-file: %s' % ldifFile )
|
ldifLines.append('ds-task-export-compress-ldif: %s' % Compress )
|
ldifLines.append('ds-task-export-encrypt-ldif: %s' % Encrypt )
|
ldifLines.append('ds-task-export-sign-hash: %s' % signHash )
|
</script>
|
|
<iterate var="branch" in="excludeBranches">
|
<sequence>
|
<if expr="branch == ' '">
|
<break/>
|
</if>
|
<script>
|
ldifLines.append('ds-task-export-exclude-branch: %s' % branch )
|
</script>
|
</sequence>
|
</iterate>
|
|
<iterate var="branch" in="includeBranches">
|
<sequence>
|
<if expr="branch == ' '">
|
<break/>
|
</if>
|
<script>
|
ldifLines.append('ds-task-export-include-branch: %s' % branch )
|
</script>
|
</sequence>
|
</iterate>
|
|
<iterate var="attribute" in="excludeAttributes">
|
<sequence>
|
<if expr="attribute == ' '">
|
<break/>
|
</if>
|
<script>
|
ldifLines.append('ds-task-export-exclude-attribute: %s' % attribute )
|
</script>
|
</sequence>
|
</iterate>
|
|
<iterate var="attribute" in="includeAttributes">
|
<sequence>
|
<if expr="attribute == ' '">
|
<break/>
|
</if>
|
<script>
|
ldifLines.append('ds-task-export-include-attribute: %s' % attribute )
|
</script>
|
</sequence>
|
</iterate>
|
|
<iterate var="filter" in="excludeFilters">
|
<sequence>
|
<if expr="filter == ' '">
|
<break/>
|
</if>
|
<script>
|
ldifLines.append('ds-task-export-exclude-filter: %s' % filter)
|
</script>
|
</sequence>
|
</iterate>
|
|
<iterate var="filter" in="includeFilters">
|
<sequence>
|
<if expr="filter == ' '">
|
<break/>
|
</if>
|
<script>
|
ldifLines.append('ds-task-export-include-filter: %s' % filter)
|
</script>
|
</sequence>
|
</iterate>
|
|
<!-- Write out the export-task ldif -->
|
<script>
|
outfile = open('%s/export-task.ldif' % TMP_DATA_DIR,"w")
|
|
for line in ldifLines:
|
outfile.write("%s\n" % line)
|
|
outfile.close()
|
</script>
|
|
<!-- Copy the export-task ldif to remote host -->
|
<message>'Copy export task ldif file.'</message>
|
<call function="'copyFile'">
|
{ 'location' : STAXServiceMachine,
|
'srcfile' : '%s/export-task.ldif' % TMP_DATA_DIR,
|
'destfile' : '%s/export-task.ldif' % STAGED_DATA_DIR,
|
'remotehost' : STAF_REMOTE_HOSTNAME }
|
</call>
|
|
<!-- On line Export 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 Export Task'">
|
<location>'%s' % (STAF_REMOTE_HOSTNAME) </location>
|
<command>'%s/ldapmodify%s' % (OPENDS_BINPATH,fileExt)</command>
|
<parms>'-a -h %s -p %s -D "%s" -w %s' % (dsInstanceHost,dsInstancePort,dsInstanceDn,dsInstancePswd)</parms>
|
<workdir>'%s' % (OPENDS_BINPATH)</workdir>
|
<envs>
|
['PATH=/bin:/usr/bin:%s' % (OPENDS_BINPATH), 'JAVA_HOME=%s' % (JAVA_HOME)]
|
</envs>
|
<stdin>'%s/export-task.ldif' % STAGED_DATA_DIR</stdin>
|
<stderr mode="'stdout'"/>
|
<returnstdout/>
|
</process>
|
|
<script>
|
exportTaskRC=RC
|
exportTaskResult=STAXResult
|
</script>
|
|
<call function="'checkRC'">
|
{ 'returncode' : exportTaskRC ,
|
'result' : exportTaskResult }
|
</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 Export Task'">
|
<location>'%s' % (STAF_REMOTE_HOSTNAME) </location>
|
<command>'%s/ldapsearch%s' % (OPENDS_BINPATH,fileExt)</command>
|
<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>
|
['PATH=/bin:/usr/bin:%s' % (OPENDS_BINPATH), 'JAVA_HOME=%s' % (JAVA_HOME)]
|
</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>
|
|
<!-- Backup Function -->
|
<function name="backup">
|
<function-prolog>
|
This function performs an on line backup
|
</function-prolog>
|
<function-map-args>
|
<function-required-arg name="backupDir">
|
The directory where the backup files will be placed
|
</function-required-arg>
|
<function-optional-arg name="backEnd" default="'%s' % DIRECTORY_INSTANCE_BE">
|
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>
|
'backup%s -n %s -d %s %s' % (fileExt,backEnd,backupDir,extraParams)
|
</message>
|
<process name="'Offline Backup'">
|
<location>'%s' % (STAF_REMOTE_HOSTNAME) </location>
|
<command>'%s/backup%s' % (OPENDS_BINPATH,fileExt)</command>
|
<parms>'-d %s -n %s %s' % (backupDir,backEnd,extraParams)</parms>
|
<workdir>'%s' % (OPENDS_BINPATH)</workdir>
|
<envs>
|
['PATH=/bin:/usr/bin:%s' % (OPENDS_BINPATH), 'JAVA_HOME=%s' % (JAVA_HOME)]
|
</envs>
|
<stderr mode="'stdout'"/>
|
<returnstdout/>
|
</process>
|
<script>
|
backupRC=RC
|
backupResult=STAXResult
|
</script>
|
<call function="'checkRC'">
|
{ 'returncode' : backupRC ,
|
'result' : backupResult }
|
</call>
|
<return>backupRC</return>
|
</sequence>
|
</function>
|
|
<!-- Backup Task Function -->
|
<function name="backupTask">
|
<function-prolog>
|
This function performs an on line backup task
|
</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="backupDir">
|
Path to the target directory for the backup file(s)
|
</function-required-arg>
|
<function-optional-arg name="backEnd" default="'%s' % DIRECTORY_INSTANCE_BE">
|
Optional the name of the database backend
|
</function-optional-arg>
|
<function-optional-arg name="backupAll" default="'FALSE'">
|
Optional back up all backends in the server
|
</function-optional-arg>
|
<function-optional-arg name="backupIncremental" default="' '">
|
Optional perform an incremental backup rather than a full backup
|
</function-optional-arg>
|
<function-optional-arg name="backupIncrementalId" default="' '">
|
Optional use the provided identifier for the backup
|
</function-optional-arg>
|
<function-optional-arg name="Compress" default="'FALSE'">
|
Optional backup contents compressed
|
</function-optional-arg>
|
<function-optional-arg name="Encrypt" default="'FALSE'">
|
Optional backup contents encrypted
|
</function-optional-arg>
|
<function-optional-arg name="signHash" default="'FALSE'">
|
Optional generate a signed hash of the backup data
|
</function-optional-arg>
|
<function-optional-arg name="hash" default="'FALSE'">
|
Optional generate a hash of the backup data
|
</function-optional-arg>
|
</function-map-args>
|
<sequence>
|
<script>
|
taskDN='ds-task-id=%s,cn=Scheduled Tasks,cn=Tasks' % taskID
|
</script>
|
|
<!-- Build the backup task configuration object -->
|
<script>
|
ldifLines=[]
|
ldifLines.append('dn: %s' % taskDN)
|
ldifLines.append('objectclass: top')
|
ldifLines.append('objectclass: ds-task')
|
ldifLines.append('objectclass: ds-task-backup')
|
ldifLines.append('ds-task-class-name: org.opends.server.tasks.BackupTask')
|
ldifLines.append('ds-backup-id: %s' % taskID)
|
</script>
|
|
<script>
|
ldifLines.append('ds-task-backup-backend-id: %s' % backEnd )
|
ldifLines.append('ds-backup-directory-path: %s' % backupDir )
|
ldifLines.append('ds-task-backup-all: %s' % backupAll )
|
ldifLines.append('ds-task-backup-compress: %s' % Compress )
|
ldifLines.append('ds-task-backup-encrypt: %s' % Encrypt )
|
ldifLines.append('ds-task-backup-sign-hash: %s' % signHash )
|
ldifLines.append('ds-task-backup-hash: %s' % hash )
|
</script>
|
|
<if expr="backupIncremental != ' '">
|
<script>
|
ldifLines.append('ds-task-backup-incremental: %s' % backupIncremental )
|
ldifLines.append('ds-task-backup-incremental-base-id: %s' % backupIncrementalId )
|
</script>
|
</if>
|
|
<!-- Write out the backup-task ldif -->
|
<script>
|
outfile = open('%s/backup-task.ldif' % TMP_DATA_DIR,"w")
|
|
for line in ldifLines:
|
outfile.write("%s\n" % line)
|
|
outfile.close()
|
</script>
|
|
<!-- Copy the backup-task ldif to remote host -->
|
<message>'Copy backup task ldif file.'</message>
|
<call function="'copyFile'">
|
{ 'location' : STAXServiceMachine,
|
'srcfile' : '%s/backup-task.ldif' % TMP_DATA_DIR,
|
'destfile' : '%s/backup-task.ldif' % STAGED_DATA_DIR,
|
'remotehost' : STAF_REMOTE_HOSTNAME }
|
</call>
|
|
<!-- On line Backup 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 Backup Task'">
|
<location>'%s' % (STAF_REMOTE_HOSTNAME) </location>
|
<command>'%s/ldapmodify%s' % (OPENDS_BINPATH,fileExt)</command>
|
<parms>'-a -h %s -p %s -D "%s" -w %s' % (dsInstanceHost,dsInstancePort,dsInstanceDn,dsInstancePswd)</parms>
|
<workdir>'%s' % (OPENDS_BINPATH)</workdir>
|
<envs>
|
['PATH=/bin:/usr/bin:%s' % (OPENDS_BINPATH), 'JAVA_HOME=%s' % (JAVA_HOME)]
|
</envs>
|
<stdin>'%s/backup-task.ldif' % STAGED_DATA_DIR</stdin>
|
<stderr mode="'stdout'"/>
|
<returnstdout/>
|
</process>
|
|
<script>
|
backupTaskRC=RC
|
backupTaskResult=STAXResult
|
</script>
|
|
<call function="'checkRC'">
|
{ 'returncode' : backupTaskRC ,
|
'result' : backupTaskResult }
|
</call>
|
|
<!-- Check that the task is completed -->
|
<script>
|
loopRC=1
|
</script>
|
|
<script>
|
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 Backup Task'">
|
<location>'%s' % (STAF_REMOTE_HOSTNAME) </location>
|
<command>'%s/ldapsearch%s' % (OPENDS_BINPATH,fileExt)</command>
|
<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>
|
['PATH=/bin:/usr/bin:%s' % (OPENDS_BINPATH), 'JAVA_HOME=%s' % (JAVA_HOME)]
|
</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>
|
|
<!-- Restore Function -->
|
<function name="restore">
|
<function-prolog>
|
This function performs an off line restore
|
</function-prolog>
|
<function-map-args>
|
<function-required-arg name="backupDir">
|
Path to the directory containing the backup file(s)
|
</function-required-arg>
|
<function-optional-arg name="extraParams" default="' '">
|
Optional extra parameters for specific test cases
|
</function-optional-arg>
|
</function-map-args>
|
<sequence>
|
<message>
|
'Stopping OpenDS'
|
</message>
|
<call function="'StopDsWithScript'">
|
{ 'location' : STAF_REMOTE_HOSTNAME,
|
'dsHost' : DIRECTORY_INSTANCE_HOST,
|
'dsPort' : DIRECTORY_INSTANCE_PORT,
|
'dsBindDN' : DIRECTORY_INSTANCE_DN,
|
'dsBindPwd' : DIRECTORY_INSTANCE_PSWD }
|
</call>
|
<call function="'checkRC'">
|
{ 'returncode' : RC ,
|
'result' : STAXResult }
|
</call>
|
<message>
|
'restore%s -d %s %s' % (fileExt,backupDir,extraParams)
|
</message>
|
<process name="'Offline restore'">
|
<location>'%s' % (STAF_REMOTE_HOSTNAME) </location>
|
<command>'%s/restore%s' % (OPENDS_BINPATH,fileExt)</command>
|
<parms>'-d %s %s' % (backupDir,extraParams)</parms>
|
<workdir>'%s' % (OPENDS_BINPATH)</workdir>
|
<envs>
|
['PATH=/bin:/usr/bin:%s' % (OPENDS_BINPATH), 'JAVA_HOME=%s' % (JAVA_HOME)]
|
</envs>
|
<stderr mode="'stdout'"/>
|
<returnstdout/>
|
</process>
|
<script>
|
restoreRC=RC
|
restoreResult=STAXResult
|
</script>
|
<call function="'checkRC'">
|
{ 'returncode' : restoreRC ,
|
'result' : restoreResult }
|
</call>
|
<message>
|
'Starting DS'
|
</message>
|
<call function="'StartDsWithScript'">
|
{ 'location' : STAF_REMOTE_HOSTNAME }
|
</call>
|
<call function="'checkRC'">
|
{ 'returncode' : RC ,
|
'result' : STAXResult }
|
</call>
|
<return>restoreRC</return>
|
</sequence>
|
</function>
|
|
<!-- Restore Task Function -->
|
<function name="restoreTask">
|
<function-prolog>
|
This function performs an on line restore task of a backup 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="backupDir">
|
The name of the backup directory
|
</function-required-arg>
|
<function-optional-arg name="backupId" default="' '">
|
Optional the name of the backupId
|
</function-optional-arg>
|
<function-optional-arg name="verify" default="'FALSE'">
|
Optional verify the contents of the backup but do not restore it
|
</function-optional-arg>
|
</function-map-args>
|
<sequence>
|
<script>
|
taskDN='ds-task-id=%s,cn=Scheduled Tasks,cn=Tasks' % taskID
|
</script>
|
<!-- Build the restore task configuration object -->
|
<script>
|
ldifLines=[]
|
ldifLines.append('dn: %s' % taskDN)
|
ldifLines.append('objectclass: top')
|
ldifLines.append('objectclass: ds-task')
|
ldifLines.append('objectclass: ds-task-restore')
|
ldifLines.append('ds-task-class-name: org.opends.server.tasks.RestoreTask')
|
ldifLines.append('ds-task-id: %s' % taskID)
|
</script>
|
<script>
|
ldifLines.append('ds-backup-directory-path: %s' % backupDir )
|
ldifLines.append('ds-task-restore-verify-only: %s' % verify )
|
</script>
|
<if expr="backupId != ' '">
|
<script>
|
ldifLines.append('ds-backup-id: %s' % backupId )
|
</script>
|
</if>
|
<!-- Write out the restore-task ldif -->
|
<script>
|
outfile = open('%s/restore-task.ldif' % TMP_DATA_DIR,"w")
|
|
for line in ldifLines:
|
outfile.write("%s\n" % line)
|
|
outfile.close()
|
</script>
|
|
<!-- Copy the restore-task ldif to remote host -->
|
<message>'Copy restore task ldif file.'</message>
|
<call function="'copyFile'">
|
{ 'location' : STAXServiceMachine,
|
'srcfile' : '%s/restore-task.ldif' % TMP_DATA_DIR,
|
'destfile' : '%s/restore-task.ldif' % STAGED_DATA_DIR,
|
'remotehost' : STAF_REMOTE_HOSTNAME }
|
</call>
|
|
<!-- On line Restore 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 Restore Task'">
|
<location>'%s' % (STAF_REMOTE_HOSTNAME) </location>
|
<command>'%s/ldapmodify%s' % (OPENDS_BINPATH,fileExt)</command>
|
<parms>'-a -h %s -p %s -D "%s" -w %s' % (dsInstanceHost,dsInstancePort,dsInstanceDn,dsInstancePswd)</parms>
|
<workdir>'%s' % (OPENDS_BINPATH)</workdir>
|
<envs>
|
['PATH=/bin:/usr/bin:%s' % (OPENDS_BINPATH), 'JAVA_HOME=%s' % (JAVA_HOME)]
|
</envs>
|
<stdin>'%s/restore-task.ldif' % STAGED_DATA_DIR</stdin>
|
<stderr mode="'stdout'"/>
|
<returnstdout/>
|
</process>
|
|
<script>
|
restoreTaskRC=RC
|
restoreTaskResult=STAXResult
|
</script>
|
|
<call function="'checkRC'">
|
{ 'returncode' : restoreTaskRC ,
|
'result' : restoreTaskResult }
|
</call>
|
|
<!-- Check that the task is completed -->
|
<script>
|
loopRC=1
|
</script>
|
|
<script>
|
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 Restore Task'">
|
<location>'%s' % (STAF_REMOTE_HOSTNAME) </location>
|
<command>'%s/ldapsearch%s' % (OPENDS_BINPATH,fileExt)</command>
|
<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>
|
['PATH=/bin:/usr/bin:%s' % (OPENDS_BINPATH), 'JAVA_HOME=%s' % (JAVA_HOME)]
|
</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>
|
</stax>
|
