2788N/A<?xml version="1.0" encoding="UTF-8" standalone="no"?>

2788N/A<!DOCTYPE stax SYSTEM "/stax.dtd">

2788N/A<stax>

2788N/A <function name="checkRC">

3853N/A <function-prolog>

3853N/A This function checks a return code against an expected return code

3853N/A </function-prolog>

3853N/A

3853N/A <function-map-args>

3853N/A <function-arg-def name="returncode" type="required">

3853N/A <function-arg-description>

3853N/A return code received from command

3853N/A </function-arg-description>

3853N/A <function-arg-property name="type" value="integer"/>

3853N/A </function-arg-def>

3853N/A <function-arg-def name="result" type="required">

3853N/A <function-arg-description>

3853N/A the output of the result

3853N/A </function-arg-description>

3853N/A <function-arg-property name="type" value="integer"/>

3853N/A </function-arg-def>

3853N/A <function-arg-def name="expected" type="optional" default="0">

3853N/A <function-arg-description>

3853N/A the expected return code

3853N/A </function-arg-description>

3853N/A <function-arg-property name="type" value="integer"/>

3853N/A </function-arg-def>

3853N/A </function-map-args>

6304N/A

6304N/A <sequence>

6304N/A <if expr="expected == 'noCheck'">

6304N/A <return/>

6304N/A </if>

6304N/A <if expr="returncode == expected">

6304N/A <sequence>

6304N/A <if expr="result == ''">

6304N/A <message log="1">

6304N/A 'RC=%s, Result=Ok' % (returncode)

6304N/A </message>

6304N/A <else>

6304N/A <message log="1">

6304N/A 'RC=%s, Result=%s' % (returncode,result)

6304N/A </message>

6304N/A </else>

6304N/A </if>

6304N/A </sequence>

6304N/A <else>

6304N/A <sequence>

6304N/A <message log="1" level="'Error'">

6304N/A 'RC=%s, Expected %s, Result=%s' % (returncode,expected,result)

6304N/A </message>

6304N/A </sequence>

6304N/A </else>

6304N/A </if>

6304N/A <return>RC</return>

6304N/A </sequence>

6304N/A </function>

6304N/A

6304N/A <function name="checktestRC">

6304N/A <function-prolog>

6304N/A This function checks the return code against an expected return code for a testcase

6304N/A </function-prolog>

6304N/A <function-map-args>

6304N/A <function-arg-def name="returncode" type="required">

6304N/A <function-arg-description>

6304N/A return code received from command

6304N/A </function-arg-description>

6304N/A <function-arg-property name="type" value="integer"/>

6304N/A </function-arg-def>

6304N/A <function-arg-def name="result" type="required">

6304N/A <function-arg-description>

6304N/A the output of the result

6304N/A </function-arg-description>

6304N/A <function-arg-property name="type" value="integer"/>

6304N/A </function-arg-def>

6387N/A <function-arg-def name="expected" type="optional" default="0">

6387N/A <function-arg-description>

6387N/A the expected return code

6387N/A </function-arg-description>

6387N/A <function-arg-property name="type" value="integer"/>

6387N/A </function-arg-def>

6387N/A <function-arg-def name="issue" type="optional" default="None">

6387N/A <function-arg-description>

6387N/A Issue id. Corresponds to an issue number.

6387N/A </function-arg-description>

6387N/A <function-arg-property name="type" value="string"/>

6387N/A </function-arg-def>

6387N/A </function-map-args>

6387N/A <sequence>

6387N/A <if expr="expected == 'noCheck'">

6387N/A <return/>

6387N/A </if>

6387N/A <if expr="returncode == expected">

6387N/A <sequence>

6387N/A <if expr="STAXCurrentTestcase != None">

6387N/A <sequence>

6387N/A <tcstatus result="'pass'"/>

6387N/A </sequence>

6387N/A </if>

6387N/A <if expr="VERBOSE_MODE == 'true'">

6304N/A <message log="1">

6387N/A 'SUCCESS: RC=%s, Expected %s, Result=%s' % (returncode,expected,result)

6304N/A </message>

6387N/A <else>

6304N/A <message log="1">

6304N/A 'SUCCESS: RC=%s, Expected %s' % (returncode,expected)

6304N/A </message>

6304N/A </else>

6304N/A </if>

6304N/A <script>

6304N/A RC=0

6304N/A </script>

6304N/A </sequence>

6304N/A <else>

6304N/A <sequence>

6304N/A <if expr="STAXCurrentTestcase != None">

6304N/A <sequence>

6304N/A <if expr="issue == None">

6304N/A <tcstatus result="'fail'"/>

6304N/A <else>

6304N/A <sequence>

6304N/A <call function="'setKnownIssue'">

6304N/A { 'issueId' : issue }

6304N/A </call>

6304N/A </sequence>

6304N/A </else>

2788N/A </if>

4618N/A

2788N/A </sequence>

2788N/A </if>

4865N/A <message log="1" level="'Error'">

2788N/A 'ERROR : RC=%s, Expected %s, Result=%s' % (returncode,expected,result)

3853N/A </message>

3853N/A </sequence>

3853N/A </else>

2788N/A </if>

2788N/A </sequence>

2788N/A </function>

2788N/A

5764N/A <function name="setKnownIssue">

5764N/A <function-prolog>

5764N/A This function set the known issue flag and maintains list of known issues

5764N/A </function-prolog>

5764N/A

5764N/A <function-map-args>

5764N/A <function-arg-def name="issueId" type="required">

5764N/A <function-arg-description>

3853N/A Issue ID

3853N/A </function-arg-description>

4153N/A <function-arg-property name="type" value="string"/>

2788N/A </function-arg-def>

2788N/A </function-map-args>

2788N/A <sequence>

2788N/A <script>

2788N/A try:

2788N/A if issueId not in issuesList:

2788N/A issuesList.append(issueId)

2788N/A except:

2788N/A print 'Issues list undefined. Unable to add issue %s' % issueId

2788N/A </script>

2788N/A <message log="1" level="'Error'">

3853N/A 'ERROR: HIT **** Known Issue (%s) ****' % issueId

3853N/A </message>

3853N/A <tcstatus result="'fail'">

3853N/A 'KnownIssue: %s' % issuesList

3853N/A </tcstatus>

3853N/A </sequence>

3853N/A </function>

3853N/A

5551N/A<!-- Set the test status to PASS -->

5551N/A

5551N/A <function name="testPassed">

5551N/A <function-prolog>

5551N/A This function set the status of the tests: PASS

2788N/A </function-prolog>

2788N/A

2788N/A <sequence>

2788N/A <message>'Set test status to PASS'</message>

2788N/A <tcstatus result="'pass'"/>

4865N/A </sequence>

2788N/A </function>

2788N/A

2788N/A

2788N/A<!-- Set the test status to FAIL -->

2788N/A

2788N/A <function name="testFailed">

2788N/A <function-prolog>

2788N/A This function set the status of the tests: FAIL

2788N/A </function-prolog>

2788N/A

4865N/A <sequence>

2788N/A <message>'Set test status to FAIL'</message>

2788N/A <tcstatus result="'fail'"/>

2788N/A </sequence>

2788N/A </function>

2788N/A

4865N/A <!-- Search string -->

