XML automation - Part V - Validate XML response

This is the last part...but I will try to summarize the posts in an article later on...maybe I will add more features, for example how to handle attributes and multiple elements.

All the example code and files are available in compressed format here for download.

Please note that I have changed the test case parameter ConvertTempResult to #ConvertTempResult in order to mark up output parameters.



Here is the function for response validation:

Function validateXMLResponse (objDictionary)

Set xmlDoc = CreateObject("Msxml2.DOMDocument")

'loadXML

xmlDoc.loadXML(objDictionary.Item("XMLResponse"))

'Check XML syntax

If (xmlDoc.parseError.errorCode <> 0) Then

Set myErr = xmlDoc.parseError

objDictionary.Item("XMLResponseResult") = "Failed"

objDictionary.Item("XMLResponseResultDetails") = "ERROR: " & myErr.reason

Set validateXMLResponse = objDictionary

Exit Function

End If

Set root = xmlDoc.documentElement

'Put all test parameters in array

arrAllKeys = objDictionary.Keys

arrAllValues = objDictionary.Items

'Update values

For i = 0 to Ubound(arrAllKeys)

'Only process #-type parameters

If Left(arrAllKeys(i),1) = "#" Then

strParameterElementName = arrAllKeys(i)

strParameterElementName = Right(strParameterElementName,Len(strParameterElementName)-1)

strParameterElementValueExpected = arrAllValues(i)

'Get element and value

Set node = root.getElementsByTagName(strParameterElementName)

If node.Length > 0 Then

For n = 0 to node.Length-1

'Return actual value in [element]_Out

objDictionary.Item(strParameterElementName & "_Out") = node.Item(n).Text

strParameterElementValueActual = node.Item(n).Text

'Set result

If strParameterElementValueExpected = strParameterElementValueActual AND _

objDictionary.Item("XMLResponseResult") <> "Failed" Then

objDictionary.Item("XMLResponseResult") = "Passed"

Else

objDictionary.Item("XMLResponseResult") = "Failed"

objDictionary.Item("XMLResponseResultDetails") = objDictionary.Item("XMLResponseResultDetails") & _

strParameterElementName & " = " & strParameterElementValueActual & " , expected value " & _

strParameterElementValueExpected & " ;" 'use ; as separator

End If

Next

End If

Set node = Nothing

End If

Next

'Return

Set validateXMLResponse = objDictionary

'Clean up

Set root = Nothing

Set xmlDoc = Nothing

End Function

So finally we have these steps all together:

' Example of XML/Web Service automation in VBScript using WinHttp, XML DOM and ADO

' by Stefan Thelenius march 2008



'Set test case id and data source file

intTestCaseID = 1

strMyDataFile = "c:\MyTestData.xls"



'Get test case parameters

Set objMyTestParameters = getTestParametersIntoDictionary (strMyDataFile, _

"TestCase", "TestCaseID", intTestCaseID)



'Get global parameters

Set objMyGlobalParameters = getTestParametersIntoDictionary (strMyDataFile, _

"Global", "GlobalID", objMyTestParameters.Item("GlobalID"))



'Merge parameters

Set objMyTestParameters = mergeDictionaries (objMyGlobalParameters, objMyTestParameters)



'Create request from template

objMyTestParameters.Item("XMLRequest") = getXMLTemplate (objMyTestParameters.Item("XMLTemplateFile"), _

objMyTestParameters.Item("XMLTemplate"))



'Insert test parameters

objMyTestParameters.Item("XMLRequest") = setTestParametersInXMLRequest (objMyTestParameters)



'Send request

objMyTestParameters.Item("XMLResponse") = sendXMLRequest (objMyTestParameters)



'Validate response

Set objMyTestParameters = validateXMLResponse (objMyTestParameters)



'Display output

Msgbox objMyTestParameters.Item("XMLResponse")

Msgbox objMyTestParameters.Item("XMLResponseResult")

Msgbox objMyTestParameters.Item("XMLResponseResultDetails")

Msgbox objMyTestParameters.Item("ConvertTempResult_Out")