<?xml version="1.0" encoding="UTF-8" standalone="no"?>

<!DOCTYPE stax SYSTEM "/shared/stax.dtd">

<stax>

<!-- ************************************************************ -->

<function name="checkRC" scope="local">

<function-prolog>

This function checks a return code against an expected return code

</function-prolog>

<function-map-args>

<function-arg-def name="returncode" type="required">

<function-arg-description>

return code received from command

</function-arg-description>

</function-arg-def>

<function-arg-def name="result" type="required">

<function-arg-description>

the output of the result

</function-arg-description>

</function-arg-def>

<function-arg-def name="expected" type="optional" default="[0]">

<function-arg-description>

the expected return code (list of value : [0] or [0,5])

</function-arg-description>

</function-arg-def>

<function-arg-def name="fileFd" type="optional" default="LOG_MAIN_FD">

<function-arg-description>

file descriptor, keywords : NO_FILE

</function-arg-description>

</function-arg-def>

</function-map-args>

<sequence>

<script>

_errNum = 0

verdict = 'FAIL'

for expRC in expected:

if ( expRC == returncode ):

verdict = 'PASS'

</script>

<if expr="verdict == 'PASS'">

<sequence>

<call function="'writeOperationResult'">

{

'returncode' : returncode,

'expected' : expected,

'result' : '',

'status' : 'SUCCESS',

'fileFd' : fileFd

}

</call>

</sequence>

<else>

<sequence>

<call function="'writeOperationResult'">

{

'returncode' : returncode,

'expected' : expected,

'result' : result,

'status' : 'ERROR',

'fileFd' : fileFd

}

</call>

<script>

_errNum = 1

</script>

</sequence>

</else>

</if>

<script>

ERR_NUM[0] += _errNum

</script>

<return>

_errNum

</return>

</sequence>

</function>

<!-- ************************************************************ -->

<function name="phasePreamble" scope="local">

<function-prolog>

Performs all the preoperations for a phase

</function-prolog>

<function-map-args>

<function-arg-def name="phase" type="required">

<function-arg-description>

phase object

</function-arg-description>

</function-arg-def>

<function-arg-def name="tagAttr" type="optional" default='[]'>

<function-arg-description>

attribute/value of the tag [[attr1,val1],[attr2,val2],...]

</function-arg-description>

</function-arg-def>

<function-arg-def name="fileFd" type="required">

</function-arg-def>

</function-map-args>

<sequence>

<!-- Start time of test suite -->

<script>

phase.setStartTime(strftime("%Y%m%d@%H:%M:%S",localtime()))

ERR_NUM[0] = 0

if tagAttr == []:

tagAttr = [['date',phase.getStartTime()]]

else:

tagAttr.append(['date',phase.getStartTime()])

</script>

<message log="1">''</message>

<message log="1">

'=================== START PHASE %s @ %s ========================='\

% (phase.getName(),phase.getStartTime())

</message>

<call function="'writeStartTagPhase'">

{

'tagName' : phase.getName(),

'tagAttr' : tagAttr,

'fileFd' : fileFd

}

</call>

</sequence>

</function>

<!-- ************************************************************ -->

<function name="phasePostamble" scope="local">

<function-prolog>

Performs all the post operations for a phase

</function-prolog>

<function-map-args>

<function-arg-def name="phase" type="required">

<function-arg-description>

phase object

</function-arg-description>

</function-arg-def>

<function-arg-def name="fileFd" type="required">

<function-arg-description>

Name of output file descriptor

</function-arg-description>

</function-arg-def>

</function-map-args>

<sequence>

<script>

phase.setRun('true')

phase.setStopTime(strftime("%Y%m%d@%H:%M:%S",localtime()))

phase.setErrNum(ERR_NUM[0])

</script>

<message log="1">

'== Found %s Error(s) during this phase' % (phase.getErrNum())

</message>

<message log="1">

'=================== STOP PHASE %s ============================' \

% (phase.getName())

</message>

<call function="'writeTag'">

{

'tagName' : 'phaseResult',

'tagAttr' : [['errNum',phase.getErrNum()]] ,

'fileFd' : LOG_MAIN_FD

}

</call>

<call function="'writeEndTagPhase'">

{

'fileFd' : LOG_MAIN_FD

}

</call>

</sequence>

</function>

<!-- ************************************************************ -->

<function name="sleep" scope="local">

<function-prolog>

