curcuru 01/02/22 07:14:37
Added: test/java/src/org/apache/qetest/trax ErrorListenerTest.java Log: New test of ErrorListener functionality Revision Changes Path 1.1 xml-xalan/test/java/src/org/apache/qetest/trax/ErrorListenerTest.java Index: ErrorListenerTest.java =================================================================== /* * The Apache Software License, Version 1.1 * * * Copyright (c) 2000-2001 The Apache Software Foundation. All rights * reserved. * * Redistribution and use in source and binary forms, with or without * modification, are permitted provided that the following conditions * are met: * * 1. Redistributions of source code must retain the above copyright * notice, this list of conditions and the following disclaimer. * * 2. 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. * * 3. The end-user documentation included with the redistribution, * if any, must include the following acknowledgment: * "This product includes software developed by the * Apache Software Foundation (http://www.apache.org/)." * Alternately, this acknowledgment may appear in the software itself, * if and wherever such third-party acknowledgments normally appear. * * 4. The names "Xalan" and "Apache Software Foundation" must * not be used to endorse or promote products derived from this * software without prior written permission. For written * permission, please contact [EMAIL PROTECTED] * * 5. Products derived from this software may not be called "Apache", * nor may "Apache" appear in their name, without prior written * permission of the Apache Software Foundation. * * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED 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 APACHE SOFTWARE FOUNDATION OR * ITS 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. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation and was * originally based on software copyright (c) 2000, Lotus * Development Corporation., http://www.lotus.com. For more * information on the Apache Software Foundation, please see * <http://www.apache.org/>. */ /* * * ErrorListenerTest.java * */ package org.apache.qetest.trax; // Support for test reporting and harness classes import org.apache.qetest.*; import org.apache.qetest.xsl.*; // Import all relevant TRAX packages import javax.xml.transform.*; import javax.xml.transform.dom.*; import javax.xml.transform.sax.*; import javax.xml.transform.stream.*; import javax.xml.parsers.DocumentBuilder; import javax.xml.parsers.DocumentBuilderFactory; import javax.xml.parsers.SAXParserFactory; // Needed SAX, DOM, JAXP classes import org.xml.sax.InputSource; import org.xml.sax.XMLReader; import org.w3c.dom.Node; // java classes import java.io.File; import java.io.FilenameFilter; import java.util.Properties; //------------------------------------------------------------------------- /** * Verify that ErrorListeners are called properly from Transformers. * @author [EMAIL PROTECTED] * @version $Id: ErrorListenerTest.java,v 1.1 2001/02/22 15:14:36 curcuru Exp $ */ public class ErrorListenerTest extends XSLProcessorTestBase { /** Provide sequential output names automatically. */ protected OutputNameManager outNames; /** FilenameFilter that lists appropriate tests in api/err directory to use. */ protected FilenameFilter errorFileFilter = null; /** * A simple stylesheet with errors for testing in various flavors. * Must be coordinated with templatesExpectedType/Value, * transformExpectedType/Value. */ protected XSLTestfileInfo testFileInfo = new XSLTestfileInfo(); /** Expected type of error during stylesheet build. */ protected int templatesExpectedType = 0; /** Expected String of error during stylesheet build. */ protected String templatesExpectedValue = null; /** Expected type of error during transform. */ protected int transformExpectedType = 0; /** Expected String of error during transform. */ protected String transformExpectedValue = null; /** Subdirectory under test\tests\api for our xsl/xml files. */ public static final String ERR_SUBDIR = "err"; /** Name of expected parent test\tests\api directory. */ public static final String API_PARENTDIR = "api"; /** Just initialize test name, comment, numTestCases. */ public ErrorListenerTest() { numTestCases = 3; // REPLACE_num testName = "ErrorListenerTest"; testComment = "Verify that ErrorListeners are called properly from Transformers."; } /** * Initialize this test * * @param p Properties to initialize from (if needed) * @return false if we should abort the test; true otherwise */ public boolean doTestFileInit(Properties p) { // Used for all tests; just dump files in trax subdir File outSubDir = new File(outputDir + File.separator + ERR_SUBDIR); if (!outSubDir.mkdirs()) reporter.logWarningMsg("Could not create output dir: " + outSubDir); // Initialize an output name manager to that dir with .out extension outNames = new OutputNameManager(outputDir + File.separator + ERR_SUBDIR + File.separator + testName, ".out"); errorFileFilter = new ConformanceErrFileRules(API_PARENTDIR); String testBasePath = inputDir + File.separator + ERR_SUBDIR + File.separator; String goldBasePath = goldDir + File.separator + ERR_SUBDIR + File.separator; testFileInfo.inputName = testBasePath + "ErrorListenerTest.xsl"; testFileInfo.xmlName = testBasePath + "ErrorListenerTest.xml"; testFileInfo.goldName = goldBasePath + "ErrorListenerTest.out"; templatesExpectedType = LoggingErrorListener.TYPE_FATALERROR; templatesExpectedValue = "decimal-format names must be unique. Name \"myminus\" has been duplicated"; transformExpectedType = LoggingErrorListener.TYPE_WARNING; transformExpectedValue = "ExpectedMessage from:list1"; return true; } /** * Build a stylesheet/do a transform with a known-bad stylesheet. * Verify that the ErrorListener is called properly. * Primarily using StreamSources. * @return false if we should abort the test; true otherwise */ public boolean testCase1() { reporter.testCaseInit("Build a stylesheet/do a transform with a known-bad stylesheet"); LoggingErrorListener loggingErrorListener = new LoggingErrorListener(reporter); loggingErrorListener.setThrowWhen(LoggingErrorListener.THROW_NEVER); reporter.logTraceMsg("loggingErrorListener originally setup:" + loggingErrorListener.getQuickCounters()); TransformerFactory factory = null; Templates templates = null; Transformer transformer = null; try { factory = TransformerFactory.newInstance(); // Set the errorListener and validate it factory.setErrorListener(loggingErrorListener); reporter.check((factory.getErrorListener() == loggingErrorListener), true, "set/getErrorListener on factory"); // Attempt to build templates from known-bad stylesheet // Validate known errors in stylesheet building loggingErrorListener.setExpected(templatesExpectedType, templatesExpectedValue); reporter.logInfoMsg("About to factory.newTemplates(" + filenameToURL(testFileInfo.inputName) + ")"); templates = factory.newTemplates(new StreamSource(filenameToURL(testFileInfo.inputName))); reporter.logTraceMsg("loggingErrorListener after newTemplates:" + loggingErrorListener.getQuickCounters()); // Clear out any setExpected or counters loggingErrorListener.reset(); reporter.checkPass("set ErrorListener prevented any exceptions in newTemplates()"); // This stylesheet will still work, even though errors // were detected during it's building. Note that // future versions of Xalan or other processors may // not be able to continue here... transformer = templates.newTransformer(); reporter.logTraceMsg("default transformer's getErrorListener is: " + transformer.getErrorListener()); // Set the errorListener and validate it transformer.setErrorListener(loggingErrorListener); reporter.check((transformer.getErrorListener() == loggingErrorListener), true, "set/getErrorListener on transformer"); // Validate the first xsl:message call in the stylesheet loggingErrorListener.setExpected(transformExpectedType, transformExpectedValue); reporter.logTraceMsg("about to transform(...)"); transformer.transform(new StreamSource(filenameToURL(testFileInfo.xmlName)), new StreamResult(outNames.nextName())); reporter.logTraceMsg("after transform(...)"); // Clear out any setExpected or counters loggingErrorListener.reset(); // Validate the actual output file as well: in this case, // the stylesheet should still work if (Logger.PASS_RESULT != fileChecker.check(reporter, new File(outNames.currentName()), new File(testFileInfo.goldName), "transform of error xsl into: " + outNames.currentName()) ) reporter.logInfoMsg("transform of error xsl failure reason:" + fileChecker.getExtendedInfo()); } catch (Throwable t) { reporter.checkFail("errorListener unexpectedly threw: " + t.toString()); reporter.logThrowable(Logger.ERRORMSG, t, "errorListener unexpectedly threw"); } reporter.testCaseClose(); return true; } /** * Build a bad stylesheet/do a transform with SAX. * Verify that the ErrorListener is called properly. * Primarily using SAXSources. * @return false if we should abort the test; true otherwise */ public boolean testCase2() { reporter.testCaseInit("Build a bad stylesheet/do a transform with SAX"); LoggingErrorListener loggingErrorListener = new LoggingErrorListener(reporter); loggingErrorListener.setThrowWhen(LoggingErrorListener.THROW_NEVER); reporter.logTraceMsg("loggingErrorListener originally setup:" + loggingErrorListener.getQuickCounters()); TransformerFactory factory = null; SAXTransformerFactory saxFactory = null; XMLReader reader = null; Templates templates = null; Transformer transformer = null; TransformerHandler handler = null; try { factory = TransformerFactory.newInstance(); saxFactory = (SAXTransformerFactory)factory; // assumes SAXSource.feature! // Set the errorListener and validate it saxFactory.setErrorListener(loggingErrorListener); reporter.check((saxFactory.getErrorListener() == loggingErrorListener), true, "set/getErrorListener on saxFactory"); // Use the JAXP way to get an XMLReader reader = SAXParserFactory.newInstance().newSAXParser().getXMLReader(); InputSource is = new InputSource(filenameToURL(testFileInfo.inputName)); // Attempt to build templates from known-bad stylesheet // Validate known errors in stylesheet building loggingErrorListener.setExpected(templatesExpectedType, templatesExpectedValue); reporter.logTraceMsg("About to factory.newTransformerHandler(SAX:" + filenameToURL(testFileInfo.inputName) + ")"); handler = saxFactory.newTransformerHandler(new SAXSource(is)); reporter.logTraceMsg("loggingErrorListener after newTransformerHandler:" + loggingErrorListener.getQuickCounters()); // Clear out any setExpected or counters loggingErrorListener.reset(); reporter.checkPass("set ErrorListener prevented any exceptions in newTransformerHandler()"); // This stylesheet will still work, even though errors // were detected during it's building. Note that // future versions of Xalan or other processors may // not be able to continue here... // Create a result and setup SAX parsing 'tree' Result result = new StreamResult(outNames.nextName()); handler.setResult(result); reader.setContentHandler(handler); // transformer.setErrorListener(loggingErrorListener); // Validate the first xsl:message call in the stylesheet loggingErrorListener.setExpected(transformExpectedType, transformExpectedValue); reporter.logTraceMsg("//@todo Need to hookup a SAX errorHandler to catch errors here!"); reporter.logInfoMsg("about to parse/transform(" + filenameToURL(testFileInfo.xmlName) + ")"); reader.parse(filenameToURL(testFileInfo.xmlName)); reporter.logTraceMsg("after parse/transform(...)"); // Clear out any setExpected or counters loggingErrorListener.reset(); // Validate the actual output file as well: in this case, // the stylesheet should still work if (Logger.PASS_RESULT != fileChecker.check(reporter, new File(outNames.currentName()), new File(testFileInfo.goldName), "SAX transform of error xsl into: " + outNames.currentName()) ) reporter.logInfoMsg("SAX transform of error xsl failure reason:" + fileChecker.getExtendedInfo()); } catch (Throwable t) { reporter.checkFail("errorListener-SAX unexpectedly threw: " + t.toString()); reporter.logThrowable(Logger.ERRORMSG, t, "errorListener-SAX unexpectedly threw"); } reporter.testCaseClose(); return true; } /** * Build a bad stylesheet/do a transform with DOMs. * Verify that the ErrorListener is called properly. * Primarily using DOMSources. * @return false if we should abort the test; true otherwise */ public boolean testCase3() { reporter.testCaseInit("Build a bad stylesheet/do a transform with DOMs"); LoggingErrorListener loggingErrorListener = new LoggingErrorListener(reporter); loggingErrorListener.setThrowWhen(LoggingErrorListener.THROW_NEVER); reporter.logTraceMsg("loggingErrorListener originally setup:" + loggingErrorListener.getQuickCounters()); TransformerFactory factory = null; Templates templates = null; Transformer transformer = null; DocumentBuilderFactory dfactory = null; DocumentBuilder docBuilder = null; Node xmlNode = null; Node xslNode = null; try { // Startup a DOM factory, create some nodes/DOMs dfactory = DocumentBuilderFactory.newInstance(); dfactory.setNamespaceAware(true); docBuilder = dfactory.newDocumentBuilder(); reporter.logInfoMsg("parsing xml, xsl files to DOMs"); xslNode = docBuilder.parse(new InputSource(filenameToURL(testFileInfo.inputName))); xmlNode = docBuilder.parse(new InputSource(filenameToURL(testFileInfo.xmlName))); // Create a transformer factory with an error listener factory = TransformerFactory.newInstance(); factory.setErrorListener(loggingErrorListener); // Attempt to build templates from known-bad stylesheet // Validate known errors in stylesheet building loggingErrorListener.setExpected(templatesExpectedType, templatesExpectedValue); reporter.logTraceMsg("About to factory.newTemplates(DOM:" + filenameToURL(testFileInfo.inputName) + ")"); templates = factory.newTemplates(new DOMSource(xslNode)); reporter.logTraceMsg("loggingErrorListener after newTemplates:" + loggingErrorListener.getQuickCounters()); // Clear out any setExpected or counters loggingErrorListener.reset(); reporter.checkPass("set ErrorListener prevented any exceptions in newTemplates()"); // This stylesheet will still work, even though errors // were detected during it's building. Note that // future versions of Xalan or other processors may // not be able to continue here... transformer = templates.newTransformer(); reporter.logTraceMsg("default transformer's getErrorListener is: " + transformer.getErrorListener()); // Set the errorListener and validate it transformer.setErrorListener(loggingErrorListener); reporter.check((transformer.getErrorListener() == loggingErrorListener), true, "set/getErrorListener on transformer"); // Validate the first xsl:message call in the stylesheet loggingErrorListener.setExpected(transformExpectedType, transformExpectedValue); reporter.logInfoMsg("about to transform(DOM, StreamResult)"); transformer.transform(new DOMSource(xmlNode), new StreamResult(outNames.nextName())); reporter.logTraceMsg("after transform(...)"); // Clear out any setExpected or counters loggingErrorListener.reset(); // Validate the actual output file as well: in this case, // the stylesheet should still work if (Logger.PASS_RESULT != fileChecker.check(reporter, new File(outNames.currentName()), new File(testFileInfo.goldName), "DOM transform of error xsl into: " + outNames.currentName()) ) reporter.logInfoMsg("DOM transform of error xsl failure reason:" + fileChecker.getExtendedInfo()); } catch (Throwable t) { reporter.checkFail("errorListener-DOM unexpectedly threw: " + t.toString()); reporter.logThrowable(Logger.ERRORMSG, t, "errorListener-DOM unexpectedly threw"); } reporter.testCaseClose(); return true; } /** * 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 ErrorListenerTest:\n" + "(Note: assumes inputDir=.\\tests\\api)\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) { ErrorListenerTest app = new ErrorListenerTest(); app.doMain(args); } }
