/*
* $Id: TestDigesterDefinitionsReader.java 673186 2008-07-01 19:20:30Z apetrelli $
*
* 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.
*/
package org.apache.tiles.definition.digester;
import java.io.IOException;
import java.io.InputStream;
import java.net.URL;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import junit.framework.Test;
import junit.framework.TestCase;
import junit.framework.TestSuite;
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import org.apache.tiles.Attribute;
import org.apache.tiles.Definition;
import org.apache.tiles.ListAttribute;
import org.apache.tiles.definition.DefinitionsFactoryException;
import org.apache.tiles.definition.DefinitionsReader;
/**
* Tests the <code>org.apache.tiles.definition.digester.DigesterDefinitionsReader</code> class.
*
* @version $Rev: 673186 $ $Date: 2008-07-01 21:20:30 +0200 (Tue, 01 Jul 2008) $
*/
public class TestDigesterDefinitionsReader extends TestCase {
/**
* The logging object.
*/
private static final Log LOG = LogFactory
.getLog(TestDigesterDefinitionsReader.class);
/**
* The definitions reader.
*/
private DefinitionsReader reader;
/**
* Creates a new instance of TestDigesterDefinitionsReader.
*
* @param name The name of the test.
*/
public TestDigesterDefinitionsReader(String name) {
super(name);
}
/**
* Start the tests.
*
* @param theArgs the arguments. Not used
*/
public static void main(String[] theArgs) {
junit.textui.TestRunner.main(
new String[] { TestDigesterDefinitionsReader.class.getName()});
}
/**
* @return a test suite (<code>TestSuite</code>) that includes all methods
* starting with "test"
*/
public static Test suite() {
return new TestSuite(TestDigesterDefinitionsReader.class);
}
/** {@inheritDoc} */
@Override
protected void setUp() throws Exception {
super.setUp();
reader = new DigesterDefinitionsReader();
}
/**
* Tests the read method under normal conditions.
* @throws IOException If something goes wrong.
*/
public void testRead() throws IOException {
reader.init(new HashMap<String, String>());
URL configFile = this.getClass().getClassLoader().getResource(
"org/apache/tiles/config/tiles-defs.xml");
assertNotNull("Config file not found", configFile);
InputStream source = configFile.openStream();
Map<String, Definition> definitions = reader.read(source);
assertNotNull("Definitions not returned.", definitions);
assertNotNull("Couldn't find doc.mainLayout tile.",
definitions.get("doc.mainLayout"));
assertNotNull("Couldn't Find title attribute.", definitions.get(
"doc.mainLayout").getAttribute("title").getValue());
assertEquals("Incorrect Find title attribute.",
"Tiles Library Documentation", definitions.get(
"doc.mainLayout").getAttribute("title").getValue());
Definition def = definitions.get("doc.role.test");
assertNotNull("Couldn't find doc.role.test tile.", def);
Attribute attribute = def.getAttribute("title");
assertNotNull("Couldn't Find title attribute.", attribute
.getValue());
assertEquals("Role 'myrole' expected", attribute.getRole(),
"myrole");
def = definitions.get("doc.listattribute.test");
assertNotNull("Couldn't find doc.listattribute.test tile.", def);
attribute = def.getAttribute("items");
assertNotNull("Couldn't Find items attribute.", attribute);
assertTrue("The class of the attribute is not right",
attribute instanceof ListAttribute);
assertTrue("The class of value of the attribute is not right",
attribute.getValue() instanceof List);
}
/**
* Tests the read method under normal conditions for the new features in 2.1
* version of the DTD.
* @throws IOException If something goes wrong.
*/
@SuppressWarnings("unchecked")
public void testRead21Version() throws IOException {
reader.init(new HashMap<String, String>());
URL configFile = this.getClass().getClassLoader().getResource(
"org/apache/tiles/config/tiles-defs-2.1.xml");
assertNotNull("Config file not found", configFile);
InputStream source = configFile.openStream();
Map<String, Definition> definitions = reader.read(source);
assertNotNull("Definitions not returned.", definitions);
Definition def = definitions.get("doc.cascaded.test");
assertNotNull("Couldn't find doc.role.test tile.", def);
Attribute attribute = def.getLocalAttribute("title");
assertNotNull("Couldn't Find title local attribute.", attribute);
attribute = def.getCascadedAttribute("title2");
assertNotNull("Couldn't Find title2 cascaded attribute.", attribute);
attribute = def.getLocalAttribute("items1");
assertNotNull("Couldn't Find items1 local attribute.", attribute);
attribute = def.getCascadedAttribute("items2");
assertNotNull("Couldn't Find items2 cascaded attribute.", attribute);
def = definitions.get("test.nesting.definitions");
assertNotNull("Couldn't find test.nesting.definitions tile.", def);
attribute = def.getAttribute("body");
assertNotNull("Couldn't Find body attribute.", attribute);
assertEquals("Attribute not of 'definition' type", "definition",
attribute.getRenderer());
assertNotNull("Attribute value null", attribute.getValue());
String defName = attribute.getValue().toString();
def = definitions.get(defName);
assertNotNull("Couldn't find " + defName + " tile.", def);
def = definitions.get("test.nesting.list.definitions");
assertNotNull("Couldn't find test.nesting.list.definitions tile.",
def);
attribute = def.getAttribute("list");
assertNotNull("Couldn't Find list attribute.", attribute);
assertTrue("Attribute not of valid type",
attribute instanceof ListAttribute);
ListAttribute listAttribute = (ListAttribute) attribute;
List<Attribute> list = (List<Attribute>) listAttribute.getValue();
assertEquals("The list is not of correct size", 1, list.size());
attribute = list.get(0);
assertNotNull("Couldn't Find element attribute.", attribute);
assertEquals("Attribute not of 'definition' type", "definition",
attribute.getRenderer());
assertNotNull("Attribute value null", attribute.getValue());
defName = attribute.getValue().toString();
def = definitions.get(defName);
assertNotNull("Couldn't find " + defName + " tile.", def);
defName = "test.inherit.list.base";
def = definitions.get(defName);
assertNotNull("Couldn't find " + defName + " tile.", def);
defName = "test.inherit.list";
def = definitions.get(defName);
assertNotNull("Couldn't find " + defName + " tile.", def);
listAttribute = (ListAttribute) def.getAttribute("list");
assertEquals("This definition does not inherit its list attribute",
true, listAttribute.isInherit());
defName = "test.noinherit.list";
def = definitions.get(defName);
listAttribute = (ListAttribute) def.getAttribute("list");
assertEquals("This definition inherits its list attribute",
false, listAttribute.isInherit());
}
/**
* Tests read with bad input source.
*/
public void testBadSource() {
try {
Map<String, String> params = new HashMap<String, String>();
// Initialize reader.
reader.init(params);
// Read definitions.
reader.read(new String("Bad Input"));
fail("Should've thrown an exception.");
} catch (DefinitionsFactoryException e) {
// correct.
if (LOG.isDebugEnabled()) {
LOG.debug("Exception caught, it is OK", e);
}
} catch (Exception e) {
fail("Exception reading configuration." + e);
}
}
/**
* Tests read with bad XML source.
*/
public void testBadXml() {
try {
reader.init(new HashMap<String, String>());
URL configFile = this.getClass().getClassLoader().getResource(
"org/apache/tiles/config/malformed-defs.xml");
assertNotNull("Config file not found", configFile);
InputStream source = configFile.openStream();
reader.read(source);
fail("Should've thrown an exception.");
} catch (DefinitionsFactoryException e) {
// correct.
if (LOG.isDebugEnabled()) {
LOG.debug("Exception caught, it is OK", e);
}
} catch (Exception e) {
fail("Exception reading configuration." + e);
}
}
/**
* Tests the validating input parameter.
*
* This test case enables Digester's validating property then passes in a
* configuration file with invalid XML.
*/
public void testValidatingParameter() {
// Testing with default (validation ON).
try {
Map<String, String> params = new HashMap<String, String>();
reader.init(params);
URL configFile = this.getClass().getClassLoader().getResource(
"org/apache/tiles/config/invalid-defs.xml");
assertNotNull("Config file not found", configFile);
InputStream source = configFile.openStream();
reader.read(source);
fail("Should've thrown an exception.");
} catch (DefinitionsFactoryException e) {
// correct.
if (LOG.isDebugEnabled()) {
LOG.debug("Exception caught, it is OK", e);
}
} catch (Exception e) {
fail("Exception reading configuration." + e);
}
// Testing with validation OFF.
try {
setUp();
Map<String, String> params = new HashMap<String, String>();
params.put(DigesterDefinitionsReader.PARSER_VALIDATE_PARAMETER_NAME,
"false");
reader.init(params);
URL configFile = this.getClass().getClassLoader().getResource(
"org/apache/tiles/config/invalid-defs.xml");
assertNotNull("Config file not found", configFile);
InputStream source = configFile.openStream();
reader.read(source);
} catch (DefinitionsFactoryException e) {
fail("Should not have thrown an exception." + e);
} catch (Exception e) {
fail("Exception reading configuration." + e);
}
}
}