test_XMLUnit.java

/*
******************************************************************
Copyright (c) 2001-2007,2015 Jeff Martin, Tim Bacon
All rights reserved.

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions
are met:

    * Redistributions of source code must retain the above copyright
      notice, this list of conditions and the following disclaimer.
    * Redistributions in binary form must reproduce the above
      copyright notice, this list of conditions and the following
      disclaimer in the documentation and/or other materials provided
      with the distribution.
    * Neither the name of the XMLUnit nor the names
      of its contributors may be used to endorse or promote products
      derived from this software without specific prior written
      permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
POSSIBILITY OF SUCH DAMAGE.

******************************************************************
*/

package org.custommonkey.xmlunit;

import javax.xml.parsers.DocumentBuilder;
import javax.xml.parsers.DocumentBuilderFactory;
import javax.xml.parsers.ParserConfigurationException;
import org.w3c.dom.Document;
import org.xml.sax.EntityResolver;
import org.xml.sax.helpers.DefaultHandler;

import junit.framework.TestCase;
import junit.framework.TestSuite;
import org.mockito.Mock;
import org.mockito.MockitoAnnotations;

import org.custommonkey.xmlunit.exceptions.ConfigurationException;

import static org.mockito.Mockito.verify;
import static org.mockito.Mockito.when;

/**
 * Test case for XMLUnit
 */
public class test_XMLUnit extends TestCase{
    @Mock
    private DocumentBuilderFactory dbFactory;

    @Mock
    private DocumentBuilder builder;

    @Mock
    private EntityResolver eResolver;
    
    public void setUp() throws Exception {
        MockitoAnnotations.initMocks(this);
        when(dbFactory.newDocumentBuilder()).thenReturn(builder);
    }

    /**
     * Contructs a new test case.
     */
    public test_XMLUnit(String name){
        super(name);
    }

    private String getDocumentBuilderFactoryImplClass() {
        return DocumentBuilderFactory.newInstance().getClass().getName();
    }

    /**
     * Test overiding the SAX parser used to parse control documents
     */
    public void testSetControlParser() throws Exception {
        Object before = XMLUnit.newControlParser();
        XMLUnit.setControlParser(getDocumentBuilderFactoryImplClass());
        assertEquals("should be different", false,
                     before == XMLUnit.newControlParser());
    }

    public void testIgnoreWhitespace() throws Exception {
        assertEquals("should not ignore whitespace by default",
                     false, XMLUnit.getIgnoreWhitespace());
        XMLUnit.setIgnoreWhitespace(true);
        String test="<test>  monkey   </test>";
        String control="<test>monkey</test>";
        assertEquals("Should be similar", true,
                     new Diff(control, test).similar());
        try {
            XMLUnit.setIgnoreWhitespace(false);
            assertEquals("Should be different", false,
                         new Diff(control, test).similar());
        } finally {
            // restore default setting
            XMLUnit.setIgnoreWhitespace(false);
        }
    }

    /**
     * Test overiding the SAX parser used to parse test documents
     */
    public void testSetTestParser() throws Exception {
        Object before = XMLUnit.newTestParser();
        XMLUnit.setTestParser(getDocumentBuilderFactoryImplClass());
        assertEquals("should be different", false,
                     before==XMLUnit.newTestParser());
    }

    public void testSetTransformerFactory() throws Exception {
        Object before = XMLUnit.getTransformerFactory();
        XMLUnit.setTransformerFactory(before.getClass().getName());
        assertEquals("should be different", false,
                     before==XMLUnit.getTransformerFactory());
    }

    public void testStripWhitespaceTransform() throws Exception {
        Document doc = XMLUnit.buildTestDocument(
                                                 test_Constants.XML_WITH_WHITESPACE);
        Transform transform = XMLUnit.getStripWhitespaceTransform(doc);
        Diff diff = new Diff(test_Constants.XML_WITHOUT_WHITESPACE, transform);
        assertTrue(diff.similar());
    }