2788N/A <function name="searchString" scope="local">

2788N/A <function-prolog>

2788N/A This function search for a string in the retrun string of a testcase

2788N/A Return 0 if the string is found, 1 otherwise

2788N/A </function-prolog>

2788N/A

2788N/A <function-map-args>

2788N/A <function-arg-def name="expectedString" type="required">

2788N/A <function-arg-description>

2788N/A the substring expected from the command

2788N/A </function-arg-description>

2788N/A <function-arg-property name="type" value="string"/>

2788N/A </function-arg-def>

2788N/A <function-arg-def name="returnString" type="required">

2788N/A <function-arg-description>

2788N/A the return string received from command

2788N/A </function-arg-description>

4865N/A <function-arg-property name="type" value="string"/>

2788N/A </function-arg-def>

2788N/A <function-arg-def name="knownIssue" type="optional" default="None">

2788N/A <function-arg-description>

2788N/A Known issue. Corresponds to an issue number.

2788N/A </function-arg-description>

3194N/A <function-arg-property name="type" value="string"/>

4618N/A </function-arg-def>

4618N/A <function-arg-def name="expectedRC" type="optional" default="0">

4618N/A <function-arg-description>

4618N/A Expected return code value. Default value is 0.

4618N/A Wildcard 'noCheck' to not check the RC

4618N/A </function-arg-description>

3951N/A <function-arg-property name="type" value="string"/>

3951N/A </function-arg-def>

3951N/A </function-map-args>

3951N/A

3951N/A <sequence>

2788N/A <script>

2788N/A searchre = re.compile('%s' % expectedString)

2788N/A myRC = 0

2788N/A myReason = 'None'

2788N/A </script>

6387N/A

6387N/A <!-- Check that returnString is really a string -->

6387N/A <if expr='returnString.__class__ is not org.python.core.PyString'>

6397N/A <sequence>

6387N/A <message log="1" level="'Error'">

6387N/A 'ERROR : Invalid returnString type (%s), requires org.python.core.PyString.' \

6387N/A % returnString.__class__

6387N/A </message>

6387N/A <script>

6387N/A myRC = 1

6387N/A myReason = 'Python error'

6387N/A </script>

6387N/A

6387N/A <return>[myRC, myReason]</return>

6387N/A </sequence>

2788N/A </if>

6387N/A

6397N/A <!-- Search for the expectedString -->

6397N/A <if expr='re.search(searchre, returnString) != None'>

6397N/A <sequence>

6387N/A <message log="1">

6397N/A 'Found substring, %s, in the return string' \

6397N/A % (expectedString)

6397N/A </message>

2788N/A <script>

2788N/A myRC = 0

6387N/A myReason = 'String found'

6387N/A </script>

6387N/A </sequence>

6387N/A <else>

6387N/A <sequence>

6387N/A <message log="1">

6387N/A 'Did not find substring, %s, in the return string, %s' \

6387N/A % (expectedString, returnString)

6387N/A </message>

6387N/A <script>

6391N/A myRC = 1

6391N/A myReason = 'String not found'

6391N/A </script>

6391N/A </sequence>

6391N/A </else>

6391N/A </if>

6391N/A

6391N/A <!-- Manage expectedRC and knownIssue -->

6391N/A <if expr="expectedRC != 'noCheck'">

6391N/A <if expr="myRC == expectedRC">

6391N/A <sequence>

6391N/A <message log="1">

6391N/A 'SUCCESS: searchString successful'

6391N/A </message>

6391N/A <tcstatus result="'pass'"/>

6391N/A </sequence>

6391N/A <else>

6391N/A <sequence>

6391N/A <message log="1" level="'Error'">

6391N/A 'ERROR: searchString fail'

6387N/A </message>

6387N/A <if expr="knownIssue == None">

6387N/A <tcstatus result="'fail'"/>

2788N/A <else>

2788N/A <call function="'setKnownIssue'">

6387N/A { 'issueId' : knownIssue }

2788N/A </call>

5764N/A </else>

5764N/A </if>

5764N/A </sequence>

2788N/A </else>

2788N/A </if>

2788N/A </if>

3853N/A

3853N/A <return>[myRC, myReason]</return>

3853N/A </sequence>

3853N/A </function>

5551N/A

5551N/A <!-- DEPRECATED, use searchString function -->

5551N/A <function name="checktestString">

5551N/A <function-prolog>

2788N/A This function checks the return string against an expected return substring for a testcase

2788N/A </function-prolog>

2788N/A

2788N/A <function-map-args>

2788N/A <function-arg-def name="expectedString" type="required">

2788N/A <function-arg-description>

2788N/A the substring expected from the command

2788N/A </function-arg-description>

2788N/A <function-arg-property name="type" value="string"/>

2788N/A </function-arg-def>

2788N/A <function-arg-def name="returnString" type="required">

2788N/A <function-arg-description>

2788N/A the return string received from command

2788N/A </function-arg-description>

2788N/A <function-arg-property name="type" value="string"/>

2788N/A </function-arg-def>

2788N/A <function-arg-def name="issue" type="optional" default="None">

2788N/A <function-arg-description>

2788N/A Known issue. Corresponds to an issue number.

2788N/A </function-arg-description>

2788N/A <function-arg-property name="type" value="string" />

2788N/A </function-arg-def>

2788N/A </function-map-args>

4865N/A

2788N/A <sequence>

2788N/A <script>

2788N/A searchre = re.compile('%s' % expectedString)

2788N/A </script>

2788N/A

2788N/A <!-- Check that returnString is really a string -->

2788N/A <if expr='returnString.__class__ is not org.python.core.PyString'>

2788N/A <sequence>

2788N/A <message log="1" level="'Error'">

2788N/A 'ERROR : Invalid returnString type (%s), requires org.python.core.PyString.' % returnString.__class__

2788N/A </message>

3194N/A <tcstatus result="'fail'"/>

4618N/A </sequence>

3951N/A </if>

2788N/A <if expr='re.search(searchre, returnString) != None'>

2788N/A <sequence>

2788N/A <tcstatus result="'pass'"/>

2788N/A <message log="1">

2788N/A 'SUCCESS : Found substring, %s, in the return string' % (expectedString)

6103N/A </message>

6103N/A </sequence>

6103N/A <else>

6103N/A <sequence>

6103N/A <if expr="issue == None">

6103N/A <tcstatus result="'fail'"/>

6103N/A <else>

6103N/A <sequence>

6103N/A <call function="'setKnownIssue'">

6103N/A { 'issueId' : issue }

6103N/A </call>

6103N/A </sequence>

6103N/A </else>

6103N/A </if>

6103N/A <message log="1" level="'Error'">

6103N/A 'ERROR : Did not find substring, %s, in the return string, %s' % (expectedString, returnString)

6103N/A </message>

6103N/A </sequence>

6103N/A </else>

6103N/A </if>

6103N/A </sequence>

6103N/A </function>

6103N/A

6103N/A <!-- DEPRECATED, use searchString function -->

6103N/A <function name="checktestStringNotPresent">

6103N/A <function-prolog>

6103N/A This function checks the return string against an expected return substring that should not be present for a testcase

6103N/A </function-prolog>

6103N/A <function-map-args>

6103N/A <function-arg-def name="testString" type="required">

