This is an automated email from the ASF dual-hosted git repository.
sodonnell pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/ozone.git
The following commit(s) were added to refs/heads/master by this push:
new aaf2d81e20 HDDS-9554. Introduce a CLI command to show the datanodes
under decommissioning (#5488)
aaf2d81e20 is described below
commit aaf2d81e2067b6006e42f0a26c3c4b64e9f821c9
Author: Tejaskriya <[email protected]>
AuthorDate: Thu Dec 7 16:39:46 2023 +0530
HDDS-9554. Introduce a CLI command to show the datanodes under
decommissioning (#5488)
---
.../cli/datanode/DecommissionStatusSubCommand.java | 93 +++++++++
.../hdds/scm/cli/datanode/StatusSubCommand.java | 56 +++++
.../datanode/TestDecommissionStatusSubCommand.java | 228 +++++++++++++++++++++
3 files changed, 377 insertions(+)
diff --git
a/hadoop-hdds/tools/src/main/java/org/apache/hadoop/hdds/scm/cli/datanode/DecommissionStatusSubCommand.java
b/hadoop-hdds/tools/src/main/java/org/apache/hadoop/hdds/scm/cli/datanode/DecommissionStatusSubCommand.java
new file mode 100644
index 0000000000..bbf1d84076
--- /dev/null
+++
b/hadoop-hdds/tools/src/main/java/org/apache/hadoop/hdds/scm/cli/datanode/DecommissionStatusSubCommand.java
@@ -0,0 +1,93 @@
+/**
+ * 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
+ * <p>
+ * http://www.apache.org/licenses/LICENSE-2.0
+ * <p>
+ * 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.hadoop.hdds.scm.cli.datanode;
+
+import com.google.common.base.Strings;
+import org.apache.hadoop.hdds.cli.HddsVersionProvider;
+import org.apache.hadoop.hdds.protocol.DatanodeDetails;
+import org.apache.hadoop.hdds.protocol.proto.HddsProtos;
+import org.apache.hadoop.hdds.scm.cli.ScmSubcommand;
+import org.apache.hadoop.hdds.scm.client.ScmClient;
+import picocli.CommandLine;
+
+import java.io.IOException;
+import java.util.List;
+import java.util.stream.Collectors;
+import java.util.stream.Stream;
+
+import static
org.apache.hadoop.hdds.protocol.proto.HddsProtos.NodeOperationalState.DECOMMISSIONING;
+
+/**
+ * Handler to print decommissioning nodes status.
+ */
[email protected](
+ name = "decommission",
+ description = "Show status of datanodes in DECOMMISSIONING",
+ mixinStandardHelpOptions = true,
+ versionProvider = HddsVersionProvider.class)
+
+public class DecommissionStatusSubCommand extends ScmSubcommand {
+
+ @CommandLine.Option(names = { "--id" },
+ description = "Show info by datanode UUID",
+ defaultValue = "")
+ private String uuid;
+
+ @CommandLine.Option(names = { "--ip" },
+ description = "Show info by datanode ipAddress",
+ defaultValue = "")
+ private String ipAddress;
+
+ @Override
+ public void execute(ScmClient scmClient) throws IOException {
+ List<HddsProtos.Node> decommissioningNodes;
+ Stream<HddsProtos.Node> allNodes = scmClient.queryNode(DECOMMISSIONING,
+ null, HddsProtos.QueryScope.CLUSTER, "").stream();
+ if (!Strings.isNullOrEmpty(uuid)) {
+ decommissioningNodes = allNodes.filter(p -> p.getNodeID().getUuid()
+ .equals(uuid)).collect(Collectors.toList());
+ if (decommissioningNodes.isEmpty()) {
+ System.err.println("Datanode: " + uuid + " is not in DECOMMISSIONING");
+ return;
+ }
+ } else if (!Strings.isNullOrEmpty(ipAddress)) {
+ decommissioningNodes = allNodes.filter(p -> p.getNodeID().getIpAddress()
+ .compareToIgnoreCase(ipAddress) == 0).collect(Collectors.toList());
+ if (decommissioningNodes.isEmpty()) {
+ System.err.println("Datanode: " + ipAddress + " is not in " +
+ "DECOMMISSIONING");
+ return;
+ }
+ } else {
+ decommissioningNodes = allNodes.collect(Collectors.toList());
+ System.out.println("\nDecommission Status: DECOMMISSIONING - " +
+ decommissioningNodes.size() + " node(s)");
+ }
+
+ for (HddsProtos.Node node : decommissioningNodes) {
+ DatanodeDetails datanode = DatanodeDetails.getFromProtoBuf(
+ node.getNodeID());
+ printDetails(datanode);
+ }
+ }
+ private void printDetails(DatanodeDetails datanode) {
+ System.out.println("\nDatanode: " + datanode.getUuid().toString() +
+ " (" + datanode.getNetworkLocation() + "/" + datanode.getIpAddress()
+ + "/" + datanode.getHostName() + ")");
+ }
+}
diff --git
a/hadoop-hdds/tools/src/main/java/org/apache/hadoop/hdds/scm/cli/datanode/StatusSubCommand.java
b/hadoop-hdds/tools/src/main/java/org/apache/hadoop/hdds/scm/cli/datanode/StatusSubCommand.java
new file mode 100644
index 0000000000..9edcd3425a
--- /dev/null
+++
b/hadoop-hdds/tools/src/main/java/org/apache/hadoop/hdds/scm/cli/datanode/StatusSubCommand.java
@@ -0,0 +1,56 @@
+package org.apache.hadoop.hdds.scm.cli.datanode;
+/**
+ * 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
+ * <p>
+ * http://www.apache.org/licenses/LICENSE-2.0
+ * <p>
+ * 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.
+ */
+
+import org.apache.hadoop.hdds.cli.GenericCli;
+import org.apache.hadoop.hdds.cli.HddsVersionProvider;
+import org.apache.hadoop.hdds.cli.SubcommandWithParent;
+import org.kohsuke.MetaInfServices;
+import picocli.CommandLine;
+import picocli.CommandLine.Command;
+import java.util.concurrent.Callable;
+
+/**
+ * View status of one or more datanodes.
+ */
+@Command(
+ name = "status",
+ description = "Show status of datanodes",
+ mixinStandardHelpOptions = true,
+ versionProvider = HddsVersionProvider.class,
+ subcommands = {
+ DecommissionStatusSubCommand.class
+ })
+
+@MetaInfServices(SubcommandWithParent.class)
+public class StatusSubCommand implements Callable<Void>, SubcommandWithParent {
+
+ @CommandLine.Spec
+ private CommandLine.Model.CommandSpec spec;
+
+ @Override
+ public Void call() throws Exception {
+ GenericCli.missingSubcommand(spec);
+ return null;
+ }
+
+ @Override
+ public Class<?> getParentType() {
+ return DatanodeCommands.class;
+ }
+}
diff --git
a/hadoop-hdds/tools/src/test/java/org/apache/hadoop/hdds/scm/cli/datanode/TestDecommissionStatusSubCommand.java
b/hadoop-hdds/tools/src/test/java/org/apache/hadoop/hdds/scm/cli/datanode/TestDecommissionStatusSubCommand.java
new file mode 100644
index 0000000000..99c930a3ee
--- /dev/null
+++
b/hadoop-hdds/tools/src/test/java/org/apache/hadoop/hdds/scm/cli/datanode/TestDecommissionStatusSubCommand.java
@@ -0,0 +1,228 @@
+/*
+ * 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.hadoop.hdds.scm.cli.datanode;
+
+import org.apache.hadoop.hdds.protocol.proto.HddsProtos;
+import org.apache.hadoop.hdds.scm.client.ScmClient;
+import org.junit.jupiter.api.AfterEach;
+import org.junit.jupiter.api.BeforeEach;
+import org.junit.jupiter.api.Test;
+
+import java.io.ByteArrayOutputStream;
+import java.io.IOException;
+import java.io.PrintStream;
+import java.io.UnsupportedEncodingException;
+import java.nio.charset.StandardCharsets;
+import java.util.ArrayList;
+import java.util.List;
+import java.util.UUID;
+import java.util.regex.Matcher;
+import java.util.regex.Pattern;
+
+import org.mockito.Mockito;
+import picocli.CommandLine;
+
+import static org.junit.jupiter.api.Assertions.assertFalse;
+import static org.junit.jupiter.api.Assertions.assertTrue;
+import static org.mockito.ArgumentMatchers.any;
+import static org.mockito.Mockito.mock;
+
+/**
+ * Unit tests to validate the DecommissionStatusSubCommand class includes the
+ * correct output when executed against a mock client.
+ */
+public class TestDecommissionStatusSubCommand {
+
+ private static final String DEFAULT_ENCODING = StandardCharsets.UTF_8.name();
+ private final ByteArrayOutputStream outContent = new ByteArrayOutputStream();
+ private final ByteArrayOutputStream errContent = new ByteArrayOutputStream();
+ private final PrintStream originalOut = System.out;
+ private final PrintStream originalErr = System.err;
+ private DecommissionStatusSubCommand cmd;
+ private List<HddsProtos.Node> nodes = getNodeDetails(2);
+
+ @BeforeEach
+ public void setup() throws UnsupportedEncodingException {
+ cmd = new DecommissionStatusSubCommand();
+ System.setOut(new PrintStream(outContent, false, DEFAULT_ENCODING));
+ System.setErr(new PrintStream(errContent, false, DEFAULT_ENCODING));
+ }
+
+ @AfterEach
+ public void tearDown() {
+ System.setOut(originalOut);
+ System.setErr(originalErr);
+ }
+
+ @Test
+ public void testSuccessWhenDecommissionStatus() throws IOException {
+ ScmClient scmClient = mock(ScmClient.class);
+ Mockito.when(scmClient.queryNode(any(), any(), any(), any()))
+ .thenAnswer(invocation -> nodes); // 2 nodes decommissioning
+
+ cmd.execute(scmClient);
+ Pattern p = Pattern.compile("Decommission\\sStatus:\\s" +
+ "DECOMMISSIONING\\s-\\s2\\snode\\(s\\)\n");
+ Matcher m = p.matcher(outContent.toString(DEFAULT_ENCODING));
+ assertTrue(m.find());
+
+ // Both DN details are shown
+ p = Pattern.compile("Datanode:\\s.*host0\\)");
+ m = p.matcher(outContent.toString(DEFAULT_ENCODING));
+ assertTrue(m.find());
+ p = Pattern.compile("Datanode:\\s.*host1\\)");
+ m = p.matcher(outContent.toString(DEFAULT_ENCODING));
+ assertTrue(m.find());
+ }
+
+ @Test
+ public void testNoNodesWhenDecommissionStatus() throws IOException {
+ ScmClient scmClient = mock(ScmClient.class);
+ // No nodes in decommissioning. No error is printed
+ Mockito.when(scmClient.queryNode(any(), any(), any(), any()))
+ .thenReturn(new ArrayList<>());
+ cmd.execute(scmClient);
+
+ Pattern p = Pattern.compile("Decommission\\sStatus:\\s" +
+ "DECOMMISSIONING\\s-\\s0\\snode\\(s\\)\n");
+ Matcher m = p.matcher(outContent.toString(DEFAULT_ENCODING));
+ assertTrue(m.find());
+
+ // no host details are shown
+ p = Pattern.compile("Datanode:\\s.*host0\\)", Pattern.MULTILINE);
+ m = p.matcher(outContent.toString(DEFAULT_ENCODING));
+ assertFalse(m.find());
+ p = Pattern.compile("Datanode:\\s.*host1.\\)", Pattern.MULTILINE);
+ m = p.matcher(outContent.toString(DEFAULT_ENCODING));
+ assertFalse(m.find());
+ }
+
+ @Test
+ public void testIdOptionDecommissionStatusSuccess() throws IOException {
+ ScmClient scmClient = mock(ScmClient.class);
+ Mockito.when(scmClient.queryNode(any(), any(), any(), any()))
+ .thenAnswer(invocation -> nodes); // 2 nodes decommissioning
+
+ CommandLine c = new CommandLine(cmd);
+ c.parseArgs("--id", nodes.get(0).getNodeID().getUuid());
+ cmd.execute(scmClient); // check status of host0
+
+ Pattern p = Pattern.compile("Datanode:\\s.*host0\\)", Pattern.MULTILINE);
+ Matcher m = p.matcher(outContent.toString(DEFAULT_ENCODING));
+ assertTrue(m.find());
+
+ // as uuid of only host0 is passed, host1 should NOT be displayed
+ p = Pattern.compile("Datanode:\\s.*host1.\\)", Pattern.MULTILINE);
+ m = p.matcher(outContent.toString(DEFAULT_ENCODING));
+ assertFalse(m.find());
+ }
+
+ @Test
+ public void testIdOptionDecommissionStatusFail() throws IOException {
+ ScmClient scmClient = mock(ScmClient.class);
+ Mockito.when(scmClient.queryNode(any(), any(), any(), any()))
+ .thenAnswer(invocation -> nodes.subList(0, 1)); // host0
decommissioning
+
+ CommandLine c = new CommandLine(cmd);
+ c.parseArgs("--id", nodes.get(1).getNodeID().getUuid());
+ cmd.execute(scmClient); // check status of host1
+
+ Pattern p = Pattern.compile("Datanode:\\s(.*)\\sis\\snot\\sin" +
+ "\\sDECOMMISSIONING", Pattern.MULTILINE);
+ Matcher m = p.matcher(errContent.toString(DEFAULT_ENCODING));
+ assertTrue(m.find());
+
+ // no host details are shown
+ p = Pattern.compile("Datanode:\\s.*host0\\)", Pattern.MULTILINE);
+ m = p.matcher(outContent.toString(DEFAULT_ENCODING));
+ assertFalse(m.find());
+ p = Pattern.compile("Datanode:\\s.*host1\\)", Pattern.MULTILINE);
+ m = p.matcher(outContent.toString(DEFAULT_ENCODING));
+ assertFalse(m.find());
+ }
+
+ @Test
+ public void testIpOptionDecommissionStatusSuccess() throws IOException {
+ ScmClient scmClient = mock(ScmClient.class);
+ Mockito.when(scmClient.queryNode(any(), any(), any(), any()))
+ .thenAnswer(invocation -> nodes); // 2 nodes decommissioning
+
+ CommandLine c = new CommandLine(cmd);
+ c.parseArgs("--ip", nodes.get(1).getNodeID().getIpAddress());
+ cmd.execute(scmClient); // check status of host1
+
+ Pattern p = Pattern.compile("Datanode:\\s.*host1\\)", Pattern.MULTILINE);
+ Matcher m = p.matcher(outContent.toString(DEFAULT_ENCODING));
+ assertTrue(m.find());
+
+ // as IpAddress of only host1 is passed, host0 should NOT be displayed
+ p = Pattern.compile("Datanode:\\s.*host0.\\)", Pattern.MULTILINE);
+ m = p.matcher(outContent.toString(DEFAULT_ENCODING));
+ assertFalse(m.find());
+ }
+
+ @Test
+ public void testIpOptionDecommissionStatusFail() throws IOException {
+ ScmClient scmClient = mock(ScmClient.class);
+ Mockito.when(scmClient.queryNode(any(), any(), any(), any()))
+ .thenAnswer(invocation -> nodes.subList(0, 1)); // host0
decommissioning
+
+ CommandLine c = new CommandLine(cmd);
+ c.parseArgs("--ip", nodes.get(1).getNodeID().getIpAddress());
+ cmd.execute(scmClient); // check status of host1
+
+ Pattern p = Pattern.compile("Datanode:\\s(.*)\\sis\\snot\\sin" +
+ "\\sDECOMMISSIONING", Pattern.MULTILINE);
+ Matcher m = p.matcher(errContent.toString(DEFAULT_ENCODING));
+ assertTrue(m.find());
+
+ p = Pattern.compile("Datanode:\\s.*host0\\)", Pattern.MULTILINE);
+ m = p.matcher(outContent.toString(DEFAULT_ENCODING));
+ assertFalse(m.find());
+
+ p = Pattern.compile("Datanode:\\s.*host1\\)", Pattern.MULTILINE);
+ m = p.matcher(outContent.toString(DEFAULT_ENCODING));
+ assertFalse(m.find());
+ }
+
+
+ private List<HddsProtos.Node> getNodeDetails(int n) {
+ List<HddsProtos.Node> nodesList = new ArrayList<>();
+
+ for (int i = 0; i < n; i++) {
+ HddsProtos.DatanodeDetailsProto.Builder dnd =
+ HddsProtos.DatanodeDetailsProto.newBuilder();
+ dnd.setHostName("host" + i);
+ dnd.setIpAddress("1.2.3." + i + 1);
+ dnd.setNetworkLocation("/default");
+ dnd.setNetworkName("host" + i);
+ dnd.addPorts(HddsProtos.Port.newBuilder()
+ .setName("ratis").setValue(5678).build());
+ dnd.setUuid(UUID.randomUUID().toString());
+
+ HddsProtos.Node.Builder builder = HddsProtos.Node.newBuilder();
+ builder.addNodeOperationalStates(
+ HddsProtos.NodeOperationalState.DECOMMISSIONING);
+ builder.addNodeStates(HddsProtos.NodeState.HEALTHY);
+ builder.setNodeID(dnd.build());
+ nodesList.add(builder.build());
+ }
+ return nodesList;
+ }
+
+}
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
