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.junit4;
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.CastUtils;
032 import org.apache.camel.util.ObjectHelper;
033 import org.junit.After;
034 import org.junit.Before;
035 import org.springframework.beans.factory.support.RootBeanDefinition;
036 import org.springframework.context.ApplicationContext;
037 import org.springframework.context.support.AbstractApplicationContext;
038 import org.springframework.context.support.GenericApplicationContext;
039
040 /**
041 * @version
042 */
043 public abstract class CamelSpringTestSupport extends CamelTestSupport {
044 protected AbstractApplicationContext applicationContext;
045 protected abstract AbstractApplicationContext createApplicationContext();
046
047 @Override
048 @Before
049 public void setUp() throws Exception {
050 applicationContext = createApplicationContext();
051 assertNotNull("Should have created a valid spring context", applicationContext);
052 super.setUp();
053 }
054
055 @Override
056 @After
057 public void tearDown() throws Exception {
058 super.tearDown();
059 if (applicationContext != null) {
060 applicationContext.destroy();
061 }
062 }
063
064 @SuppressWarnings("unchecked")
065 private static class ExcludingPackageScanClassResolver extends DefaultPackageScanClassResolver {
066
067 public void setExcludedClasses(Set<Class<?>> excludedClasses) {
068 excludedClasses = excludedClasses == null ? Collections.EMPTY_SET : excludedClasses;
069 addFilter(new InvertingPackageScanFilter(new AssignableToPackageScanFilter(excludedClasses)));
070 }
071
072 }
073
074 /**
075 * Create a parent context that initializes a
076 * {@link org.apache.camel.spi.PackageScanClassResolver} to exclude a set of given classes from
077 * being resolved. Typically this is used at test time to exclude certain routes,
078 * which might otherwise be just noisy, from being discovered and initialized.
079 * <p/>
080 * To use this filtering mechanism it is necessary to provide the
081 * {@link ApplicationContext} returned from here as the parent context to
082 * your test context e.g.
083 *
084 * <pre>
085 * protected AbstractXmlApplicationContext createApplicationContext() {
086 * return new ClassPathXmlApplicationContext(new String[] {"test-context.xml"}, getRouteExcludingApplicationContext());
087 * }
088 * </pre>
089 *
090 * This will, in turn, call the template methods <code>excludedRoutes</code>
091 * and <code>excludedRoute</code> to determine the classes to be excluded from scanning.
092 *
093 * @return ApplicationContext a parent {@link ApplicationContext} configured
094 * to exclude certain classes from package scanning
095 */
096 protected ApplicationContext getRouteExcludingApplicationContext() {
097 GenericApplicationContext routeExcludingContext = new GenericApplicationContext();
098 routeExcludingContext.registerBeanDefinition("excludingResolver", new RootBeanDefinition(ExcludingPackageScanClassResolver.class));
099 routeExcludingContext.refresh();
100
101 ExcludingPackageScanClassResolver excludingResolver = (ExcludingPackageScanClassResolver)routeExcludingContext.getBean("excludingResolver");
102 List<Class<?>> excluded = CastUtils.cast(Arrays.asList(excludeRoutes()));
103 excludingResolver.setExcludedClasses(new HashSet<Class<?>>(excluded));
104
105 return routeExcludingContext;
106 }
107
108 /**
109 * Template method used to exclude {@link org.apache.camel.Route} from the test time context
110 * route scanning
111 *
112 * @return Class[] the classes to be excluded from test time context route scanning
113 */
114 protected Class<?>[] excludeRoutes() {
115 Class<?> excludedRoute = excludeRoute();
116 return excludedRoute != null ? new Class[] {excludedRoute} : new Class[0];
117 }
118
119 /**
120 * Template method used to exclude a {@link org.apache.camel.Route} from the test camel context
121 */
122 protected Class<?> excludeRoute() {
123 return null;
124 }
125
126 /**
127 * Looks up the mandatory spring bean of the given name and type, failing if
128 * it is not present or the correct type
129 */
130 public <T> T getMandatoryBean(Class<T> type, String name) {
131 Object value = applicationContext.getBean(name);
132 assertNotNull("No spring bean found for name <" + name + ">", value);
133 if (type.isInstance(value)) {
134 return type.cast(value);
135 } else {
136 fail("Spring bean <" + name + "> is not an instanceof " + type.getName() + " but is of type " + ObjectHelper.className(value));
137 return null;
138 }
139 }
140
141 @Override
142 protected void assertValidContext(CamelContext context) {
143 super.assertValidContext(context);
144
145 List<Route> routes = context.getRoutes();
146 int routeCount = getExpectedRouteCount();
147 if (routeCount > 0) {
148 assertNotNull("Should have some routes defined", routes);
149 assertTrue("Should have at least one route", routes.size() >= routeCount);
150 }
151 log.debug("Camel Routes: " + routes);
152 }
153
154 protected int getExpectedRouteCount() {
155 return 1;
156 }
157
158 @Override
159 protected CamelContext createCamelContext() throws Exception {
160 return SpringCamelContext.springCamelContext(applicationContext);
161 }
162 }