6103N/A <function-arg-description>

6103N/A the substring being tested from the command

6103N/A </function-arg-description>

6103N/A <function-arg-property name="type" value="string"/>

6103N/A </function-arg-def>

6103N/A <function-arg-def name="returnString" type="required">

6103N/A <function-arg-description>

6103N/A the return string received from command

6103N/A </function-arg-description>

6103N/A <function-arg-property name="type" value="string"/>

6103N/A </function-arg-def>

6103N/A <function-arg-def name="issue" type="optional" default="None">

6103N/A <function-arg-description>

6103N/A Known issue. Corresponds to an issue number.

6103N/A </function-arg-description>

6103N/A <function-arg-property name="type" value="string" />

6103N/A </function-arg-def>

6103N/A </function-map-args>

6103N/A

6103N/A <sequence>

6103N/A <script>

6103N/A searchre = re.compile('%s' % testString)

6103N/A </script>

6103N/A <if expr='re.search(searchre, returnString) == None'>

6103N/A <sequence>

6103N/A <tcstatus result="'pass'"/>

6103N/A <message log="1">

6103N/A 'Did Not Find substring, %s, in the return string' % (testString)

6103N/A </message>

6103N/A </sequence>

6103N/A <else>

6103N/A <sequence>

6103N/A <if expr="issue == None">

6103N/A <tcstatus result="'fail'"/>

6103N/A <else>

6103N/A <sequence>

6103N/A <call function="'setKnownIssue'">

6103N/A { 'issueId' : issue }

6103N/A </call>

6103N/A </sequence>

6103N/A </else>

6103N/A </if>

6103N/A <message log="1" level="'Error'">

6103N/A 'Found substring, %s, in the return string, %s' % (testString, returnString)

6103N/A </message>

6103N/A </sequence>

6103N/A </else>

6103N/A </if>

6103N/A </sequence>

6103N/A </function>

6103N/A

6103N/A <!-- DEPRECATED, use searchString function -->

6103N/A <function name="searchStringForSubstring">

6103N/A <function-prolog>

6103N/A This function simply searches a string for a substring

6103N/A </function-prolog>

6103N/A

6103N/A <function-map-args>

6103N/A <function-arg-def name="testString" type="required">

6103N/A <function-arg-description>

6103N/A the substring being tested from the command

6103N/A </function-arg-description>

6103N/A <function-arg-property name="type" value="string"/>

6103N/A </function-arg-def>

6103N/A <function-arg-def name="returnString" type="required">

6103N/A <function-arg-description>

6103N/A the return string received from command

6103N/A </function-arg-description>

6103N/A <function-arg-property name="type" value="string"/>

6103N/A </function-arg-def>

6103N/A <function-arg-def name="expectedResult" type="optional" default="'2'">

6103N/A <function-arg-description>

6103N/A the expected result, 0 for false (not present), 1 for true (present), 2 for old behavior

6103N/A </function-arg-description>

6103N/A <function-arg-property name="type" value="string"/>

6103N/A </function-arg-def>

6103N/A </function-map-args>

6103N/A

6103N/A <!-- Until all the test cases are refactored to use the expectedResult param,

6103N/A <sequence>

6103N/A <if expr="expectedResult == '2'">

6103N/A <sequence>

6103N/A <script>

6103N/A searchre = re.compile(testString)

6103N/A </script>

6103N/A <if expr='re.search(searchre, returnString) == None'>

6103N/A <sequence>

6103N/A <script>returnCode='0'</script>

6103N/A <message log="1">

6103N/A 'Did Not Find substring, %s, in the return string' % (testString)

6103N/A </message>

6103N/A </sequence>

6103N/A <else>

6103N/A <sequence>

6103N/A <script>returnCode='1'</script>

6103N/A <message log="1">

6103N/A 'Found substring, %s, in the return string' % (testString)

6103N/A </message>

6103N/A </sequence>

6103N/A </else>

6103N/A </if>

6103N/A <return>returnCode</return>

6103N/A </sequence>

6103N/A <else>

6103N/A <sequence>

6103N/A <script>

6103N/A searchre = re.compile(testString)

6103N/A </script>

6103N/A <if expr='re.search(searchre, returnString) == None'>

6103N/A <sequence>

6103N/A <script>returnCode='0'</script>

6103N/A <if expr="expectedResult == '0'">

6103N/A <sequence>

6103N/A <tcstatus result="'pass'"/>

6103N/A <message log="1">

6103N/A 'SUCCESS : Did Not Find substring, %s, in the return string' % (testString)

6103N/A </message>

6103N/A </sequence>

6103N/A <else>

6103N/A <sequence>

6103N/A <tcstatus result="'fail'"/>

6103N/A <message log="1" level="'Error'">

6103N/A 'ERROR : Did Not Find substring, %s, in the return string' % (testString)

6103N/A </message>

6103N/A </sequence>

6103N/A </else>

6103N/A </if>

2788N/A </sequence>

2788N/A <else>

2788N/A <sequence>

2788N/A <script>returnCode='1'</script>

2788N/A <if expr="expectedResult == '1'">

2788N/A <sequence>

2788N/A <tcstatus result="'pass'"/>

2788N/A <message log="1">

2788N/A 'SUCCESS : Found substring, %s, in the return string' % (testString)

2788N/A </message>

2788N/A </sequence>

2788N/A <else>

4865N/A <sequence>

2788N/A <tcstatus result="'fail'"/>

2788N/A <message log="1" level="'Error'">

2788N/A 'ERROR : Found substring, %s, in the return string' % (testString)

2788N/A </message>

2788N/A </sequence>

2788N/A </else>

2788N/A </if>

2788N/A </sequence>

2788N/A </else>

2788N/A </if>

4865N/A <return>returnCode</return>

2788N/A </sequence>

2788N/A </else>

2788N/A </if>

2788N/A </sequence>

2788N/A </function>

2788N/A

2788N/A <function name="isAlive" scope="local">

2788N/A <function-prolog>

2788N/A Checks that the ldap server is running

2788N/A </function-prolog>

2788N/A <function-map-args>

2788N/A <function-arg-def name="location" type="optional" default="STAF_REMOTE_HOSTNAME">

2788N/A <function-arg-description>

2788N/A Location of target host

2788N/A </function-arg-description>

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

2788N/A </function-arg-def>

2788N/A <function-arg-def name="dsPath" type="optional" default="'%s/%s' % (DIRECTORY_INSTANCE_BIN,OPENDSNAME)">

2788N/A <function-arg-description>

2788N/A Pathname to installation root

2788N/A </function-arg-description>

2788N/A <function-arg-property name="type" value="pathname"/>

2788N/A </function-arg-def>

3194N/A <function-arg-def name="noOfLoops" type="required">

3194N/A <function-arg-description>

3194N/A Number of iterations

3194N/A </function-arg-description>

3194N/A <function-arg-property name="type" value="integer"/>

3194N/A </function-arg-def>

3194N/A <function-arg-def name="noOfMilliSeconds" type="required">

3951N/A <function-arg-description>

3951N/A Number of seconds to wait between iterations

3951N/A </function-arg-description>

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

3951N/A </function-arg-def>

2788N/A <function-arg-def name="dsInstanceHost" type="optional" default="DIRECTORY_INSTANCE_HOST">

