[FLINK-6695] Activate strict checkstyle for flink-connector-wikiedits
Project: http://git-wip-us.apache.org/repos/asf/flink/repo Commit: http://git-wip-us.apache.org/repos/asf/flink/commit/a84ce0be Tree: http://git-wip-us.apache.org/repos/asf/flink/tree/a84ce0be Diff: http://git-wip-us.apache.org/repos/asf/flink/diff/a84ce0be Branch: refs/heads/master Commit: a84ce0befb397d3554c718240acc80205524ee15 Parents: f12c591 Author: zentol <[email protected]> Authored: Tue May 23 21:40:35 2017 +0200 Committer: zentol <[email protected]> Committed: Thu Jun 1 11:14:11 2017 +0200 ---------------------------------------------------------------------- flink-contrib/flink-connector-wikiedits/pom.xml | 39 ++++++++++++++++++++ .../wikiedits/WikipediaEditEvent.java | 3 ++ .../wikiedits/WikipediaEditsSource.java | 6 ++- .../wikiedits/WikipediaEditsSourceTest.java | 6 ++- 4 files changed, 52 insertions(+), 2 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/flink/blob/a84ce0be/flink-contrib/flink-connector-wikiedits/pom.xml ---------------------------------------------------------------------- diff --git a/flink-contrib/flink-connector-wikiedits/pom.xml b/flink-contrib/flink-connector-wikiedits/pom.xml index 20b6db4..1e5fbfd 100644 --- a/flink-contrib/flink-connector-wikiedits/pom.xml +++ b/flink-contrib/flink-connector-wikiedits/pom.xml @@ -47,4 +47,43 @@ under the License. <version>1.10</version> </dependency> </dependencies> + + <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> http://git-wip-us.apache.org/repos/asf/flink/blob/a84ce0be/flink-contrib/flink-connector-wikiedits/src/main/java/org/apache/flink/streaming/connectors/wikiedits/WikipediaEditEvent.java ---------------------------------------------------------------------- diff --git a/flink-contrib/flink-connector-wikiedits/src/main/java/org/apache/flink/streaming/connectors/wikiedits/WikipediaEditEvent.java b/flink-contrib/flink-connector-wikiedits/src/main/java/org/apache/flink/streaming/connectors/wikiedits/WikipediaEditEvent.java index ee3617d..a635c1e 100644 --- a/flink-contrib/flink-connector-wikiedits/src/main/java/org/apache/flink/streaming/connectors/wikiedits/WikipediaEditEvent.java +++ b/flink-contrib/flink-connector-wikiedits/src/main/java/org/apache/flink/streaming/connectors/wikiedits/WikipediaEditEvent.java @@ -21,6 +21,9 @@ package org.apache.flink.streaming.connectors.wikiedits; import java.util.regex.Matcher; import java.util.regex.Pattern; +/** + * Instances of this class represent edits made on Wikipedia. + */ public class WikipediaEditEvent { // Metadata http://git-wip-us.apache.org/repos/asf/flink/blob/a84ce0be/flink-contrib/flink-connector-wikiedits/src/main/java/org/apache/flink/streaming/connectors/wikiedits/WikipediaEditsSource.java ---------------------------------------------------------------------- diff --git a/flink-contrib/flink-connector-wikiedits/src/main/java/org/apache/flink/streaming/connectors/wikiedits/WikipediaEditsSource.java b/flink-contrib/flink-connector-wikiedits/src/main/java/org/apache/flink/streaming/connectors/wikiedits/WikipediaEditsSource.java index 943119c..a10abdb 100644 --- a/flink-contrib/flink-connector-wikiedits/src/main/java/org/apache/flink/streaming/connectors/wikiedits/WikipediaEditsSource.java +++ b/flink-contrib/flink-connector-wikiedits/src/main/java/org/apache/flink/streaming/connectors/wikiedits/WikipediaEditsSource.java @@ -23,6 +23,10 @@ import org.apache.flink.streaming.api.functions.source.RichSourceFunction; import java.util.concurrent.TimeUnit; +/** + * This class is a SourceFunction that reads {@link WikipediaEditEvent} instances from the IRC channel + * <code>#en.wikipedia</code>. + */ public class WikipediaEditsSource extends RichSourceFunction<WikipediaEditEvent> { /** Hostname of the server to connect to. */ @@ -31,7 +35,7 @@ public class WikipediaEditsSource extends RichSourceFunction<WikipediaEditEvent> /** Port of the server to connect to. */ public static final int DEFAULT_PORT = 6667; - /** IRC channel to join */ + /** IRC channel to join. */ public static final String DEFAULT_CHANNEL = "#en.wikipedia"; private final String host; http://git-wip-us.apache.org/repos/asf/flink/blob/a84ce0be/flink-contrib/flink-connector-wikiedits/src/test/java/org/apache/flink/streaming/connectors/wikiedits/WikipediaEditsSourceTest.java ---------------------------------------------------------------------- diff --git a/flink-contrib/flink-connector-wikiedits/src/test/java/org/apache/flink/streaming/connectors/wikiedits/WikipediaEditsSourceTest.java b/flink-contrib/flink-connector-wikiedits/src/test/java/org/apache/flink/streaming/connectors/wikiedits/WikipediaEditsSourceTest.java index c10c56a..439aa36 100644 --- a/flink-contrib/flink-connector-wikiedits/src/test/java/org/apache/flink/streaming/connectors/wikiedits/WikipediaEditsSourceTest.java +++ b/flink-contrib/flink-connector-wikiedits/src/test/java/org/apache/flink/streaming/connectors/wikiedits/WikipediaEditsSourceTest.java @@ -21,6 +21,7 @@ package org.apache.flink.streaming.connectors.wikiedits; import org.apache.flink.streaming.api.datastream.DataStream; import org.apache.flink.streaming.api.environment.StreamExecutionEnvironment; import org.apache.flink.streaming.api.functions.sink.SinkFunction; + import org.junit.Test; import org.slf4j.Logger; import org.slf4j.LoggerFactory; @@ -32,6 +33,9 @@ import static org.junit.Assert.assertEquals; import static org.junit.Assert.assertNotNull; import static org.junit.Assert.fail; +/** + * Tests for the WikipediaEditsSource. + */ public class WikipediaEditsSourceTest { private static final Logger LOG = LoggerFactory.getLogger(WikipediaEditsSourceTest.class); @@ -39,7 +43,7 @@ public class WikipediaEditsSourceTest { /** * NOTE: if you are behind a firewall you may need to use a SOCKS Proxy for this test. * - * We first check the connection to the IRC server. If it fails, this test + * <p>We first check the connection to the IRC server. If it fails, this test * is effectively ignored. * * @see <a href="http://docs.oracle.com/javase/8/docs/technotes/guides/net/proxies.html";>Socks Proxy</a>
