Checkstyle; Include test files for checkstyle, removed AvoidWildcard, StaticVariableName, MemberVariableNameCheck

2026-01-07 21:16:45 +00:00 · 2021-08-05 15:49:59 -07:00 · 2021-08-05 15:49:59 -07:00 · b4c14ab27b
commit b4c14ab27b
parent d1a4fab04d
12 changed files with 54 additions and 55 deletions
--- a/catalog-rest-service/src/main/java/org/openmetadata/catalog/jdbi3/TableRepository.java
+++ b/catalog-rest-service/src/main/java/org/openmetadata/catalog/jdbi3/TableRepository.java
@ -35,7 +35,6 @@ import org.openmetadata.catalog.resources.databases.TableResource;
 import org.openmetadata.catalog.type.Column;
 import org.openmetadata.catalog.type.DailyCount;
 import org.openmetadata.catalog.type.EntityReference;
-import org.openmetadata.catalog.type.TableJoins;
 import org.openmetadata.catalog.type.TagLabel;
 import org.openmetadata.catalog.util.EntityUtil;
 import org.openmetadata.catalog.util.EntityUtil.Fields;
--- a/catalog-rest-service/src/main/java/org/openmetadata/catalog/resources/CatalogResource.java
+++ b/catalog-rest-service/src/main/java/org/openmetadata/catalog/resources/CatalogResource.java
@ -17,7 +17,6 @@
 package org.openmetadata.catalog.resources;

 import com.fasterxml.jackson.core.JsonProcessingException;
-import org.openmetadata.catalog.resources.databases.TableResource.TableList;
 import org.openmetadata.catalog.type.CollectionDescriptor;
 import io.swagger.annotations.Api;
 import io.swagger.v3.oas.annotations.Operation;
--- a/catalog-rest-service/src/main/java/org/openmetadata/catalog/resources/config/ConfigResource.java
+++ b/catalog-rest-service/src/main/java/org/openmetadata/catalog/resources/config/ConfigResource.java
@ -24,7 +24,6 @@ import io.swagger.v3.oas.annotations.responses.ApiResponse;
 import org.openmetadata.catalog.CatalogApplicationConfig;
 import org.openmetadata.catalog.resources.Collection;
 import org.openmetadata.catalog.security.AuthenticationConfiguration;
-import org.openmetadata.catalog.type.CollectionDescriptor;

 import javax.ws.rs.GET;
 import javax.ws.rs.Path;