2788N/A <function-arg-description>

2788N/A Directory server hostname or IP address

2788N/A </function-arg-description>

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

2788N/A </function-arg-def>

2788N/A <function-arg-def name="dsInstancePort" type="optional" default="DIRECTORY_INSTANCE_PORT">

2788N/A <function-arg-description>

2788N/A Directory server port number

2788N/A </function-arg-description>

2788N/A <function-arg-property name="type" value="Port number"/>

2788N/A </function-arg-def>

2788N/A <function-arg-def name="dsInstanceDn" type="optional" default="DIRECTORY_INSTANCE_DN">

2788N/A <function-arg-description>

2788N/A Bind DN

2788N/A </function-arg-description>

2788N/A <function-arg-property name="type" value="DN"/>

2788N/A </function-arg-def>

2788N/A <function-arg-def name="dsInstancePswd" type="optional" default="DIRECTORY_INSTANCE_PSWD">

2788N/A <function-arg-description>

2788N/A Bind password

2788N/A </function-arg-description>

2788N/A <function-arg-property name="type" value="string"/>

2788N/A </function-arg-def>

2788N/A </function-map-args>

2788N/A

2788N/A <sequence>

2788N/A <!-- Local variables -->

2788N/A <script>

2788N/A mylocation=location

2788N/A mypath=dsPath

2788N/A myhost=dsInstanceHost

2788N/A myport=dsInstancePort

2788N/A mydn=dsInstanceDn

5073N/A mypswd=dsInstancePswd

5073N/A </script>

5073N/A

5073N/A <script>

5073N/A myLoop=0

5073N/A ldapRC=9999

5073N/A </script>

5073N/A <loop from="1" to="noOfLoops" while="ldapRC != 0">

5073N/A <sequence>

5073N/A <script>

5073N/A myLoop=myLoop+1

5073N/A </script>

5073N/A

5073N/A <call function="'SearchObject'">

5073N/A { 'location' : mylocation,

5073N/A 'dsPath' : mypath,

5073N/A 'dsInstanceHost' : myhost ,

5073N/A 'dsInstancePort' : myport ,

5073N/A 'dsInstanceDn' : mydn ,

5073N/A 'dsInstancePswd' : mypswd ,

5116N/A 'dsScope' : 'base' ,

5073N/A 'dsBaseDN' : 'cn=config' ,

5073N/A 'dsFilter' : 'objectclass=*' ,

5073N/A 'attributes' : 'dn',

5073N/A 'expectedRC' : 'noCheck'

5073N/A }

5073N/A </call>

5073N/A

5073N/A <script>

5073N/A ldapRC=RC

5073N/A </script>

5073N/A

5073N/A <message>

5073N/A 'LOOP %s => RC=%s' % (myLoop, ldapRC)

5073N/A </message>

5073N/A

5073N/A <call function="'Sleep'">

5073N/A { 'sleepForMilliSeconds' : noOfMilliSeconds }

5073N/A </call>

5073N/A

5073N/A </sequence>

5073N/A </loop>

5073N/A

5073N/A <call function="'checktestRC'">

5073N/A { 'returncode' : ldapRC ,

5073N/A 'result' : 'Check is alive' }

5073N/A </call>

5073N/A </sequence>

5073N/A </function>

5073N/A

5073N/A <function name="Sleep">

5073N/A <function-prolog>

5073N/A Sleep for number of milliseconds

5073N/A </function-prolog>

5073N/A <function-map-args>

5073N/A <function-arg-def name="sleepForMilliSeconds" type="required">

5073N/A <function-arg-description>

5073N/A Number of milliseconds to sleep

5073N/A </function-arg-description>

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

5073N/A </function-arg-def>

5073N/A </function-map-args>

5073N/A

5073N/A <sequence>

5073N/A <stafcmd name="'STAF Command: Delay'">

5073N/A <location>STAXServiceMachine</location>

5073N/A <service>'delay'</service>

5073N/A <request>

5073N/A 'delay %i' % sleepForMilliSeconds

5073N/A </request>

5073N/A </stafcmd>

5073N/A

5073N/A <call function="'checkRC'">

5073N/A { 'returncode' : RC ,

5073N/A 'result' : STAFResult }

5073N/A </call>

5073N/A </sequence>

2788N/A </function>

2788N/A

2788N/A <function name="getOSvariables">

2788N/A <function-prolog>

3194N/A Get OS related variables

3951N/A </function-prolog>

3951N/A <function-map-args>

2788N/A <function-arg-def name="hostname" type="required">

2788N/A <function-arg-description>

3194N/A Name of host on which to retrieve variables

2788N/A </function-arg-description>

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

2788N/A </function-arg-def>

2788N/A </function-map-args>

2788N/A <sequence>

2788N/A <stafcmd name="'STAF Command: Get OS Name'">

2788N/A <location>'%s' % hostname</location>

2788N/A <service>'var'</service>

2788N/A <request>

4865N/A 'get system var STAF/Config/OS/Name'

4865N/A </request>

3853N/A </stafcmd>

3853N/A <message>

3853N/A 'OS Name= %s' % STAFResult

2788N/A </message>

2788N/A <return>STAFResult</return>

2788N/A </sequence>

2788N/A </function>

2788N/A

3853N/A <function name="testCase_StartBanner">

3853N/A <function-prolog>

4153N/A Pretty prints a banner at the start of a test.

2788N/A </function-prolog>

2788N/A <function-no-args />

2788N/A <sequence>

2788N/A <message level="'start'">'testcase: %s' % STAXCurrentTestcase</message>

2788N/A <message>'****************************************************'</message>

2788N/A <message>'*** STARTING TEST CASE %s.' % STAXCurrentTestcase</message>

2788N/A <message>'***'</message>

2788N/A </sequence>

2788N/A </function>

2788N/A

2788N/A <function name="testCase_EndBanner">

3853N/A <function-prolog>

3853N/A Pretty prints a banner at the end of a test.

3853N/A </function-prolog>

2788N/A <function-no-args />

2788N/A <sequence>

2788N/A <message>'***'</message>

2788N/A <message>'*** ENDING TEST CASE %s.' % STAXCurrentTestcase</message>

2788N/A <message>'****************************************************'</message>

2788N/A <message level="'stop'">'testcase: %s' % STAXCurrentTestcase</message>

2788N/A </sequence>

2788N/A </function>

4865N/A

2788N/A <function name="testCase_Preamble">

2788N/A <function-prolog>

2788N/A Performs all the preoperations for a test case

2788N/A </function-prolog>

2788N/A <function-no-args />

2788N/A <sequence>

2788N/A <script>

2788N/A import time

2788N/A testcaseStart=int(time.time())

2788N/A testcaseStartTime=strftime("%Y%m%d@%H:%M:%S",localtime())

2788N/A issuesList=[]

2788N/A for logType in ['errors','access']:

2788N/A if os.path.exists('%s/%s/logs/%s' % (DIRECTORY_INSTANCE_DIR,OPENDSNAME,logType)):

2788N/A logfile=open('%s/%s/logs/%s' % (DIRECTORY_INSTANCE_DIR,OPENDSNAME,logType),'a')

2788N/A logfile.seek(0,2)

