HDDS-11728. Refactor subcommand layouts of ozone debug and repair (#7489

)
apache · Dec 3, 2024 · 98e070e · 98e070e
1 parent 1c5676b
commit 98e070e
Show file tree

Hide file tree

Showing 30 changed files with 107 additions and 32 deletions.
diff --git a/hadoop-ozone/integration-test/src/test/java/org/apache/hadoop/ozone/debug/TestLDBCli.java b/hadoop-ozone/integration-test/src/test/java/org/apache/hadoop/ozone/debug/TestLDBCli.java
@@ -36,6 +36,9 @@
 import org.apache.hadoop.ozone.container.common.statemachine.DatanodeConfiguration;
 import org.apache.hadoop.ozone.container.keyvalue.helpers.BlockUtils;
 import org.apache.hadoop.ozone.container.metadata.DatanodeSchemaThreeDBDefinition;
+import org.apache.hadoop.ozone.debug.ldb.DBScanner;
+import org.apache.hadoop.ozone.debug.ldb.RDBParser;
+import org.apache.hadoop.ozone.debug.ldb.ValueSchema;
 import org.apache.hadoop.ozone.om.helpers.OmKeyInfo;
 import org.apache.hadoop.ozone.om.request.OMRequestTestUtils;
 import jakarta.annotation.Nonnull;

diff --git a/...integration-test/src/test/java/org/apache/hadoop/ozone/dn/ratis/TestDnRatisLogParser.java b/...integration-test/src/test/java/org/apache/hadoop/ozone/dn/ratis/TestDnRatisLogParser.java
@@ -26,7 +26,7 @@
 import org.apache.hadoop.hdds.conf.OzoneConfiguration;
 import org.apache.hadoop.ozone.MiniOzoneCluster;
 import org.apache.hadoop.ozone.OzoneConfigKeys;
-import org.apache.hadoop.ozone.segmentparser.DatanodeRatisLogParser;
+import org.apache.hadoop.ozone.debug.segmentparser.DatanodeRatisLogParser;
 
 import org.apache.ozone.test.GenericTestUtils;
 import org.junit.jupiter.api.AfterEach;

diff --git a/...egration-test/src/test/java/org/apache/hadoop/ozone/parser/TestOzoneHARatisLogParser.java b/...egration-test/src/test/java/org/apache/hadoop/ozone/parser/TestOzoneHARatisLogParser.java
@@ -29,8 +29,8 @@
 import org.apache.hadoop.ozone.client.OzoneClientFactory;
 import org.apache.hadoop.ozone.om.helpers.OMRatisHelper;
 import org.apache.hadoop.ozone.MiniOzoneCluster;
-import org.apache.hadoop.ozone.segmentparser.OMRatisLogParser;
-import org.apache.hadoop.ozone.segmentparser.SCMRatisLogParser;
+import org.apache.hadoop.ozone.debug.segmentparser.OMRatisLogParser;
+import org.apache.hadoop.ozone.debug.segmentparser.SCMRatisLogParser;
 import org.apache.ozone.test.GenericTestUtils;
 import org.apache.ozone.test.tag.Flaky;
 import org.junit.jupiter.api.AfterEach;

diff --git a/...one/integration-test/src/test/java/org/apache/hadoop/ozone/shell/TestOzoneDebugShell.java b/...one/integration-test/src/test/java/org/apache/hadoop/ozone/shell/TestOzoneDebugShell.java
@@ -36,9 +36,9 @@
 import org.apache.hadoop.ozone.client.OzoneClient;
 import org.apache.hadoop.ozone.client.OzoneClientFactory;
 import org.apache.hadoop.ozone.client.OzoneSnapshot;
-import org.apache.hadoop.ozone.debug.DBScanner;
+import org.apache.hadoop.ozone.debug.ldb.DBScanner;
 import org.apache.hadoop.ozone.debug.OzoneDebug;
-import org.apache.hadoop.ozone.debug.RDBParser;
+import org.apache.hadoop.ozone.debug.ldb.RDBParser;
 import org.apache.hadoop.ozone.om.OMConfigKeys;
 import org.apache.hadoop.ozone.om.OMStorage;
 import org.apache.hadoop.ozone.om.helpers.BucketLayout;

