/*
* $Id: QDoxTemplateSuiteFactoryTest.java 1349964 2012-06-13 17:18:51Z nlebas $
*
* 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.autotag.core;
import static org.junit.Assert.*;
import java.util.ArrayList;
import java.util.List;
import org.apache.tiles.autotag.core.internal.AnnotatedExampleModel;
import org.apache.tiles.autotag.core.internal.ExampleExecutableModel;
import org.apache.tiles.autotag.core.internal.ExampleModel;
import org.apache.tiles.autotag.core.internal.ExampleRequest;
import org.apache.tiles.autotag.core.internal.NotFeasibleExampleModel;
import org.apache.tiles.autotag.core.runtime.ModelBody;
import org.apache.tiles.autotag.model.TemplateClass;
import org.apache.tiles.autotag.model.TemplateMethod;
import org.apache.tiles.autotag.model.TemplateParameter;
import org.apache.tiles.autotag.model.TemplateSuite;
import org.junit.Before;
import org.junit.Test;
/**
* Tests {@link QDoxTemplateSuiteFactory}.
*
* @version $Rev: 1349964 $ $Date: 2012-06-13 13:18:51 -0400 (Wed, 13 Jun 2012) $
*/
public class QDoxTemplateSuiteFactoryTest {
private static final String REQUEST_CLASS = ExampleRequest.class.getName();
/**
* The factory to test.
*/
private QDoxTemplateSuiteFactory factory;
/**
* @throws java.lang.Exception
*/
@Before
public void setUp() {
factory = new QDoxTemplateSuiteFactory(
getClass().getResource("/org/apache/tiles/autotag/core/internal/ExampleModel.java"),
getClass().getResource("/org/apache/tiles/autotag/core/internal/AnnotatedExampleModel.java"),
getClass().getResource("/org/apache/tiles/autotag/core/internal/ExampleExcluded.java"),
getClass().getResource("/org/apache/tiles/autotag/core/internal/ExampleExecutableModel.java"),
getClass().getResource("/org/apache/tiles/autotag/core/internal/NotFeasibleExampleModel.java"));
factory.setSuiteName("The suite name");
factory.setSuiteDocumentation("This are the docs");
factory.setRequestClass(REQUEST_CLASS);
}
/**
* Test method for {@link org.apache.tiles.autotag.core.DefaultTemplateSuiteFactory#createTemplateSuite()}.
*/
@Test
public void testCreateTemplateSuite() {
TemplateSuite suite = factory.createTemplateSuite();
assertEquals("The suite name", suite.getName());
assertEquals("This are the docs", suite.getDocumentation());
assertEquals(3, suite.getTemplateClasses().size());
TemplateClass templateClass = suite.getTemplateClassByName(ExampleModel.class.getName());
assertNotNull(templateClass);
assertEquals(ExampleModel.class.getName(), templateClass.getName());
assertEquals("Example start/stop template.", templateClass.getDocumentation());
TemplateMethod templateMethod = templateClass.getExecuteMethod();
assertNotNull(templateMethod);
assertTrue(templateMethod.hasBody());
assertTrue(templateClass.hasBody());
assertEquals("execute", templateMethod.getName());
assertEquals("It starts.", templateMethod.getDocumentation());
List<TemplateParameter> parameters = new ArrayList<TemplateParameter>(templateMethod.getParameters());
assertEquals(4, parameters.size());
TemplateParameter parameter = parameters.get(0);
assertEquals("one", parameter.getName());
assertEquals("java.lang.String", parameter.getType());
assertEquals("Parameter one.", parameter.getDocumentation());
parameter = parameters.get(1);
assertEquals("two", parameter.getName());
assertEquals("int", parameter.getType());
assertEquals("Parameter two.", parameter.getDocumentation());
parameter = parameters.get(2);
assertEquals("request", parameter.getName());
assertEquals(REQUEST_CLASS, parameter.getType());
assertEquals("The request.", parameter.getDocumentation());
parameter = parameters.get(3);
assertEquals("modelBody", parameter.getName());
assertEquals(ModelBody.class.getName(), parameter.getType());
assertEquals("The model body.", parameter.getDocumentation());
templateClass = suite.getTemplateClassByName(AnnotatedExampleModel.class.getName());
assertNotNull(templateClass);
assertEquals(AnnotatedExampleModel.class.getName(), templateClass.getName());
templateMethod = templateClass.getExecuteMethod();
assertNotNull(templateMethod);
assertEquals("execute", templateMethod.getName());
parameters = new ArrayList<TemplateParameter>(templateMethod.getParameters());
assertEquals(4, parameters.size());
parameter = parameters.get(0);
assertEquals("one", parameter.getName());
assertEquals("alternateOne", parameter.getExportedName());
assertEquals("java.lang.String", parameter.getType());
assertEquals("Parameter one.", parameter.getDocumentation());
assertEquals("hello", parameter.getDefaultValue());
assertTrue(parameter.isRequired());
templateClass = suite.getTemplateClassByName(ExampleExecutableModel.class.getName());
assertNotNull(templateClass);
assertEquals(ExampleExecutableModel.class.getName(), templateClass.getName());
assertEquals("Example executable template.", templateClass.getDocumentation());
templateMethod = templateClass.getExecuteMethod();
assertNotNull(templateMethod);
assertEquals("execute", templateMethod.getName());
assertEquals("It executes.", templateMethod.getDocumentation());
parameters = new ArrayList<TemplateParameter>(templateMethod.getParameters());
assertEquals(3, parameters.size());
parameter = parameters.get(0);
assertEquals("one", parameter.getName());
assertEquals("java.lang.String", parameter.getType());
assertEquals("Parameter one.", parameter.getDocumentation());
parameter = parameters.get(1);
assertEquals("two", parameter.getName());
assertEquals("int", parameter.getType());
assertEquals("Parameter two.", parameter.getDocumentation());
parameter = parameters.get(2);
assertEquals("request", parameter.getName());
assertEquals(REQUEST_CLASS, parameter.getType());
assertEquals("The request.", parameter.getDocumentation());
assertNull(suite.getTemplateClassByName(NotFeasibleExampleModel.class.getName()));
}
}