check xml query result

Check an XPath query result against an expected string.Result is Passed if the strings match, otherwise Failed.

Name	Description	Type	Modifier
xml	XML target string that the query runs against. Tip: To access content from an XML file, use the get text file action to load the XML document into a variable, then reference the variable in this argument.	String	None
xpath	XPath query string.	String	None
expected	(Optional) Expected query result.	String	None

Name

Description

Type

Modifier

xml

XML target string that the query runs against.

Tip:

To access content from an XML file, use the get text file action to load the XML document into a variable, then reference the variable in this argument.

String

None

xpath

XPath query string.

String

None

expected

(Optional) Expected query result.

String

None

Result is Passed if the strings match; otherwise Failed.

This action may be used within the following project items: test modules and user-defined actions.

Desktop Web, SAP, WPF, Java, .Net, Win32

Windows, Linux

The following settings are applicable to this action: remove double quotes from cells.

This action is applicable to the following controls: none

Example - Case 1: Using an XPath predicate in an XPath query

The following example retrieves the text from the title element of the first book element that is a child of a **bookstore** element and then compares the retrieved text against an expected value, Everyday Italian.

<?xml version="1.0"?>
<bookstore>
  <book id="bk101" category="COOKING">
    <title lang="en">Everyday Italian</title>
    <author>Giada De Laurentiis</author>
    <year>2005</year>
    <price>30</price>
  </book>
  <book id="bk102" category="CHILDREN">
    <title lang="en">Harry Potter</title>
    <author>J K. Rowling</author>
    <year>2005</year>
    <price>35</price>
  </book>
</bookstore>

Action lines

      
        	file	variable	
get text file	D:\bookstore.txt	bookstore	
&nbsp			
	xml	xpath	expected
check xml query result	# bookstore	/bookstore/book[1]/title/text()	Everyday Italian

Result

Example - Case 2: Using an XPath function in an XPath query

The following example calculates the sum of all price nodes and then compares the returned sum against an expected value, 65.

<?xml version="1.0"?>
<bookstore>
  <book id="bk101" category="COOKING">
    <title lang="en">Everyday Italian</title>
    <author>Giada De Laurentiis</author>
    <year>2005</year>
    <price>30</price>
  </book>
  <book id="bk102" category="CHILDREN">
    <title lang="en">Harry Potter</title>
    <author>J K. Rowling</author>
    <year>2005</year>
    <price>35</price>
  </book>
</bookstore>

Test Lines

      
        	file	variable	
get text file	D:\bookstore.txt	bookstore	
&nbsp			
	xml	xpath	expected
check xml query result	# bookstore	sum(/bookstore/book/price)	65

Result

Example - Case 3: Using a data set

The following example iteratively retrieves the contents of the price element based on the title variable defined within a data set and then compares it against the expected value, price, also defined within the data set.
As an example, the first iteration of the use data set loop issues an XPath query of //price[../title="Everyday Italian"]/text().

Important:

:To have TestArchitect parse a quotation mark, enter four consecutive quotation marks into the editor cell, that is, """".

<?xml version="1.0"?>
<bookstore>
  <book id="bk101" category="COOKING">
    <title lang="en">Everyday Italian</title>
    <author>Giada De Laurentiis</author>
    <year>2005</year>
    <price>30.00</price>
  </book>
  <book id="bk102" category="CHILDREN">
    <title lang="en">Harry Potter</title>
    <author>J K. Rowling</author>
    <year>2005</year>
    <price>35</price>
  </book>
</bookstore>

Action lines

      
        	file	variable	
get text file	D:\bookstore.txt	bookstore	
&nbsp			
	name		
use data set	/books_ds		
&nbsp			
	xml	xpath	expected
check xml query result	# bookstore	#"//price[../title=" & """" & title & """" & "]/text()"	# price
&nbsp			
repeat for data set

Result

Example - Case 4: Passing an entire XML file’s content into the xml argument

The following example passes an entire well-formed XML string into the xml argument. Whitespace and line breaks between XML nodes within the document have been removed beforehand, as required.

Action lines

      
        	xml	xpath	expected
check xml query result	&lt;bookstore&gt;&lt;book id="bk101" category="COOKING"&gt;&lt;title lang="en"&gt;Everyday Italian&lt;/title&gt;&lt;author&gt;Giada De Laurentiis&lt;/author&gt;&lt;year&gt;2005&lt;/year&gt;&lt;price&gt;30&lt;/price&gt;  &lt;/book&gt;&lt;book id="bk102" category="CHILDREN"&gt;&lt;title lang="en"&gt;Harry Potter&lt;/title&gt;&lt;author&gt;J K. Rowling&lt;/author&gt;&lt;year&gt;2005&lt;/year&gt;&lt;price&gt;35&lt;/price&gt;&lt;/book&gt;&lt;/bookstore&gt;	/bookstore/book[1]/title/text()	Everyday Italian

Result

Example - Case 5: Resolving the problem of namespaces

In this example, an XPath query is run against the following XML file with a namespace:

<cr:cricketers xmlns:cr="http://www.example.com/">
  <cr:cricketer type="righty">
  <name>MS Dhoni</name>
  <role>Captain</role>
  <position>Wicket-Keeper</position>
  </cr:cricketer>
  </cr:cricketers>

Use the local-name() function for your XPath, in order to retrieve the content of the <name> element of the cricketer node despite its enclosure in a namespace. For example, //*[local-name()=‘cricketer’]/name/text():

Test Lines

      
        	file	variable	
get text file	D:\cricketTeam_info.xml	team	
&nbsp			
	xml	xpath	expected
check xml query result	# team	//*[local-name()='cricketer']/name/text()	MS Dhoni

Result

An empty expected argument results in Pass if the returned XML is indeed empty; otherwise Fail.
It is possible to insert an entire XML file’s content into the xml argument; however, all whitespace and line breaks between XML nodes must be removed manually to avoid automation failure (see example #4 above).
If your XML target string has a namespace (defined by the xmlns attribute in the start tag of an element), yet no namespace is configured in the XPath expression, your query strings will not return any result. To resolve this namespace problem, you may use the local-name() function. This function returns the query results as if no namespace is declared in the target string (see example #5 above).
This action supports the <ignore> modifier. If the string <ignore> is present as the value of any of the arguments, or any argument contains an expression that evaluates to <ignore>, the action is skipped during execution.