/*
* Copyright 2002-2008 the original author or authors.
*
* Licensed 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.springframework.beans.factory.config;
import junit.framework.TestCase;
import org.easymock.MockControl;
import org.springframework.beans.FatalBeanException;
import org.springframework.beans.MutablePropertyValues;
import org.springframework.beans.PropertyValue;
import org.springframework.beans.factory.BeanFactory;
import org.springframework.beans.factory.NoSuchBeanDefinitionException;
import org.springframework.context.support.StaticApplicationContext;
import org.springframework.core.NestedCheckedException;
import org.springframework.core.NestedRuntimeException;
import org.springframework.test.AssertThrows;
/**
* @author Colin Sampaleanu
* @author Rick Evans
*/
public class ServiceLocatorFactoryBeanTests extends TestCase {
public void testNoArgGetter() {
StaticApplicationContext ctx = new StaticApplicationContext();
ctx.registerSingleton("testService", TestService.class, new MutablePropertyValues());
MutablePropertyValues mpv = new MutablePropertyValues();
mpv.addPropertyValue(new PropertyValue("serviceLocatorInterface", TestServiceLocator.class));
ctx.registerSingleton("factory", ServiceLocatorFactoryBean.class, mpv);
ctx.refresh();
TestServiceLocator factory = (TestServiceLocator) ctx.getBean("factory");
TestService testService = factory.getTestService();
assertNotNull(testService);
}
public void testErrorOnTooManyOrTooFew() throws Exception {
StaticApplicationContext ctx = new StaticApplicationContext();
ctx.registerSingleton("testService", TestService.class, new MutablePropertyValues());
ctx.registerSingleton("testServiceInstance2", TestService.class, new MutablePropertyValues());
MutablePropertyValues mpv = new MutablePropertyValues();
mpv.addPropertyValue(new PropertyValue("serviceLocatorInterface", TestServiceLocator.class));
ctx.registerSingleton("factory", ServiceLocatorFactoryBean.class, mpv);
mpv = new MutablePropertyValues();
mpv.addPropertyValue(new PropertyValue("serviceLocatorInterface", TestServiceLocator2.class));
ctx.registerSingleton("factory2", ServiceLocatorFactoryBean.class, mpv);
mpv = new MutablePropertyValues();
mpv.addPropertyValue(new PropertyValue("serviceLocatorInterface", TestService2Locator.class));
ctx.registerSingleton("factory3", ServiceLocatorFactoryBean.class, mpv);
ctx.refresh();
final TestServiceLocator factory = (TestServiceLocator) ctx.getBean("factory");
new AssertThrows(NoSuchBeanDefinitionException.class, "Must fail on more than one matching type") {
public void test() throws Exception {
factory.getTestService();
}
}.runTest();
final TestServiceLocator2 factory2 = (TestServiceLocator2) ctx.getBean("factory2");
new AssertThrows(NoSuchBeanDefinitionException.class, "Must fail on more than one matching type") {
public void test() throws Exception {
factory2.getTestService(null);
}
}.runTest();
final TestService2Locator factory3 = (TestService2Locator) ctx.getBean("factory3");
new AssertThrows(NoSuchBeanDefinitionException.class, "Must fail on no matching types") {
public void test() throws Exception {
factory3.getTestService();
}
}.runTest();
}
public void testErrorOnTooManyOrTooFewWithCustomServiceLocatorException() {
StaticApplicationContext ctx = new StaticApplicationContext();
ctx.registerSingleton("testService", TestService.class, new MutablePropertyValues());
ctx.registerSingleton("testServiceInstance2", TestService.class, new MutablePropertyValues());
MutablePropertyValues mpv = new MutablePropertyValues();
mpv.addPropertyValue(new PropertyValue("serviceLocatorInterface", TestServiceLocator.class));
mpv.addPropertyValue(new PropertyValue("serviceLocatorExceptionClass", CustomServiceLocatorException1.class));
ctx.registerSingleton("factory", ServiceLocatorFactoryBean.class, mpv);
mpv = new MutablePropertyValues();
mpv.addPropertyValue(new PropertyValue("serviceLocatorInterface", TestServiceLocator2.class));
mpv.addPropertyValue(new PropertyValue("serviceLocatorExceptionClass", CustomServiceLocatorException2.class));
ctx.registerSingleton("factory2", ServiceLocatorFactoryBean.class, mpv);
mpv = new MutablePropertyValues();
mpv.addPropertyValue(new PropertyValue("serviceLocatorInterface", TestService2Locator.class));
mpv.addPropertyValue(new PropertyValue("serviceLocatorExceptionClass", CustomServiceLocatorException3.class));
ctx.registerSingleton("factory3", ServiceLocatorFactoryBean.class, mpv);
ctx.refresh();
TestServiceLocator factory = (TestServiceLocator) ctx.getBean("factory");
try {
factory.getTestService();
fail("Must fail on more than one matching type");
}
catch (CustomServiceLocatorException1 expected) {
assertTrue(expected.getCause() instanceof NoSuchBeanDefinitionException);
}
TestServiceLocator2 factory2 = (TestServiceLocator2) ctx.getBean("factory2");
try {
factory2.getTestService(null);
fail("Must fail on more than one matching type");
}
catch (CustomServiceLocatorException2 expected) {
assertTrue(expected.getCause() instanceof NoSuchBeanDefinitionException);
}
final TestService2Locator factory3 = (TestService2Locator) ctx.getBean("factory3");
new AssertThrows(CustomServiceLocatorException3.class, "Must fail on no matching types") {
public void test() throws Exception {
factory3.getTestService();
}
}.runTest();
}
public void testStringArgGetter() throws Exception {
StaticApplicationContext ctx = new StaticApplicationContext();
ctx.registerSingleton("testService", TestService.class, new MutablePropertyValues());
MutablePropertyValues mpv = new MutablePropertyValues();
mpv.addPropertyValue(new PropertyValue("serviceLocatorInterface", TestServiceLocator2.class));
ctx.registerSingleton("factory", ServiceLocatorFactoryBean.class, mpv);
ctx.refresh();
// test string-arg getter with null id
final TestServiceLocator2 factory = (TestServiceLocator2) ctx.getBean("factory");
TestService testBean = factory.getTestService(null);
// now test with explicit id
testBean = factory.getTestService("testService");
// now verify failure on bad id
new AssertThrows(NoSuchBeanDefinitionException.class, "Illegal operation allowed") {
public void test() throws Exception {
factory.getTestService("bogusTestService");
}
}.runTest();
}
public void testCombinedLocatorInterface() {
StaticApplicationContext ctx = new StaticApplicationContext();
ctx.registerPrototype("testService", TestService.class, new MutablePropertyValues());
ctx.registerAlias("testService", "1");
MutablePropertyValues mpv = new MutablePropertyValues();
mpv.addPropertyValue("serviceLocatorInterface", TestServiceLocator3.class);
ctx.registerSingleton("factory", ServiceLocatorFactoryBean.class, mpv);
ctx.refresh();
TestServiceLocator3 factory = (TestServiceLocator3) ctx.getBean("factory");
TestService testBean1 = factory.getTestService();
TestService testBean2 = factory.getTestService("testService");
TestService testBean3 = factory.getTestService(1);
TestService testBean4 = factory.someFactoryMethod();
assertNotSame(testBean1, testBean2);
assertNotSame(testBean1, testBean3);
assertNotSame(testBean1, testBean4);
assertNotSame(testBean2, testBean3);
assertNotSame(testBean2, testBean4);
assertNotSame(testBean3, testBean4);
assertTrue(factory.toString().indexOf("TestServiceLocator3") != -1);
}
public void testServiceMappings() {
StaticApplicationContext ctx = new StaticApplicationContext();
ctx.registerPrototype("testService1", TestService.class, new MutablePropertyValues());
ctx.registerPrototype("testService2", ExtendedTestService.class, new MutablePropertyValues());
MutablePropertyValues mpv = new MutablePropertyValues();
mpv.addPropertyValue("serviceLocatorInterface", TestServiceLocator3.class);
mpv.addPropertyValue("serviceMappings", "=testService1\n1=testService1\n2=testService2");
ctx.registerSingleton("factory", ServiceLocatorFactoryBean.class, mpv);
ctx.refresh();
TestServiceLocator3 factory = (TestServiceLocator3) ctx.getBean("factory");
TestService testBean1 = factory.getTestService();
TestService testBean2 = factory.getTestService("testService1");
TestService testBean3 = factory.getTestService(1);
TestService testBean4 = factory.getTestService(2);
assertNotSame(testBean1, testBean2);
assertNotSame(testBean1, testBean3);
assertNotSame(testBean1, testBean4);
assertNotSame(testBean2, testBean3);
assertNotSame(testBean2, testBean4);
assertNotSame(testBean3, testBean4);
assertFalse(testBean1 instanceof ExtendedTestService);
assertFalse(testBean2 instanceof ExtendedTestService);
assertFalse(testBean3 instanceof ExtendedTestService);
assertTrue(testBean4 instanceof ExtendedTestService);
}
public void testNoServiceLocatorInterfaceSupplied() throws Exception {
new AssertThrows(IllegalArgumentException.class, "No serviceLocator interface supplied") {
public void test() throws Exception {
new ServiceLocatorFactoryBean().afterPropertiesSet();
}
}.runTest();
}
public void testWhenServiceLocatorInterfaceIsNotAnInterfaceType() throws Exception {
new AssertThrows(IllegalArgumentException.class, "Bad (non-interface-type) serviceLocator interface supplied") {
public void test() throws Exception {
ServiceLocatorFactoryBean factory = new ServiceLocatorFactoryBean();
factory.setServiceLocatorInterface(getClass());
factory.afterPropertiesSet();
}
}.runTest();
}
public void testWhenServiceLocatorExceptionClassToExceptionTypeWithOnlyNoArgCtor() throws Exception {
new AssertThrows(IllegalArgumentException.class, "Bad (invalid-Exception-type) serviceLocatorException class supplied") {
public void test() throws Exception {
ServiceLocatorFactoryBean factory = new ServiceLocatorFactoryBean();
factory.setServiceLocatorExceptionClass(ExceptionClassWithOnlyZeroArgCtor.class);
}
}.runTest();
}
public void testWhenServiceLocatorExceptionClassIsNotAnExceptionSubclass() throws Exception {
new AssertThrows(IllegalArgumentException.class, "Bad (non-Exception-type) serviceLocatorException class supplied") {
public void test() throws Exception {
ServiceLocatorFactoryBean factory = new ServiceLocatorFactoryBean();
factory.setServiceLocatorExceptionClass(getClass());
}
}.runTest();
}
public void testWhenServiceLocatorMethodCalledWithTooManyParameters() throws Exception {
ServiceLocatorFactoryBean factory = new ServiceLocatorFactoryBean();
factory.setServiceLocatorInterface(ServiceLocatorInterfaceWithExtraNonCompliantMethod.class);
factory.afterPropertiesSet();
final ServiceLocatorInterfaceWithExtraNonCompliantMethod locator = (ServiceLocatorInterfaceWithExtraNonCompliantMethod) factory.getObject();
new AssertThrows(UnsupportedOperationException.class, "Bad method (too many args, doesn't obey class contract)") {
public void test() throws Exception {
locator.getTestService("not", "allowed");
}
}.runTest();
}
public void testRequiresListableBeanFactoryAndChokesOnAnythingElse() throws Exception {
MockControl mockBeanFactory = MockControl.createControl(BeanFactory.class);
final BeanFactory beanFactory = (BeanFactory) mockBeanFactory.getMock();
mockBeanFactory.replay();
new AssertThrows(FatalBeanException.class) {
public void test() throws Exception {
ServiceLocatorFactoryBean factory = new ServiceLocatorFactoryBean();
factory.setBeanFactory(beanFactory);
}
}.runTest();
mockBeanFactory.verify();
}
public static class TestService {
}
public static class ExtendedTestService extends TestService {
}
public static class TestService2 {
}
public static interface TestServiceLocator {
TestService getTestService();
}
public static interface TestServiceLocator2 {
TestService getTestService(String id) throws CustomServiceLocatorException2;
}
public static interface TestServiceLocator3 {
TestService getTestService();
TestService getTestService(String id);
TestService getTestService(int id);
TestService someFactoryMethod();
}
public static interface TestService2Locator {
TestService2 getTestService() throws CustomServiceLocatorException3;
}
public static interface ServiceLocatorInterfaceWithExtraNonCompliantMethod {
TestService2 getTestService();
TestService2 getTestService(String serviceName, String defaultNotAllowedParameter);
}
public static class CustomServiceLocatorException1 extends NestedRuntimeException {
public CustomServiceLocatorException1(String message, Throwable cause) {
super(message, cause);
}
}
public static class CustomServiceLocatorException2 extends NestedCheckedException {
public CustomServiceLocatorException2(Throwable cause) {
super("", cause);
}
}
public static class CustomServiceLocatorException3 extends NestedCheckedException {
public CustomServiceLocatorException3(String message) {
super(message);
}
}
public static class ExceptionClassWithOnlyZeroArgCtor extends Exception {
}
}