debian man page for test::xml::xpath

Test::XML::XPath(3pm)					User Contributed Perl Documentation				     Test::XML::XPath(3pm)

NAME
       Test::XML::XPath - Test XPath assertions

SYNOPSIS
	 use Test::XML::XPath tests => 3;
	 like_xpath( '<foo />', '/foo' );   # PASS
	 like_xpath( '<foo />', '/bar' );   # FAIL
	 unlike_xpath( '<foo />', '/bar' ); # PASS

	 is_xpath( '<foo>bar</foo>', '/foo', 'bar' ); # PASS
	 is_xpath( '<foo>bar</foo>', '/bar', 'foo' ); # FAIL

	 # More interesting examples of xpath assertions.
	 my $xml = '<foo attrib="1"><bish><bosh args="42">pub</bosh></bish></foo>';

	 # Do testing for attributes.
	 like_xpath( $xml, '/foo[@attrib="1"]' ); # PASS
	 # Find an element anywhere in the document.
	 like_xpath( $xml, '//bosh' ); # PASS
	 # Both.
	 like_xpath( $xml, '//bosh[@args="42"]' ); # PASS

DESCRIPTION
       This module allows you to assert statements about your XML in the form of XPath statements.  You can say that a piece of XML must contain
       certain tags, with so-and-so attributes, etc.  It will try to use any installed XPath module that it knows about.  Currently, this means
       XML::LibXML and XML::XPath, in that order.

       NB: Normally in XPath processing, the statement occurs from a context node.  In the case of like_xpath(), the context node will always be
       the root node.  In practice, this means that these two statements are identical:

	  # Absolute path.
	  like_xpath( '<foo/>', '/foo' );
	  # Path relative to root.
	  like_xpath( '<foo/>', 'foo' );

       It's probably best to use absolute paths everywhere in order to keep things simple.

       NB: Beware of specifying attributes.  Because they use an @-sign, perl will complain about trying to interpolate arrays if you don't escape
       them or use single quotes.

FUNCTIONS
       like_xpath ( XML, XPATH [, NAME ] )
	   Assert that XML (a string containing XML) matches the statement XPATH.  NAME is the name of the test.

	   Returns true or false depending upon test success.

       unlike_xpath ( XML, XPATH [, NAME ] )
	   This is the reverse of like_xpath().  The test will only pass if XPATH does not generates any matches in XML.

	   Returns true or false depending upon test success.

       is_xpath ( XML, XPATH, EXPECTED [, NAME ] )
	   Evaluates XPATH against XML, and pass the test if the is EXPECTED.  Uses findvalue() internally.

	   Returns true or false depending upon test success.

       set_xpath_processor ( CLASS )
	   Set the class name of the XPath processor used.  It is up to you to ensure that this class is loaded.

       In all cases, XML must be well formed, or the test will fail.

SEE ALSO
       Test::XML.

       XML::XPath, which is the basis for this module.

       If you are not conversant with XPath, there are many tutorials available on the web.  Google will point you at them.  The first one that I
       saw was: <http://www.zvon.org/xxl/XPathTutorial/>, which appears to offer interactive XPath as well as the tutorials.

AUTHOR
       Dominic Mitchell <cpan2 (at) semantico.com>

COPYRIGHT AND LICENSE
       Copyright 2002 by semantico

       This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

perl v5.14.2							    2009-07-02						     Test::XML::XPath(3pm)