[checkstyle] Improved validation scope of MagicNumber (#2194)

apache · Jul 19, 2022 · 6d08b5f · 6d08b5f
1 parent dda2bb7
commit 6d08b5f
Show file tree

Hide file tree

Showing 18 changed files with 10 additions and 18 deletions.
diff --git a/seatunnel-api/src/main/java/org/apache/seatunnel/api/table/type/SeaTunnelRow.java b/seatunnel-api/src/main/java/org/apache/seatunnel/api/table/type/SeaTunnelRow.java
@@ -87,7 +87,6 @@ public boolean equals(Object o) {
         return tableId == that.tableId && kind == that.kind && Arrays.deepEquals(fields, that.fields);
     }
 
-    @SuppressWarnings("magicnumber")
     @Override
     public int hashCode() {
         int result = Objects.hash(tableId, kind);

diff --git a/seatunnel-api/src/main/java/org/apache/seatunnel/api/table/type/SeaTunnelRowType.java b/seatunnel-api/src/main/java/org/apache/seatunnel/api/table/type/SeaTunnelRowType.java
@@ -98,7 +98,6 @@ public boolean equals(Object obj) {
     }
 
     @Override
-    @SuppressWarnings("MagicNumber")
     public int hashCode() {
         int result = Arrays.hashCode(fieldNames);
         result = 31 * result + Arrays.hashCode(fieldTypes);

diff --git a/...unnel-common/src/test/java/org/apache/seatunnel/common/utils/VariablesSubstituteTest.java b/...unnel-common/src/test/java/org/apache/seatunnel/common/utils/VariablesSubstituteTest.java
@@ -26,7 +26,6 @@
 
 public class VariablesSubstituteTest {
 
-    @SuppressWarnings("checkstyle:MagicNumber")
     @Test
     public void testSubstitute() {
         String timeFormat = "yyyyMMddHHmmss";

diff --git a/...nnector-assert/src/test/java/org/apache/seatunnel/flink/assertion/AssertExecutorTest.java b/...nnector-assert/src/test/java/org/apache/seatunnel/flink/assertion/AssertExecutorTest.java
@@ -29,7 +29,6 @@
 
 import java.util.List;
 
-@SuppressWarnings("magicnumber")
 public class AssertExecutorTest extends TestCase {
     SeaTunnelRow row = new SeaTunnelRow(new Object[]{"jared", 17});
     SeaTunnelRowType rowType = new SeaTunnelRowType(new String[]{"name", "age"}, new SeaTunnelDataType[]{BasicType.STRING_TYPE, BasicType.INT_TYPE});

diff --git a/...-assert/src/test/java/org/apache/seatunnel/flink/assertion/rule/AssertRuleParserTest.java b/...-assert/src/test/java/org/apache/seatunnel/flink/assertion/rule/AssertRuleParserTest.java
@@ -28,7 +28,6 @@
 
 import java.util.List;
 
-@SuppressWarnings("magicnumber")
 public class AssertRuleParserTest extends TestCase {
     AssertRuleParser parser = new AssertRuleParser();
 

diff --git a/...apache/seatunnel/connectors/seatunnel/file/sink/hdfs/FileSinkAggregatedCommitterTest.java b/...apache/seatunnel/connectors/seatunnel/file/sink/hdfs/FileSinkAggregatedCommitterTest.java
@@ -64,7 +64,7 @@ public void testCommit() throws Exception {
         Assert.assertTrue(!HdfsUtils.fileExist(transactionDir));
     }
 
-    @SuppressWarnings({"checkstyle:MagicNumber", "checkstyle:UnnecessaryParentheses"})
+    @SuppressWarnings("checkstyle:UnnecessaryParentheses")
     @Test
     public void testCombine() throws Exception {
         FileSinkAggregatedCommitter fileSinkAggregatedCommitter = new FileSinkAggregatedCommitter(new HdfsFileSystemCommitter());

diff --git a/...pache/seatunnel/connectors/seatunnel/file/sink/local/FileSinkAggregatedCommitterTest.java b/...pache/seatunnel/connectors/seatunnel/file/sink/local/FileSinkAggregatedCommitterTest.java
@@ -64,7 +64,7 @@ public void testCommit() throws Exception {
         Assert.assertTrue(!FileUtils.fileExist(transactionDir));
     }
 
-    @SuppressWarnings({"checkstyle:UnnecessaryParentheses", "checkstyle:MagicNumber"})
+    @SuppressWarnings("checkstyle:UnnecessaryParentheses")
     @Test
     public void testCombine() throws Exception {
         FileSinkAggregatedCommitter fileSinkAggregatedCommitter = new FileSinkAggregatedCommitter(new LocalFileSystemCommitter());

diff --git a/...r-flink-assert/src/test/java/org/apache/seatunnel/flink/assertion/AssertExecutorTest.java b/...r-flink-assert/src/test/java/org/apache/seatunnel/flink/assertion/AssertExecutorTest.java
@@ -26,7 +26,6 @@
 
 import java.util.List;
 
-@SuppressWarnings("magicnumber")
 public class AssertExecutorTest extends TestCase {
     Row row = Row.withNames();
     AssertExecutor assertExecutor = new AssertExecutor();

diff --git a/...-assert/src/test/java/org/apache/seatunnel/flink/assertion/rule/AssertRuleParserTest.java b/...-assert/src/test/java/org/apache/seatunnel/flink/assertion/rule/AssertRuleParserTest.java
@@ -25,7 +25,6 @@
 
 import java.util.List;
 
-@SuppressWarnings("magicnumber")
 public class AssertRuleParserTest extends TestCase {
     AssertRuleParser parser = new AssertRuleParser();
 

diff --git a/...ctor-flink-clickhouse/src/main/java/org/apache/seatunnel/flink/clickhouse/pojo/Shard.java b/...ctor-flink-clickhouse/src/main/java/org/apache/seatunnel/flink/clickhouse/pojo/Shard.java
@@ -114,7 +114,6 @@ public boolean equals(Object o) {
     }
 
     @Override
-    @SuppressWarnings("magicnumber")
     public int hashCode() {
         if (hashCode != -1) {
             return hashCode;

diff --git a/...nk-clickhouse/src/main/java/org/apache/seatunnel/flink/clickhouse/pojo/ShardMetadata.java b/...nk-clickhouse/src/main/java/org/apache/seatunnel/flink/clickhouse/pojo/ShardMetadata.java
@@ -122,7 +122,6 @@ public boolean equals(Object o) {
     }
 
     @Override
-    @SuppressWarnings("magicnumber")
     public int hashCode() {
         int result = shardKey.hashCode();
         result = 31 * result + shardKeyType.hashCode();

diff --git a/...or-v2-e2e/src/test/java/org/apache/seatunnel/e2e/flink/v2/fake/FakeSourceToConsoleIT.java b/...or-v2-e2e/src/test/java/org/apache/seatunnel/e2e/flink/v2/fake/FakeSourceToConsoleIT.java
@@ -28,7 +28,6 @@
 public class FakeSourceToConsoleIT extends FlinkContainer {
 
     @Test
-    @SuppressWarnings("magicnumber")
     public void testFakeSourceToConsoleSink() throws IOException, InterruptedException {
         Container.ExecResult execResult = executeSeaTunnelFlinkJob("/fake/fakesource_to_console.conf");
         Assert.assertEquals(0, execResult.getExitCode());

diff --git a/...e2e/src/test/java/org/apache/seatunnel/e2e/flink/clickhouse/FakeSourceToClickhouseIT.java b/...e2e/src/test/java/org/apache/seatunnel/e2e/flink/clickhouse/FakeSourceToClickhouseIT.java
@@ -50,7 +50,6 @@ public class FakeSourceToClickhouseIT extends FlinkContainer {
     private static final Logger LOGGER = LoggerFactory.getLogger(FakeSourceToClickhouseIT.class);
 
     @Before
-    @SuppressWarnings("magicnumber")
     public void startClickhouseContainer() throws InterruptedException {
         clickhouseServer = new GenericContainer<>(CLICKHOUSE_DOCKER_IMAGE)
             .withNetwork(NETWORK)

diff --git a/...or-v2-e2e/src/test/java/org/apache/seatunnel/e2e/spark/v2/fake/FakeSourceToConsoleIT.java b/...or-v2-e2e/src/test/java/org/apache/seatunnel/e2e/spark/v2/fake/FakeSourceToConsoleIT.java
@@ -32,7 +32,6 @@
 public class FakeSourceToConsoleIT extends SparkContainer {
 
     @Test
-    @SuppressWarnings("magicnumber")
     public void testFakeSourceToConsoleSine() throws IOException, InterruptedException {
         Container.ExecResult execResult = executeSeaTunnelSparkJob("/fake/fakesource_to_console.conf");
         Assert.assertEquals(0, execResult.getExitCode());

diff --git a/...ector-v2-e2e/src/test/java/org/apache/seatunnel/e2e/spark/v2/file/FakeSourceToFileIT.java b/...ector-v2-e2e/src/test/java/org/apache/seatunnel/e2e/spark/v2/file/FakeSourceToFileIT.java
@@ -32,7 +32,6 @@
 public class FakeSourceToFileIT extends SparkContainer {
 
     @Test
-    @SuppressWarnings("magicnumber")
     public void testFakeSourceToFile() throws IOException, InterruptedException {
         Container.ExecResult execResult = executeSeaTunnelSparkJob("/file/fakesource_to_file.conf");
         Assert.assertEquals(0, execResult.getExitCode());

diff --git a/...lugin-discovery/src/main/java/org/apache/seatunnel/plugin/discovery/PluginIdentifier.java b/...lugin-discovery/src/main/java/org/apache/seatunnel/plugin/discovery/PluginIdentifier.java
@@ -70,7 +70,6 @@ public boolean equals(Object o) {
     }
 
     @Override
-    @SuppressWarnings("checkstyle:magicnumber")
     public int hashCode() {
         int result = engineType != null ? engineType.hashCode() : 0;
         result = 31 * result + (pluginType != null ? pluginType.hashCode() : 0);

diff --git a/...nk/src/test/java/org/apache/seatunnel/translation/flink/utils/TypeConverterUtilsTest.java b/...nk/src/test/java/org/apache/seatunnel/translation/flink/utils/TypeConverterUtilsTest.java
@@ -73,7 +73,6 @@ public void convertShortType() {
     }
 
     @Test
-    @SuppressWarnings("MagicNumber")
     public void convertBigDecimalType() {
         Assert.assertEquals(new BigDecimalTypeInfo(30, 2), TypeConverterUtils.convert(new DecimalType(30, 2)));
     }

diff --git a/tools/checkstyle/checkStyle.xml b/tools/checkstyle/checkStyle.xml
@@ -85,6 +85,11 @@
         <property name="ignorePattern" value="^package.*|^import.*|a href|href|http://|https://|ftp://"/>
     </module>
 
+    <module name="SuppressionSingleFilter">
+        <property name="files" value=".*(IT|Test).java"/>
+        <property name="checks" value="MagicNumber"/>
+    </module>
+
     <module name="SuppressWarningsFilter"/>
     <module name="TreeWalker">
         <module name="SuppressWarningsHolder"/>
@@ -207,7 +212,9 @@
 
         <module name="OneStatementPerLine"/>
 
-        <module name="MagicNumber"/>
+        <module name="MagicNumber">
+            <property name="ignoreHashCodeMethod" value="true"/>
+        </module>
 
         <module name="MultipleVariableDeclarations"/>