2788N/A logfile.write('Begin testcase %s\n' % STAXCurrentTestcase)

2788N/A logfile.close()

2788N/A </script>

2788N/A <call function="'testCase_StartBanner'" />

2788N/A </sequence>

2788N/A </function>

2788N/A

2788N/A <function name="testCase_Postamble">

2788N/A <function-prolog>

2788N/A Performs all the post operations for a test suite

2788N/A </function-prolog>

2788N/A <function-no-args />

2788N/A <sequence>

2788N/A

2788N/A <!-- Check the SignalRaised flag -->

2788N/A <if expr="SignalRaised">

2788N/A <sequence>

2788N/A <message>

2788N/A 'A signal (%s) was raised during this test case' % SignalRaised

2788N/A </message>

4865N/A <tcstatus result="'fail'"/>

2788N/A </sequence>

2788N/A </if>

2788N/A

2788N/A <!-- Reset the SignalRaised flag -->

2788N/A <script>

4865N/A SignalRaised=''

2788N/A </script>

2788N/A

2788N/A <!-- Query the test case results -->

2788N/A <call function="'queryTestcase'" />

2788N/A

4865N/A <script>

2788N/A if STAFResult.has_key('numPasses'):

2788N/A numPass=int(STAFResult['numPasses'])

2788N/A else:

2788N/A numPass=int(0)

2788N/A

2788N/A if STAFResult.has_key('numFails'):

2788N/A numFail=int(STAFResult['numFails'])

2788N/A else:

2788N/A numFail=int(0)

2788N/A

2788N/A if numFail == 0:

2788N/A if numPass == 0:

2788N/A _status='INCONCLUSIVE'

2788N/A else:

2788N/A _status='PASS'

2788N/A else:

2788N/A if len(issuesList)==0:

2788N/A _status='FAIL'

2788N/A else:

2788N/A _status='KNOWN ISSUES %s' % str(issuesList)

2788N/A </script>

2788N/A <message level="'status'">'## Test Verdict: %s ##' % _status</message>

2788N/A <call function="'testCase_EndBanner'" />

4865N/A

2788N/A <script>

2788N/A testcaseEndTime = strftime("%Y%m%d@%H:%M:%S",localtime())

2788N/A </script>

2788N/A

2788N/A <call function="'queryLogs'">

2788N/A { 'location' : STAXServiceMachine,

2788N/A 'logname' : 'STAX_Job_%s_User' % STAXJobID,

2788N/A 'startfrom' : testcaseStartTime,

2788N/A 'endat' : testcaseEndTime }

2788N/A </call>

2788N/A

2788N/A <script>

2788N/A class Test:

2788N/A def __init__(self, group, suite, fullname, start, stop, failures, successes, issues, duration):

2788N/A self.message=[]

2788N/A self.log='%s/test.log' % local.temp

2788N/A self.errors='%s/error.log' % local.temp

4865N/A self.access='%s/access.log' % local.temp

2788N/A for f in [self.log,self.errors,self.access]:

2788N/A if os.path.exists(local.temp):

2788N/A fh=open(f,'w')

2788N/A fh.write('')

2788N/A fh.close()

2788N/A self.group=group

2788N/A self.suite=suite

2788N/A self.fullname=fullname

2788N/A self.start=start

2788N/A self.stop=stop

2788N/A tmp=fullname.split(":")

2788N/A if len(tmp) > 2:

4865N/A del tmp[0:2]

4865N/A self.name=''.join(tmp)

4865N/A else:

4865N/A self.name=fullname

4865N/A self.duration = duration

4865N/A if failures == 0:

4865N/A if successes == 0:

4865N/A self.result='inconclusive'

4865N/A else:

4865N/A self.result='pass'

4865N/A else:

4865N/A if len(issues) == 0:

4865N/A self.result='fail'

4865N/A else:

4865N/A self.result='known'

4865N/A self.issues=issues

3194N/A

3194N/A def toXML(self):

3194N/A xml = ' &lt;test&gt;%s' % newLine

3194N/A xml += ' &lt;name&gt;%s&lt;/name&gt;%s' % (self.name,newLine)

3194N/A xml += ' &lt;group&gt;%s&lt;/group&gt;%s' % (self.group,newLine)

3194N/A xml += ' &lt;suite&gt;%s&lt;/suite&gt;%s' % (self.suite,newLine)

3951N/A xml += ' &lt;start&gt;%s&lt;/start&gt;%s' % (self.start,newLine)

3951N/A xml += ' &lt;stop&gt;%s&lt;/stop&gt;%s' % (self.stop,newLine)

3951N/A xml += ' &lt;result&gt;%s&lt;/result&gt;%s' % (self.result,newLine)

3951N/A xml += ' &lt;duration&gt;%d&lt;/duration&gt;%s' % (self.duration,newLine)

3951N/A xml += ' &lt;issues&gt;%s' % newLine

2788N/A for issue in self.issues:

2788N/A xml += ' &lt;issue&gt;%s&lt;/issue&gt;%s' % (issue,newLine)

2788N/A xml += ' &lt;/issues&gt;%s' % newLine

2788N/A xml += ' &lt;log&gt;%s' % newLine

2788N/A xml += ' &lt;![CDATA[%s' % newLine

2788N/A if self.result!='pass':

2788N/A try:

2788N/A fh=open(self.log)

2788N/A xml += fh.read()

2788N/A fh.close()

2788N/A except IOError,details:

2788N/A self.message.append('IOError: Opening %s for reading %s' % (self.log,details.args))

2788N/A xml += ' ]]&gt;%s' % newLine

2788N/A xml += ' &lt;/log&gt;%s' % newLine

2788N/A xml += ' &lt;error&gt;%s' % newLine

2788N/A xml += ' &lt;![CDATA[%s' % newLine

3853N/A if self.result!='pass':

3853N/A try:

3853N/A fh=open(self.errors)

3853N/A xml += fh.read()

2788N/A fh.close()

2788N/A except IOError,details:

2788N/A self.message.append('IOError: Opening %s for reading %s' % (self.errors,details.args))

2788N/A xml += ' ]]&gt;%s' % newLine

2788N/A xml += ' &lt;/error&gt;%s' % newLine

2788N/A xml += ' &lt;access&gt;%s' % newLine

2788N/A xml += ' &lt;![CDATA[%s' % newLine

2788N/A if self.result!='pass':

2788N/A try:

2788N/A fh=open(self.access)

2788N/A xml += fh.read()

2788N/A fh.close()

2788N/A except IOError,details:

2788N/A self.message.append('IOError: Opening %s for reading %s' % (self.access,details.args))

2788N/A xml += ' ]]&gt;%s' % newLine

2788N/A xml += ' &lt;/access&gt;%s' % newLine

2788N/A xml += ' &lt;/test&gt;%s' % newLine

2788N/A return xml

2788N/A

2788N/A def appendLog(self, category, log):

2788N/A wrappedLog=''

2788N/A for _line in log.splitlines():

2788N/A _line=_line.strip()

2788N/A _leftPadding=''

2788N/A while len(_line)>100:

2788N/A _logChunk=_line[:100]

2788N/A _line=_line[100:]

2788N/A wrappedLog+='%s%s%s' % (_leftPadding,_logChunk,newLine)

