INT-1830: add tests and workaround for MBeanExporters triggering eager loading

spring-integration-jmx/src/test/java/org/springframework/integration/monitor/MBeanExporterIntegrationTests.java

@@ -0,0 +1,169 @@
+/*
+ * Copyright 2009-2010 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.integration.monitor;
+
+import static org.junit.Assert.assertEquals;
+import static org.junit.Assert.assertNotNull;
+import static org.junit.Assert.assertTrue;
+
+import java.util.Arrays;
+import java.util.Date;
+
+import javax.management.MBeanServer;
+import javax.management.ObjectName;
+
+import org.junit.After;
+import org.junit.Test;
+import org.springframework.beans.factory.FactoryBean;
+import org.springframework.beans.factory.InitializingBean;
+import org.springframework.context.support.GenericXmlApplicationContext;
+import org.springframework.integration.MessageChannel;
+import org.springframework.jmx.export.annotation.ManagedResource;
+import org.springframework.util.Assert;
+
+public class MBeanExporterIntegrationTests {
+
+	private IntegrationMBeanExporter messageChannelsMonitor;
+	
+	private GenericXmlApplicationContext context;
+	
+	@After
+	public void close() {
+		if (context!=null) {
+			context.close();
+		}
+	}
+
+	@Test
+	public void testCircularReferenceNoChannel() throws Exception {		
+		context = new GenericXmlApplicationContext(getClass(), "oref-nonchannel.xml");
+		messageChannelsMonitor = context.getBean(IntegrationMBeanExporter.class);
+		assertNotNull(messageChannelsMonitor);
+	}
+
+	@Test
+	public void testCircularReferenceNoChannelInFactoryBean() throws Exception {		
+		context = new GenericXmlApplicationContext(getClass(), "oref-factory-nonchannel.xml");
+		messageChannelsMonitor = context.getBean(IntegrationMBeanExporter.class);
+		assertNotNull(messageChannelsMonitor);
+	}
+
+	@Test
+	public void testCircularReferenceWithChannel() throws Exception {		
+		context = new GenericXmlApplicationContext(getClass(), "oref-channel.xml");
+		messageChannelsMonitor = context.getBean(IntegrationMBeanExporter.class);
+		assertNotNull(messageChannelsMonitor);
+	}
+
+	@Test
+	public void testCircularReferenceWithChannelInFactoryBean() throws Exception {		
+		context = new GenericXmlApplicationContext(getClass(), "oref-factory-channel.xml");
+		messageChannelsMonitor = context.getBean(IntegrationMBeanExporter.class);
+		assertNotNull(messageChannelsMonitor);
+		assertTrue(Arrays.asList(messageChannelsMonitor.getChannelNames()).contains("anonymous"));
+		MBeanServer server = context.getBean(MBeanServer.class);
+		assertEquals(1, server.queryNames(ObjectName.getInstance("com.foo:*"), null).size());
+		assertEquals(1, server.queryNames(ObjectName.getInstance("org.springframework.integration:name=anonymous,*"), null).size());
+	}
+
+	@Test
+	public void testCircularReferenceWithChannelInFactoryBeanAutodetected() throws Exception {		
+		context = new GenericXmlApplicationContext(getClass(), "oref-factory-channel-autodetect.xml");
+		messageChannelsMonitor = context.getBean(IntegrationMBeanExporter.class);
+		assertNotNull(messageChannelsMonitor);
+	}
+
+	public static class DateFactoryBean implements FactoryBean<Date> {
+
+		private Date date;
+
+		public void setDate(Date date) {
+			this.date = date;
+		}
+
+		// This has the potential to blow up if called before setDate().
+		// Depends on bean instantiation order and IntegrationMBeanExporter
+		// can influence that by aggressively instantiating other MBeanExporters
+		public Date getObject() throws Exception {
+			Assert.state(date != null, "A date must be provided");
+			return date;
+		}
+
+		public Class<?> getObjectType() {
+			return Date.class;
+		}
+
+		public boolean isSingleton() {
+			return true;
+		}
+
+	}
+
+	public static class DateHolder implements InitializingBean {
+
+		private Date date;
+
+		public void setDate(Date date) {
+			this.date = date;
+		}
+
+		public void afterPropertiesSet() throws Exception {
+			Assert.state(date != null, "A date must be provided");
+		}
+
+	}
+
+	public static class MetricFactoryBean implements FactoryBean<Metric> {
+
+		private MessageChannel channel;
+		private Metric date = new Metric();
+
+		public void setChannel(MessageChannel channel) {
+			this.channel = channel;
+		}
+
+		public Metric getObject() throws Exception {
+			Assert.state(channel != null, "A channel must be provided");
+			return date;
+		}
+
+		public Class<?> getObjectType() {
+			return Metric.class;
+		}
+
+		public boolean isSingleton() {
+			return true;
+		}
+
+	}
+	
+	@ManagedResource
+	public static class Metric {
+		
+	}
+
+	public static class MetricHolder implements InitializingBean {
+
+		private MessageChannel channel;
+		
+		public void setChannel(MessageChannel channel) {
+			this.channel = channel;
+		}
+
+		public void afterPropertiesSet() throws Exception {
+			Assert.state(channel != null, "A channel must be provided");
+		}
+
+	}
+
+}

spring-integration-jmx/src/test/java/org/springframework/integration/monitor/oref-channel.xml

@@ -0,0 +1,33 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<beans xmlns="http://www.springframework.org/schema/beans" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+	xmlns:context="http://www.springframework.org/schema/context" xmlns:int="http://www.springframework.org/schema/integration"
+	xsi:schemaLocation="http://www.springframework.org/schema/integration http://www.springframework.org/schema/integration/spring-integration.xsd
+		http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans-2.5.xsd
+		http://www.springframework.org/schema/context http://www.springframework.org/schema/context/spring-context-2.5.xsd">
+
+	<bean id="foo" class="org.springframework.integration.monitor.MBeanExporterIntegrationTests$MetricHolder">
+		<property name="channel" ref="anonymous"/>
+	</bean>
+
+	<bean id="auto" class="org.springframework.jmx.export.annotation.AnnotationMBeanExporter">
+		<property name="defaultDomain" value="org.springframework.integration"/>
+		<property name="server" ref="mbeanServer" />
+	</bean>
+
+	<bean id="exporter" class="org.springframework.jmx.export.MBeanExporter">
+		<property name="beans">
+			<map>
+				<entry key="foo.domain.com:type=Foo,name=foo" value-ref="foo" />
+			</map>
+		</property>
+		<property name="server" ref="mbeanServer" />
+	</bean>
+
+	<import resource="common-context.xml" />
+
+	<int:channel id="anonymous">
+		<int:queue />
+	</int:channel>
+	
+
+</beans>

spring-integration-jmx/src/test/java/org/springframework/integration/monitor/oref-factory-channel-autodetect.xml

@@ -0,0 +1,24 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<beans xmlns="http://www.springframework.org/schema/beans" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+	xmlns:context="http://www.springframework.org/schema/context" xmlns:int="http://www.springframework.org/schema/integration"
+	xsi:schemaLocation="http://www.springframework.org/schema/integration http://www.springframework.org/schema/integration/spring-integration.xsd
+		http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans-2.5.xsd
+		http://www.springframework.org/schema/context http://www.springframework.org/schema/context/spring-context-2.5.xsd">
+
+	<bean id="foo" class="org.springframework.integration.monitor.MBeanExporterIntegrationTests$MetricFactoryBean">
+		<property name="channel" ref="anonymous"/>
+	</bean>
+
+	<bean id="exporter" class="org.springframework.jmx.export.annotation.AnnotationMBeanExporter">
+		<property name="defaultDomain" value="org.springframework.integration"/>
+		<property name="server" ref="mbeanServer" />
+	</bean>
+
+	<import resource="common-context.xml" />
+
+	<int:channel id="anonymous">
+		<int:queue />
+	</int:channel>
+	
+
+</beans>

spring-integration-jmx/src/test/java/org/springframework/integration/monitor/oref-factory-channel.xml

@@ -0,0 +1,28 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<beans xmlns="http://www.springframework.org/schema/beans" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+	xmlns:context="http://www.springframework.org/schema/context" xmlns:int="http://www.springframework.org/schema/integration"
+	xsi:schemaLocation="http://www.springframework.org/schema/integration http://www.springframework.org/schema/integration/spring-integration.xsd
+		http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans-2.5.xsd
+		http://www.springframework.org/schema/context http://www.springframework.org/schema/context/spring-context-2.5.xsd">
+
+	<bean id="foo" class="org.springframework.integration.monitor.MBeanExporterIntegrationTests$MetricFactoryBean">
+		<property name="channel" ref="anonymous"/>
+	</bean>
+
+	<import resource="common-context.xml" />
+
+	<int:channel id="anonymous">
+		<int:queue />
+	</int:channel>
+	
+	<bean id="auto" class="org.springframework.jmx.export.annotation.AnnotationMBeanExporter">
+		<property name="defaultDomain" value="org.springframework.integration"/>
+		<property name="beans">
+			<map>
+				<entry key="com.foo:type=Foo,name=foo" value-ref="foo" />
+			</map>
+		</property>
+		<property name="server" ref="mbeanServer" />
+	</bean>
+
+</beans>

spring-integration-jmx/src/test/java/org/springframework/integration/monitor/oref-factory-nonchannel.xml

@@ -0,0 +1,35 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<beans xmlns="http://www.springframework.org/schema/beans" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+	xmlns:context="http://www.springframework.org/schema/context" xmlns:int="http://www.springframework.org/schema/integration"
+	xsi:schemaLocation="http://www.springframework.org/schema/integration http://www.springframework.org/schema/integration/spring-integration.xsd
+		http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans-2.5.xsd
+		http://www.springframework.org/schema/context http://www.springframework.org/schema/context/spring-context-2.5.xsd">
+
+	<bean id="foo" class="org.springframework.integration.monitor.MBeanExporterIntegrationTests$DateFactoryBean">
+		<property name="date" ref="date"/>
+	</bean>
+
+	<bean id="date" class="java.util.Date" />
+
+	<bean id="auto" class="org.springframework.jmx.export.annotation.AnnotationMBeanExporter">
+		<property name="defaultDomain" value="org.springframework.integration"/>
+		<property name="server" ref="mbeanServer" />
+	</bean>
+
+	<bean id="exporter" class="org.springframework.jmx.export.MBeanExporter">
+		<property name="beans">
+			<map>
+				<entry key="foo.domain.com:type=Foo,name=foo" value-ref="foo" />
+			</map>
+		</property>
+		<property name="server" ref="mbeanServer" />
+	</bean>
+
+	<import resource="common-context.xml" />
+
+	<int:channel id="anonymous">
+		<int:queue />
+	</int:channel>
+	
+
+</beans>

spring-integration-jmx/src/test/java/org/springframework/integration/monitor/oref-nonchannel.xml

@@ -0,0 +1,35 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<beans xmlns="http://www.springframework.org/schema/beans" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+	xmlns:context="http://www.springframework.org/schema/context" xmlns:int="http://www.springframework.org/schema/integration"
+	xsi:schemaLocation="http://www.springframework.org/schema/integration http://www.springframework.org/schema/integration/spring-integration.xsd
+		http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans-2.5.xsd
+		http://www.springframework.org/schema/context http://www.springframework.org/schema/context/spring-context-2.5.xsd">
+
+	<bean id="foo" class="org.springframework.integration.monitor.MBeanExporterIntegrationTests$DateHolder">
+		<property name="date" ref="date"/>
+	</bean>
+
+	<bean id="date" class="java.util.Date" />
+
+	<bean id="auto" class="org.springframework.jmx.export.annotation.AnnotationMBeanExporter">
+		<property name="defaultDomain" value="org.springframework.integration"/>
+		<property name="server" ref="mbeanServer" />
+	</bean>
+		
+	<bean id="exporter" class="org.springframework.jmx.export.MBeanExporter">
+		<property name="beans">
+			<map>
+				<entry key="foo.domain.com:type=Foo,name=foo" value-ref="foo" />
+			</map>
+		</property>
+		<property name="server" ref="mbeanServer" />
+	</bean>
+
+	<import resource="common-context.xml" />
+
+	<int:channel id="anonymous">
+		<int:queue />
+	</int:channel>
+	
+
+</beans>