Mmuzaf commented on code in PR #2497: URL: https://github.com/apache/cassandra/pull/2497#discussion_r2232089983
########## src/java/org/apache/cassandra/tools/nodetool/AbstractCommand.java: ########## @@ -0,0 +1,104 @@ +/* + * 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.tools.nodetool; + +import javax.inject.Inject; + +import org.apache.cassandra.tools.NodeProbe; +import org.apache.cassandra.tools.Output; + +import picocli.CommandLine; +import picocli.CommandLine.ExecutionException; + +/** + * Abstract class for all nodetool commands, which provides common methods and fields + * for running commands and outputting results. + * <p> + * The command is executed by calling {@link #execute(NodeProbe)}, in all other cases + * it should not contain any fields or methods that are specific to a particular API + * being executed, or common methods that are shared across multiple commands. + * <p> + * Commands must work only with the API provided by the {@link NodeProbe} instance. + */ +public abstract class AbstractCommand implements Runnable +{ + @Inject + protected Output output; + + private NodeProbe probe; + + public void probe(NodeProbe probe) + { + this.probe = probe; + } + + public NodeProbe probe() + { + return probe; + } + + public void logger(Output output) + { + this.output = output; + } + + @Override + public void run() + { + execute(probe()); + } + + /** + * Prepare a command for execution. This method is called before the command is executed and + * can be used to perform any necessary setup or validation. If this method returns {@code false}, + * the command will not initiate connection and will be executed locally. The default implementation + * returns {@code true} so that the command initiates connection to the node before execution. + * + * @return {@code true} if the command is required to connect to the node, {@code false} otherwise. + * @throws ExecutionException if an error occurs during preparation and execution must be aborted. + */ + protected boolean prepareAndConnect() throws ExecutionException Review Comment: `shouldConnect` sounds good. ########## src/java/org/apache/cassandra/tools/nodetool/JmxConnect.java: ########## @@ -0,0 +1,239 @@ +/* + * 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.tools.nodetool; + +import java.io.Console; +import java.io.FileNotFoundException; +import java.io.IOException; +import java.util.List; +import java.util.Scanner; +import javax.inject.Inject; + +import com.google.common.base.Throwables; + +import org.apache.cassandra.io.util.File; +import org.apache.cassandra.tools.INodeProbeFactory; +import org.apache.cassandra.tools.NodeProbe; +import picocli.CommandLine; +import picocli.CommandLine.Command; +import picocli.CommandLine.ExecutionException; +import picocli.CommandLine.IExecutionStrategy; +import picocli.CommandLine.InitializationException; +import picocli.CommandLine.Model.CommandSpec; +import picocli.CommandLine.Option; +import picocli.CommandLine.ParameterException; +import picocli.CommandLine.ParseResult; +import picocli.CommandLine.RunLast; +import picocli.CommandLine.Spec; + +import static java.lang.Integer.parseInt; +import static org.apache.commons.lang3.StringUtils.EMPTY; +import static org.apache.commons.lang3.StringUtils.isEmpty; +import static org.apache.commons.lang3.StringUtils.isNotEmpty; + +/** + * Command options for NodeTool commands that are executed via JMX. + */ +@Command(name = "connect", description = "Connect to a Cassandra node via JMX") +public class JmxConnect extends AbstractCommand implements AutoCloseable +{ + public static final String MIXIN_KEY = "jmx"; + + /** The command specification, used to access command-specific properties. */ + @Spec + protected CommandSpec spec; // injected by picocli + + @Option(names = { "-h", "--host" }, description = "Node hostname or ip address", arity = "0..1") + private String host = "127.0.0.1"; + + @Option(names = { "-p", "--port" }, description = "Remote jmx agent port number", arity = "0..1") + private String port = "7199"; + + @Option(names = { "-u", "--username" }, description = "Remote jmx agent username", arity = "0..1") + private String username = EMPTY; + + @Option(names = { "-pw", "--password" }, description = "Remote jmx agent password", arity = "0..1") + private String password = EMPTY; + + @Option(names = { "-pwf", "--password-file" }, description = "Path to the JMX password file", arity = "0..1") + private String passwordFilePath = EMPTY; + + @Inject + private INodeProbeFactory nodeProbeFactory; + + /** + * This method is called by picocli and used depending on the execution strategy. + * @param parseResult The parsed command line. + * @return The exit code. + */ + public static int executionStrategy(ParseResult parseResult) + { + CommandSpec jmx = parseResult.commandSpec().mixins().get(MIXIN_KEY); + if (jmx == null) + throw new InitializationException("No JmxConnect command found in the top-level hierarchy"); + + try (JmxConnectionCommandInvoker invoker = new JmxConnectionCommandInvoker((JmxConnect) jmx.userObject())) + { + return invoker.execute(parseResult); + } + catch (JmxConnectionCommandInvoker.CloseException e) + { + jmx.commandLine() + .getErr() + .println("Failed to connect to JMX: " + e.getMessage()); + return jmx.commandLine().getExitCodeExceptionMapper().getExitCode(e); + } + } + + /** + * Initialize the JMX connection to the Cassandra node using the provided options. + */ + @Override + protected void execute(NodeProbe probe) + { + assert probe == null; + try + { + if (isNotEmpty(username)) + { + if (isNotEmpty(passwordFilePath)) + password = readUserPasswordFromFile(username, passwordFilePath); + + if (isEmpty(password)) + password = promptAndReadPassword(); + } + + probe(username.isEmpty() ? nodeProbeFactory.create(host, parseInt(port)) + : nodeProbeFactory.create(host, parseInt(port), username, password)); + } + catch (IOException | SecurityException e) + { + Throwable rootCause = Throwables.getRootCause(e); + output.printError("nodetool: Failed to connect to '%s:%s' - %s: '%s'.%n", host, port, + rootCause.getClass().getSimpleName(), rootCause.getMessage()); + throw new InitializationException("Failed to connect to JMX", e); + } + } + + @Override + public void close() throws Exception + { + if (probe() == null) + return; + ((AutoCloseable) probe()).close(); + } + + private static String readUserPasswordFromFile(String username, String passwordFilePath) + { + String password = EMPTY; + + File passwordFile = new File(passwordFilePath); + try (Scanner scanner = new Scanner(passwordFile.toJavaIOFile()).useDelimiter("\\s+")) + { + while (scanner.hasNextLine()) + { + if (scanner.hasNext()) + { + String jmxRole = scanner.next(); + if (jmxRole.equals(username) && scanner.hasNext()) + { + password = scanner.next(); + break; + } + } + scanner.nextLine(); + } + } + catch (FileNotFoundException e) + { + throw new RuntimeException(e); Review Comment: Fixed. -- 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: pr-unsubscr...@cassandra.apache.org For queries about this service, please contact Infrastructure at: us...@infra.apache.org --------------------------------------------------------------------- To unsubscribe, e-mail: pr-unsubscr...@cassandra.apache.org For additional commands, e-mail: pr-h...@cassandra.apache.org
