/*
* 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.solr.core;
import org.apache.lucene.util.LuceneTestCase;
import org.apache.solr.common.util.NamedList;
import org.apache.solr.core.SolrConfig.JmxConfiguration;
import org.junit.After;
import org.junit.Before;
import org.junit.Test;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import javax.management.MBeanServerConnection;
import javax.management.ObjectInstance;
import javax.management.ObjectName;
import javax.management.Query;
import javax.management.remote.JMXConnector;
import javax.management.remote.JMXConnectorFactory;
import javax.management.remote.JMXServiceURL;
import java.io.IOException;
import java.lang.invoke.MethodHandles;
import java.net.ServerSocket;
import java.rmi.registry.LocateRegistry;
import java.rmi.server.RMIServerSocketFactory;
import java.util.Set;
import static org.hamcrest.CoreMatchers.allOf;
import static org.hamcrest.CoreMatchers.equalTo;
import static org.hamcrest.CoreMatchers.instanceOf;
/**
* Test for JmxMonitoredMap
*
*
* @since solr 1.3
*/
public class TestJmxMonitoredMap extends LuceneTestCase {
private static final Logger log = LoggerFactory.getLogger(MethodHandles.lookup().lookupClass());
private int port = 0;
private JMXConnector connector;
private MBeanServerConnection mbeanServer;
private JmxMonitoredMap<String, SolrInfoMBean> monitoredMap;
@Override
@Before
public void setUp() throws Exception {
super.setUp();
String oldHost = System.getProperty("java.rmi.server.hostname");
try {
// this stupid sysprop thing is needed, because remote stubs use an
// arbitrary local ip to connect
// See: http://weblogs.java.net/blog/emcmanus/archive/2006/12/multihomed_comp.html
System.setProperty("java.rmi.server.hostname", "127.0.0.1");
class LocalhostRMIServerSocketFactory implements RMIServerSocketFactory {
ServerSocket socket;
@Override
public ServerSocket createServerSocket(int port) throws IOException {
return socket = new ServerSocket(port);
}
};
LocalhostRMIServerSocketFactory factory = new LocalhostRMIServerSocketFactory();
LocateRegistry.createRegistry(0, null, factory);
port = factory.socket.getLocalPort();
log.info("Using port: " + port);
String url = "service:jmx:rmi:///jndi/rmi://127.0.0.1:"+port+"/solrjmx";
JmxConfiguration config = new JmxConfiguration(true, null, url, null);
monitoredMap = new JmxMonitoredMap<>("", "", config);
JMXServiceURL u = new JMXServiceURL(url);
connector = JMXConnectorFactory.connect(u);
mbeanServer = connector.getMBeanServerConnection();
} finally {
if (oldHost == null) {
System.clearProperty("java.rmi.server.hostname");
} else {
System.setProperty("java.rmi.server.hostname", oldHost);
}
}
}
@Override
@After
public void tearDown() throws Exception {
try {
connector.close();
} catch (Exception e) {
}
super.tearDown();
}
@Test
public void testTypeName() throws Exception{
MockInfoMBean mock = new MockInfoMBean();
monitoredMap.put("mock", mock);
NamedList dynamicStats = mock.getStatistics();
assertTrue(dynamicStats.size() != 0);
assertTrue(dynamicStats.get("Integer") instanceof Integer);
assertTrue(dynamicStats.get("Double") instanceof Double);
assertTrue(dynamicStats.get("Long") instanceof Long);
assertTrue(dynamicStats.get("Short") instanceof Short);
assertTrue(dynamicStats.get("Byte") instanceof Byte);
assertTrue(dynamicStats.get("Float") instanceof Float);
assertTrue(dynamicStats.get("String") instanceof String);
Set<ObjectInstance> objects = mbeanServer.queryMBeans(null, Query.match(
Query.attr("name"), Query.value("mock")));
ObjectName name = objects.iterator().next().getObjectName();
assertMBeanTypeAndValue(name, "Integer", Integer.class, 123);
assertMBeanTypeAndValue(name, "Double", Double.class, 567.534);
assertMBeanTypeAndValue(name, "Long", Long.class, 32352463l);
assertMBeanTypeAndValue(name, "Short", Short.class, (short) 32768);
assertMBeanTypeAndValue(name, "Byte", Byte.class, (byte) 254);
assertMBeanTypeAndValue(name, "Float", Float.class, 3.456f);
assertMBeanTypeAndValue(name, "String",String.class, "testing");
}
@SuppressWarnings("unchecked")
public void assertMBeanTypeAndValue(ObjectName name, String attr, Class type, Object value) throws Exception {
assertThat(mbeanServer.getAttribute(name, attr),
allOf(instanceOf(type), equalTo(value))
);
}
@Test
public void testPutRemoveClear() throws Exception {
MockInfoMBean mock = new MockInfoMBean();
monitoredMap.put("mock", mock);
Set<ObjectInstance> objects = mbeanServer.queryMBeans(null, Query.match(
Query.attr("name"), Query.value("mock")));
assertFalse("No MBean for mock object found in MBeanServer", objects
.isEmpty());
monitoredMap.remove("mock");
objects = mbeanServer.queryMBeans(null, Query.match(Query.attr("name"),
Query.value("mock")));
assertTrue("MBean for mock object found in MBeanServer even after removal",
objects.isEmpty());
monitoredMap.put("mock", mock);
monitoredMap.put("mock2", mock);
objects = mbeanServer.queryMBeans(null, Query.match(Query.attr("name"),
Query.value("mock")));
assertFalse("No MBean for mock object found in MBeanServer", objects
.isEmpty());
monitoredMap.clear();
objects = mbeanServer.queryMBeans(null, Query.match(Query.attr("name"),
Query.value("mock")));
assertTrue(
"MBean for mock object found in MBeanServer even after clear has been called",
objects.isEmpty());
}
@Test
public void testJmxAugmentedSolrInfoMBean() throws Exception {
final MockInfoMBean mock = new MockInfoMBean();
final String jmxKey = "jmx";
final String jmxValue = "jmxValue";
MockJmxAugmentedSolrInfoMBean mbean = new MockJmxAugmentedSolrInfoMBean(mock) {
@Override
public NamedList getStatisticsForJmx() {
NamedList stats = getStatistics();
stats.add(jmxKey, jmxValue);
return stats;
}
};
monitoredMap.put("mock", mbean);
// assert getStatistics called when used as a map. Note can't use equals here to compare
// because getStatistics returns a new Object each time.
assertNull(monitoredMap.get("mock").getStatistics().get(jmxKey));
// assert getStatisticsForJmx called when used as jmx server
Set<ObjectInstance> objects = mbeanServer.queryMBeans(null, Query.match(
Query.attr("name"), Query.value("mock")));
ObjectName name = objects.iterator().next().getObjectName();
assertMBeanTypeAndValue(name, jmxKey, jmxValue.getClass(), jmxValue);
}
private static abstract class MockJmxAugmentedSolrInfoMBean
extends SolrInfoMBeanWrapper implements JmxMonitoredMap.JmxAugmentedSolrInfoMBean {
public MockJmxAugmentedSolrInfoMBean(SolrInfoMBean mbean) {
super(mbean);
}
@Override
public abstract NamedList getStatisticsForJmx();
}
}