java/src/org/apache/qetest/trax/ToHTMLStreamTest.java

/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements. See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership. The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the  "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
/*
 * $Id$
 */

/*
 *
 * ToHTMLStreamTest.java
 *
 */
package org.apache.qetest.trax;

import org.apache.xml.serializer.ToStream;
import org.xml.sax.SAXException;

import java.io.IOException;
import java.io.StringWriter;

import org.apache.xml.serializer.ToHTMLStream;

//-------------------------------------------------------------------------

/**
 * Verify how stream output works.
 * @author jesper@selskabet.org
 * @version $Id$
 */
public class ToHTMLStreamTest extends ToStreamTest
{

    private static final String AELIG_OSLASH_ARING_NAMED_ENTITY = "æøå";
	private static final String AELIG_OSLASH_ARING = "\u00e6\u00f8\u00e5";

	/** Just initialize test name, comment, numTestCases. */
    public ToHTMLStreamTest()
    {
        testName = "ToHTMLStreamTest";
        testComment = "Testing tricky Unicode encoding issues for HTML output";
    }

    protected ToStream makeStream(String encodingName) {
		return makeHTMLStream(encodingName);
	}

    protected ToHTMLStream makeHTMLStream(String encodingName) {
    	ToHTMLStream stream = new ToHTMLStream();
		stream.setEncoding(encodingName);
		return stream;
	}

    /**
     * Verify outputting simple text in a different encodings
     * @return false if we should abort the test; true otherwise
     * @throws SAXException 
     * @throws IOException 
     */
    public boolean testCase1() throws SAXException, IOException
    {
    	reporter.testCaseInit("Verify UTF-9 encoding in HTMLStream");

    	String actual1 = outputCharacters(makeStream("UTF-8"), "abc");
		reporter.check(actual1, "abc", "Simple characters should come out unscathed");
    	String actual1a = outputAttrValue(makeStream("UTF-8"), "abc");
		reporter.check(actual1a, "abc", "Simple characters should come out unscathed (as attribute value)");

    	String actual2 = outputCharacters(makeStream("UTF-8"), AELIG_OSLASH_ARING);
		reporter.check(actual2, AELIG_OSLASH_ARING_NAMED_ENTITY, "ISO-8859-1 characters should come out as named entities");
    	String actual2a = outputAttrValue(makeStream("UTF-8"), AELIG_OSLASH_ARING);
		reporter.check(actual2a, AELIG_OSLASH_ARING_NAMED_ENTITY, "ISO-8859-1 characters should come out unscathed (as attribute value)");

		String CHINESE = "\u95c9\u6d77\u4e95"; // \
    	String actual3 = outputCharacters(makeStream("UTF-8"), CHINESE);
		reporter.check(actual3, CHINESE, "BMP characters should come out unscathed");
    	String actual3a = outputAttrValue(makeStream("UTF-8"), CHINESE);
		reporter.check(actual3a, CHINESE, "BMP characters should come out unscathed (as attribute value)");

		// ¤ is output as ¤ ...
		String utf16String = buildUtf16String(new int[] { 0x010030, 0xa4, 0x010032});
		String expectedUtf16 = buildUtf16String(new int[] { 0x010030 }) + "¤" + buildUtf16String(new int[] { 0x010032 });
		
    	String actual4 = outputCharacters(makeStream("UTF-8"), utf16String);
		reporter.check(actual4, expectedUtf16, "Astral characters should come out unscathed");
    	String actual4a = outputAttrValue(makeStream("UTF-8"), utf16String);
		reporter.check(actual4a, expectedUtf16, "Astral characters should come out unscathed (as attribute value)");
		
        reporter.testCaseClose();
        return true;
    }
    
