001 /**
002 * Licensed to the Apache Software Foundation (ASF) under one or more
003 * contributor license agreements. See the NOTICE file distributed with
004 * this work for additional information regarding copyright ownership.
005 * The ASF licenses this file to You under the Apache License, Version 2.0
006 * (the "License"); you may not use this file except in compliance with
007 * the License. You may obtain a copy of the License at
008 *
009 * http://www.apache.org/licenses/LICENSE-2.0
010 *
011 * Unless required by applicable law or agreed to in writing, software
012 * distributed under the License is distributed on an "AS IS" BASIS,
013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014 * See the License for the specific language governing permissions and
015 * limitations under the License.
016 */
017 package org.apache.camel.test;
018
019 import java.util.Arrays;
020 import java.util.Collections;
021 import java.util.HashSet;
022 import java.util.List;
023 import java.util.Set;
024
025 import org.apache.camel.CamelContext;
026 import org.apache.camel.Route;
027 import org.apache.camel.impl.DefaultPackageScanClassResolver;
028 import org.apache.camel.impl.scan.AssignableToPackageScanFilter;
029 import org.apache.camel.impl.scan.InvertingPackageScanFilter;
030 import org.apache.camel.spring.SpringCamelContext;
031 import org.apache.camel.util.ObjectHelper;
032 import org.springframework.beans.factory.support.RootBeanDefinition;
033 import org.springframework.context.ApplicationContext;
034 import org.springframework.context.support.AbstractXmlApplicationContext;
035 import org.springframework.context.support.GenericApplicationContext;
036
037 /**
038 * @version $Revision: 795035 $
039 */
040 public abstract class CamelSpringTestSupport extends CamelTestSupport {
041 protected AbstractXmlApplicationContext applicationContext;
042 protected abstract AbstractXmlApplicationContext createApplicationContext();
043
044 @Override
045 protected void setUp() throws Exception {
046 applicationContext = createApplicationContext();
047 assertNotNull("Should have created a valid spring context", applicationContext);
048 super.setUp();
049 }
050
051 @Override
052 protected void tearDown() throws Exception {
053 super.tearDown();
054 if (applicationContext != null) {
055 applicationContext.destroy();
056 }
057 }
058
059 @SuppressWarnings("unchecked")
060 private static class ExcludingPackageScanClassResolver extends DefaultPackageScanClassResolver {
061
062 public void setExcludedClasses(Set<Class> excludedClasses) {
063 excludedClasses = excludedClasses == null ? Collections.EMPTY_SET : excludedClasses;
064 addFilter(new InvertingPackageScanFilter(new AssignableToPackageScanFilter(excludedClasses)));
065 }
066
067 }
068
069 /**
070 * Create a parent context that initializes a
071 * {@link org.apache.camel.spi.PackageScanClassResolver} to exclude a set of given classes from
072 * being resolved. Typically this is used at test time to exclude certain routes,
073 * which might otherwise be just noisy, from being discovered and initialized.
074 * <p/>
075 * To use this filtering mechanism it is necessary to provide the
076 * {@link ApplicationContext} returned from here as the parent context to
077 * your test context e.g.
078 *
079 * <pre>
080 * protected AbstractXmlApplicationContext createApplicationContext() {
081 * return new ClassPathXmlApplicationContext(new String[] {"test-context.xml"}, getRouteExcludingApplicationContext());
082 * }
083 * </pre>
084 *
085 * This will, in turn, call the template methods <code>excludedRoutes</code>
086 * and <code>excludedRoute</code> to determine the classes to be excluded from scanning.
087 *
088 * @see org.apache.camel.spring.config.scan.SpringComponentScanTest for an example.
089 * @return ApplicationContext a parent {@link ApplicationContext} configured
090 * to exclude certain classes from package scanning
091 */
092 protected ApplicationContext getRouteExcludingApplicationContext() {
093 GenericApplicationContext routeExcludingContext = new GenericApplicationContext();
094 routeExcludingContext.registerBeanDefinition("excludingResolver", new RootBeanDefinition(ExcludingPackageScanClassResolver.class));
095 routeExcludingContext.refresh();
096
097 ExcludingPackageScanClassResolver excludingResolver = (ExcludingPackageScanClassResolver)routeExcludingContext.getBean("excludingResolver");
098 excludingResolver.setExcludedClasses(new HashSet<Class>(Arrays.asList(excludeRoutes())));
099
100 return routeExcludingContext;
101 }
102
103 /**
104 * Template method used to exclude {@link org.apache.camel.Route} from the test time context
105 * route scanning
106 *
107 * @return Class[] the classes to be excluded from test time context route scanning
108 */
109 protected Class[] excludeRoutes() {
110 Class excludedRoute = excludeRoute();
111 return excludedRoute != null ? new Class[] {excludedRoute} : new Class[0];
112 }
113
114 /**
115 * Template method used to exclude a {@link org.apache.camel.Route} from the test camel context
116 */
117 protected Class excludeRoute() {
118 return null;
119 }
120
121 /**
122 * Looks up the mandatory spring bean of the given name and type, failing if
123 * it is not present or the correct type
124 */
125 public <T> T getMandatoryBean(Class<T> type, String name) {
126 Object value = applicationContext.getBean(name);
127 assertNotNull("No spring bean found for name <" + name + ">", value);
128 if (type.isInstance(value)) {
129 return type.cast(value);
130 } else {
131 fail("Spring bean <" + name + "> is not an instanceof " + type.getName() + " but is of type " + ObjectHelper.className(value));
132 return null;
133 }
134 }
135
136 @Override
137 protected void assertValidContext(CamelContext context) {
138 super.assertValidContext(context);
139
140 List<Route> routes = context.getRoutes();
141 int routeCount = getExpectedRouteCount();
142 if (routeCount > 0) {
143 assertNotNull("Should have some routes defined", routes);
144 assertTrue("Should have at least one route", routes.size() >= routeCount);
145 }
146 log.debug("Camel Routes: " + routes);
147 }
148
149 protected int getExpectedRouteCount() {
150 return 1;
151 }
152
153 @Override
154 protected CamelContext createCamelContext() throws Exception {
155 return SpringCamelContext.springCamelContext(applicationContext);
156 }
157
158 }