Sleep for number of milliseconds

</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="sleepForMilliSeconds" type="required">

<function-arg-description>

Number of milliseconds to sleep

</function-arg-description>

<function-arg-property name="type" value="seconds"/>

</function-arg-def>

<function-arg-def name="silentMode" type="optional" default="FALSE">

<function-arg-description>

do not write message in log file if set to TRUE

</function-arg-description>

<function-arg-property name="type" value="seconds"/>

</function-arg-def>

<function-arg-def name="fileFd" type="required">

<function-arg-description>

Name of output file descriptor

</function-arg-description>

</function-arg-def>

</function-map-args>

<sequence>

<if expr="silentMode == 'FALSE'">

<sequence>

<call function="'writeStartTagOperation'">

{ 'tagName' : 'sleep',

'fileFd' : fileFd }

</call>

<call function="'writeMessage'">

{ 'fileFd' : fileFd,

'content' : 'sleep for %s milliseconds on %s' % (sleepForMilliSeconds,location)

}

</call>

</sequence>

</if>

<stafcmd name="'STAF Command: Delay'">

<location>'%s' % location</location>

<service>'delay'</service>

<request>

'delay %i' % sleepForMilliSeconds

</request>

</stafcmd>

<if expr="silentMode == 'FALSE'">

<sequence>

<call function="'checkRC'">

{ 'returncode' : RC ,

'result' : STAFResult,

'fileFd' : fileFd }

</call>

<call function="'writeEndTagOperation'">{'fileFd' : fileFd}</call>

</sequence>

</if>

</sequence>

</function>

<!-- ************************************************************ -->

<function name="ldifDiff" scope="local">

<function-prolog>

This function compares two LDIF files and reports the differences in LDIF format

</function-prolog>

<function-map-args>

<function-arg-def name="location" type="optional" default="STAF_REMOTE_HOSTNAME">

<function-arg-description>

Location of target host

</function-arg-description>

</function-arg-def>

<function-arg-def name="dsPath" type="required">

<function-arg-description>

Pathname to installation root

</function-arg-description>

</function-arg-def>

<function-arg-def name="version" type="optional">

<function-arg-description>

Display Directory Server version information

</function-arg-description>

</function-arg-def>

<function-arg-def name="sourceLdif" type="required">

<function-arg-description>

LDIF file to use as the source data

</function-arg-description>

</function-arg-def>

<function-arg-def name="targetLdif" type="required">

<function-arg-description>

LDIF file to use as the target data

</function-arg-description>

</function-arg-def>

<function-arg-def name="outputLdif" type="required">

<function-arg-description>

File to which the diffs should be written

</function-arg-description>

</function-arg-def>

<function-arg-def name="overwriteExisting" type="optional" default="TRUE">

<function-arg-description>

Overwrite existing output file rather than append to it

</function-arg-description>

</function-arg-def>

<function-arg-def name="singleValueChanges" type="optional">

<function-arg-description>

Write each attribute-level change as a separate modification

per attribute value rather than one modification per entry

</function-arg-description>

</function-arg-def>

<function-arg-def name="Help" type="optional">

<function-arg-description>

Help option

</function-arg-description>

</function-arg-def>

<function-arg-def name="fileFd" type="required">

<function-arg-description>

Name of output file descriptor

</function-arg-description>

</function-arg-def>

</function-map-args>

<sequence>

<call function="'writeStartTagOperation'">

{ 'tagName' : 'ldifDiff',

'fileFd' : fileFd }

</call>

<call function="'writeMessage'">

{ 'fileFd' : fileFd,

'content' : 'Compares two LDIF files and reports the differences in LDIF format'

}

</call>

<!-- Build the Command -->

<script>

STAFCmdParamsList=[]

STAFCmdParams=''

if dsPath:

dsBinPath='%s/bin' % (dsPath)

STAFCmd='%s/ldif-diff' % (dsBinPath)

if version:

STAFCmdParamsList.append('-V')

if sourceLdif:

STAFCmdParamsList.append('-s %s' % sourceLdif)

if targetLdif:

STAFCmdParamsList.append('-t %s' % targetLdif)

if outputLdif:

STAFCmdParamsList.append('-o %s' % outputLdif)

if overwriteExisting:

STAFCmdParamsList.append('-O')

if singleValueChanges:

STAFCmdParamsList.append('-S')

if Help:

