enshrined\svgSanitize\Tests\SanitizerTest Class Reference

Class SanitizerTest. More...

Inheritance diagram for enshrined\svgSanitize\Tests\SanitizerTest:

Collaboration diagram for enshrined\svgSanitize\Tests\SanitizerTest:

Public Member Functions
	testLoadDefaultTags ()
	Make sure the initial tags are loaded. More...
	testLoadDefaultAttributes ()
	Make sure the initial attributes are loaded. More...
	testSetCustomTags ()
	Test the custom tag setters and getters. More...
	testSetCustomAttributes ()
	Test the custom attribute setters and getters. More...
	testSanitizeXMLDoc ()
	Test that malicious elements and attributes are removed from standard XML. More...
	testSanitizeSVGDoc ()
	Test that malicious elements and attributes are removed from an SVG. More...
	testBadXMLReturnsFalse ()
	Test that a badly formatted XML document returns false. More...
	testSanitizeHrefs ()
	Make sure that hrefs get sanitized correctly. More...
	testSanitizeHrefsNoXlinkNamespace ()
	Make sure that hrefs get sanitized correctly when the xlink namespace is omitted. More...
	testSanitizeExternal ()
	Make sure that external references get sanitized correctly. More...
	testSanitizeAndMinifiySVGDoc ()
	Test that minification of an SVG works. More...
	testThatAriaAndDataAttributesAreAllowed ()
	Test that ARIA and Data Attributes are allowed. More...
	testThatExternalUseElementsAreStripped ()
	Test that ARIA and Data Attributes are allowed. More...
	testMinifiedOptions ()
	Test setXMLOptions and minifying works as expected. More...
	useRecursionsAreDetected ()
	infiniteUseLoopsAreDetected ()
	testUseDOSattacksAreNullified ()
	Make sure that DOS attacks using the <use> element are detected. More...
	testLargeUseDOSattacksAreNullified ()
	Make sure that DOS attacks using the <use> element are detected, especially when the SVG is extremely large. More...

Protected Member Functions
	setUp ()
	Set up the test class. More...
	tearDown ()

Protected Attributes
	$class

Detailed Description

Class SanitizerTest.

Definition at line 12 of file SanitizerTest.php.

Member Function Documentation

infiniteUseLoopsAreDetected()

enshrined\svgSanitize\Tests\SanitizerTest::infiniteUseLoopsAreDetected

(

)

Test:

Definition at line 245 of file SanitizerTest.php.

    {
        $dataDirectory = __DIR__ . '/data';
        $initialData = file_get_contents($dataDirectory . '/xlinkLoopTest.svg');
        $expected = file_get_contents($dataDirectory . '/xlinkLoopClean.svg');
 
        $this->class->minify(false);
        $cleanData = $this->class->sanitize($initialData);
 
        $this->assertXmlStringEqualsXmlString($expected, $cleanData);
    }

setUp()

enshrined\svgSanitize\Tests\SanitizerTest::setUp ( )

protected

Set up the test class.

Definition at line 22 of file SanitizerTest.php.

    {
        $this->class = new Sanitizer();
    }

tearDown()

enshrined\svgSanitize\Tests\SanitizerTest::tearDown ( )

protected

Definition at line 27 of file SanitizerTest.php.

    {
        unset($this->class);
    }

testBadXMLReturnsFalse()

enshrined\svgSanitize\Tests\SanitizerTest::testBadXMLReturnsFalse

(

)

Test that a badly formatted XML document returns false.

Definition at line 111 of file SanitizerTest.php.

    {
        $dataDirectory = __DIR__ . '/data';
        $initialData = file_get_contents($dataDirectory . '/badXmlTestOne.svg');
 
        $cleanData = $this->class->sanitize($initialData);
 
        $this->assertEquals(false, $cleanData);
    }

testLargeUseDOSattacksAreNullified()

enshrined\svgSanitize\Tests\SanitizerTest::testLargeUseDOSattacksAreNullified

(

)

Make sure that DOS attacks using the <use> element are detected, especially when the SVG is extremely large.

Definition at line 276 of file SanitizerTest.php.

    {
        $dataDirectory = __DIR__ . '/data';
        $initialData = file_get_contents($dataDirectory . '/useDosTestTwo.svg');
        $expected = file_get_contents($dataDirectory . '/useDosCleanTwo.svg');
 
        $this->class->minify(false);
        $cleanData = $this->class->sanitize($initialData);
 
        $this->assertXmlStringEqualsXmlString($expected, $cleanData);
    }

testLoadDefaultAttributes()

enshrined\svgSanitize\Tests\SanitizerTest::testLoadDefaultAttributes

(

)

Make sure the initial attributes are loaded.

