HADOOP-18269. Misleading method name in DistCpOptions.(#4216)

Contributed by guophilipse
apache · May 30, 2022 · ba6520f · ba6520f
1 parent 835f39c
commit ba6520f
Show file tree

Hide file tree

Showing 5 changed files with 22 additions and 5 deletions.
diff --git a/hadoop-tools/hadoop-distcp/src/main/java/org/apache/hadoop/tools/DistCpOptions.java b/hadoop-tools/hadoop-distcp/src/main/java/org/apache/hadoop/tools/DistCpOptions.java
@@ -684,11 +684,28 @@ public Builder withAppend(boolean newAppend) {
       return this;
     }
 
+    /**
+     * whether builder with crc.
+     * @param newSkipCRC whether to skip crc check
+     * @return  Builder object whether to skip crc check
+     * @deprecated Use {@link #withSkipCRC(boolean)} instead.
+     */
+    @Deprecated
     public Builder withCRC(boolean newSkipCRC) {
       this.skipCRC = newSkipCRC;
       return this;
     }
 
+    /**
+     * whether builder with crc.
+     * @param newSkipCRC whether to skip crc check
+     * @return  Builder object whether to skip crc check
+     */
+    public Builder withSkipCRC(boolean newSkipCRC) {
+      this.skipCRC = newSkipCRC;
+      return this;
+    }
+
     public Builder withBlocking(boolean newBlocking) {
       this.blocking = newBlocking;
       return this;

diff --git a/hadoop-tools/hadoop-distcp/src/main/java/org/apache/hadoop/tools/OptionsParser.java b/hadoop-tools/hadoop-distcp/src/main/java/org/apache/hadoop/tools/OptionsParser.java
@@ -108,7 +108,7 @@ public static DistCpOptions parse(String[] args)
             command.hasOption(DistCpOptionSwitch.OVERWRITE.getSwitch()))
         .withAppend(
             command.hasOption(DistCpOptionSwitch.APPEND.getSwitch()))
-        .withCRC(
+        .withSkipCRC(
             command.hasOption(DistCpOptionSwitch.SKIP_CRC.getSwitch()))
         .withBlocking(
             !command.hasOption(DistCpOptionSwitch.BLOCKING.getSwitch()))

diff --git a/hadoop-tools/hadoop-distcp/src/test/java/org/apache/hadoop/tools/TestDistCpOptions.java b/hadoop-tools/hadoop-distcp/src/test/java/org/apache/hadoop/tools/TestDistCpOptions.java
@@ -128,7 +128,7 @@ public void testSetSkipCRC() {
         new Path("hdfs://localhost:8020/target/"));
     Assert.assertFalse(builder.build().shouldSkipCRC());
 
-    final DistCpOptions options = builder.withSyncFolder(true).withCRC(true)
+    final DistCpOptions options = builder.withSyncFolder(true).withSkipCRC(true)
         .build();
     Assert.assertTrue(options.shouldSyncFolder());
     Assert.assertTrue(options.shouldSkipCRC());
@@ -391,7 +391,7 @@ public void testAppendOption() {
           new Path("hdfs://localhost:8020/target/"))
           .withSyncFolder(true)
           .withAppend(true)
-          .withCRC(true)
+          .withSkipCRC(true)
           .build();
       fail("Append should fail if skipCrc option is specified");
     } catch (IllegalArgumentException e) {

diff --git a/...oop-distcp/src/test/java/org/apache/hadoop/tools/contract/AbstractContractDistCpTest.java b/...oop-distcp/src/test/java/org/apache/hadoop/tools/contract/AbstractContractDistCpTest.java
@@ -349,7 +349,7 @@ private Job distCpUpdate(final Path srcDir, final Path destDir)
             Collections.singletonList(srcDir), destDir)
             .withDeleteMissing(true)
             .withSyncFolder(true)
-            .withCRC(true)
+            .withSkipCRC(true)
             .withDirectWrite(shouldUseDirectWrite())
             .withOverwrite(false)));
   }

diff --git a/...p-tools/hadoop-distcp/src/test/java/org/apache/hadoop/tools/mapred/TestCopyCommitter.java b/...p-tools/hadoop-distcp/src/test/java/org/apache/hadoop/tools/mapred/TestCopyCommitter.java
@@ -536,7 +536,7 @@ private void testCommitWithChecksumMismatch(boolean skipCrc)
           Collections.singletonList(new Path(sourceBase)),
           new Path("/out"))
           .withBlocksPerChunk(blocksPerChunk)
-          .withCRC(skipCrc)
+          .withSkipCRC(skipCrc)
           .build();
       options.appendToConf(conf);
       conf.setBoolean(