diff --git a/...ne/integration-test/src/test/java/org/apache/hadoop/ozone/shell/TestOzoneRepairShell.java b/...ne/integration-test/src/test/java/org/apache/hadoop/ozone/shell/TestOzoneRepairShell.java
@@ -19,12 +19,12 @@
 
 import org.apache.hadoop.hdds.conf.OzoneConfiguration;
 import org.apache.hadoop.ozone.MiniOzoneCluster;
-import org.apache.hadoop.ozone.debug.DBScanner;
-import org.apache.hadoop.ozone.debug.RDBParser;
+import org.apache.hadoop.ozone.debug.ldb.DBScanner;
+import org.apache.hadoop.ozone.debug.ldb.RDBParser;
 import org.apache.hadoop.ozone.om.OMStorage;
 import org.apache.hadoop.ozone.repair.OzoneRepair;
-import org.apache.hadoop.ozone.repair.RDBRepair;
-import org.apache.hadoop.ozone.repair.TransactionInfoRepair;
+import org.apache.hadoop.ozone.repair.ldb.RDBRepair;
+import org.apache.hadoop.ozone.repair.ldb.TransactionInfoRepair;
 import org.apache.hadoop.ozone.repair.quota.QuotaRepair;
 import org.apache.hadoop.ozone.repair.quota.QuotaStatus;
 import org.apache.hadoop.ozone.repair.quota.QuotaTrigger;

diff --git a/...oop/ozone/debug/ChunkDataNodeDetails.java → ...one/debug/chunk/ChunkDataNodeDetails.java b/...oop/ozone/debug/ChunkDataNodeDetails.java → ...one/debug/chunk/ChunkDataNodeDetails.java
@@ -16,7 +16,7 @@
  * limitations under the License.
  */
 
-package org.apache.hadoop.ozone.debug;
+package org.apache.hadoop.ozone.debug.chunk;
 /**
  * Class that gives datanode details on which the chunk is present.
  */

diff --git a/...ache/hadoop/ozone/debug/ChunkDetails.java → ...adoop/ozone/debug/chunk/ChunkDetails.java b/...ache/hadoop/ozone/debug/ChunkDetails.java → ...adoop/ozone/debug/chunk/ChunkDetails.java
@@ -16,7 +16,7 @@
  * limitations under the License.
  */
 
-package org.apache.hadoop.ozone.debug;
+package org.apache.hadoop.ozone.debug.chunk;
 
 /**
  * Class that gives chunkDetails.

diff --git a/...e/hadoop/ozone/debug/ChunkKeyHandler.java → ...op/ozone/debug/chunk/ChunkKeyHandler.java b/...e/hadoop/ozone/debug/ChunkKeyHandler.java → ...op/ozone/debug/chunk/ChunkKeyHandler.java
@@ -16,7 +16,7 @@
  * limitations under the License.
  */
 
-package org.apache.hadoop.ozone.debug;
+package org.apache.hadoop.ozone.debug.chunk;
 
 import java.io.File;
 import java.io.IOException;
@@ -42,6 +42,7 @@
 import org.apache.hadoop.ozone.OzoneConsts;
 import org.apache.hadoop.ozone.client.OzoneClient;
 import org.apache.hadoop.ozone.container.common.impl.ContainerLayoutVersion;
+import org.apache.hadoop.ozone.debug.OzoneDebug;
 import org.apache.hadoop.ozone.om.helpers.OmKeyArgs;
 import org.apache.hadoop.ozone.om.helpers.OmKeyInfo;
 import org.apache.hadoop.ozone.om.helpers.OmKeyLocationInfo;

diff --git a/.../apache/hadoop/ozone/debug/ChunkType.java → ...e/hadoop/ozone/debug/chunk/ChunkType.java b/.../apache/hadoop/ozone/debug/ChunkType.java → ...e/hadoop/ozone/debug/chunk/ChunkType.java
@@ -14,7 +14,7 @@
  * License for the specific language governing permissions and limitations under
  * the License.
  */
-package org.apache.hadoop.ozone.debug;
+package org.apache.hadoop.ozone.debug.chunk;
 
 /**
  * The type of chunks of an Erasure Coded key.

diff --git a/...adoop/ozone/debug/ContainerChunkInfo.java → ...ozone/debug/chunk/ContainerChunkInfo.java b/...adoop/ozone/debug/ContainerChunkInfo.java → ...ozone/debug/chunk/ContainerChunkInfo.java
@@ -16,7 +16,7 @@
  * limitations under the License.
  */
 
-package org.apache.hadoop.ozone.debug;
+package org.apache.hadoop.ozone.debug.chunk;
 
 import com.fasterxml.jackson.annotation.JsonInclude;
 