2788N/A _leftPadding='... '

2788N/A wrappedLog += '%s%s%s' % (_leftPadding,_line,newLine)

2788N/A if category == 'access':

2788N/A try:

2788N/A fh=open(self.access,'a')

2788N/A except IOError,details:

2788N/A self.message.append('IOError: Opening %s for appending %s' % (self.access,details.args))

2788N/A elif category == 'error':

2788N/A try:

2788N/A fh=open(self.errors,'a')

2788N/A except IOError,details:

2788N/A self.message.append('IOError: Opening %s for appending %s' % (self.errors,details.args))

2788N/A else:

2788N/A try:

2788N/A fh=open(self.log,'a')

2788N/A except IOError,details:

2788N/A self.message.append('IOError: Opening %s for appending %s' % (self.log,details.args))

2788N/A fh.seek(0,2)

2788N/A fh.write(wrappedLog)

2788N/A fh.close()

2788N/A

2788N/A def getName(self):

2788N/A return self.name

2788N/A

5815N/A def clean(self):

5815N/A for _file in [self.log,self.errors,self.access]:

5815N/A if os.path.exists(_file):

2788N/A os.remove(_file)

2788N/A

2788N/A testcaseStop=int(time.time())

2788N/A testcaseDuration=testcaseStop-testcaseStart

2788N/A thisTest = Test(CurrentTestPath['group'],CurrentTestPath['suite'],STAXCurrentTestcase, testcaseStartTime,testcaseEndTime,numFail,numPass,issuesList,testcaseDuration)

2788N/A

2788N/A doLog = False

2788N/A

2788N/A # loop through the log lines

2788N/A for element in STAFResult:

3194N/A level=element['level']

3951N/A

3951N/A # this test is BEFORE the append so we don't get the

2788N/A # end of testcase banner in the XML but only the relevant data

2788N/A if level == 'Stop':

6103N/A doLog=False

6103N/A

6103N/A # if the current element is actually this test's output then log it

6103N/A if doLog == True:

6103N/A thisTest.appendLog('test',element['message'])

4865N/A

5061N/A # this test is AFTER the append log so we don't get the

5061N/A # "starting testcase ..." header in the XML

5061N/A if level == 'Start':

5061N/A tmp = element['message'].split(':')

5061N/A # this is a verification that we start logging for the right

5061N/A # test case. this is especially useful for tests that execute

5061N/A # within the same second (that is the resolution of the STAF

5061N/A # log facility)

5061N/A if thisTest.getName().startswith(tmp[3]):

5061N/A doLog=True

5061N/A

5061N/A # parse the server's error log

5061N/A # TODO: figure out how to do this for multiple instance for the replication

5061N/A # tests for example

5061N/A for logType in ['errors','access']:

5061N/A if os.path.exists('%s/%s/logs/%s' % (DIRECTORY_INSTANCE_DIR,OPENDSNAME,logType)):

5061N/A logfile=open('%s/%s/logs/%s' % (DIRECTORY_INSTANCE_DIR,OPENDSNAME,logType),'a')

5061N/A logfile.seek(0,2)

4865N/A logfile.write('End testcase %s\n' % STAXCurrentTestcase)

5815N/A logfile.close()

5815N/A logfile=open('%s/%s/logs/%s' % (DIRECTORY_INSTANCE_DIR,OPENDSNAME,logType), 'r')

5815N/A _log=''

5815N/A _doLog=False

5815N/A while True:

5815N/A line = logfile.readline()

5815N/A if not line:

5815N/A break

5815N/A if line.startswith('End testcase %s' % STAXCurrentTestcase):

5815N/A _doLog=False

5815N/A if _doLog:

5816N/A _log+=line

5815N/A if line.startswith('Begin testcase %s' % STAXCurrentTestcase):

6103N/A _doLog=True

6103N/A logfile.close()

6103N/A thisTest.appendLog(logType, _log)

6103N/A

2788N/A # save to test log

2788N/A testlog=open('%s/tests-log.xml' % logs.tests,'a')

2788N/A testlog.seek(0,2)

5073N/A testlog.write(thisTest.toXML())

5912N/A testlog.close()

2788N/A

5073N/A # clean the temporary log files for this test

2788N/A # this MUST be done AFTER the call to toXML or the logs will appear empty

2788N/A thisTest.clean()

5073N/A </script>

3853N/A

3853N/A <if expr="thisTest.message">

2788N/A <iterate in="thisTest.message" var="_message">

2788N/A <message>'%s' % _message</message>

2788N/A </iterate>

2788N/A </if>

2788N/A

5073N/A <script>thisTest.message=[]</script>

3853N/A

4153N/A </sequence>

2788N/A </function>

2788N/A

2788N/A <function name="testSuite_Preamble">

2788N/A <function-prolog>

2788N/A Performs all the pre operations for a test suite

2788N/A </function-prolog>

2788N/A <function-no-args />

2788N/A <sequence>

2788N/A

2788N/A <!-- Take the values from the current test path -->

2788N/A <script>

2788N/A if not CurrentTestPath.has_key('group'):

2788N/A CurrentTestPath['group']='unknown-group'

2788N/A

2788N/A if not CurrentTestPath.has_key('suite'):

2788N/A CurrentTestPath['suite']='unknown-suite'

2788N/A

5073N/A ThisGroupName=CurrentTestPath['group']

5073N/A ThisSuiteName=CurrentTestPath['suite']

5073N/A </script>

5073N/A

5073N/A <!-- Start time of test suite -->

5073N/A <script>

2788N/A TestSuiteStartTime=strftime("%Y%m%d@%H:%M:%S",localtime())

2788N/A </script>

2788N/A

2788N/A <message>

2788N/A '#### %s/%s suite preamble ####' % (ThisGroupName,ThisSuiteName)

4865N/A </message>

2788N/A

2788N/A </sequence>

2788N/A </function>

2788N/A

2788N/A <function name="testSuite_Postamble">

4865N/A <function-prolog>

2788N/A Performs all the post operations for a test suite

2788N/A </function-prolog>

2788N/A <function-no-args />

2788N/A <sequence>

2788N/A

2788N/A <!-- Take the values from the current test path -->

2788N/A <script>

2788N/A if CurrentTestPath.has_key('suite'):

2788N/A ThisSuiteName=CurrentTestPath['suite']

2788N/A else:

2788N/A ThisSuiteName='unknown-suite'

2788N/A

5073N/A if CurrentTestPath.has_key('group'):

5073N/A ThisGroupName=CurrentTestPath['group']

5073N/A else:

2788N/A ThisGroupName='unknown-group'

2788N/A </script>

2788N/A

2788N/A <message>

2788N/A '#### %s/%s suite postamble ####' % (ThisGroupName,ThisSuiteName)

5073N/A </message>

5073N/A

5073N/A <!-- Start time of test suite -->

5073N/A <script>

5073N/A TestSuiteEndTime=strftime("%Y%m%d@%H:%M:%S",localtime())

5073N/A </script>

5184N/A

5073N/A <!-- Format the test group and suite names to create folder -->

5073N/A <script>

5073N/A FormattedTestcase=format_testcase()

5073N/A FormattedTestgroup=FormattedTestcase.group(ThisGroupName)