Definition at line 45 of file SanitizerTest.php.

    {
        $attributes = $this->class->getAllowedAttrs();
 
        $this->assertInternalType('array', $attributes);
    }

References $attributes.

testLoadDefaultTags()

enshrined\svgSanitize\Tests\SanitizerTest::testLoadDefaultTags

(

)

Make sure the initial tags are loaded.

Definition at line 35 of file SanitizerTest.php.

    {
        $tags = $this->class->getAllowedTags();
 
        $this->assertInternalType('array', $tags);
    }

References $tags.

testMinifiedOptions()

enshrined\svgSanitize\Tests\SanitizerTest::testMinifiedOptions

(

)

Test setXMLOptions and minifying works as expected.

Definition at line 216 of file SanitizerTest.php.

    {
        $this->class->minify(true);
        $this->class->removeXMLTag(true);
        $this->class->setXMLOptions(0);
 
        $input = '<svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24"><title>chevron-double-down</title><path d="M4 11.73l.68-.73L12 17.82 19.32 11l.68.73-7.66 7.13a.5.5 0 0 1-.68 0z"/><path d="M4 5.73L4.68 5 12 11.82 19.32 5l.68.73-7.66 7.13a.5.5 0 0 1-.68 0z"/></svg>';
        $output = $this->class->sanitize($input);
        $this->assertEquals($input, $output);
    }

References $output.

testSanitizeAndMinifiySVGDoc()

enshrined\svgSanitize\Tests\SanitizerTest::testSanitizeAndMinifiySVGDoc

(

)

Test that minification of an SVG works.

Definition at line 168 of file SanitizerTest.php.

    {
        $dataDirectory = __DIR__ . '/data';
        $initialData = file_get_contents($dataDirectory . '/svgTestOne.svg');
        $expected = file_get_contents($dataDirectory . '/svgCleanOneMinified.svg');
 
        $this->class->minify(true);
        $cleanData = $this->class->sanitize($initialData);
        $this->class->minify(false);
 
        $this->assertXmlStringEqualsXmlString($expected, $cleanData);
    }

testSanitizeExternal()

enshrined\svgSanitize\Tests\SanitizerTest::testSanitizeExternal

(

)

Make sure that external references get sanitized correctly.

Definition at line 152 of file SanitizerTest.php.

    {
        $dataDirectory = __DIR__ . '/data';
        $initialData = file_get_contents($dataDirectory . '/externalTest.svg');
        $expected = file_get_contents($dataDirectory . '/externalClean.svg');
 
        $this->class->removeRemoteReferences(true);
        $cleanData = $this->class->sanitize($initialData);
        $this->class->removeRemoteReferences(false);
 
        $this->assertXmlStringEqualsXmlString($expected, $cleanData);
    }

testSanitizeHrefs()

enshrined\svgSanitize\Tests\SanitizerTest::testSanitizeHrefs

(

)

Make sure that hrefs get sanitized correctly.

Definition at line 124 of file SanitizerTest.php.

    {
        $dataDirectory = __DIR__ . '/data';
        $initialData = file_get_contents($dataDirectory . '/hrefTestOne.svg');
        $expected = file_get_contents($dataDirectory . '/hrefCleanOne.svg');
 
        $cleanData = $this->class->sanitize($initialData);
 
        $this->assertXmlStringEqualsXmlString($expected, $cleanData);
    }

testSanitizeHrefsNoXlinkNamespace()

enshrined\svgSanitize\Tests\SanitizerTest::testSanitizeHrefsNoXlinkNamespace

(

)

Make sure that hrefs get sanitized correctly when the xlink namespace is omitted.

Definition at line 138 of file SanitizerTest.php.

    {
        $dataDirectory = __DIR__ . '/data';
        $initialData = file_get_contents($dataDirectory . '/hrefTestTwo.svg');
        $expected = file_get_contents($dataDirectory . '/hrefCleanTwo.svg');
 
        $cleanData = $this->class->sanitize($initialData);
 
        $this->assertXmlStringEqualsXmlString($expected, $cleanData);
    }

testSanitizeSVGDoc()

enshrined\svgSanitize\Tests\SanitizerTest::testSanitizeSVGDoc

(

)

Test that malicious elements and attributes are removed from an SVG.

Definition at line 97 of file SanitizerTest.php.

    {
        $dataDirectory = __DIR__ . '/data';
        $initialData = file_get_contents($dataDirectory . '/svgTestOne.svg');
        $expected = file_get_contents($dataDirectory . '/svgCleanOne.svg');
 
        $cleanData = $this->class->sanitize($initialData);
 
        $this->assertXmlStringEqualsXmlString($expected, $cleanData);
    }

testSanitizeXMLDoc()

enshrined\svgSanitize\Tests\SanitizerTest::testSanitizeXMLDoc

(

)