diff --git a/hadoop-ozone/tools/src/main/java/org/apache/hadoop/ozone/debug/chunk/package-info.java b/hadoop-ozone/tools/src/main/java/org/apache/hadoop/ozone/debug/chunk/package-info.java
@@ -0,0 +1,22 @@
+/*
+ * 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.
+ */
+
+/**
+ * Command to debug chunk information.
+ */
+package org.apache.hadoop.ozone.debug.chunk;
diff --git a/.../apache/hadoop/ozone/debug/DBScanner.java → ...che/hadoop/ozone/debug/ldb/DBScanner.java b/.../apache/hadoop/ozone/debug/DBScanner.java → ...che/hadoop/ozone/debug/ldb/DBScanner.java
@@ -16,7 +16,7 @@
  *  limitations under the License.
  */
 
-package org.apache.hadoop.ozone.debug;
+package org.apache.hadoop.ozone.debug.ldb;
 
 import com.fasterxml.jackson.annotation.JsonAutoDetect;
 import com.fasterxml.jackson.annotation.JsonInclude;
@@ -44,6 +44,8 @@
 import org.apache.hadoop.ozone.OzoneConsts;
 import org.apache.hadoop.ozone.container.common.statemachine.DatanodeConfiguration;
 import org.apache.hadoop.ozone.container.metadata.DatanodeSchemaThreeDBDefinition;
+import org.apache.hadoop.ozone.debug.DBDefinitionFactory;
+import org.apache.hadoop.ozone.debug.RocksDBUtils;
 import org.apache.hadoop.ozone.utils.Filter;
 import org.kohsuke.MetaInfServices;
 import org.rocksdb.ColumnFamilyDescriptor;

diff --git a/.../apache/hadoop/ozone/debug/DropTable.java → ...che/hadoop/ozone/debug/ldb/DropTable.java b/.../apache/hadoop/ozone/debug/DropTable.java → ...che/hadoop/ozone/debug/ldb/DropTable.java
@@ -16,10 +16,11 @@
  *  limitations under the License.
  */
 
-package org.apache.hadoop.ozone.debug;
+package org.apache.hadoop.ozone.debug.ldb;
 
 import org.apache.hadoop.hdds.cli.SubcommandWithParent;
 import org.apache.hadoop.hdds.utils.db.managed.ManagedRocksDB;
+import org.apache.hadoop.ozone.debug.RocksDBUtils;
 import org.rocksdb.ColumnFamilyDescriptor;
 import org.rocksdb.ColumnFamilyHandle;
 import picocli.CommandLine;

diff --git a/...apache/hadoop/ozone/debug/ListTables.java → ...he/hadoop/ozone/debug/ldb/ListTables.java b/...apache/hadoop/ozone/debug/ListTables.java → ...he/hadoop/ozone/debug/ldb/ListTables.java
@@ -16,7 +16,7 @@
  *  limitations under the License.
  */
 
-package org.apache.hadoop.ozone.debug;
+package org.apache.hadoop.ozone.debug.ldb;
 
 import java.nio.charset.StandardCharsets;
 import java.util.List;

diff --git a/.../apache/hadoop/ozone/debug/RDBParser.java → ...che/hadoop/ozone/debug/ldb/RDBParser.java b/.../apache/hadoop/ozone/debug/RDBParser.java → ...che/hadoop/ozone/debug/ldb/RDBParser.java
@@ -16,13 +16,14 @@
  *  limitations under the License.
  */
 
-package org.apache.hadoop.ozone.debug;
+package org.apache.hadoop.ozone.debug.ldb;
 
 import java.util.concurrent.Callable;
 
 import org.apache.hadoop.hdds.cli.GenericCli;
 import org.apache.hadoop.hdds.cli.SubcommandWithParent;
 
+import org.apache.hadoop.ozone.debug.OzoneDebug;
 import org.kohsuke.MetaInfServices;
 import picocli.CommandLine;
 import picocli.CommandLine.Model.CommandSpec;

diff --git a/...pache/hadoop/ozone/debug/ValueSchema.java → ...e/hadoop/ozone/debug/ldb/ValueSchema.java b/...pache/hadoop/ozone/debug/ValueSchema.java → ...e/hadoop/ozone/debug/ldb/ValueSchema.java
@@ -16,14 +16,15 @@
  *  limitations under the License.
  */
 