STAFCmdParamsList.append('-H')

STAFCmdParams=' '.join(STAFCmdParamsList)

</script>

<call function="'writeMessage'">

{ 'fileFd' : fileFd,

'content' : '%s %s' % (STAFCmd,STAFCmdParams)

}

</call>

<process name="'LDIF Diff Script'">

<location>location</location>

<command>STAFCmd</command>

<parms>STAFCmdParams</parms>

<workdir>dsBinPath</workdir>

<envs>

['PATH=/bin:/usr/bin:%s' % dsBinPath]

</envs>

<console use="'same'"/>

<stderr mode="'stdout'"/>

<returnstdout/>

<returnfile>outputLdif</returnfile>

</process>

<script>

STAXCode=RC

STAXReason=STAXResult

</script>

<script>

diffsInfo = STAXReason[1]

diffs = diffsInfo[1]

if (diffsInfo[0] == 0) and (diffs.startswith("# No differences were detected between the source and target LDIF files")) :

diffRC = 0

else:

diffRC = 1

</script>

<call function="'checkRC'">

{ 'returncode' : diffRC,

'result' : 'diff file : %s' % outputLdif,

'fileFd' : fileFd }

</call>

<call function="'writeEndTagOperation'">{'fileFd' : fileFd}</call>

<return> diffRC </return>

</sequence>

</function>

<!-- ************************************************************ -->

<function name="grep" scope="local">

<function-prolog>

This function compares grep a string in a file

</function-prolog>

<function-map-args>

<function-arg-def name="location" type="optional" default="STAF_REMOTE_HOSTNAME">

<function-arg-description>

Location of target host

</function-arg-description>

</function-arg-def>

<function-arg-def name="string2grep" type="required">

<function-arg-description>

string to grep

</function-arg-description>

</function-arg-def>

<function-arg-def name="file" type="required">

<function-arg-description>

File where grep will be done

</function-arg-description>

</function-arg-def>

<function-arg-def name="expect2Find" type="optional" default="TRUE">

<function-arg-description>

if true, return SUCCESS if string2find is in the file

if false, return SUCCESS if string2find is NOT in the file

</function-arg-description>

</function-arg-def>

<function-arg-def name="caseSensitive" type="optional" default="TRUE">

<function-arg-description>

if true, grep with case sensitive mode

if false, grep with case insensitive mode

</function-arg-description>

</function-arg-def>

<function-arg-def name="fileFd" type="required">

<function-arg-description>

Name of output file descriptor

</function-arg-description>

</function-arg-def>

</function-map-args>

<sequence>

<!-- ========== -->

<call function="'writeStartTagOperation'">

{ 'tagName' : 'grep',

'fileFd' : fileFd }

</call>

<if expr="expect2Find == TRUE">

<call function="'writeMessage'">

{ 'fileFd' : fileFd,

'content' : "Check '%s' is in %s" % (string2grep,file)

}

</call>

<else>

<call function="'writeMessage'">

{ 'fileFd' : fileFd,

'content' : "Check '%s' is NOT in %s" % (string2grep,file)

}

</call>

</else>

</if>

<!-- ========== -->

<script>

_errNum = 0

result = 'NOTHING'

if (caseSensitive == TRUE):

options = ''

else:

options = '-i'

</script>

<process name="'Grep'">

<location>location</location>

<command mode="'shell'">

"grep %s '%s' %s" % (options,string2grep,file)

</command>

<envs>['PATH=/bin:/usr/bin']</envs>

<stderr mode="'stdout'"/>

<stdout/>

<returnstdout/>

</process>

<script>

grepRC=RC

grepRC2=STAXResult[0][0]

result=STAXResult[0][1]

</script>

<if expr="expect2Find == TRUE">

<sequence>

<if expr="(result != 'NOTHING') and (grepRC == 0)">

<call function="'checkRC'">

{ 'returncode' : 0,

'result' : '',

'fileFd' : fileFd }

</call>

<else>

<call function="'checkRC'">

{ 'returncode' : grepRC,

'result' : result,

'fileFd' : fileFd }

</call>

</else>

</if>

<script> _errNum += STAXResult </script>

</sequence>

<!-- == expect2Find == FALSE == -->

<else>

<sequence>

<if expr="(result == '') and (grepRC != 0)">

<call function="'checkRC'">

{ 'returncode' : 0,

'result' : '',

'fileFd' : fileFd }

</call>