Test that malicious elements and attributes are removed from standard XML.

Definition at line 83 of file SanitizerTest.php.

    {
        $dataDirectory = __DIR__ . '/data';
        $initialData = file_get_contents($dataDirectory . '/xmlTestOne.xml');
        $expected = file_get_contents($dataDirectory . '/xmlCleanOne.xml');
 
        $cleanData = $this->class->sanitize($initialData);
 
        $this->assertXmlStringEqualsXmlString($expected, $cleanData);
    }

testSetCustomAttributes()

enshrined\svgSanitize\Tests\SanitizerTest::testSetCustomAttributes

(

)

Test the custom attribute setters and getters.

Definition at line 69 of file SanitizerTest.php.

    {
        $this->class->setAllowedAttrs(new TestAllowedAttributes());
 
        $attributes = $this->class->getAllowedAttrs();
 
        $this->assertInternalType('array', $attributes);
 
        $this->assertEquals( array_map('strtolower', TestAllowedAttributes::getAttributes()), $attributes);
    }

References $attributes, and enshrined\svgSanitize\Tests\Fixtures\TestAllowedAttributes\getAttributes().

Here is the call graph for this function:

testSetCustomTags()

enshrined\svgSanitize\Tests\SanitizerTest::testSetCustomTags

(

)

Test the custom tag setters and getters.

Definition at line 55 of file SanitizerTest.php.

    {
        $this->class->setAllowedTags(new TestAllowedTags());
 
        $tags = $this->class->getAllowedTags();
 
        $this->assertInternalType('array', $tags);
 
        $this->assertEquals(array_map('strtolower', TestAllowedTags::getTags()), $tags);
    }

References $tags, and enshrined\svgSanitize\Tests\Fixtures\TestAllowedTags\getTags().

Here is the call graph for this function:

testThatAriaAndDataAttributesAreAllowed()

enshrined\svgSanitize\Tests\SanitizerTest::testThatAriaAndDataAttributesAreAllowed

(

)

Test that ARIA and Data Attributes are allowed.

Definition at line 184 of file SanitizerTest.php.

    {
        $dataDirectory = __DIR__ . '/data';
        $initialData = file_get_contents($dataDirectory . '/ariaDataTest.svg');
        $expected = file_get_contents($dataDirectory . '/ariaDataClean.svg');
 
        $this->class->minify(false);
        $cleanData = $this->class->sanitize($initialData);
        $this->class->minify(false);
 
        $this->assertXmlStringEqualsXmlString($expected, $cleanData);
    }

testThatExternalUseElementsAreStripped()

enshrined\svgSanitize\Tests\SanitizerTest::testThatExternalUseElementsAreStripped

(

)

Test that ARIA and Data Attributes are allowed.

Definition at line 200 of file SanitizerTest.php.

    {
        $dataDirectory = __DIR__ . '/data';
        $initialData = file_get_contents($dataDirectory . '/useTest.svg');
        $expected = file_get_contents($dataDirectory . '/useClean.svg');
 
        $this->class->minify(false);
        $cleanData = $this->class->sanitize($initialData);
        $this->class->minify(false);
 
        $this->assertXmlStringEqualsXmlString($expected, $cleanData);
    }

testUseDOSattacksAreNullified()

enshrined\svgSanitize\Tests\SanitizerTest::testUseDOSattacksAreNullified

(

)

Make sure that DOS attacks using the <use> element are detected.

Definition at line 260 of file SanitizerTest.php.

    {
        $dataDirectory = __DIR__ . '/data';
        $initialData = file_get_contents($dataDirectory . '/useDosTest.svg');
        $expected = file_get_contents($dataDirectory . '/useDosClean.svg');
 
        $this->class->minify(false);
        $cleanData = $this->class->sanitize($initialData);
 
        $this->assertXmlStringEqualsXmlString($expected, $cleanData);
    }

useRecursionsAreDetected()

enshrined\svgSanitize\Tests\SanitizerTest::useRecursionsAreDetected

(

)

Test:

Definition at line 230 of file SanitizerTest.php.

    {
        $dataDirectory = __DIR__ . '/data';
        $initialData = file_get_contents($dataDirectory . '/xlinkLaughsTest.svg');
        $expected = file_get_contents($dataDirectory . '/xlinkLaughsClean.svg');
 
        $this->class->minify(false);
        $cleanData = $this->class->sanitize($initialData);
 
        $this->assertXmlStringEqualsXmlString($expected, $cleanData);
    }

Field Documentation

$class

enshrined\svgSanitize\Tests\SanitizerTest::$class

protected

Definition at line 17 of file SanitizerTest.php.

---

The documentation for this class was generated from the following file:

• libs/composer/vendor/enshrined/svg-sanitize/tests/SanitizerTest.php