[FLINK-6675] Activate strict checkstyle for flink-annotations

This closes apache#3970.
deepfield · May 24, 2017 · dbcc456 · dbcc456
1 parent 04fae53
commit dbcc456
Show file tree

Hide file tree

Showing 5 changed files with 43 additions and 1 deletion.
diff --git a/flink-annotations/pom.xml b/flink-annotations/pom.xml
@@ -34,4 +34,42 @@ under the License.
 
  <packaging>jar</packaging>
 
+ <build>
+ <plugins>
+ <plugin>
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-checkstyle-plugin</artifactId>
+ <version>2.17</version>
+ <dependencies>
+ <dependency>
+ <groupId>com.puppycrawl.tools</groupId>
+ <artifactId>checkstyle</artifactId>
+ <version>6.19</version>
+ </dependency>
+ </dependencies>
+ <configuration>
+ <configLocation>/tools/maven/strict-checkstyle.xml</configLocation>
+ <suppressionsLocation>/tools/maven/suppressions.xml</suppressionsLocation>
+ <includeTestSourceDirectory>true</includeTestSourceDirectory>
+ <logViolationsToConsole>true</logViolationsToConsole>
+ <failOnViolation>true</failOnViolation>
+ </configuration>
+ <executions>
+ <!--
+ Execute checkstyle after compilation but before tests.
+ This ensures that any parsing or type checking errors are from
+ javac, so they look as expected. Beyond that, we want to
+ fail as early as possible.
+ -->
+ <execution>
+ <phase>test-compile</phase>
+ <goals>
+ <goal>check</goal>
+ </goals>
+ </execution>
+ </executions>
+ </plugin>
+ </plugins>
+ </build>
+
 </project>
diff --git a/flink-annotations/src/main/java/org/apache/flink/annotation/Internal.java b/flink-annotations/src/main/java/org/apache/flink/annotation/Internal.java
@@ -16,6 +16,7 @@
  * limitations under the License.
  *
  */
+
 package org.apache.flink.annotation;
 
 import java.lang.annotation.Documented;

diff --git a/flink-annotations/src/main/java/org/apache/flink/annotation/Public.java b/flink-annotations/src/main/java/org/apache/flink/annotation/Public.java
@@ -16,6 +16,7 @@
  * limitations under the License.
  *
  */
+
 package org.apache.flink.annotation;
 
 import java.lang.annotation.Documented;

diff --git a/flink-annotations/src/main/java/org/apache/flink/annotation/PublicEvolving.java b/flink-annotations/src/main/java/org/apache/flink/annotation/PublicEvolving.java
@@ -16,6 +16,7 @@
  * limitations under the License.
  *
  */
+
 package org.apache.flink.annotation;
 
 import java.lang.annotation.Documented;

diff --git a/flink-annotations/src/main/java/org/apache/flink/annotation/VisibleForTesting.java b/flink-annotations/src/main/java/org/apache/flink/annotation/VisibleForTesting.java
@@ -16,6 +16,7 @@
  * limitations under the License.
  *
  */
+
 package org.apache.flink.annotation;
 
 import java.lang.annotation.Documented;
@@ -25,7 +26,7 @@
 /**
  * This annotations declares that a function, field, constructor, or entire type, is only visible for
  * testing purposes.
- * 
+ *
  * <p>This annotation is typically attached when for example a method should be {@code private}
  * (because it is not intended to be called externally), but cannot be declared private, because
  * some tests need to have access to it.