    public void testXSLTVersion() {
        try {
            assertEquals("1.0", XMLUnit.getXSLTVersion());
            assertEquals(XSLTConstants.XSLT_START, XMLUnit.getXSLTStart());
            XMLUnit.setXSLTVersion("2.0");
            assertTrue(XMLUnit.getXSLTStart()
                       .startsWith(XSLTConstants.XSLT_START_NO_VERSION));
            assertTrue(XMLUnit.getXSLTStart().endsWith("\"2.0\">"));
            try {
                XMLUnit.setXSLTVersion("foo");
                fail("foo is not a number");
            } catch (ConfigurationException expected) {
            }
            try {
                XMLUnit.setXSLTVersion("-1.0");
                fail("-1.0 is negative");
            } catch (ConfigurationException expected) {
            }
        } finally {
            XMLUnit.setXSLTVersion("1.0");
        }
    }

    public void testCantSetNullControlDocumentBuilderFactory() throws Exception {
        try {
            XMLUnit.setControlDocumentBuilderFactory(null);
            fail("should have thrown an exception");
        } catch (IllegalArgumentException f) {
            // expected
            return;
        }
    }

    public void testCantSetNullTestDocumentBuilderFactory() throws Exception {
        try {
            XMLUnit.setTestDocumentBuilderFactory(null);
            fail("should have thrown an exception");
        } catch (IllegalArgumentException f) {
            // expected
            return;
        }
    }

    public void testTranslatesParserConfigurationExceptionControl() throws Exception {
        when(dbFactory.newDocumentBuilder()).thenThrow(new ParserConfigurationException());
        DocumentBuilderFactory orig = XMLUnit.getControlDocumentBuilderFactory();
        try {
            XMLUnit.setControlDocumentBuilderFactory(dbFactory);
            XMLUnit.newControlParser();
            fail("should have thrown an exception");
        } catch (ConfigurationException f) {
            // expected
            return;
        } finally {
            XMLUnit.setControlDocumentBuilderFactory(orig);
        }
    }

    public void testSetsControlEntityResolver() throws Exception {
        DocumentBuilderFactory orig = XMLUnit.getControlDocumentBuilderFactory();
        EntityResolver origResolver = XMLUnit.getControlEntityResolver();
        try {
            XMLUnit.setControlDocumentBuilderFactory(dbFactory);
            XMLUnit.setControlEntityResolver(eResolver);
            XMLUnit.newControlParser();
        } finally {
            XMLUnit.setControlEntityResolver(origResolver);
            XMLUnit.setControlDocumentBuilderFactory(orig);
        }
        verify(builder).setEntityResolver(eResolver);
    }

    public void testTranslatesParserConfigurationExceptionTest() throws Exception {
        when(dbFactory.newDocumentBuilder()).thenThrow(new ParserConfigurationException());
        DocumentBuilderFactory orig = XMLUnit.getTestDocumentBuilderFactory();
        try {
            XMLUnit.setTestDocumentBuilderFactory(dbFactory);
            XMLUnit.newTestParser();
            fail("should have thrown an exception");
        } catch (ConfigurationException f) {
            // expected
            return;
        } finally {
            XMLUnit.setTestDocumentBuilderFactory(orig);
        }
    }

    public void testSetsTestEntityResolver() throws Exception {
        DocumentBuilderFactory orig = XMLUnit.getTestDocumentBuilderFactory();
        EntityResolver origResolver = XMLUnit.getTestEntityResolver();
        try {
            XMLUnit.setTestDocumentBuilderFactory(dbFactory);
            XMLUnit.setTestEntityResolver(eResolver);
            XMLUnit.newTestParser();
        } finally {
            XMLUnit.setTestEntityResolver(origResolver);
            XMLUnit.setTestDocumentBuilderFactory(orig);
        }
        verify(builder).setEntityResolver(eResolver);
    }

}