5073N/A FormattedTestsuite=FormattedTestcase.suite(ThisSuiteName)

5073N/A

5073N/A TestLogDir= '%s/%s' % (logs.tests,FormattedTestgroup)

5073N/A TestLogFile='%s/%s' % (TestLogDir,FormattedTestsuite)

2788N/A </script>

2788N/A

2788N/A <call function="'WriteLogsForTestCase'">

5073N/A { 'starttime' : TestSuiteStartTime,

5073N/A 'endtime' : TestSuiteEndTime,

5073N/A 'logFile' : TestLogFile }

5073N/A </call>

5073N/A

5073N/A <script>

5073N/A if CurrentTestPath.has_key('suite'):

5073N/A del CurrentTestPath['suite']

5073N/A </script>

2788N/A

2788N/A </sequence>

2788N/A </function>

5073N/A

5073N/A <function name="testGroup_Preamble">

5073N/A <function-prolog>

5073N/A Performs all the pre operations for a test group

5073N/A </function-prolog>

5073N/A <function-no-args />

5073N/A <sequence>

5073N/A <!-- Take the values from the current test path -->

5073N/A <script>

5073N/A if not CurrentTestPath.has_key('group'):

5073N/A CurrentTestPath['group']='unknown-group'

5073N/A

5073N/A ThisGroupName=CurrentTestPath['group']

5073N/A </script>

5073N/A <message>'##### %s group preamble #####' % ThisGroupName</message>

2788N/A </sequence>

2788N/A </function>

2788N/A

5073N/A <function name="testGroup_Postamble">

5073N/A <function-prolog>

5073N/A Performs all the post operations for a test group

2788N/A </function-prolog>

2788N/A <function-no-args />

2788N/A <sequence>

5073N/A

5073N/A <script>

5073N/A if CurrentTestPath.has_key('group'):

2788N/A ThisGroupName=CurrentTestPath['group']

2788N/A else:

2788N/A ThisGroupName='unknown-group'

5073N/A

5073N/A coverage='N/A'

5073N/A </script>

2788N/A

2788N/A <message>'##### %s group postamble #####' % ThisGroupName</message>

4865N/A

2788N/A <script>

2788N/A emmaJar='%s/%s/lib/emma.jar' % (DIRECTORY_INSTANCE_DIR,OPENDSNAME)

2788N/A </script>

2788N/A <if expr="os.path.exists(emmaJar)">

2788N/A <sequence>

2788N/A <script>

2788N/A coveragePath=os.path.join(LOGS_ROOT,'coverage')

2788N/A coverageEm=os.path.join(coveragePath,'coverage.em')

2788N/A ecPath=os.path.join(coveragePath,CurrentTestPath['group'])

2788N/A coverageEcs=[ os.path.join(ecPath,ec) for ec in os.listdir(ecPath) if ec.startswith('coverage') and ec.endswith('.ec')]

2788N/A coverageFiles=','.join(coverageEcs)

2788N/A coverageXml=os.path.join(ecPath,'coverage.xml')

2788N/A coverageHtml=os.path.join(ecPath,'coverage.html')

2788N/A srcPathPrefix = os.path.join(TMPDIR,"..","..","..","..","..","..","src")

2788N/A srcPaths = [ os.path.join(srcPathPrefix,"server"),

2788N/A os.path.join(srcPathPrefix,"ads"),

2788N/A os.path.join(srcPathPrefix,"server","org"),

2788N/A os.path.join(srcPathPrefix,"admin","defn","org"),

2788N/A os.path.join(srcPathPrefix,"snmp","src","org"),

2788N/A os.path.join(srcPathPrefix,"ads","org"),

2788N/A os.path.join(srcPathPrefix,"dsml","org"),

2788N/A os.path.join(srcPathPrefix,"messages","src","org")

2788N/A ]

2788N/A srcArgs = " -sp ".join(srcPaths)

2788N/A </script>

2788N/A <call function="'runCommand'">

2788N/A { 'name' : 'Generate coverage xml report for test group %s' % CurrentTestPath['group'],

2788N/A 'command' : 'java',

2788N/A 'arguments' : ' -Xms64M -Xmx1G -cp %s emma report -r html -in %s,%s -Dreport.html.out.file=%s -sp %s' % (emmaJar, coverageEm, coverageFiles, coverageHtml, srcArgs),

4865N/A 'path' : TMPDIR

2788N/A }

2788N/A </call>

2788N/A <script>

2788N/A from java.io import FileInputStream

2788N/A from javax.xml.transform.stream import StreamSource

2788N/A from javax.xml.transform.stream import StreamResult

5073N/A from javax.xml.parsers import DocumentBuilderFactory

5073N/A from org.w3c.dom import *

5073N/A

5073N/A factory = DocumentBuilderFactory.newInstance()

5073N/A builder = factory.newDocumentBuilder()

5073N/A

5073N/A input = FileInputStream("%s/coverage/%s/coverage.xml" % (TMPDIR,CurrentTestPath['group']))

5073N/A document = builder.parse(input)

5073N/A dom = document.getDocumentElement()

5073N/A coverageNodes = dom.getElementsByTagName("all").item(0).getChildNodes()

5073N/A for coverageNodeIndex in range(coverageNodes.getLength()):

5073N/A thisNode = coverageNodes.item(coverageNodeIndex)

2788N/A if thisNode.getNodeName() == 'coverage':

2788N/A thisNodeAttributes = thisNode.getAttributes()

2788N/A if thisNodeAttributes.getNamedItem("type").getNodeValue() == 'block, %':

2788N/A rawCoverage = thisNodeAttributes.getNamedItem("value").getNodeValue()

2788N/A coverage = rawCoverage.split('%')[0]

4865N/A testlog=open('%s/tests-log.xml' % logs.tests,'a')

2788N/A testlog.seek(0,2)

2788N/A testlog.write(" &lt;group&gt;\n")

2788N/A testlog.write(" &lt;name&gt;\n")

2788N/A testlog.write(" %s\n" % CurrentTestPath['group'])

2788N/A testlog.write(" &lt;/name&gt;\n")

4865N/A testlog.write(" &lt;coverage&gt;\n")

3289N/A testlog.write(" %s\n" % coverage)

3289N/A testlog.write(" &lt;/coverage&gt;\n")

3289N/A testlog.write(" &lt;/group&gt;\n")

3289N/A testlog.close()

3289N/A </script>

4865N/A </sequence>

4865N/A <else>

3951N/A <script>

3951N/A testlog=open('%s/tests-log.xml' % logs.tests,'a')

3951N/A testlog.seek(0,2)

3951N/A testlog.write(" &lt;group&gt;\n")

4865N/A testlog.write(" &lt;name&gt;\n")

5073N/A testlog.write(" %s\n" % CurrentTestPath['group'])

5073N/A testlog.write(" &lt;/name&gt;\n")

5073N/A testlog.write(" &lt;coverage&gt;\n")

5073N/A testlog.write(" N/A\n")

5073N/A testlog.write(" &lt;/coverage&gt;\n")

5073N/A testlog.write(" &lt;/group&gt;\n")

5073N/A testlog.close()

5073N/A </script>

5073N/A </else>

2788N/A </if>

5073N/A

2788N/A <script>

5073N/A if CurrentTestPath.has_key('group'):

