[HUDI-354] Introduce stricter comment and code style validation rules

• Type: Task
• Status: Closed
• Priority: Major
• Resolution: Fixed
• Component/s: code-quality
• Assignee: Unassigned
• Reporter: vinoyang
• Created: 21/Nov/19 03:22
• Updated: 09/May/22 09:32
• Resolved: 09/May/22 09:32

Description

This is an umbrella issue used to track apply some stricter comment and code style validation rules for the whole project. The rules list below:

1. All public classes must add class-level comments;
2. All comments must end with a clear "."
3. In the import statement of the class, clearly distinguish (by blank lines) the import of Java SE and the import of non-java SE. Currently, I saw at least two projects(Spark and Flink) that implement this rule. Flink implements stricter rules than Spark. It is divided into several blocks from top to bottom(owner import -> non-owner and non-JavaSE import -> Java SE import -> static import), each block are sorted according to the natural sequence of letters;
4. Reconfirm the method and whether the comment is consistency;

Each project sub-module mappings to one subtask.

How to find all the invalidated points?

• Add the XML code snippet into PROJECT_ROOT/style/checkstyle.xml : 

<module name="TreeWalker">

    <!-- add the below modules-->

    <!-- JAVADOC CHECKS -->
<module name="JavadocStyle">
    <property name="severity" value="error"/>
</module>
<module name="JavadocType">
    <property name="scope" value="protected"/>
    <property name="severity" value="error"/>
    <property name="allowMissingParamTags" value="true"/>
</module>
<module name="ImportOrder">
    <!-- Checks for out of order import statements. -->
    <property name="severity" value="error"/>
    <property name="groups" value="org.apache.hudi,*,javax,java,scala"/>
    <property name="separated" value="true"/>
    <property name="sortStaticImportsAlphabetically" value="true"/>
    <property name="option" value="bottom"/>
    <property name="tokens" value="STATIC_IMPORT, IMPORT"/>
    <message key="import.ordering"
      value="Import {0} appears after other imports that it should precede"/>
</module>
<module name="RedundantImport">
    <!-- Checks for redundant import statements. -->
    <property name="severity" value="error"/>
    <message key="import.redundancy"
      value="Redundant import {0}."/>
</module>
<module name="AvoidStarImport">
    <property name="severity" value="error"/>
</module>
</module>

•  Make sure you have installed CheckStyle-IDEA plugin and activated for the project.
• Scan the project module you want to refactor and fix all the issues one by one.

 

Sub-Tasks

• Refactor hudi-common based on new comment and code style rules: Closed
• Refactor hudi-cli based on new comment and code style rules: Closed
• Add Java-doc and importOrder checkstyle rule: Closed
• Refactor the codes based on new JavadocStyle code style rule: Resolved