<else>

<call function="'checkRC'">

{ 'returncode' : grepRC,

'expected' : [1],

'result' : result,

'fileFd' : fileFd }

</call>

</else>

</if>

<script> _errNum += STAXResult </script>

</sequence>

</else>

</if>

<!-- ========== -->

<call function="'writeEndTagOperation'">{'fileFd' : fileFd}</call>

<return> _errNum </return>

</sequence>

</function>

<!-- ************************************************************ -->

<function name="getOSvariables" scope="local">

<function-prolog>

Get OS related variables

</function-prolog>

<function-map-args>

<function-arg-def name="hostname" type="required">

<function-arg-description>

Name of host on which to retrieve variables

</function-arg-description>

<function-arg-property name="type" value="hostname"/>

</function-arg-def>

</function-map-args>

<sequence>

<stafcmd name="'STAF Command: Get OS Name'">

<location>'%s' % hostname</location>

<service>'var'</service>

<request>

'get system var STAF/Config/OS/Name'

</request>

</stafcmd>

<return>STAFResult</return>

</sequence>

</function>

<!-- ************************************************************ -->

<function name="getOSDate" scope="local">

<function-prolog>

This function returns the date (MONTH/DAY/YEARS-HOURS/MIN) of the OS

</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-def>

</function-map-args>

<sequence>

<call function="'getOSvariables'">

{ 'hostname' : location }

</call>

<script>

import re

winPattern=re.compile('win', re.IGNORECASE)

isWindows=winPattern.search(STAXResult)

</script>

<!-- OS is windows -->

<if expr="isWindows">

<sequence>

<process name="'get date on %s' % location">

<location>location</location>

<command mode="'shell'">'date /T'</command>

<workdir>'/'</workdir>

<stderr mode="'stdout'"/>

<returnstdout/>

</process>

<script>

date = STAFResult

date = date[date.find(' ')+1:len(date)].strip()

</script>

<process name="'get time on %s' % location">

<location>location</location>

<command mode="'shell'">'time /T'</command>

<workdir>'/'</workdir>

<stderr mode="'stdout'"/>

<returnstdout/>

</process>

<script>

time = STAFResult

#time = time[0:time.find(' ')].strip()

date = '%s-%s' % (date,time)

</script>

</sequence>

<!-- OS is UNIX based -->

<else>

<sequence>

<process name="'get date on %s' % location">

<location>location</location>

<command mode="'shell'">'date'</command>

<parms>"'+%m/%d/%Y-%H:%M:%S'"</parms>

<workdir>'/'</workdir>

<envs>['PATH=/bin:/usr/bin']</envs>

<stderr mode="'stdout'"/>

<returnstdout/>

</process>

<script>

date = STAXResult[0][1].split('\n')

</script>

</sequence>

</else>

</if>

<return>date</return>

</sequence>

</function>

<function name="runCommand" scope="local">

<function-description>

A general wrapper to run a command without having to write a dedicated

function for it

</function-description>

<function-map-args>

<function-arg-def name="command" type="required">

<function-arg-description>

the command to run

</function-arg-description>

</function-arg-def>

<function-arg-def name="path" type="required">

<function-arg-description>

the path where the command is to be run from

</function-arg-description>

</function-arg-def>

<function-arg-def name="arguments" type="optional" default="''">

<function-arg-description>

the path where the command is to be found

</function-arg-description>

</function-arg-def>

<function-arg-def name="env"

type="optional">

<function-arg-description>

the environment variables to set. The default set here should just

work for OpenDS commands

</function-arg-description>

</function-arg-def>

<function-arg-def name="location"

type="optional"

default="STAXServiceMachine">

<function-arg-description>

Which machine should the command be executed on

</function-arg-description>

</function-arg-def>

<function-arg-def name="name"

default="'Running %s' % command"

type="optional">

<function-arg-description>

The name to give the process (only matters in the STAX Monitor really)

</function-arg-description>

</function-arg-def>

<function-arg-def name="stripOutput" default="'true'" type="optional">

<function-arg-description>

A boolean (use True or False here, case matters) to enable disable

stripping the output of a command

TODO: consider allowing passing a function name to enable custom

output manipulation (overkill?)

</function-arg-description>

<function-arg-property name="type" value="enum">

<function-arg-property-description>

This argument can only have boolean values

</function-arg-property-description>

<function-arg-property-data type="choice" value="'true'"/>