2788N/A del CurrentTestPath['group']

2788N/A </script>

5073N/A </sequence>

5073N/A </function>

2788N/A

2788N/A <function name="WriteLogsForTestCase" scope="local">

5073N/A

5073N/A <function-prolog>

5073N/A Queries the staf logs for the test case and write to file as text

2788N/A </function-prolog>

5912N/A <function-map-args>

5912N/A <function-arg-def name="starttime" type="required">

5073N/A <function-arg-description>

5073N/A timestamp to start logging from

5073N/A </function-arg-description>

5073N/A <function-arg-property name="type" value="timestamp"/>

5073N/A </function-arg-def>

5073N/A <function-arg-def name="endtime" type="required">

5073N/A <function-arg-description>

5073N/A timestamp to start logging to

5073N/A </function-arg-description>

5073N/A <function-arg-property name="type" value="timestamp"/>

5073N/A </function-arg-def>

5073N/A <function-arg-def name="logFile" type="required">

5073N/A <function-arg-description>

5073N/A name of file to write the logs

5073N/A </function-arg-description>

5073N/A <function-arg-property name="type" value="filepath"/>

5073N/A </function-arg-def>

5073N/A </function-map-args>

5073N/A

5073N/A <sequence>

5073N/A

5073N/A <script>

5073N/A xmlFile = '%s-log.xml' % logFile

5912N/A htmlFile = '%s-log.html' % logFile

5073N/A xslFile = '%s/gen-logs.xsl' % TESTS_XSL_DIR

5073N/A </script>

5073N/A

5912N/A <!-- Query STAF to obtain the logs for the test case -->

5073N/A <call function="'queryLogs'">

5073N/A { 'location' : STAXServiceMachine,

5073N/A 'logname' : 'STAX_Job_%s_User' % STAXJobID,

5073N/A 'startfrom' : starttime,

5073N/A 'endat' : endtime }

5073N/A </call>

5073N/A

5073N/A <!-- Write out the logs into an XML file -->

5073N/A <call function="'WriteXmlLogs'">

5073N/A { 'queryresult' : STAFResult,

5073N/A 'output' : xmlFile }

5073N/A </call>

5073N/A

5073N/A <!-- Transform the XML file into an HTML file -->

5073N/A <call function="'WriteHtmlLogs'">

5073N/A { 'input' : xmlFile,

5073N/A 'stylesheet' : xslFile,

5073N/A 'output' : htmlFile }

5073N/A </call>

5073N/A

5073N/A </sequence>

5073N/A

5073N/A </function>

5073N/A

5073N/A <function name="WriteXmlLogs" scope="local">

5073N/A

5073N/A <function-prolog>

5073N/A Process staf log query results and write them to a file

5073N/A </function-prolog>

5073N/A <function-map-args>

5073N/A <function-arg-def name="queryresult" type="required">

5073N/A <function-arg-description>

5073N/A result of the staf log query

5073N/A </function-arg-description>

5073N/A <function-arg-property name="type" value="string"/>

5073N/A </function-arg-def>

5073N/A <function-arg-def name="output" type="required">

5073N/A <function-arg-description>

5073N/A name of the XML file to where results are written

5073N/A </function-arg-description>

5073N/A <function-arg-property name="type" value="string"/>

5073N/A </function-arg-def>

5073N/A </function-map-args>

5073N/A

5073N/A <sequence>

5073N/A

5073N/A <script>

5073N/A logFile=output

5073N/A NewLogDir=os.path.dirname(logFile)

5073N/A </script>

5073N/A

5073N/A <message>'Creating XML log file %s' % logFile</message>

2788N/A

5073N/A <call function="'createFolder'">

5912N/A { 'location' : STAXServiceMachine,

5912N/A 'foldername' : NewLogDir }

5912N/A </call>

5912N/A

5912N/A <script>

5912N/A from xml.dom.minidom import Document

5073N/A doc = Document()

5073N/A

5073N/A # Create the qa base element

5912N/A qa = doc.createElement("qa")

5073N/A doc.appendChild(qa)

5073N/A

5073N/A # Create the base element

5073N/A logs = doc.createElement("logs")

2788N/A qa.appendChild(logs)

5073N/A

5073N/A # Try to pass only the pretty print of the test suite name

5073N/A try:

5073N/A suite=CurrentTestPath['suite'].split('.')[2].strip()

5073N/A except:

5073N/A formattedTestcase = format_testcase()

5073N/A suite = formattedTestcase.suite(CurrentTestPath['suite'])

5073N/A

2788N/A # Create the log element

3269N/A log = doc.createElement("log")

3269N/A log.setAttribute("group", "%s" % CurrentTestPath['group'])

5815N/A log.setAttribute("suite", "%s" % suite)

5073N/A log.setAttribute("jobid", "%s" % STAXJobID)

3269N/A log.setAttribute("parent", "%s" % STAXParentID)

5073N/A logs.appendChild(log)

5073N/A </script>

2788N/A

5073N/A <if expr="queryresult == '[]'">

5073N/A <sequence>

5073N/A <script>

5073N/A output1 = 'queryresult is empty'

5073N/A output2 = 'check the date between the OS, the logs'

5073N/A output3 = 'and the local time zone'

5073N/A output = '%s %s %s' % (output1,output2,output3)

5073N/A </script>

5073N/A <call function="'checktestRC'">

5073N/A { 'returncode' : '1' ,

5073N/A 'result' : output,

5073N/A 'expected' : '0' }

5073N/A </call>

3289N/A </sequence>

2788N/A <else>

2788N/A <iterate var="element" in="queryresult">

5073N/A <script>

5073N/A level=element['level']

5073N/A message=element['message']

2788N/A timestamp=element['timestamp']

2788N/A

2788N/A line = doc.createElement("line")

2788N/A line.setAttribute("timestamp", "%s" % timestamp)

2788N/A line.setAttribute("level", "%s" % level)

5476N/A line.setAttribute("message", "%s" % message)

2788N/A if level == 'Start':

2788N/A tag=get_test_name(message.replace('testcase: ',''))

2788N/A line.setAttribute("tag", "%s" % tag.lower())

2788N/A log.appendChild(line)

3853N/A </script>

3853N/A </iterate>

3853N/A </else>

2788N/A </if>

2788N/A

2788N/A <script>

2788N/A _message='Generated XML test case report.'

2788N/A testlogfh=open('%s' % logFile,'w')

3853N/A try:

3853N/A testlogfh.writelines(doc.toprettyxml(indent=" "))

4153N/A except AttributeError,details:

2788N/A _message='Unable to generate XML test case report %s.' % details

2788N/A except:

2788N/A _message='Unable to generate XML test case report !!!'

2788N/A testlogfh.close()

2788N/A </script>

3853N/A

3853N/A <message>_message</message>

3853N/A

2788N/A </sequence>

2788N/A

2788N/A </function>

2788N/A

4865N/A <function name="WriteHtmlLogs" scope="local">

3853N/A

3853N/A <function-prolog>

3853N/A Process XML file and transform that to an HTML log file

2788N/A </function-prolog>

2788N/A <function-map-args>

2788N/A <function-arg-def name="input" type="required">

2788N/A <function-arg-description>

2788N/A name of the XML file to where results are obtained