-package org.apache.hadoop.ozone.debug;
+package org.apache.hadoop.ozone.debug.ldb;
 
 import org.apache.hadoop.hdds.cli.SubcommandWithParent;
 import org.apache.hadoop.hdds.conf.OzoneConfiguration;
 import org.apache.hadoop.hdds.server.JsonUtils;
 import org.apache.hadoop.hdds.utils.db.DBColumnFamilyDefinition;
 import org.apache.hadoop.hdds.utils.db.DBDefinition;
 import org.apache.hadoop.ozone.OzoneConsts;
+import org.apache.hadoop.ozone.debug.DBDefinitionFactory;
 import org.kohsuke.MetaInfServices;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;

diff --git a/hadoop-ozone/tools/src/main/java/org/apache/hadoop/ozone/debug/ldb/package-info.java b/hadoop-ozone/tools/src/main/java/org/apache/hadoop/ozone/debug/ldb/package-info.java
@@ -0,0 +1,22 @@
+/*
+ * 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.
+ */
+
+/**
+ * RDB debug related commands.
+ */
+package org.apache.hadoop.ozone.debug.ldb;
diff --git a/...op/ozone/segmentparser/BaseLogParser.java → ...ne/debug/segmentparser/BaseLogParser.java b/...op/ozone/segmentparser/BaseLogParser.java → ...ne/debug/segmentparser/BaseLogParser.java
@@ -15,7 +15,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-package org.apache.hadoop.ozone.segmentparser;
+package org.apache.hadoop.ozone.debug.segmentparser;
 
 import com.google.common.annotations.VisibleForTesting;
 import org.apache.ratis.proto.RaftProtos;

diff --git a/...segmentparser/DatanodeRatisLogParser.java → ...segmentparser/DatanodeRatisLogParser.java b/...segmentparser/DatanodeRatisLogParser.java → ...segmentparser/DatanodeRatisLogParser.java
@@ -15,7 +15,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-package org.apache.hadoop.ozone.segmentparser;
+package org.apache.hadoop.ozone.debug.segmentparser;
 
 import org.apache.hadoop.hdds.cli.HddsVersionProvider;
 import org.apache.hadoop.ozone.container.common.transport.server

diff --git a/.../segmentparser/GenericRatisLogParser.java → .../segmentparser/GenericRatisLogParser.java b/.../segmentparser/GenericRatisLogParser.java → .../segmentparser/GenericRatisLogParser.java
@@ -15,7 +15,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-package org.apache.hadoop.ozone.segmentparser;
+package org.apache.hadoop.ozone.debug.segmentparser;
 
 import org.apache.hadoop.hdds.cli.HddsVersionProvider;
 import picocli.CommandLine;

diff --git a/...ozone/segmentparser/OMRatisLogParser.java → ...debug/segmentparser/OMRatisLogParser.java b/...ozone/segmentparser/OMRatisLogParser.java → ...debug/segmentparser/OMRatisLogParser.java
@@ -16,7 +16,7 @@
  * limitations under the License.
  */
 
-package org.apache.hadoop.ozone.segmentparser;
+package org.apache.hadoop.ozone.debug.segmentparser;
 
 import org.apache.hadoop.hdds.cli.HddsVersionProvider;
 import org.apache.hadoop.ozone.om.helpers.OMRatisHelper;

diff --git a/...p/ozone/segmentparser/RatisLogParser.java → ...e/debug/segmentparser/RatisLogParser.java b/...p/ozone/segmentparser/RatisLogParser.java → ...e/debug/segmentparser/RatisLogParser.java
@@ -15,7 +15,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-package org.apache.hadoop.ozone.segmentparser;
+package org.apache.hadoop.ozone.debug.segmentparser;
 
 import org.apache.hadoop.hdds.cli.GenericCli;
 import org.apache.hadoop.hdds.cli.HddsVersionProvider;

diff --git a/...zone/segmentparser/SCMRatisLogParser.java → ...ebug/segmentparser/SCMRatisLogParser.java b/...zone/segmentparser/SCMRatisLogParser.java → ...ebug/segmentparser/SCMRatisLogParser.java
@@ -16,7 +16,7 @@
  * limitations under the License.
  */
 
-package org.apache.hadoop.ozone.segmentparser;
+package org.apache.hadoop.ozone.debug.segmentparser;
 
 import org.apache.hadoop.hdds.cli.HddsVersionProvider;
 import org.apache.hadoop.hdds.scm.ha.SCMRatisRequest;

