XmlCharacterReferenceTest.java

/**
 * JHOVE2 - Next-generation architecture for format-aware characterization
 * <p>
 * Copyright (c) 2009 by The Regents of the University of California, Ithaka
 * Harbors, Inc., and The Board of Trustees of the Leland Stanford Junior
 * University. All rights reserved.
 * </p>
 * <p>
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 * </p>
 * <ul>
 * <li>Redistributions of source code must retain the above copyright notice,
 * this list of conditions and the following disclaimer.</li>
 * <li>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.</li>
 * <li>Neither the name of the University of California/California Digital
 * Library, Ithaka Harbors/Portico, or Stanford University, nor the names of its
 * contributors may be used to endorse or promote products derived from this
 * software without specific prior written permission.</li>
 * </ul>
 * <p>
 * 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.
 * </p>
 */
package org.jhove2.module.format.xml;

import static org.junit.Assert.assertEquals;
import static org.junit.Assert.assertTrue;

import java.util.ArrayList;
import java.util.List;
import java.util.TreeMap;

import org.jhove2.module.format.Validator.Validity;
import org.junit.Before;
import org.junit.Test;

/**
 * Tests of XML Module
 * @see org.jhove2.module.xml.XmlModule
 * @author rnanders
 * 
 */
public class XmlCharacterReferenceTest  extends XmlModuleTestBase {

    
    @Before 
    public void initialize() {
        if (! initialized) {
            parse("samples/character-reference-sample.xml");
        }
    }

    /**
     * Test method for SAX Parser information
     */
    @Test
    public void testSaxParserInfo() {
        SaxParser saxParser = testXmlModule.saxParser;
        assertEquals("org.apache.xerces.parsers.SAXParser",saxParser.parser);
        List<String> features = saxParser.getSaxFeatures();
        assertTrue(features.contains("http://xml.org/sax/features/validation = true"));
        List<String> properties = saxParser.getSaxProperties();
        assertTrue(properties.contains("http://xml.org/sax/properties/lexical-handler = org.jhove2.module.format.xml.SaxParserLexicalHandler"));
    }

    /**
     * Test method for XML Declaration information
     */
    @Test
    public void testXmlDeclaration() {
        XmlDeclaration xmlDecl = testXmlModule.xmlDeclaration;
        assertEquals("1.0",xmlDecl.getVersion());
        assertEquals("UTF-8",xmlDecl.getEncoding());
        assertEquals("yes",xmlDecl.getStandalone());
    }

    /**
     * Test method for root element information
     */
    @Test
    public void testRootElement() {
        RootElement root = testXmlModule.rootElement;
        assertEquals("characterReferences",root.getName());
        assertEquals("[noNamespace]",root.getNamespace());
    }

    /**
     * Test method for namespace information
     */
    @Test
    public void testNamespaceInfo() {
        NamespaceInformation nsInfo = testXmlModule.getNamespaceInformation();
        assertEquals(0,nsInfo.getNamespaceCount());
    }

    
    /**
     * Test method for Character Entity References
     */
    @Test
    public void testCharacterEntityReferences() {
        TreeMap<String, EntityReference> erMap = testXmlModule.entityReferences.entityReferenceMap;
        assertEquals(5,erMap.size());
        assertEquals(5, erMap.get("amp").getCount().intValue());
        assertEquals(4, erMap.get("apos").getCount().intValue());
        assertEquals(2, erMap.get("gt").getCount().intValue());
        assertEquals(3, erMap.get("lt").getCount().intValue());
        assertEquals(1, erMap.get("quot").getCount().intValue());
    }

    /**
     * Test method for Numeric Character References
     */   
    @Test
    public void testNumericCharacterReferences() {
        TreeMap<Integer, NumericCharacterReference> ncrMap = testXmlModule.numericCharacterReferenceInformation.numericCharacterReferenceMap;
        assertEquals(7, ncrMap.size());
        assertEquals(3, ncrMap.get(0x0009).getCount().intValue());
        assertEquals(1, ncrMap.get(0x000A).getCount().intValue());
        assertEquals(1, ncrMap.get(0x000D).getCount().intValue());
        assertEquals(1, ncrMap.get(0x00B6).getCount().intValue());
        assertEquals(2, ncrMap.get(0x2021).getCount().intValue());
        assertEquals(1, ncrMap.get(0x12415).getCount().intValue());
        assertEquals(1, ncrMap.get(0x0026).getCount().intValue());
    }

    /**
     * Test method for Comment Information
     */   
    @Test
    public void testCommentInfo() {
        CommentInformation commentInfo = testXmlModule.getCommentInformation();
        assertEquals(2, commentInfo.getCount());
        ArrayList<String> comments = commentInfo.getComments();
        assertTrue(comments.contains(" Character Entity References "));
        assertTrue(comments.contains(" Numeric Character References (Unicode code points) "));
    }

    /**
     * Test method for Validation Information
     */   
    @Test
    public void testValidationInfo() {
        ValidationResults vr = testXmlModule.getValidationResults();
        ValidationMessageList warnings = vr.getParserWarnings();
        assertEquals(0, warnings.getValidationMessageCount());
        ValidationMessageList errors = vr.getParserErrors();
        assertEquals(0, errors.getValidationMessageCount());
        ValidationMessageList fatals = vr.getFatalParserErrors();
        assertEquals(0, fatals.getValidationMessageCount());
    }

    /**
     * Test method for Validity
     */   
    @Test
    public void testValidatity() {
        assertEquals(Validity.True,testXmlModule.isWellFormed());
        assertEquals(Validity.True, testXmlModule.isValid());
    }
 
}