jonmeredith commented on code in PR #2322: URL: https://github.com/apache/cassandra/pull/2322#discussion_r1195285617
########## test/distributed/org/apache/cassandra/distributed/test/jmx/JMXFeatureTest.java: ########## @@ -0,0 +1,94 @@ +/* + * 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.cassandra.distributed.test.jmx; + +import java.io.IOException; +import java.util.HashSet; +import java.util.Set; +import javax.management.MBeanServerConnection; +import javax.management.remote.JMXConnector; +import javax.management.remote.JMXConnectorFactory; +import javax.management.remote.JMXServiceURL; + +import org.junit.Assert; +import org.junit.Test; + +import org.apache.cassandra.distributed.Cluster; +import org.apache.cassandra.distributed.api.Feature; +import org.apache.cassandra.distributed.api.IInvokableInstance; +import org.apache.cassandra.distributed.test.TestBaseImpl; + +import static org.hamcrest.Matchers.startsWith; + +public class JMXFeatureTest extends TestBaseImpl +{ + + public static final String JMX_SERVICE_URL_FMT = "service:jmx:rmi:///jndi/rmi://%s:%d/jmxrmi"; + + /** + * Test the in-jvm dtest JMX feature. + * - Create a cluster with multiple JMX servers, one per instance + * - Test that when connecting, we get the correct MBeanServer by checking the default domain, which is set to the IP of the instance + * - Run the test multiple times to ensure cleanup of the JMX servers is complete so the next test can run successfully using the same host/port. + * NOTE: In later versions of Cassandra, there is also a `testOneNetworkInterfaceProvisioning` that leverages the ability to specify + * ports in addition to IP/Host for binding, but this version does not support that feature. Keeping the test name the same + * so that it's consistent across versions. + * + * @throws Exception + */ + @Test + public void testMultipleNetworkInterfacesProvisioning() throws Exception + { + int iterations = 2; // Make sure the JMX infrastructure all cleans up properly by running this multiple times. + Set<String> allInstances = new HashSet<>(); + for (int i = 0; i < iterations; i++) + { + try (Cluster cluster = Cluster.build(2).withConfig(c -> c.with(Feature.values())).start()) + { + Set<String> instancesContacted = new HashSet<>(); + for (IInvokableInstance instance : cluster.get(1, 2)) + { + testInstance(instancesContacted, instance); + } + Assert.assertEquals("Should have connected with both JMX instances.", 2, instancesContacted.size()); + allInstances.addAll(instancesContacted); + } + } + Assert.assertEquals("Each instance from each cluster should have been unique", iterations * 2, allInstances.size()); + } + + private void testInstance(Set<String> instancesContacted, IInvokableInstance instance) throws IOException + { + // NOTE: At some point, the hostname of the broadcastAddress can be resolved + // and then the `getHostString`, which would otherwise return the IP address, + // starts returning `localhost` - use `.getAddress().getHostAddress()` to work around this. + String jmxHost = instance.config().broadcastAddress().getAddress().getHostAddress(); + int jmxPort = instance.config().jmxPort(); + String url = String.format(JMX_SERVICE_URL_FMT, jmxHost, jmxPort); + try (JMXConnector jmxc = JMXConnectorFactory.connect(new JMXServiceURL(url), null)) Review Comment: is it worth making a convenience method that takes an IInstanceConfig and returns the `JMXConnector`. Is there any test where you wouldn't do those same four statements to make the connector? ########## src/java/org/apache/cassandra/utils/MBeanWrapper.java: ########## @@ -33,62 +38,144 @@ */ public interface MBeanWrapper { - static final Logger logger = LoggerFactory.getLogger(MBeanWrapper.class); + Logger logger = LoggerFactory.getLogger(MBeanWrapper.class); - static final MBeanWrapper instance = Boolean.getBoolean("org.apache.cassandra.disable_mbean_registration") ? - new NoOpMBeanWrapper() : - new PlatformMBeanWrapper(); + MBeanWrapper instance = create(); + String IS_DISABLED_MBEAN_REGISTRATION = "org.apache.cassandra.disable_mbean_registration"; + String IS_IN_JVM_DTEST = "org.apache.cassandra.is_in_jvm_dtest"; + String MBEAN_REGISTRATION_CLASS = "org.apache.cassandra.mbean_registration_class"; + + static MBeanWrapper create() + { + // If we're running in the in-jvm dtest environment, always use the delegating + // mbean wrapper even if we start off with no-op, so it can be switched later + if (Boolean.getBoolean(IS_IN_JVM_DTEST)) + return new DelegatingMbeanWrapper(getmBeanWrapper()); + + return getmBeanWrapper(); + } + + static MBeanWrapper getmBeanWrapper() + { + if (Boolean.getBoolean(IS_DISABLED_MBEAN_REGISTRATION)) + return new NoOpMBeanWrapper(); + + String klass = System.getProperty(MBEAN_REGISTRATION_CLASS); + if (klass == null) + if (Boolean.getBoolean(IS_IN_JVM_DTEST)) + return new NoOpMBeanWrapper(); + else + return new PlatformMBeanWrapper(); Review Comment: nit: my personal preference would be to include the outer `if` braces `{}` but don't think this goes against the style guide. ########## test/distributed/org/apache/cassandra/distributed/test/jmx/JMXGetterCheckTest.java: ########## @@ -0,0 +1,138 @@ +/* + * 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.cassandra.distributed.test.jmx; + +import java.util.ArrayList; +import java.util.Collections; +import java.util.List; +import java.util.Set; +import java.util.TreeSet; +import javax.management.JMRuntimeException; +import javax.management.MBeanAttributeInfo; +import javax.management.MBeanInfo; +import javax.management.MBeanOperationInfo; +import javax.management.MBeanServerConnection; +import javax.management.ObjectName; +import javax.management.remote.JMXConnector; +import javax.management.remote.JMXConnectorFactory; +import javax.management.remote.JMXServiceURL; + +import com.google.common.collect.ImmutableSet; +import org.junit.Test; + +import org.apache.cassandra.distributed.Cluster; +import org.apache.cassandra.distributed.api.Feature; +import org.apache.cassandra.distributed.api.IInvokableInstance; +import org.apache.cassandra.distributed.test.TestBaseImpl; + +public class JMXGetterCheckTest extends TestBaseImpl +{ + private static final Set<String> IGNORE_ATTRIBUTES = ImmutableSet.of( + "org.apache.cassandra.net:type=MessagingService:BackPressurePerHost" // throws unsupported saying the feature was removed... dropped in CASSANDRA-15375 + ); + private static final Set<String> IGNORE_OPERATIONS = ImmutableSet.of( + "org.apache.cassandra.db:type=StorageService:stopDaemon", // halts the instance, which then causes the JVM to exit + "org.apache.cassandra.db:type=StorageService:drain", // don't drain, it stops things which can cause other APIs to be unstable as we are in a stopped state + "org.apache.cassandra.db:type=StorageService:stopGossiping", // if we stop gossip this can cause other issues, so avoid + "org.apache.cassandra.db:type=StorageService:resetLocalSchema", // this will fail when there are no other nodes which can serve schema + "org.apache.cassandra.db:type=HintedHandoffManager:listEndpointsPendingHints", // this will fail because it only exists to match an old, deprecated mbean and just throws an UnsportedOperationException + "org.apache.cassandra.db:type=StorageService:decommission" // Don't decommission nodes! Note that in future versions of C* this is unnecessary because decommission takes an argument. + ); + + public static final String JMX_SERVICE_URL_FMT = "service:jmx:rmi:///jndi/rmi://%s:%d/jmxrmi"; + + @Test + public void testGetters() throws Exception + { + try (Cluster cluster = Cluster.build(1).withConfig(c -> c.with(Feature.values())).start()) + { + IInvokableInstance instance = cluster.get(1); + + String jmxHost = instance.config().broadcastAddress().getAddress().getHostAddress(); + String url = String.format(JMX_SERVICE_URL_FMT, jmxHost, instance.config().jmxPort()); + List<Named> errors = new ArrayList<>(); + try (JMXConnector jmxc = JMXConnectorFactory.connect(new JMXServiceURL(url), null)) + { + MBeanServerConnection mbsc = jmxc.getMBeanServerConnection(); + Set<ObjectName> metricNames = new TreeSet<>(mbsc.queryNames(null, null)); + for (ObjectName name : metricNames) + { + if (!name.getDomain().startsWith("org.apache.cassandra")) + continue; + MBeanInfo info = mbsc.getMBeanInfo(name); + for (MBeanAttributeInfo a : info.getAttributes()) + { + String fqn = String.format("%s:%s", name, a.getName()); + if (!a.isReadable() || IGNORE_ATTRIBUTES.contains(fqn)) + continue; + try + { + mbsc.getAttribute(name, a.getName()); + } + catch (JMRuntimeException e) + { + errors.add(new Named(String.format("Attribute %s", fqn), e.getCause())); + } + } + + for (MBeanOperationInfo o : info.getOperations()) + { + String fqn = String.format("%s:%s", name, o.getName()); + if (o.getSignature().length != 0 || IGNORE_OPERATIONS.contains(fqn)) + continue; + try + { + mbsc.invoke(name, o.getName(), new Object[0], new String[0]); + } + catch (JMRuntimeException e) + { + errors.add(new Named(String.format("Operation %s", fqn), e.getCause())); + } + } + } + } + if (!errors.isEmpty()) + { + AssertionError root = new AssertionError(); + errors.forEach(root::addSuppressed); + throw root; + } + } + } + + /** + * This class is meant to make new errors easier to read, by adding the JMX endpoint, and cleaning up the unneded JMX/Reflection logic cluttering the stacktrace Review Comment: ```suggestion * This class is meant to make new errors easier to read, by adding the JMX endpoint, and cleaning up the unneeded JMX/Reflection logic cluttering the stacktrace ``` -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected] --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