diff --git a/...oop/ozone/segmentparser/package-info.java → ...one/debug/segmentparser/package-info.java b/...oop/ozone/segmentparser/package-info.java → ...one/debug/segmentparser/package-info.java
@@ -15,8 +15,8 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-package org.apache.hadoop.ozone.segmentparser;
 
 /**
  * Command line utility for dump ratis log files.
  */
+package org.apache.hadoop.ozone.debug.segmentparser;
diff --git a/...apache/hadoop/ozone/repair/RDBRepair.java → ...he/hadoop/ozone/repair/ldb/RDBRepair.java b/...apache/hadoop/ozone/repair/RDBRepair.java → ...he/hadoop/ozone/repair/ldb/RDBRepair.java
@@ -16,10 +16,11 @@
  *  limitations under the License.
  */
 
-package org.apache.hadoop.ozone.repair;
+package org.apache.hadoop.ozone.repair.ldb;
 
 import org.apache.hadoop.hdds.cli.GenericCli;
 import org.apache.hadoop.hdds.cli.SubcommandWithParent;
+import org.apache.hadoop.ozone.repair.OzoneRepair;
 import org.kohsuke.MetaInfServices;
 import picocli.CommandLine;
 

diff --git a/...adoop/ozone/repair/om/SnapshotRepair.java → ...doop/ozone/repair/ldb/SnapshotRepair.java b/...adoop/ozone/repair/om/SnapshotRepair.java → ...doop/ozone/repair/ldb/SnapshotRepair.java
@@ -16,7 +16,7 @@
  *  limitations under the License.
  */
 
-package org.apache.hadoop.ozone.repair.om;
+package org.apache.hadoop.ozone.repair.ldb;
 
 import org.apache.hadoop.hdds.cli.SubcommandWithParent;
 import org.apache.hadoop.hdds.utils.IOUtils;
@@ -25,7 +25,6 @@
 import org.apache.hadoop.hdds.utils.db.managed.ManagedRocksIterator;
 import org.apache.hadoop.ozone.debug.RocksDBUtils;
 import org.apache.hadoop.ozone.om.helpers.SnapshotInfo;
-import org.apache.hadoop.ozone.repair.RDBRepair;
 import org.apache.hadoop.ozone.shell.bucket.BucketUri;
 import org.kohsuke.MetaInfServices;
 import org.rocksdb.ColumnFamilyDescriptor;

diff --git a/...p/ozone/repair/TransactionInfoRepair.java → ...one/repair/ldb/TransactionInfoRepair.java b/...p/ozone/repair/TransactionInfoRepair.java → ...one/repair/ldb/TransactionInfoRepair.java
@@ -19,7 +19,7 @@
  * permissions and
  * limitations under the License.
  */
-package org.apache.hadoop.ozone.repair;
+package org.apache.hadoop.ozone.repair.ldb;
 
 import org.apache.hadoop.hdds.cli.HddsVersionProvider;
 import org.apache.hadoop.hdds.cli.SubcommandWithParent;

diff --git a/hadoop-ozone/tools/src/main/java/org/apache/hadoop/ozone/repair/ldb/package-info.java b/hadoop-ozone/tools/src/main/java/org/apache/hadoop/ozone/repair/ldb/package-info.java
@@ -0,0 +1,22 @@
+/*
+ * 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.
+ */
+
+/**
+ * RDB related repair tools.
+ */
+package org.apache.hadoop.ozone.repair.ldb;
diff --git a/hadoop-ozone/tools/src/main/java/org/apache/hadoop/ozone/repair/quota/package-info.java b/hadoop-ozone/tools/src/main/java/org/apache/hadoop/ozone/repair/quota/package-info.java
@@ -17,6 +17,6 @@
  */
 
 /**
- * Ozone Repair tools.
+ * Ozone Quota Repair tools.
  */
 package org.apache.hadoop.ozone.repair.quota;
diff --git a/...one/repair/TestTransactionInfoRepair.java → ...repair/ldb/TestTransactionInfoRepair.java b/...one/repair/TestTransactionInfoRepair.java → ...repair/ldb/TestTransactionInfoRepair.java
@@ -15,7 +15,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-package org.apache.hadoop.ozone.repair;
+package org.apache.hadoop.ozone.repair.ldb;
 
 import org.apache.hadoop.hdds.utils.TransactionInfo;
 import org.apache.hadoop.hdds.utils.db.Codec;