XmlSerializerTest.java

/**
 * Copyright (C) 2010 MediaShelf <http://www.yourmediashelf.com/>
 *
 * This file is part of fedora-client.
 *
 * fedora-client is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * fedora-client is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with fedora-client.  If not, see <http://www.gnu.org/licenses/>.
 */

package com.yourmediashelf.fedora.util;

import static org.junit.Assert.assertEquals;

import java.io.ByteArrayOutputStream;
import java.io.File;
import java.io.FileInputStream;
import java.io.InputStream;

import org.apache.commons.io.FileUtils;
import org.junit.After;
import org.junit.Before;
import org.junit.Test;

/**
 * @author Edwin Shin
 * @see "http://www.w3.org/TR/xml-c14n11/#Examples"
 */
public class XmlSerializerTest {

    private final File testDir = new File("src/test/resources/c14n");

    @Before
    public void setUp() throws Exception {
    }

    @After
    public void tearDown() throws Exception {
    }

    @Test(expected = RuntimeException.class)
    public void testCanonicalizeWithLS() throws Exception {
        ByteArrayOutputStream bout = new ByteArrayOutputStream();
        String control = "<a>b</a>";
        XmlSerializer.canonicalizeWithDOM3LS(XmlSerializer
                .string2document(control), bout);
    }

    @Test
    /**
     * Demonstrates:
     * <ul>
     *  <li>Loss of XML declaration
     *  <li>Loss of DTD
     *  <li>Normalization of whitespace outside of document element (first character of both canonical forms is '<'; single line breaks separate PIs and comments outside of document element)
     *  <li>Loss of whitespace between PITarget and its data
     *  <li>Retention of whitespace inside PI data
     *  <li>Comment removal from uncommented canonical form, including delimiter for comments outside document element (the last character in both canonical forms is '>')
     * </ul>
     * @throws Exception
     */
    public void test31() throws Exception {
        testCanonicalization("3.1");
    }

    @Test
    /**
     * Demonstrates:
     * <ul>
     * <li>Retain all whitespace between consecutive start tags, clean or dirty
     * <li>Retain all whitespace between consecutive end tags, clean or dirty
     * <li>Retain all whitespace between end tag/start tag pair, clean or dirty
     * <li>Retain all whitespace in character content, clean or dirty
     * </ul>
     *
     * @throws Exception
     */
    public void test32() throws Exception {
        testCanonicalization("3.2");
    }

    @Test
    /**
     * @throws Exception
     */
    public void test33() throws Exception {
        testCanonicalization("3.3");
    }

    @Test
    /**
     * @throws Exception
     */
    public void test34() throws Exception {
        testCanonicalization("3.4");
    }

    @Test
    /**
     * @throws Exception
     */
    public void test36() throws Exception {
        testCanonicalization("3.6");
    }

    private void testCanonicalization(String prefix) throws Exception {
        String input = String.format("%s-input.xml", prefix);
        String canonical = String.format("%s-canonical.xml", prefix);
        InputStream in = new FileInputStream(new File(testDir, input));
        ByteArrayOutputStream bout = new ByteArrayOutputStream();
        XmlSerializer.canonicalize(in, bout);
        String control =
                FileUtils.readFileToString(new File(testDir, canonical));
        assertEquals(input + " did not match " + canonical, control, bout
                .toString("UTF-8"));
    }
}