--- a/catalog-rest-service/src/main/java/org/openmetadata/catalog/resources/databases/TableResource.java
+++ b/catalog-rest-service/src/main/java/org/openmetadata/catalog/resources/databases/TableResource.java
@ -147,7 +147,8 @@ public class TableResource {
                        @QueryParam("before") String before,
                        @Parameter(description = "Returns list of tables after this curor",
                                schema = @Schema(type = "string"))
-                        @QueryParam("after") String after) throws IOException, ParseException, GeneralSecurityException {
+                        @QueryParam("after") String after)
+          throws IOException, ParseException, GeneralSecurityException {
    RestUtil.validateCursors(before, after);
    Fields fields = new Fields(FIELD_LIST, fieldsParam);

@ -350,7 +351,7 @@ public class TableResource {
  @PUT
  @Path("/{id}/sampleData")
  @Operation(summary = "Add sample data", tags = "tables",
-          description = "Add sample data to the table." )
+          description = "Add sample data to the table.")
  public Table addSampleData(@Context UriInfo uriInfo,
                                @Context SecurityContext securityContext,
                                @Parameter(description = "Id of the table", schema = @Schema(type = "string"))
--- a/catalog-rest-service/src/main/java/org/openmetadata/catalog/resources/teams/TeamResource.java
+++ b/catalog-rest-service/src/main/java/org/openmetadata/catalog/resources/teams/TeamResource.java
@ -99,9 +99,9 @@ public class TeamResource {

  static class TeamList extends ResultList<Team> {
    @SuppressWarnings("unused") /* Required for tests */
-    public TeamList() {}
+    TeamList() {}

-    public TeamList(List<Team> teams, int limitParam, String beforeCursor, String afterCursor)
+    TeamList(List<Team> teams, int limitParam, String beforeCursor, String afterCursor)
            throws GeneralSecurityException, UnsupportedEncodingException {
      super(teams, limitParam, beforeCursor, afterCursor);
    }
--- a/catalog-rest-service/src/main/java/org/openmetadata/catalog/resources/teams/UserResource.java
+++ b/catalog-rest-service/src/main/java/org/openmetadata/catalog/resources/teams/UserResource.java
@ -104,7 +104,7 @@ public class UserResource {
    @SuppressWarnings("unused")  // Used for deserialization
    UserList() {}

-    public UserList(List<User> users, int limitParam, String beforeCursor, String afterCursor)
+    UserList(List<User> users, int limitParam, String beforeCursor, String afterCursor)
            throws GeneralSecurityException, UnsupportedEncodingException {
      super(users, limitParam, beforeCursor, afterCursor);
    }
--- a/catalog-rest-service/src/main/java/org/openmetadata/catalog/security/AuthenticationConfiguration.java
+++ b/catalog-rest-service/src/main/java/org/openmetadata/catalog/security/AuthenticationConfiguration.java
@ -35,7 +35,9 @@ public class AuthenticationConfiguration {
    this.provider = provider;
  }

-  public String getPublicKey() { return publicKey; }
+  public String getPublicKey() {
+    return publicKey;
+  }

  public void setPublicKey(String publicKey) {
    this.publicKey = publicKey;
--- a/checkstyle/checkstyle.xml
+++ b/checkstyle/checkstyle.xml
@ -15,10 +15,9 @@
  ~ See the License for the specific language governing permissions and
  ~ limitations under the License.
  -->
-
 <!DOCTYPE module PUBLIC
-        "-//Puppy Crawl//DTD Check Configuration 1.2//EN"
-        "http://www.puppycrawl.com/dtds/configuration_1_2.dtd">
+        "-//Checkstyle//DTD Checkstyle Configuration 1.3//EN"
+        "https://checkstyle.org/dtds/configuration_1_3.dtd">

 <!--

@ -98,11 +97,14 @@
        <module name="ConstantName"/>
        <module name="LocalFinalVariableName"/>
        <module name="LocalVariableName"/>
-        <module name="MemberName"/>
-        <module name="MethodName"/>
+        <!-- <module name="MemberName"/> -->
+        <module name="MethodName">
+            <property name="format" value="^[a-z][a-z0-9][a-zA-Z0-9_]*$"/>
+            <message key="name.invalidPattern"
+                     value="Method name ''{0}'' must match pattern ''{1}''."/>
+        </module>
        <module name="PackageName"/>
        <module name="ParameterName"/>
-        <module name="StaticVariableName"/>
        <module name="TypeName"/>


@ -129,7 +131,6 @@
        <module name="IllegalImport"/> <!-- defaults to sun.* packages -->
        <module name="RedundantImport"/>
        <module name="UnusedImports"/>
-        <module name="AvoidStarImport"/>


        <!-- Checks for Size Violations.                    -->
--- a/common/src/main/java/org/openmetadata/common/utils/CipherText.java
+++ b/common/src/main/java/org/openmetadata/common/utils/CipherText.java
@ -1,18 +1,17 @@
 /*
- * 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
+ *  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.
+ *  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.openmetadata.common.utils;
--- a/common/src/main/java/org/openmetadata/common/utils/CommonUtil.java
+++ b/common/src/main/java/org/openmetadata/common/utils/CommonUtil.java
@ -1,18 +1,17 @@
 /*
- * 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
+ *  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.
+ *  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.openmetadata.common.utils;
--- a/common/src/main/java/org/openmetadata/common/utils/JsonSchemaUtil.java
+++ b/common/src/main/java/org/openmetadata/common/utils/JsonSchemaUtil.java
@ -1,18 +1,17 @@
 /*
- * 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
+ *  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.
+ *  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.openmetadata.common.utils;
--- a/pom.xml
+++ b/pom.xml
@ -435,6 +435,7 @@
           <version>3.1.2</version>
           <configuration>
             <configLocation>./checkstyle/checkstyle.xml</configLocation>
+               <includeTestSourceDirectory>true</includeTestSourceDirectory>
           </configuration>
           <dependencies>
            <dependency>