[hbase] branch master updated: HBASE-20804 Document and add tests for HBaseConfTool (#5190)

[zh...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

zhangduo pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/hbase.git


The following commit(s) were added to refs/heads/master by this push:
     new e86f9308944 HBASE-20804 Document and add tests for HBaseConfTool (#5190)
e86f9308944 is described below

commit e86f9308944bd57f34da64746adfda75f093b825
Author: Nihal Jain <ni...@gmail.com>
AuthorDate: Sun Apr 23 20:50:12 2023 +0530

    HBASE-20804 Document and add tests for HBaseConfTool (#5190)
    
    Signed-off-by: Duo Zhang <zh...@apache.org>
---
 .../hadoop/hbase/util/TestHBaseConfTool.java       | 80 ++++++++++++++++++++++
 src/main/asciidoc/_chapters/ops_mgt.adoc           |  9 +++
 2 files changed, 89 insertions(+)

diff --git a/hbase-server/src/test/java/org/apache/hadoop/hbase/util/TestHBaseConfTool.java b/hbase-server/src/test/java/org/apache/hadoop/hbase/util/TestHBaseConfTool.java
new file mode 100644
index 00000000000..693d8194e98
--- /dev/null
+++ b/hbase-server/src/test/java/org/apache/hadoop/hbase/util/TestHBaseConfTool.java
@@ -0,0 +1,80 @@
+/*
+ * 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.hbase.util;
+
+import static org.junit.Assert.assertEquals;
+import static org.junit.Assert.assertNotNull;
+
+import java.io.PrintStream;
+import java.util.LinkedList;
+import java.util.List;
+import org.apache.hadoop.hbase.HBaseClassTestRule;
+import org.apache.hadoop.hbase.master.cleaner.TimeToLiveLogCleaner;
+import org.apache.hadoop.hbase.testclassification.MiscTests;
+import org.apache.hadoop.hbase.testclassification.SmallTests;
+import org.junit.ClassRule;
+import org.junit.Test;
+import org.junit.experimental.categories.Category;
+
+@Category({ MiscTests.class, SmallTests.class })
+public class TestHBaseConfTool {
+
+  @ClassRule
+  public static final HBaseClassTestRule CLASS_RULE =
+    HBaseClassTestRule.forClass(TestHBaseConfTool.class);
+
+  @Test
+  public void testHBaseConfTool() {
+    String[] args = { TimeToLiveLogCleaner.TTL_CONF_KEY };
+    PrintStream stdout = System.out;
+
+    try {
+      DummyPrintStream printStream = new DummyPrintStream(System.out);
+      System.setOut(printStream);
+
+      HBaseConfTool.main(args);
+
+      List<String> printedLines = printStream.getPrintedLines();
+      assertNotNull(printedLines);
+      assertEquals(1, printedLines.size());
+      assertEquals(String.valueOf(TimeToLiveLogCleaner.DEFAULT_TTL), printedLines.get(0));
+    } finally {
+      // reset to standard output
+      System.setOut(stdout);
+    }
+  }
+
+  static class DummyPrintStream extends PrintStream {
+
+    private List<String> printedLines = new LinkedList<>();
+
+    public DummyPrintStream(PrintStream printStream) {
+      super(printStream);
+    }
+
+    @Override
+    public void println(String line) {
+      printedLines.add(line);
+      super.println(line);
+    }
+
+    public List<String> getPrintedLines() {
+      return printedLines;
+    }
+  }
+}
diff --git a/src/main/asciidoc/_chapters/ops_mgt.adoc b/src/main/asciidoc/_chapters/ops_mgt.adoc
index 34fb028f094..15296d971c4 100644
--- a/src/main/asciidoc/_chapters/ops_mgt.adoc
+++ b/src/main/asciidoc/_chapters/ops_mgt.adoc
@@ -1296,6 +1296,15 @@ Options:
 
 ----
 
+[[ops.conf-tool]]
+=== HBase Conf Tool
+HBase Conf tool can be used to print out the current value of a configuration. It can be used by passing the configuration key on the command-line.
+
+[source, bash]
+----
+$ bin/hbase org.apache.hadoop.hbase.util.HBaseConfTool <configuration_key>
+----
+
 [[ops.regionmgt]]
 == Region Management