<function-arg-property-data type="choice" value="'false'"/>

</function-arg-property>

</function-arg-def>

<function-arg-def name="timerDuration"

type="optional"

default="'5m'">

<function-arg-description>

The duration that the process is allowed to run

</function-arg-description>

</function-arg-def>

<function-arg-def name="outputFile" type="optional" default="'None'">

<function-arg-description>

Output file containing the command output

</function-arg-description>

<function-arg-property name="type" value="file"/>

</function-arg-def>

<function-arg-def name="expectedRC" type="optional" default="0">

<function-arg-description>

Expected return code value. Default value is 0.

Wildcard 'noCheck' to not check the RC

</function-arg-description>

</function-arg-def>

<function-arg-def name="logStderr" type="optional" default="'true'">

<function-arg-description>

If true, stderr for the command is redirect to stdout.

</function-arg-description>

<function-arg-property name="type" value="enum">

<function-arg-property-description>

This argument can only have boolean values

</function-arg-property-description>

<function-arg-property-data type="choice" value="'true'"/>

<function-arg-property-data type="choice" value="'false'"/>

</function-arg-property>

</function-arg-def>

<function-arg-def name="fileFd" type="required">

<function-arg-description>

output file descriptor

</function-arg-description>

</function-arg-def>

</function-map-args>

<sequence>

<script>

import random

import java.util.Date

random.seed(java.util.Date().getTime())

_id = '%s#%d' % (strftime('%Y-%m-%d %H:%M:%S',localtime()),random.randint(0,999))

if not env:

#if isWindows:

# env=['PATH=C:\Windows;C:\Windows\system32;%s' % path, 'JAVA_HOME=%s' % JAVA_HOME]

#else:

env=['PATH=/bin:/usr/bin:%s' % path, 'JAVA_HOME=%s' % JAVA_HOME]

</script>

<call function="'writeStartTagOperation'">

{ 'tagName' : name,

'fileFd' : fileFd }

</call>

<!-- check if command exists -->

<call function="'isFile'">

{

'location' : location,

'fileName' : command

}

</call>

<script>

STAFCmdExist = STAXResult

</script>

<if expr="STAFCmdExist == TRUE">

<sequence>

<call function="'writeMessage'">

{ 'content' : 'Running cmd: %s %s' % (command,arguments),

'fileFd' : fileFd }

</call>

<!-- If 'logStderr' is True then redirect sdterr to sdtout -->

<if expr="logStderr == 'true'">

<process name="name">

<location>location</location>

<command>command</command>

<parms>arguments</parms>

<workdir>path</workdir>

<envs>env</envs>

<console use="'same'"/>

<stdout if="outputFile != 'None'" mode="'replace'">

'%s' % outputFile

</stdout>

<stderr mode="'stdout'"/>

<returnstdout/>

</process>

<else>

<process name="name">

<location>location</location>

<command>command</command>

<parms>arguments</parms>

<workdir>path</workdir>

<envs>env</envs>

<console use="'same'"/>

<stdout if="outputFile != 'None'" mode="'replace'">

'%s' % outputFile

</stdout>

<returnstdout/>

</process>

</else>

</if>

<!-- The problem here is that STAXResult can either be a

<script>

try:

cmdOutput=STAXResult[0][1]

cmdRC = RC

except:

cmdOutput=STAXResult

cmdRC = RC

cmdResult=[cmdRC,cmdOutput]

</script>

</sequence>

<else>

<sequence>

<script>

cmdRC = 9999

cmdOutput = 'ERROR : file does not exist on %s : %s'\

% (location,command)

cmdResult = [cmdRC,cmdOutput]

</script>

<call function="'writeMessage'">

{

'content' : cmdOutput,

'fileFd' : fileFd

}

</call>

</sequence>

</else>

</if>

<script>

isList = FALSE

try:

if len(expectedRC) >= 0:

isList = TRUE

except:

isList = FALSE

if isList == FALSE:

expectedRC = [expectedRC]

</script>

<if expr="expectedRC != 'noCheck'">

<call function="'checkRC'">

{ 'returncode' : cmdRC,

'result' : cmdOutput,

'expected' : expectedRC,

'fileFd' : fileFd

}

</call>

</if>

<call function="'writeEndTagOperation'">{'fileFd' : fileFd}</call>

<return>

cmdResult

</return>

</sequence>

</function>

</stax>