Added tests for SimpleSAML\Utils\XML

tests/lib/SimpleSAML/Utils/XMLTest.php

+<?php
+
+namespace SimpleSAML\Test\Utils;
+
+use \SimpleSAML_Configuration as Configuration;
+use \SimpleSAML\Utils\XML;
+
+/**
+ * Tests for SimpleSAML\Utils\XML.
+ */
+class XMLTest extends \PHPUnit_Framework_TestCase
+{
+    /**
+     * @covers \SimpleSAML\Utils\XML::isDOMNodeOfType
+     * @test
+     */
+    public function testIsDomNodeOfTypeBasic()
+    {
+        $name = 'name';
+        $namespace_uri = 'ns';
+        $element = new \DOMElement($name, 'value', $namespace_uri);
+
+        $res = XML::isDOMNodeOfType($element, $name, $namespace_uri);
+
+        $this->assertTrue($res);
+    }
+
+    /**
+     * @expectedException \InvalidArgumentException
+     *
+     * @covers \SimpleSAML\Utils\XML::isDOMNodeOfType
+     * @test
+     */
+    public function testIsDomNodeOfTypeMissingNamespace()
+    {
+        $name = 'name';
+        $namespace_uri = '@missing';
+        $element = new \DOMElement($name, 'value', $namespace_uri);
+
+        XML::isDOMNodeOfType($element, $name, $namespace_uri);
+    }
+
+    /**
+     * @covers \SimpleSAML\Utils\XML::isDOMNodeOfType
+     * @test
+     */
+    public function testIsDomNodeOfTypeEmpty()
+    {
+        $name = 'name';
+        $namespace_uri = '';
+        $element = new \DOMElement($name);
+
+        $res = XML::isDOMNodeOfType($element, $name, $namespace_uri);
+
+        $this->assertFalse($res);
+    }
+
+    /**
+     * @covers \SimpleSAML\Utils\XML::isDOMNodeOfType
+     * @test
+     */
+    public function testIsDomNodeOfTypeShortcut()
+    {
+        $name = 'name';
+        $namespace_uri = 'urn:oasis:names:tc:SAML:2.0:metadata';
+        $short_namespace_uri = '@md';
+        $element = new \DOMElement($name, 'value', $namespace_uri);
+
+        $res = XML::isDOMNodeOfType($element, $name, $short_namespace_uri);
+
+        $this->assertTrue($res);
+    }
+
+    /**
+     * @covers \SimpleSAML\Utils\XML::isDOMNodeOfType
+     * @test
+     */
+    public function testIsDomNodeOfTypeIncorrectName()
+    {
+        $name = 'name';
+        $bad_name = 'bad name';
+        $namespace_uri = 'ns';
+        $element = new \DOMElement($name, 'value', $namespace_uri);
+
+        $res = XML::isDOMNodeOfType($element, $bad_name, $namespace_uri);
+
+        $this->assertFalse($res);
+    }
+
+    /**
+     * @covers \SimpleSAML\Utils\XML::isDOMNodeOfType
+     * @test
+     */
+    public function testIsDomNodeOfTypeIncorrectNamespace()
+    {
+        $name = 'name';
+        $namespace_uri = 'ns';
+        $bad_namespace_uri = 'bad name';
+        $element = new \DOMElement($name, 'value', $namespace_uri);
+
+        $res = XML::isDOMNodeOfType($element, $name, $bad_namespace_uri);
+
+        $this->assertFalse($res);
+    }
+
+    /**
+     * @covers \SimpleSAML\Utils\XML::getDOMText
+     * @test
+     */
+    public function testGetDomTextBasic()
+    {
+        $data = 'root value';
+        $dom = new \DOMDocument();
+        $element = $dom->appendChild(new \DOMElement('root'));
+        $element->appendChild(new \DOMText($data));
+
+        $res = XML::getDOMText($element);
+        $expected = $data;
+
+        $this->assertEquals($expected, $res);
+    }
+
+    /**
+     * @covers \SimpleSAML\Utils\XML::getDOMText
+     * @test
+     */
+    public function testGetDomTextMulti()
+    {
+        $data1 = 'root value 1';
+        $data2 = 'root value 2';
+        $dom = new \DOMDocument();
+        $element = $dom->appendChild(new \DOMElement('root'));
+        $element->appendChild(new \DOMText($data1));
+        $element->appendChild(new \DOMText($data2));
+
+        $res = XML::getDOMText($element);
+        $expected = $data1 . $data2 . $data1 . $data2;
+
+        $this->assertEquals($expected, $res);
+    }
+
+    /**
+     * @expectedException \SimpleSAML_Error_Exception
+     *
+     * @covers \SimpleSAML\Utils\XML::getDOMText
+     * @test
+     */
+    public function testGetDomTextIncorrectType()
+    {
+        $dom = new \DOMDocument();
+        $element = $dom->appendChild(new \DOMElement('root'));
+        $comment = $element->appendChild(new \DOMComment(''));
+
+        XML::getDOMText($element);
+    }
+
+    /**
+     * @covers \SimpleSAML\Utils\XML::getDOMChildren
+     * @test
+     */
+    public function testGetDomChildrenBasic()
+    {
+        $name = 'name';
+        $namespace_uri = 'ns';
+        $dom = new \DOMDocument();
+        $element = new \DOMElement($name, 'value', $namespace_uri);
+        $dom->appendChild($element);
+
+        $res = XML::getDOMChildren($dom, $name, $namespace_uri);
+        $expected = array($element);
+
+        $this->assertEquals($expected, $res);
+    }
+
+    /**
+     * @covers \SimpleSAML\Utils\XML::getDOMChildren
+     * @test
+     */
+    public function testGetDomChildrenIncorrectType()
+    {
+        $dom = new \DOMDocument();
+        $text = new \DOMText('text');
+        $comment = new \DOMComment('comment');
+        $dom->appendChild($text);
+        $dom->appendChild($comment);
+
+        $res = XML::getDOMChildren($dom, 'name', 'ns');
+
+        $this->assertEmpty($res);
+    }
+
+    /**
+     * @covers \SimpleSAML\Utils\XML::getDOMChildren
+     * @test
+     */
+    public function testGetDomChildrenIncorrectName()
+    {
+        $name = 'name';
+        $bad_name = 'bad name';
+        $namespace_uri = 'ns';
+        $dom = new \DOMDocument();
+        $element = new \DOMElement($name, 'value', $namespace_uri);
+        $dom->appendChild($element);
+
+        $res = XML::getDOMChildren($dom, $bad_name, $namespace_uri);
+
+        $this->assertEmpty($res);
+    }
+
+    /**
+     * @covers \SimpleSAML\Utils\XML::formatDOMElement
+     * @test
+     */
+    public function testFormatDomElementBasic()
+    {
+        $dom = new \DOMDocument();
+        $root = new \DOMElement('root');
+        $dom->appendChild($root);
+        $root->appendChild(new \DOMText('text'));
+
+        XML::formatDOMElement($root);
+        $res = $dom->saveXML();
+        $expected = <<<'NOWDOC'
+<?xml version="1.0"?>
+<root>text</root>
+
+NOWDOC;
+
+        $this->assertEquals($expected, $res);
+    }
+
+    /**
+     * @covers \SimpleSAML\Utils\XML::formatDOMElement
+     * @test
+     */
+    public function testFormatDomElementNested()
+    {
+        $dom = new \DOMDocument();
+        $root = new \DOMElement('root');
+        $nested = new \DOMElement('nested');
+        $dom->appendChild($root);
+        $root->appendChild($nested);
+        $nested->appendChild(new \DOMText('text'));
+
+        XML::formatDOMElement($root);
+        $res = $dom->saveXML();
+        $expected = <<<'NOWDOC'
+<?xml version="1.0"?>
+<root>
+  <nested>text</nested>
+</root>
+
+NOWDOC;
+
+        $this->assertEquals($expected, $res);
+    }
+
+    /**
+     * @covers \SimpleSAML\Utils\XML::formatDOMElement
+     * @test
+     */
+    public function testFormatDomElementIndentBase()
+    {
+        $indent_base = 'base';
+        $dom = new \DOMDocument();
+        $root = new \DOMElement('root');
+        $nested = new \DOMElement('nested');
+        $dom->appendChild($root);
+        $root->appendChild($nested);
+        $nested->appendChild(new \DOMText('text'));
+
+        XML::formatDOMElement($root, $indent_base);
+        $res = $dom->saveXML();
+        $expected = <<<HEREDOC
+<?xml version="1.0"?>
+<root>
+$indent_base  <nested>text</nested>
+$indent_base</root>
+
+HEREDOC;
+
+        $this->assertEquals($expected, $res);
+    }
+
+    /**
+     * @covers \SimpleSAML\Utils\XML::formatDOMElement
+     * @test
+     */
+    public function testFormatDomElementTextAndChild()
+    {
+        $dom = new \DOMDocument();
+        $root = new \DOMElement('root');
+        $dom->appendChild($root);
+        $root->appendChild(new \DOMText('text'));
+        $root->appendChild(new \DOMElement('child'));
+
+        XML::formatDOMElement($root);
+        $res = $dom->saveXML();
+        $expected = <<<HEREDOC
+<?xml version="1.0"?>
+<root>text<child/></root>
+
+HEREDOC;
+
+        $this->assertEquals($expected, $res);
+    }
+
+    /**
+     * @covers \SimpleSAML\Utils\XML::formatXMLString
+     * @test
+     */
+    public function testFormatXmlStringBasic()
+    {
+        $xml = '<root><nested>text</nested></root>';
+
+        $res = XML::formatXMLString($xml);
+        $expected = <<<'NOWDOC'
+<root>
+  <nested>text</nested>
+</root>
+NOWDOC;
+
+        $this->assertEquals($expected, $res);
+    }
+
+    /**
+     * @expectedException \DOMException
+     *
+     * @covers \SimpleSAML\Utils\XML::formatXMLString
+     * @test
+     */
+    public function testFormatXmlStringMalformedXml()
+    {
+        $xml = '<root><nested>text';
+
+        XML::formatXMLString($xml);
+    }
+
+    /**
+     * @covers \SimpleSAML\Utils\XML::isValid
+     * @test
+     */
+    public function testIsValidMalformedXml()
+    {
+        $xml = '<root><nested>text';
+
+        $res = XML::isValid($xml, 'unused');
+        $expected = 'Failed to parse XML string for schema validation';
+
+        $this->assertContains($expected, $res);
+    }
+
+    /**
+     * @covers \SimpleSAML\Utils\XML::isValid
+     * @test
+     */
+    public function testIsValidMetadata()
+    {
+        $schema = 'saml-schema-metadata-2.0.xsd';
+
+        $dom = $this->getMockBuilder('\DOMDocument')
+            ->setMethods(array('schemaValidate'))
+            ->disableOriginalConstructor()
+            ->getMock();
+
+        /*
+         * Unfortunately, we cannot actually test schemaValidate. To
+         * effectively unit test this function we'd have to enable LIBXML_NONET
+         * which disables network access when loading documents. PHP does not
+         * currently support enabling this flag.
+         */
+        $dom->method('schemaValidate')
+            ->willReturn(true);
+
+        $res = XML::isValid($dom, $schema);
+
+        $this->assertTrue($res);
+    }
+}