    /**
     * Verify outputting simple text in simpler 
     * @return false if we should abort the test; true otherwise
     * @throws SAXException 
     * @throws IOException 
     */
    public boolean testCase2() throws SAXException, IOException
    {
    	reporter.testCaseInit("Verify ISO-8859-1 encoding in HTMLStream.");

		String actual1 = outputCharacters(makeStream("ISO-8859-1"), "abc");
		reporter.check(actual1, "abc", "Simple characters should come out unscathed");
    	String actual1a = outputAttrValue(makeStream("ISO-8859-1"), "abc");
		reporter.check(actual1a, "abc", "Simple characters should come out unscathed (as attribute value)");

    	String actual2 = outputCharacters(makeStream("ISO-8859-1"), AELIG_OSLASH_ARING);
		reporter.check(actual2, AELIG_OSLASH_ARING_NAMED_ENTITY, "ISO-8859-1 characters should come out as NCRs");
    	String actual2a = outputAttrValue(makeStream("ISO-8859-1"), AELIG_OSLASH_ARING);
		reporter.check(actual2a, AELIG_OSLASH_ARING_NAMED_ENTITY, "ISO-8859-1 characters should come out as NCRs (as attribute value)");

		String CHINESE = "\u95c9\u6d77\u4e95"; // \
    	String actual3 = outputCharacters(makeStream("ISO-8859-1"), CHINESE);
		reporter.check(actual3, "闉海井", "BMP characters should come out as NCRs");
    	String actual3a = outputAttrValue(makeStream("ISO-8859-1"), CHINESE);
		reporter.check(actual3a, "闉海井", "BMP characters should come out as NCRs (as attribute value)");

		String utf16String = buildUtf16String(new int[] { 0x010030, 0xa4, 0x010032});
		reporter.check(utf16String.length(), 5, "String with two astral characters and one in the BMP should have length of 5 UTF-16 code units");
		
    	String actual4 = outputCharacters(makeStream("ISO-8859-1"), utf16String);
		reporter.check(actual4, "𐀰¤𐀲", "Astral characters should come out as NCRs");
    	String actual4a = outputAttrValue(makeStream("ISO-8859-1"), utf16String);
		reporter.check(actual4a, "𐀰¤𐀲", "Astral characters should come out as NCRs (as attribute value)");
		
        reporter.testCaseClose();
        return true;
    }

    /**
     * Verify outputting simple text in simpler 
     * @return false if we should abort the test; true otherwise
     * @throws SAXException 
     * @throws IOException 
     */
    public boolean testCase3() throws SAXException, IOException
    {
    	reporter.testCaseInit("Verify ASCII encoding in HTMLStream.");

    	String actual1 = outputCharacters(makeStream("ASCII"), "abc");
		reporter.check(actual1, "abc", "Simple characters should come out unscathed");
		String actual1a = outputAttrValue(makeStream("ASCII"), "abc");
		reporter.check(actual1a, "abc", "Simple characters should come out unscathed (as attribute value)");

    	String actual2 = outputCharacters(makeStream("ASCII"), AELIG_OSLASH_ARING);
		reporter.check(actual2, AELIG_OSLASH_ARING_NAMED_ENTITY,"ISO-8859-1 characters should come out as NCRs");
    	String actual2a = outputAttrValue(makeStream("ASCII"), AELIG_OSLASH_ARING);
		reporter.check(actual2a, AELIG_OSLASH_ARING_NAMED_ENTITY,"ISO-8859-1 characters should come out as NCRs (as attribute value)");

		String CHINESE = "\u95c9\u6d77\u4e95"; // \
    	String actual3 = outputCharacters(makeStream("ASCII"), CHINESE);
		reporter.check(actual3, "闉海井", "BMP characters should come out as NCRs");
    	String actual3a = outputAttrValue(makeStream("ASCII"), CHINESE);
		reporter.check(actual3a, "闉海井", "BMP characters should come out as NCRs (as attribute value)");

		String utf16String = buildUtf16String(new int[] { 0x010030, 0xa4, 0x010032});
		reporter.check(utf16String.length(), 5, "String with two astral characters and one in the BMP should have length of 5 UTF-16 code units");
		
    	String actual4 = outputCharacters(makeStream("ASCII"), utf16String);
		reporter.check(actual4, "𐀰¤𐀲", "Astral characters should come out as NCRs");
    	String actual4a = outputAttrValue(makeStream("ASCII"), utf16String);
		reporter.check(actual4a, "𐀰¤𐀲", "Astral characters should come out as NCRs (as attribute value)");

		String actual4b = outputAttrURLValue(makeHTMLStream("ASCII"), utf16String, true);
		reporter.check(actual4b, "%F0%90%80%B0%C2%A4%F0%90%80%B2", "Astral characters should come out as URL-escaped UTF-8 sequence (as attribute value)");

		String actual4c = outputAttrURLValue(makeHTMLStream("ASCII"), utf16String, false);
		reporter.check(actual4c, "𐀰¤𐀲", "Astral characters should come out as NCRs (as attribute value)");

        reporter.testCaseClose();
        return true;
    }

	protected String outputAttrURLValue(ToHTMLStream stream, String input, boolean urlEscape) throws SAXException, IOException {
		StringWriter writer = new StringWriter();
		stream.setOmitXMLDeclaration(true);
		stream.setWriter(writer);
		stream.writeAttrURI(writer, input, urlEscape);
		stream.flushPending();
		return writer.getBuffer().toString();
	}
    
    /**
     * Convenience method to print out usage information - update if needed.  
     * @return String denoting usage of this test class
     */
    public String usage()
    {
        return ("Common [optional] options supported by ToXMLStreamTest:\n"
                + super.usage());   // Grab our parent classes usage as well
    }

    /**
     * Main method to run test from the command line - can be left alone.  
     * @param args command line argument array
     */
    public static void main(String[] args)
    {

        ToHTMLStreamTest app = new ToHTMLStreamTest();

        app.doMain(args);
    }
}