Skip to content

Commit 2be939c

Browse files
zabetakzabetak
authored
HIVE-29182: Upgrade maven-checkstyle-plugin from 2.17 to 3.5.0 (#6066)
1. Upgrade to a recent version to address build failures due to bugs in Checkstyle implementation and benefit from recent improvements. 2. Update config files (checkstyle.xml) to address breaking changes in recent versions. 3. Set standalone.metastore.path.to.root property hive-standalone-metastore-client module to be able to find checkstyle config. 4. Replace iceberg.checkstyle.plugin.version with maven.checkstyle.plugin.version aligning plugin version in all modules.
1 parent 751fd73 commit 2be939c

File tree

8 files changed

+96
-112
lines changed

8 files changed

+96
-112
lines changed

‎checkstyle/checkstyle.xml‎

Lines changed: 36 additions & 43 deletions
Original file line numberDiff line numberDiff line change
@@ -70,6 +70,11 @@
7070
<property name="max" value="2000"/>
7171
</module>
7272

73+
<module name="LineLength">
74+
<property name="max" value="120"/>
75+
<property name="ignorePattern" value="^ *\* *[^ ]+$"/>
76+
</module>
77+
7378
<!-- No TAB characters -->
7479
<module name="FileTabCharacter"/>
7580

@@ -81,51 +86,43 @@
8186
<property name="file" value="${config_loc}/suppressions.xml"/>
8287
</module>
8388

84-
<!-- Ignore JavaCC/JJTree files -->
85-
<module name="SuppressWithNearbyCommentFilter">
86-
<property name="commentFormat"
87-
value=".*Generated By:(JJTree|JavaCC).*"/>
88-
<property name="checkFormat" value=".*"/>
89-
<property name="influenceFormat" value="100000"/>
90-
</module>
91-
92-
<!-- Ignore generated vectorized files -->
93-
<module name="SuppressWithNearbyCommentFilter">
94-
<property name="commentFormat"
95-
value=".*Generated from template.*"/>
96-
<property name="checkFormat" value=".*"/>
97-
<property name="influenceFormat" value="100000"/>
98-
</module>
99-
100-
<!-- Ignore Thrift files -->
101-
<module name="SuppressWithNearbyCommentFilter">
102-
<property name="commentFormat"
103-
value=".*Autogenerated by Thrift.*"/>
104-
<property name="checkFormat" value=".*"/>
105-
<property name="influenceFormat" value="100000"/>
106-
</module>
107-
108-
<!-- Ignore Hadoop record compiler files -->
109-
<module name="SuppressWithNearbyCommentFilter">
110-
<property name="commentFormat"
111-
value="File generated by hadoop record compiler. Do not edit."/>
112-
<property name="checkFormat" value=".*"/>
113-
<property name="influenceFormat" value="100000"/>
114-
</module>
115-
11689
<!-- honor on/off tags -->
117-
<module name="SuppressionCommentFilter">
90+
<module name="SuppressWithPlainTextCommentFilter">
11891
<property name="offCommentFormat" value="@formatter:off"/>
11992
<property name="onCommentFormat" value="@formatter:on"/>
12093
</module>
121-
122-
<module name="TreeWalker">
12394

95+
<module name="TreeWalker">
96+
<!-- Ignore JavaCC/JJTree files -->
97+
<module name="SuppressWithNearbyCommentFilter">
98+
<property name="commentFormat"
99+
value=".*Generated By:(JJTree|JavaCC).*"/>
100+
<property name="checkFormat" value=".*"/>
101+
<property name="influenceFormat" value="100000"/>
102+
</module>
103+
<!-- Ignore generated vectorized files -->
104+
<module name="SuppressWithNearbyCommentFilter">
105+
<property name="commentFormat"
106+
value=".*Generated from template.*"/>
107+
<property name="checkFormat" value=".*"/>
108+
<property name="influenceFormat" value="100000"/>
109+
</module>
110+
<!-- Ignore Thrift files -->
111+
<module name="SuppressWithNearbyCommentFilter">
112+
<property name="commentFormat"
113+
value=".*Autogenerated by Thrift.*"/>
114+
<property name="checkFormat" value=".*"/>
115+
<property name="influenceFormat" value="100000"/>
116+
</module>
117+
<!-- Ignore Hadoop record compiler files -->
118+
<module name="SuppressWithNearbyCommentFilter">
119+
<property name="commentFormat"
120+
value="File generated by hadoop record compiler. Do not edit."/>
121+
<property name="checkFormat" value=".*"/>
122+
<property name="influenceFormat" value="100000"/>
123+
</module>
124124
<!-- required for @SuppressWarnings -->
125125
<module name="SuppressWarningsHolder" />
126-
127-
<!-- Required for SuppressWithNearbyCommentFilter -->
128-
<module name="FileContentsHolder"/>
129126

130127
<!-- Checks for Javadoc comments. -->
131128
<!-- See http://checkstyle.sf.net/config_javadoc.html -->
@@ -156,10 +153,7 @@
156153

157154
<!-- Checks for Size Violations. -->
158155
<!-- See http://checkstyle.sf.net/config_sizes.html -->
159-
<module name="LineLength">
160-
<property name="max" value="120"/>
161-
<property name="ignorePattern" value="^ *\* *[^ ]+$"/>
162-
</module>
156+
163157
<module name="ParameterNumber">
164158
<property name="id" value="maxParameterNumber"/>
165159
<property name="max" value="20"/>
@@ -238,7 +232,6 @@
238232
</module>
239233
<module name="TodoComment"/>
240234
<module name="UpperEll"/>
241-
242235
</module>
243236

244237
</module>

‎iceberg/pom.xml‎

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,6 @@
3030
<kryo-shaded.version>4.0.3</kryo-shaded.version>
3131
<iceberg.mockito-core.version>5.2.0</iceberg.mockito-core.version>
3232
<iceberg.avro.version>1.12.0</iceberg.avro.version>
33-
<iceberg.checkstyle.plugin.version>3.5.0</iceberg.checkstyle.plugin.version>
3433
<spotless.maven.plugin.version>2.44.4</spotless.maven.plugin.version>
3534
<google.errorprone.version>2.29.2</google.errorprone.version>
3635
<assertj.version>3.27.3</assertj.version>
@@ -270,7 +269,7 @@
270269
<plugin>
271270
<groupId>org.apache.maven.plugins</groupId>
272271
<artifactId>maven-checkstyle-plugin</artifactId>
273-
<version>${iceberg.checkstyle.plugin.version}</version>
272+
<version>${maven.checkstyle.plugin.version}</version>
274273
<configuration>
275274
<skip>${validate.skip}</skip>
276275
<propertyExpansion>config_loc=${basedir}/${path.to.iceberg.root}/checkstyle/</propertyExpansion>

‎pom.xml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -93,7 +93,7 @@
9393
<!-- Plugin and Plugin Dependency Versions -->
9494
<ant.contrib.version>1.0b3</ant.contrib.version>
9595
<maven.test.jvm.args>-Xmx2048m -DJETTY_AVAILABLE_PROCESSORS=4 -Duser.country=US -Dio.netty.tryReflectionSetAccessible=true -Djava.locale.providers=COMPAT,CLDR --add-opens java.base/java.net=ALL-UNNAMED --add-opens java.base/java.util=ALL-UNNAMED --add-opens java.base/java.lang=ALL-UNNAMED --add-opens java.base/java.nio=ALL-UNNAMED --add-opens java.base/java.util.concurrent=ALL-UNNAMED --add-opens java.base/java.util.concurrent.atomic=ALL-UNNAMED --add-opens java.base/java.util.regex=ALL-UNNAMED --add-opens java.base/java.lang.reflect=ALL-UNNAMED --add-opens java.sql/java.sql=ALL-UNNAMED --add-opens java.base/java.io=ALL-UNNAMED --add-opens java.base/java.text=ALL-UNNAMED</maven.test.jvm.args>
96-
<maven.checkstyle.plugin.version>2.17</maven.checkstyle.plugin.version>
96+
<maven.checkstyle.plugin.version>3.5.0</maven.checkstyle.plugin.version>
9797
<maven.build-helper.plugin.version>3.4.0</maven.build-helper.plugin.version>
9898
<maven.eclipse.plugin.version>2.10</maven.eclipse.plugin.version>
9999
<maven.exec.plugin.version>3.1.0</maven.exec.plugin.version>

‎standalone-metastore/checkstyle/checkstyle.xml‎

Lines changed: 27 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -70,43 +70,41 @@
7070
<property name="max" value="2000"/>
7171
</module>
7272

73+
<module name="LineLength">
74+
<property name="max" value="120"/>
75+
<property name="ignorePattern" value="^ *\* *[^ ]+$"/>
76+
</module>
77+
7378
<!-- No TAB characters -->
7479
<module name="FileTabCharacter"/>
7580

7681
<!-- List of files to ignore -->
7782
<module name="SuppressionFilter">
7883
<property name="file" value="${config_loc}/suppressions.xml"/>
7984
</module>
80-
81-
<!-- Ignore JavaCC/JJTree files -->
82-
<module name="SuppressWithNearbyCommentFilter">
83-
<property name="commentFormat"
84-
value=".*Generated By:(JJTree|JavaCC).*"/>
85-
<property name="checkFormat" value=".*"/>
86-
<property name="influenceFormat" value="100000"/>
87-
</module>
88-
89-
<!-- Ignore Thrift files -->
90-
<module name="SuppressWithNearbyCommentFilter">
91-
<property name="commentFormat"
92-
value=".*Autogenerated by Thrift.*"/>
93-
<property name="checkFormat" value=".*"/>
94-
<property name="influenceFormat" value="100000"/>
95-
</module>
96-
97-
<!-- Ignore Hadoop record compiler files -->
98-
<module name="SuppressWithNearbyCommentFilter">
99-
<property name="commentFormat"
100-
value="File generated by hadoop record compiler. Do not edit."/>
101-
<property name="checkFormat" value=".*"/>
102-
<property name="influenceFormat" value="100000"/>
103-
</module>
10485

10586
<module name="TreeWalker">
106-
107-
<!-- Required for SuppressWithNearbyCommentFilter -->
108-
<module name="FileContentsHolder"/>
109-
87+
<!-- Ignore JavaCC/JJTree files -->
88+
<module name="SuppressWithNearbyCommentFilter">
89+
<property name="commentFormat"
90+
value=".*Generated By:(JJTree|JavaCC).*"/>
91+
<property name="checkFormat" value=".*"/>
92+
<property name="influenceFormat" value="100000"/>
93+
</module>
94+
<!-- Ignore Thrift files -->
95+
<module name="SuppressWithNearbyCommentFilter">
96+
<property name="commentFormat"
97+
value=".*Autogenerated by Thrift.*"/>
98+
<property name="checkFormat" value=".*"/>
99+
<property name="influenceFormat" value="100000"/>
100+
</module>
101+
<!-- Ignore Hadoop record compiler files -->
102+
<module name="SuppressWithNearbyCommentFilter">
103+
<property name="commentFormat"
104+
value="File generated by hadoop record compiler. Do not edit."/>
105+
<property name="checkFormat" value=".*"/>
106+
<property name="influenceFormat" value="100000"/>
107+
</module>
110108
<!-- Checks for Javadoc comments. -->
111109
<!-- See http://checkstyle.sf.net/config_javadoc.html -->
112110
<module name="JavadocType">
@@ -136,10 +134,7 @@
136134

137135
<!-- Checks for Size Violations. -->
138136
<!-- See http://checkstyle.sf.net/config_sizes.html -->
139-
<module name="LineLength">
140-
<property name="max" value="120"/>
141-
<property name="ignorePattern" value="^ *\* *[^ ]+$"/>
142-
</module>
137+
143138
<module name="MethodLength"/>
144139
<module name="ParameterNumber"/>
145140

@@ -211,7 +206,6 @@
211206
</module>
212207
<module name="TodoComment"/>
213208
<module name="UpperEll"/>
214-
215209
</module>
216210

217211
</module>

‎standalone-metastore/metastore-client/pom.xml‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,9 @@
1919
<modelVersion>4.0.0</modelVersion>
2020
<artifactId>hive-standalone-metastore-client</artifactId>
2121
<name>Hive Metastore Client</name>
22+
<properties>
23+
<standalone.metastore.path.to.root>..</standalone.metastore.path.to.root>
24+
</properties>
2225
<dependencies>
2326
<dependency>
2427
<groupId>org.apache.hive</groupId>

‎standalone-metastore/pom.xml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@
5959
<test.groups>org.apache.hadoop.hive.metastore.annotation.MetastoreUnitTest</test.groups>
6060
<!-- Plugin versions -->
6161
<ant.contrib.version>1.0b3</ant.contrib.version>
62-
<maven.checkstyle.plugin.version>2.17</maven.checkstyle.plugin.version>
62+
<maven.checkstyle.plugin.version>3.5.0</maven.checkstyle.plugin.version>
6363
<maven.versions.plugin.version>2.16.0</maven.versions.plugin.version>
6464
<maven.surefire.plugin.version>3.5.3</maven.surefire.plugin.version>
6565
<!-- Dependency versions -->

‎storage-api/checkstyle/checkstyle.xml‎

Lines changed: 26 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -69,43 +69,42 @@
6969
<module name="FileLength">
7070
<property name="max" value="2000"/>
7171
</module>
72-
72+
<module name="LineLength">
73+
<property name="max" value="120"/>
74+
<property name="ignorePattern" value="^ *\* *[^ ]+$"/>
75+
</module>
7376
<!-- No TAB characters -->
7477
<module name="FileTabCharacter"/>
7578

7679
<!-- List of files to ignore -->
7780
<module name="SuppressionFilter">
7881
<property name="file" value="${config_loc}/suppressions.xml"/>
7982
</module>
80-
81-
<!-- Ignore JavaCC/JJTree files -->
82-
<module name="SuppressWithNearbyCommentFilter">
83-
<property name="commentFormat"
84-
value=".*Generated By:(JJTree|JavaCC).*"/>
85-
<property name="checkFormat" value=".*"/>
86-
<property name="influenceFormat" value="100000"/>
87-
</module>
88-
89-
<!-- Ignore Thrift files -->
90-
<module name="SuppressWithNearbyCommentFilter">
91-
<property name="commentFormat"
92-
value=".*Autogenerated by Thrift.*"/>
93-
<property name="checkFormat" value=".*"/>
94-
<property name="influenceFormat" value="100000"/>
95-
</module>
96-
97-
<!-- Ignore Hadoop record compiler files -->
98-
<module name="SuppressWithNearbyCommentFilter">
99-
<property name="commentFormat"
100-
value="File generated by hadoop record compiler. Do not edit."/>
101-
<property name="checkFormat" value=".*"/>
102-
<property name="influenceFormat" value="100000"/>
103-
</module>
10483

10584
<module name="TreeWalker">
85+
<!-- Ignore JavaCC/JJTree files -->
86+
<module name="SuppressWithNearbyCommentFilter">
87+
<property name="commentFormat"
88+
value=".*Generated By:(JJTree|JavaCC).*"/>
89+
<property name="checkFormat" value=".*"/>
90+
<property name="influenceFormat" value="100000"/>
91+
</module>
92+
93+
<!-- Ignore Thrift files -->
94+
<module name="SuppressWithNearbyCommentFilter">
95+
<property name="commentFormat"
96+
value=".*Autogenerated by Thrift.*"/>
97+
<property name="checkFormat" value=".*"/>
98+
<property name="influenceFormat" value="100000"/>
99+
</module>
106100

107-
<!-- Required for SuppressWithNearbyCommentFilter -->
108-
<module name="FileContentsHolder"/>
101+
<!-- Ignore Hadoop record compiler files -->
102+
<module name="SuppressWithNearbyCommentFilter">
103+
<property name="commentFormat"
104+
value="File generated by hadoop record compiler. Do not edit."/>
105+
<property name="checkFormat" value=".*"/>
106+
<property name="influenceFormat" value="100000"/>
107+
</module>
109108

110109
<!-- Checks for Javadoc comments. -->
111110
<!-- See http://checkstyle.sf.net/config_javadoc.html -->
@@ -136,10 +135,6 @@
136135

137136
<!-- Checks for Size Violations. -->
138137
<!-- See http://checkstyle.sf.net/config_sizes.html -->
139-
<module name="LineLength">
140-
<property name="max" value="120"/>
141-
<property name="ignorePattern" value="^ *\* *[^ ]+$"/>
142-
</module>
143138
<module name="MethodLength"/>
144139
<module name="ParameterNumber"/>
145140

‎storage-api/pom.xml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@
3636
<junit.vintage.version>5.13.3</junit.vintage.version>
3737
<slf4j.version>1.7.30</slf4j.version>
3838
<spotbugs.version>4.8.6</spotbugs.version>
39-
<maven.checkstyle.plugin.version>2.17</maven.checkstyle.plugin.version>
39+
<maven.checkstyle.plugin.version>3.5.0</maven.checkstyle.plugin.version>
4040
<maven.cyclonedx.plugin.version>2.7.10</maven.cyclonedx.plugin.version>
4141
<checkstyle.conf.dir>${basedir}/checkstyle/</checkstyle.conf.dir>
4242
<maven.versions.plugin.version>2.16.0</maven.versions.plugin.version>

0 commit comments

Comments
 (0)