# $Id$
##
# this test checks the DOM Document interface of XML::LibXML
# it relies on the success of t/01basic.t and t/02parse.t
# it will ONLY test the DOM capabilities as specified in DOM Level3
# XPath tests should be done in another test file
# since all tests are run on a preparsed
use strict;
use warnings;
# Should be 168.
use Test::More tests => 193;
use XML::LibXML;
use XML::LibXML::Common qw(:libxml);
use IO::Handle;
sub is_empty_str
{
my $s = shift;
return (!defined($s) or (length($s) == 0));
}
# TEST:$c=0;
sub _check_element_node
{
local $Test::Builder::Level = $Test::Builder::Level + 1;
my ($node, $name, $blurb) = @_;
# TEST:$c++;
ok($node, "$blurb - node was initialised");
# TEST:$c++;
is($node->nodeType, XML_ELEMENT_NODE, "$blurb - node is an element node");
# TEST:$c++;
is($node->nodeName, $name, "$blurb - node has the right name.");
}
# TEST:$_check_element_node=$c;
sub _check_created_element
{
local $Test::Builder::Level = $Test::Builder::Level + 1;
my ($doc, $given_name, $name, $blurb) = @_;
return _check_element_node(
$doc->createElement($given_name),
$name,
$blurb
);
}
# TEST:$_check_created_element=$_check_element_node;
sub _multi_arg_generic_count
{
local $Test::Builder::Level = $Test::Builder::Level + 1;
my ($doc, $method, $params) = @_;
my ($meth_params, $want_count, $blurb) = @$params;
my @elems = $doc->$method( @$meth_params );
return is (scalar(@elems), $want_count, $blurb);
}
sub _generic_count
{
local $Test::Builder::Level = $Test::Builder::Level + 1;
my ($doc, $method, $params) = @_;
my ($name, $want_count, $blurb) = @$params;
return _multi_arg_generic_count(
$doc, $method, [[$name], $want_count, $blurb, ],
);
}
sub _count_local_name
{
local $Test::Builder::Level = $Test::Builder::Level + 1;
my $doc = shift;
return _generic_count($doc, 'getElementsByLocalName', [@_]);
}
sub _count_tag_name
{
local $Test::Builder::Level = $Test::Builder::Level + 1;
my $doc = shift;
return _generic_count($doc, 'getElementsByTagName', [@_]);
}
sub _count_children_by_local_name
{
local $Test::Builder::Level = $Test::Builder::Level + 1;
my $doc = shift;
return _generic_count($doc, 'getChildrenByLocalName', [@_]);
}
sub _count_children_by_name
{
local $Test::Builder::Level = $Test::Builder::Level + 1;
my $doc = shift;
return _generic_count($doc, 'getChildrenByTagName', [@_]);
}
sub _count_elements_by_name_ns
{
local $Test::Builder::Level = $Test::Builder::Level + 1;
my ($doc, $ns_and_name, $want_count, $blurb) = @_;
return _multi_arg_generic_count($doc, 'getElementsByTagNameNS',
[$ns_and_name, $want_count, $blurb]
);
}
sub _count_children_by_name_ns
{
local $Test::Builder::Level = $Test::Builder::Level + 1;
my ($doc, $ns_and_name, $want_count, $blurb) = @_;
return _multi_arg_generic_count($doc, 'getChildrenByTagNameNS',
[$ns_and_name, $want_count, $blurb]
);
}
{
# Document Attributes
my $doc = XML::LibXML::Document->createDocument();
# TEST
ok($doc, ' TODO : Add test name');
# TEST
ok( ! defined($doc->encoding), ' TODO : Add test name');
# TEST
is( $doc->version, "1.0", ' TODO : Add test name' );
# TEST
is( $doc->standalone, -1, ' TODO : Add test name' ); # is the value we get for undefined,
# actually the same as 0 but just not set.
# TEST
ok( !defined($doc->URI), ' TODO : Add test name'); # should be set by default.
# TEST
is( $doc->compression, -1, ' TODO : Add test name' ); # -1 indicates NO compression at all!
# while 0 indicates just no zip compression
# (big difference huh?)
$doc->setEncoding( "iso-8859-1" );
# TEST
is( $doc->encoding, "iso-8859-1", 'Encoding was set.' );
$doc->setVersion(12.5);
# TEST
is( $doc->version, "12.5", 'Version was set.' );
$doc->setStandalone(1);
# TEST
is( $doc->standalone, 1, 'Standalone was set.' );
$doc->setBaseURI( "localhost/here.xml" );
# TEST
is( $doc->URI, "localhost/here.xml", 'URI is set.' );
my $doc2 = XML::LibXML::Document->createDocument("1.1", "iso-8859-2");
# TEST
is( $doc2->encoding, "iso-8859-2", 'doc2 encoding was set.' );
# TEST
is( $doc2->version, "1.1", 'doc2 version was set.' );
# TEST
is( $doc2->standalone, -1, 'doc2 standalone' );
}
{
# 2. Creating Elements
my $doc = XML::LibXML::Document->new();
{
my $node = $doc->createDocumentFragment();
# TEST
ok($node, ' TODO : Add test name');
# TEST
is($node->nodeType, XML_DOCUMENT_FRAG_NODE, ' TODO : Add test name');
}
# TEST*$_check_created_element
_check_created_element($doc, 'foo', 'foo', 'Simple Element');
{
# document with encoding
my $encdoc = XML::LibXML::Document->new( "1.0" );
$encdoc->setEncoding( "iso-8859-1" );
# TEST*$_check_created_element
_check_created_element(
$encdoc, 'foo', 'foo', 'Encdoc Element creation'
);
# SAX style document with encoding
my $node_def = {
Name => "object",
LocalName => "object",
Prefix => "",
NamespaceURI => "",
};
# TEST*$_check_created_element
_check_created_element(
$encdoc, $node_def->{Name}, 'object',
'Encdoc element creation based on node_def->{name}',
);
}
{
# namespaced element test
my $node = $doc->createElementNS( "http://kungfoo", "foo:bar" );
# TEST
ok($node, ' TODO : Add test name');
# TEST
is($node->nodeType, XML_ELEMENT_NODE, ' TODO : Add test name');
# TEST
is($node->nodeName, "foo:bar", ' TODO : Add test name');
# TEST
is($node->prefix, "foo", ' TODO : Add test name');
# TEST
is($node->localname, "bar", ' TODO : Add test name');
# TEST
is($node->namespaceURI, "http://kungfoo", ' TODO : Add test name');
}
{
# bad element creation
# TEST:$badnames_count=5;
my @badnames = ( ";", "&", "<><", "/", "1A");
foreach my $name ( @badnames ) {
my $node = eval {$doc->createElement( $name );};
# TEST*$badnames_count
ok( !(defined $node), ' TODO : Add test name' );
}
}
{
my $node = $doc->createTextNode( "foo" );
# TEST
ok($node, ' TODO : Add test name');
# TEST
is($node->nodeType, XML_TEXT_NODE, ' TODO : Add test name' );
# TEST
is($node->nodeValue, "foo", ' TODO : Add test name' );
}
{
my $node = $doc->createComment( "foo" );
# TEST
ok($node, ' TODO : Add test name');
# TEST
is($node->nodeType, XML_COMMENT_NODE, ' TODO : Add test name' );
# TEST
is($node->nodeValue, "foo", ' TODO : Add test name' );
# TEST
is($node->toString, "", ' TODO : Add test name');
}
{
my $node = $doc->createCDATASection( "foo" );
# TEST
ok($node, ' TODO : Add test name');
# TEST
is($node->nodeType, XML_CDATA_SECTION_NODE, ' TODO : Add test name' );
# TEST
is($node->nodeValue, "foo", ' TODO : Add test name' );
# TEST
is($node->toString, "", ' TODO : Add test name');
}
# -> Create Attributes
{
my $attr = $doc->createAttribute("foo", "bar");
# TEST
ok($attr, ' TODO : Add test name');
# TEST
is($attr->nodeType, XML_ATTRIBUTE_NODE, ' TODO : Add test name' );
# TEST
is($attr->name, "foo", ' TODO : Add test name');
# TEST
is($attr->value, "bar", ' TODO : Add test name' );
# TEST
is($attr->hasChildNodes, 0, ' TODO : Add test name');
my $content = $attr->firstChild;
# TEST
ok( $content, ' TODO : Add test name' );
# TEST
is( $content->nodeType, XML_TEXT_NODE, ' TODO : Add test name' );
}
{
# bad attribute creation
# TEST:$badnames_count=5;
my @badnames = ( ";", "&", "<><", "/", "1A");
foreach my $name ( @badnames ) {
my $node = eval {$doc->createAttribute( $name, "bar" );};
# TEST*$badnames_count
ok( !defined($node), ' TODO : Add test name' );
}
}
{
my $elem = $doc->createElement('foo');
my $attr = $doc->createAttribute(attr => 'e & f');
$elem->addChild($attr);
# TEST
ok ($elem->toString() eq '', ' TODO : Add test name');
$elem->removeAttribute('attr');
$attr = $doc->createAttributeNS(undef,'attr2' => 'a & b');
$elem->addChild($attr);
# TEST
ok ($elem->toString() eq '', ' TODO : Add test name');
}
{
eval {
my $attr = $doc->createAttributeNS("http://kungfoo", "kung:foo","bar");
};
# TEST
ok($@, ' TODO : Add test name');
my $root = $doc->createElement( "foo" );
$doc->setDocumentElement( $root );
my $attr;
eval {
$attr = $doc->createAttributeNS("http://kungfoo", "kung:foo","bar");
};
# TEST
ok($attr, ' TODO : Add test name');
# TEST
is($attr->nodeName, "kung:foo", ' TODO : Add test name');
# TEST
is($attr->name,"foo", ' TODO : Add test name' );
# TEST
is($attr->value, "bar", ' TODO : Add test name' );
$attr->setValue( q(bar&) );
# TEST
is($attr->getValue, q(bar&), ' TODO : Add test name' );
}
{
# bad attribute creation
# TEST:$badnames_count=5;
my @badnames = ( ";", "&", "<><", "/", "1A");
foreach my $name ( @badnames ) {
my $node = eval {$doc->createAttributeNS( undef, $name, "bar" );};
# TEST*$badnames_count
ok( (!defined $node), ' TODO : Add test name' );
}
}
# -> Create PIs
{
my $pi = $doc->createProcessingInstruction( "foo", "bar" );
# TEST
ok($pi, ' TODO : Add test name');
# TEST
is($pi->nodeType, XML_PI_NODE, ' TODO : Add test name');
# TEST
is($pi->nodeName, "foo", ' TODO : Add test name');
# TEST
is($pi->textContent, "bar", ' TODO : Add test name');
# TEST
is($pi->getData, "bar", ' TODO : Add test name');
}
{
my $pi = $doc->createProcessingInstruction( "foo" );
# TEST
ok($pi, ' TODO : Add test name');
# TEST
is($pi->nodeType, XML_PI_NODE, ' TODO : Add test name');
# TEST
is($pi->nodeName, "foo", ' TODO : Add test name');
my $data = $pi->textContent;
# undef or "" depending on libxml2 version
# TEST
ok( is_empty_str($data), ' TODO : Add test name' );
$data = $pi->getData;
# TEST
ok( is_empty_str($data), ' TODO : Add test name' );
$pi->setData(q(bar&));
# TEST
is( $pi->getData, q(bar&), ' TODO : Add test name');
# TEST
is($pi->textContent, q(bar&), ' TODO : Add test name');
}
}
{
# Document Manipulation
# -> Document Elements
my $doc = XML::LibXML::Document->new();
my $node = $doc->createElement( "foo" );
$doc->setDocumentElement( $node );
my $tn = $doc->documentElement;
# TEST
ok($tn, ' TODO : Add test name');
# TEST
ok($node->isSameNode($tn), ' TODO : Add test name');
my $node2 = $doc->createElement( "bar" );
{ my $warn;
eval {
local $SIG{__WARN__} = sub { $warn = 1 };
# TEST
ok( !defined($doc->appendChild($node2)), ' TODO : Add test name' );
};
# TEST
ok(($@ or $warn), ' TODO : Add test name');
}
my @cn = $doc->childNodes;
# TEST
is( scalar(@cn) , 1, ' TODO : Add test name');
# TEST
ok($cn[0]->isSameNode($node), ' TODO : Add test name');
eval {
$doc->insertBefore($node2, $node);
};
# TEST
ok ($@, ' TODO : Add test name');
@cn = $doc->childNodes;
# TEST
is( scalar(@cn) , 1, ' TODO : Add test name');
# TEST
ok($cn[0]->isSameNode($node), ' TODO : Add test name');
$doc->removeChild($node);
@cn = $doc->childNodes;
# TEST
is( scalar(@cn) , 0, ' TODO : Add test name');
for ( 1..2 ) {
my $nodeA = $doc->createElement( "x" );
$doc->setDocumentElement( $nodeA );
}
# TEST
ok(1, ' TODO : Add test name'); # must not segfault here :)
$doc->setDocumentElement( $node2 );
@cn = $doc->childNodes;
# TEST
is( scalar(@cn) , 1, ' TODO : Add test name');
# TEST
ok($cn[0]->isSameNode($node2), ' TODO : Add test name');
my $node3 = $doc->createElementNS( "http://foo", "bar" );
# TEST
ok($node3, ' TODO : Add test name');
# -> Processing Instructions
{
my $pi = $doc->createProcessingInstruction( "foo", "bar" );
$doc->appendChild( $pi );
@cn = $doc->childNodes;
# TEST
ok( $pi->isSameNode($cn[-1]), ' TODO : Add test name' );
$pi->setData( 'bar="foo"' );
# TEST
is( $pi->textContent, 'bar="foo"', ' TODO : Add test name');
$pi->setData( foo=>"foo" );
# TEST
is( $pi->textContent, 'foo="foo"', ' TODO : Add test name');
}
}
package Stringify;
use overload q[""] => sub { return 'foobarXbaz'; };
sub new
{
return bless \(my $x);
}
package main;
{
# Document Storing
my $parser = XML::LibXML->new;
my $doc = $parser->parse_string("bar");
# TEST
ok( $doc, ' TODO : Add test name' );
# -> to file handle
{
open my $fh, '>', 'example/testrun.xml'
or die "Cannot open example/testrun.xml for writing - $!.";
$doc->toFH( $fh );
$fh->close;
# TEST
ok(1, ' TODO : Add test name');
# now parse the file to check, if succeeded
my $tdoc = $parser->parse_file( "example/testrun.xml" );
# TEST
ok( $tdoc, ' TODO : Add test name' );
# TEST
ok( $tdoc->documentElement, ' TODO : Add test name' );
# TEST
is( $tdoc->documentElement->nodeName, "foo", ' TODO : Add test name' );
# TEST
is( $tdoc->documentElement->textContent, "bar", ' TODO : Add test name' );
unlink "example/testrun.xml" ;
}
# -> to named file
{
$doc->toFile( "example/testrun.xml" );
# TEST
ok(1, ' TODO : Add test name');
# now parse the file to check, if succeeded
my $tdoc = $parser->parse_file( "example/testrun.xml" );
# TEST
ok( $tdoc, ' TODO : Add test name' );
# TEST
ok( $tdoc->documentElement, ' TODO : Add test name' );
# TEST
is( $tdoc->documentElement->nodeName, "foo", ' TODO : Add test name' );
# TEST
is( $tdoc->documentElement->textContent, "bar", ' TODO : Add test name' );
unlink "example/testrun.xml" ;
}
# ELEMENT LIKE FUNCTIONS
{
my $parser2 = XML::LibXML->new();
my $string1 = "";
my $string2 = '';
my $string3 = '';
my $string4 = '';
my $string5 = 'foobarXbaz';
{
my $doc2 = $parser2->parse_string($string1);
# TEST
_count_tag_name($doc2, 'A', 3, q{3 As});
# TEST
_count_tag_name($doc2, '*', 5, q{5 elements of all names});
# TEST
_count_elements_by_name_ns($doc2, ['*', 'B'], 2,
'2 Bs of any namespace'
);
# TEST
_count_local_name($doc2, 'A', 3, q{3 A's});
# TEST
_count_local_name($doc2, '*', 5, q{5 Sub-elements});
}
{
my $doc2 = $parser2->parse_string($string2);
# TEST
_count_tag_name( $doc2, 'C:A', 3, q{C:A count});
# TEST
_count_elements_by_name_ns($doc2, [ "xml://D", "A" ], 3,
q{3 elements of namespace xml://D and A},
);
# TEST
_count_elements_by_name_ns($doc2, ['*', 'A'], 3,
q{3 Elements A of any namespace}
);
# TEST
_count_local_name($doc2, 'A', 3, q{3 As});
}
{
my $doc2 = $parser2->parse_string($string3);
# TEST
_count_elements_by_name_ns($doc2, ["xml://D", "A"], 3,
q{3 Elements A of any namespace}
);
# TEST
_count_local_name($doc2, 'A', 3, q{3 As});
}
=begin taken_out
# This was taken out because the XML uses an undefined namespace.
# I don't know why this test was introduced in the first place,
# but it fails now
#
# This test fails in this bug report -
# https://rt.cpan.org/Ticket/Display.html?id=75403
# -- Shlomi Fish
{
$parser2->recover(1);
local $SIG{'__WARN__'} = sub {
print "warning caught: @_\n";
};
# my $doc2 = $parser2->parse_string($string4);
#-TEST
# _count_local_name( $doc2, 'A', 3, q{3 As});
}
=end taken_out
=cut
# TEST:$count=3;
# Also test that we can parse from scalar references:
# See RT #64051 ( https://rt.cpan.org/Ticket/Display.html?id=64051 )
# Also test that we can parse from references to scalars with
# overloaded strings:
# See RT #77864 ( https://rt.cpan.org/Public/Bug/Display.html?id=77864 )
my $obj = Stringify->new;
foreach my $input ( $string5, (\$string5), $obj )
{
my $doc2 = $parser2->parse_string($input);
# TEST*$count
_count_tag_name($doc2, 'C:A', 1, q{3 C:As});
# TEST*$count
_count_tag_name($doc2, 'A', 3, q{3 As});
# TEST*$count
_count_elements_by_name_ns($doc2, ["*", "A"], 4,
q{4 Elements of A of any namespace}
);
# TEST*$count
_count_elements_by_name_ns($doc2, ['*', '*'], 5,
q{4 Elements of any namespace},
);
# TEST*$count
_count_elements_by_name_ns( $doc2, ["xml://D", "*" ], 2,
q{2 elements of any name in D}
);
my $A = $doc2->getDocumentElement;
# TEST*$count
_count_children_by_name($A, 'A', 1, q{1 A});
# TEST*$count
_count_children_by_name($A, 'C:A', 1, q{C:A});
# TEST*$count
_count_children_by_name($A, 'C:B', 0, q{No C:B children});
# TEST*$count
_count_children_by_name($A, "*", 2, q{2 Childern in $A in total});
# TEST*$count
_count_children_by_name_ns($A, ['*', 'A'], 2,
q{2 As of any namespace});
# TEST*$count
_count_children_by_name_ns($A, [ "xml://D", "*" ], 1,
q{1 Child of D},
);
# TEST*$count
_count_children_by_name_ns($A, [ "*", "*" ], 2,
q{2 Children in total},
);
# TEST*$count
_count_children_by_local_name($A, 'A', 2, q{2 As});
}
}
}
{
# Bug fixes (to be used with valgrind)
{
my $doc=XML::LibXML->createDocument(); # create a doc
my $x=$doc->createPI(foo=>"bar"); # create a PI
undef $doc; # should not free
undef $x; # free the PI
# TEST
ok(1, ' TODO : Add test name');
}
{
my $doc=XML::LibXML->createDocument(); # create a doc
my $x=$doc->createAttribute(foo=>"bar"); # create an attribute
undef $doc; # should not free
undef $x; # free the attribute
# TEST
ok(1, ' TODO : Add test name');
}
{
my $doc=XML::LibXML->createDocument(); # create a doc
my $x=$doc->createAttributeNS(undef,foo=>"bar"); # create an attribute
undef $doc; # should not free
undef $x; # free the attribute
# TEST
ok(1, ' TODO : Add test name');
}
{
my $doc=XML::LibXML->new->parse_string('');
my $x=$doc->createAttributeNS('http://foo.bar','x:foo'=>"bar"); # create an attribute
undef $doc; # should not free
undef $x; # free the attribute
# TEST
ok(1, ' TODO : Add test name');
}
{
# rt.cpan.org #30610
# valgrind this
my $object=XML::LibXML::Element->new( 'object' );
my $xml = qq(\n);
my $lom_doc=XML::LibXML->new->parse_string($xml);
my $lom_root=$lom_doc->getDocumentElement();
$object->appendChild( $lom_root );
# TEST
ok(!defined($object->firstChild->ownerDocument), ' TODO : Add test name');
}
}
{
my $xml = q{
};
my $out = q{
};
my $dom = XML::LibXML->new->parse_string($xml);
# TEST
is($dom->getEncoding, "UTF-8", ' TODO : Add test name');
$dom->setEncoding();
# TEST
is($dom->getEncoding, undef, ' TODO : Add test name');
# TEST
is($dom->toString, $out, ' TODO : Add test name');
}
# the following tests were added for #33810
SKIP:
{
if (! eval { require Encode; })
{
skip "Encoding related tests require Encode", (3*8);
}
# TEST:$num_encs=3;
# The count.
# TEST:$c=0;
for my $enc (qw(UTF-16 UTF-16LE UTF-16BE)) {
my $xml = Encode::encode($enc,qq{
});
my $dom = XML::LibXML->new->parse_string($xml);
# TEST:$c++;
is($dom->getEncoding,$enc, ' TODO : Add test name');
# TEST:$c++;
is($dom->actualEncoding,$enc, ' TODO : Add test name');
# TEST:$c++;
is($dom->getDocumentElement->getAttribute('foo'),'bar', ' TODO : Add test name');
# TEST:$c++;
is($dom->getDocumentElement->getAttribute(Encode::encode('UTF-16','foo')), 'bar', ' TODO : Add test name');
# TEST:$c++;
is($dom->getDocumentElement->getAttribute(Encode::encode($enc,'foo')), 'bar', ' TODO : Add test name');
my $exp_enc = $enc eq 'UTF-16' ? 'UTF-16LE' : $enc;
# TEST:$c++;
is($dom->getDocumentElement->getAttribute('foo',1), Encode::encode($exp_enc,'bar'), ' TODO : Add test name');
# TEST:$c++;
is($dom->getDocumentElement->getAttribute(Encode::encode('UTF-16','foo'),1), Encode::encode($exp_enc,'bar'), ' TODO : Add test name');
# TEST:$c++;
is($dom->getDocumentElement->getAttribute(Encode::encode($enc,'foo'),1), Encode::encode($exp_enc,'bar'), ' TODO : Add test name');
}
# TEST*$num_encs*$c
}