Add Java and Scala style checkers.

Let's get this out of the way and enforce some style rules during the build. The rules are mostly borrowed from Spark, with some very minor tweaks. Most changes are to break long lines and reorder imports; notable exception is the renaming of the "scala" repl session package, because some very wise person involved in defining Scala decided that relative imports were a good idea. Closes apache#50
swapnilushinde · Feb 2, 2016 · b4c2706 · b4c2706
1 parent 1f4c108
commit b4c2706
Show file tree

Hide file tree

Showing 61 changed files with 630 additions and 251 deletions.
diff --git a/api/src/main/java/com/cloudera/livy/LivyClientBuilder.java b/api/src/main/java/com/cloudera/livy/LivyClientBuilder.java
@@ -17,8 +17,8 @@
 
 package com.cloudera.livy;
 
-import java.io.InputStreamReader;
 import java.io.IOException;
+import java.io.InputStreamReader;
 import java.io.Reader;
 import java.net.URI;
 import java.net.URISyntaxException;

diff --git a/api/src/main/java/com/cloudera/livy/MetricsCollection.java b/api/src/main/java/com/cloudera/livy/MetricsCollection.java
@@ -28,10 +28,10 @@
 
 import com.cloudera.livy.annotations.Private;
 import com.cloudera.livy.metrics.DataReadMethod;
-import com.cloudera.livy.metrics.ShuffleReadMetrics;
-import com.cloudera.livy.metrics.ShuffleWriteMetrics;
 import com.cloudera.livy.metrics.InputMetrics;
 import com.cloudera.livy.metrics.Metrics;
+import com.cloudera.livy.metrics.ShuffleReadMetrics;
+import com.cloudera.livy.metrics.ShuffleWriteMetrics;
 
 /**
  * Provides metrics collected for a submitted job.

diff --git a/api/src/test/java/com/cloudera/livy/TestMetricsCollection.java b/api/src/test/java/com/cloudera/livy/TestMetricsCollection.java
@@ -21,15 +21,15 @@
 import java.util.HashSet;
 import java.util.Set;
 
+import org.junit.Test;
+import static org.junit.Assert.*;
+
 import com.cloudera.livy.metrics.DataReadMethod;
 import com.cloudera.livy.metrics.InputMetrics;
 import com.cloudera.livy.metrics.Metrics;
 import com.cloudera.livy.metrics.ShuffleReadMetrics;
 import com.cloudera.livy.metrics.ShuffleWriteMetrics;
 
-import org.junit.Test;
-import static org.junit.Assert.*;
-
 public class TestMetricsCollection {
 
   @Test

diff --git a/checkstyle-suppressions.xml b/checkstyle-suppressions.xml
@@ -0,0 +1,23 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+  ~ Licensed to Cloudera, Inc. under one
+  ~ or more contributor license agreements.  See the NOTICE file
+  ~ distributed with this work for additional information
+  ~ regarding copyright ownership.  Cloudera, Inc. 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.
+-->
+<!DOCTYPE suppressions PUBLIC
+  "-//Puppy Crawl//DTD Suppressions 1.1//EN"
+  "http://www.puppycrawl.com/dtds/suppressions_1_1.dtd">
+<suppressions>
+</suppressions>
diff --git a/checkstyle.xml b/checkstyle.xml
@@ -0,0 +1,120 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+  ~ Licensed to Cloudera, Inc. under one
+  ~ or more contributor license agreements.  See the NOTICE file
+  ~ distributed with this work for additional information
+  ~ regarding copyright ownership.  Cloudera, Inc. 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.
+-->
+<!DOCTYPE module PUBLIC
+  "-//Puppy Crawl//DTD Check Configuration 1.3//EN"
+  "http://www.puppycrawl.com/dtds/configuration_1_3.dtd">
+<module name="Checker">
+  <property name="charset" value="UTF-8"/>
+
+  <property name="severity" value="error"/>
+
+  <property name="fileExtensions" value="java, properties, xml"/>
+
+  <module name="SuppressionFilter">
+    <property name="file" value="checkstyle-suppressions.xml"/>
+  </module>
+
+  <module name="FileTabCharacter">
+    <property name="eachLine" value="true"/>
+  </module>
+
+  <module name="RegexpSingleline">
+    <property name="format" value="\s+$"/>
+    <property name="message" value="No trailing whitespace allowed."/>
+  </module>
+
+  <module name="TreeWalker">
+    <module name="OuterTypeFilename"/>
+    <module name="IllegalTokenText">
+      <property name="tokens" value="STRING_LITERAL, CHAR_LITERAL"/>
+      <property name="format" value="\\u00(08|09|0(a|A)|0(c|C)|0(d|D)|22|27|5(C|c))|\\(0(10|11|12|14|15|42|47)|134)"/>
+      <property name="message" value="Avoid using corresponding octal or Unicode escape."/>
+    </module>
+    <module name="AvoidEscapedUnicodeCharacters">
+      <property name="allowEscapesForControlCharacters" value="true"/>
+      <property name="allowByTailComment" value="true"/>
+      <property name="allowNonPrintableEscapes" value="true"/>
+    </module>
+    <module name="LineLength">
+      <property name="max" value="100"/>
+      <property name="ignorePattern" value="^package.*|^import.*|a href|href|http://|https://|ftp://"/>
+    </module>
+    <module name="NoLineWrap"/>
+    <module name="EmptyBlock">
+      <property name="option" value="TEXT"/>
+      <property name="tokens" value="LITERAL_TRY, LITERAL_FINALLY, LITERAL_IF, LITERAL_ELSE, LITERAL_SWITCH"/>
+    </module>
+    <module name="NeedBraces">
+      <property name="allowSingleLineStatement" value="true"/>
+    </module>
+    <module name="OneStatementPerLine"/>
+    <module name="ArrayTypeStyle"/>
+    <module name="FallThrough"/>
+    <module name="UpperEll"/>
+    <module name="ModifierOrder"/>
+    <module name="SeparatorWrap">
+      <property name="tokens" value="DOT"/>
+      <property name="option" value="nl"/>
+    </module>
+    <module name="SeparatorWrap">
+      <property name="tokens" value="COMMA"/>
+      <property name="option" value="EOL"/>
+    </module>
+    <module name="PackageName">
+      <property name="format" value="^[a-z]+(\.[a-z][a-z0-9]*)*$"/>
+      <message key="name.invalidPattern" value="Package name ''{0}'' must match pattern ''{1}''."/>
+    </module>
+    <module name="ClassTypeParameterName">
+      <property name="format" value="([A-Z][a-zA-Z0-9]*$)"/>
+      <message key="name.invalidPattern" value="Class type name ''{0}'' must match pattern ''{1}''."/>
+    </module>
+    <module name="MethodTypeParameterName">
+      <property name="format" value="([A-Z][a-zA-Z0-9]*)"/>
+      <message key="name.invalidPattern" value="Method type name ''{0}'' must match pattern ''{1}''."/>
+    </module>
+    <module name="NoFinalizer"/>
+    <module name="GenericWhitespace">
+      <message key="ws.followed" value="GenericWhitespace ''{0}'' is followed by whitespace."/>
+      <message key="ws.preceded" value="GenericWhitespace ''{0}'' is preceded with whitespace."/>
+      <message key="ws.illegalFollow" value="GenericWhitespace ''{0}'' should followed by whitespace."/>
+      <message key="ws.notPreceded" value="GenericWhitespace ''{0}'' is not preceded with whitespace."/>
+    </module>
+    <module name="ImportOrder">
+      <property name="separated" value="true"/>
+      <property name="ordered" value="true"/>
+      <property name="groups" value="/^javax?\./,scala,*,com.cloudera.livy"/>
+    </module>
+    <module name="MethodParamPad"/>
+    <module name="AnnotationLocation">
+      <property name="tokens" value="CLASS_DEF, INTERFACE_DEF, ENUM_DEF, METHOD_DEF, CTOR_DEF"/>
+    </module>
+    <module name="AnnotationLocation">
+      <property name="tokens" value="VARIABLE_DEF"/>
+      <property name="allowSamelineMultipleAnnotations" value="true"/>
+    </module>
+    <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="EmptyCatchBlock">
+      <property name="exceptionVariableName" value="expected"/>
+    </module>
+    <module name="CommentsIndentation"/>
+  </module>
+</module>
diff --git a/client-http/src/main/java/com/cloudera/livy/client/http/HttpClient.java b/client-http/src/main/java/com/cloudera/livy/client/http/HttpClient.java
@@ -24,8 +24,8 @@
 import java.util.Map;
 import java.util.concurrent.Callable;
 import java.util.concurrent.Executors;
-import java.util.concurrent.ScheduledExecutorService;
 import java.util.concurrent.Future;
+import java.util.concurrent.ScheduledExecutorService;
 import java.util.concurrent.ThreadFactory;
 
 import com.cloudera.livy.Job;

diff --git a/client-http/src/main/java/com/cloudera/livy/client/http/JobHandleImpl.java b/client-http/src/main/java/com/cloudera/livy/client/http/JobHandleImpl.java
@@ -22,8 +22,8 @@
 import java.util.concurrent.ExecutionException;
 import java.util.concurrent.ScheduledExecutorService;
 import java.util.concurrent.ScheduledFuture;
-import java.util.concurrent.TimeoutException;
 import java.util.concurrent.TimeUnit;
+import java.util.concurrent.TimeoutException;
 
 import com.cloudera.livy.JobHandle;
 import com.cloudera.livy.client.common.AbstractJobHandle;

diff --git a/client-http/src/main/java/com/cloudera/livy/client/http/LivyConnection.java b/client-http/src/main/java/com/cloudera/livy/client/http/LivyConnection.java
@@ -29,8 +29,8 @@
 import org.apache.http.HttpStatus;
 import org.apache.http.client.config.RequestConfig;
 import org.apache.http.client.methods.CloseableHttpResponse;
-import org.apache.http.client.methods.HttpEntityEnclosingRequestBase;
 import org.apache.http.client.methods.HttpDelete;
+import org.apache.http.client.methods.HttpEntityEnclosingRequestBase;
 import org.apache.http.client.methods.HttpGet;
 import org.apache.http.client.methods.HttpPost;
 import org.apache.http.client.methods.HttpRequestBase;

diff --git a/client-local/src/main/java/com/cloudera/livy/client/local/BaseProtocol.java b/client-local/src/main/java/com/cloudera/livy/client/local/BaseProtocol.java
@@ -20,8 +20,8 @@
 import com.google.common.base.Throwables;
 
 import com.cloudera.livy.Job;
-import com.cloudera.livy.metrics.Metrics;
 import com.cloudera.livy.client.local.rpc.RpcDispatcher;
+import com.cloudera.livy.metrics.Metrics;
 
 public abstract class BaseProtocol extends RpcDispatcher {
 

diff --git a/client-local/src/main/java/com/cloudera/livy/client/local/JobHandleImpl.java b/client-local/src/main/java/com/cloudera/livy/client/local/JobHandleImpl.java
@@ -105,12 +105,4 @@ void setFailure(Throwable error) {
     }
   }
 
-  /** Last attempt at preventing stray jobs from accumulating in SparkClientImpl. */
-  @Override
-  protected void finalize() {
-    if (!isDone()) {
-      cancel(true);
-    }
-  }
-
 }
diff --git a/client-local/src/main/java/com/cloudera/livy/client/local/LocalClient.java b/client-local/src/main/java/com/cloudera/livy/client/local/LocalClient.java
@@ -43,8 +43,8 @@
 
 import com.google.common.base.Charsets;
 import com.google.common.base.Joiner;
-import com.google.common.base.Strings;
 import com.google.common.base.Preconditions;
+import com.google.common.base.Strings;
 import com.google.common.base.Throwables;
 import com.google.common.collect.Lists;
 import com.google.common.collect.Maps;
@@ -250,7 +250,10 @@ public void run() {
         LOG.info("No spark.home provided, calling SparkSubmit directly.");
         argv.add(new File(System.getProperty("java.home"), "bin/java").getAbsolutePath());
 
-        if (master.startsWith("local") || master.startsWith("mesos") || master.endsWith("-client") || master.startsWith("spark")) {
+        if (master.startsWith("local") ||
+              master.startsWith("mesos") ||
+              master.endsWith("-client") ||
+              master.startsWith("spark")) {
           String mem = conf.get("spark.driver.memory");
           if (mem != null) {
             argv.add("-Xms" + mem);

diff --git a/client-local/src/main/java/com/cloudera/livy/client/local/driver/RemoteDriver.java b/client-local/src/main/java/com/cloudera/livy/client/local/driver/RemoteDriver.java
@@ -19,14 +19,14 @@
 
 import java.io.File;
 import java.io.FileInputStream;
-import java.io.InputStreamReader;
 import java.io.IOException;
+import java.io.InputStreamReader;
 import java.io.Reader;
 import java.util.List;
 import java.util.Map;
 import java.util.Properties;
-import java.util.concurrent.Executors;
 import java.util.concurrent.ExecutorService;
+import java.util.concurrent.Executors;
 import static java.nio.charset.StandardCharsets.UTF_8;
 
 import com.google.common.base.Joiner;

diff --git a/client-local/src/main/java/com/cloudera/livy/client/local/rpc/Rpc.java b/client-local/src/main/java/com/cloudera/livy/client/local/rpc/Rpc.java
@@ -22,8 +22,8 @@
 import java.util.Collection;
 import java.util.Collections;
 import java.util.Map;
-import java.util.concurrent.TimeoutException;
 import java.util.concurrent.TimeUnit;
+import java.util.concurrent.TimeoutException;
 import java.util.concurrent.atomic.AtomicBoolean;
 import java.util.concurrent.atomic.AtomicLong;
 import java.util.concurrent.atomic.AtomicReference;
@@ -51,8 +51,8 @@
 import io.netty.channel.nio.NioEventLoopGroup;
 import io.netty.channel.socket.SocketChannel;
 import io.netty.channel.socket.nio.NioSocketChannel;
-import io.netty.handler.logging.LoggingHandler;
 import io.netty.handler.logging.LogLevel;
+import io.netty.handler.logging.LoggingHandler;
 import io.netty.util.concurrent.EventExecutorGroup;
 import io.netty.util.concurrent.Future;
 import io.netty.util.concurrent.GenericFutureListener;

diff --git a/client-local/src/main/java/com/cloudera/livy/client/local/rpc/RpcServer.java b/client-local/src/main/java/com/cloudera/livy/client/local/rpc/RpcServer.java
@@ -24,8 +24,8 @@
 import java.util.Map;
 import java.util.Properties;
 import java.util.concurrent.ConcurrentMap;
-import java.util.concurrent.TimeoutException;
 import java.util.concurrent.TimeUnit;
+import java.util.concurrent.TimeoutException;
 import javax.security.auth.callback.Callback;
 import javax.security.auth.callback.CallbackHandler;
 import javax.security.auth.callback.NameCallback;

diff --git a/client-local/src/test/java/com/cloudera/livy/client/local/TestSparkClient.java b/client-local/src/test/java/com/cloudera/livy/client/local/TestSparkClient.java
@@ -378,7 +378,7 @@ private void runTest(boolean local, TestFunction test) throws Exception {
   private static class HiveJob implements Job<ArrayList<String>> {
 
     @Override
-    public ArrayList<String> call (JobContext jc){
+    public ArrayList<String> call(JobContext jc){
       String inputFile = "src/test/resources/testweet.json";
       HiveContext hivectx = jc.hivectx();
 
@@ -405,7 +405,8 @@ public ArrayList<String> call(JobContext jc){
       DataFrame input = sqlctx.jsonFile(inputFile);
       input.registerTempTable("tweets");
 
-      DataFrame topTweets = sqlctx.sql("SELECT text, retweetCount FROM tweets ORDER BY retweetCount LIMIT 10");
+      DataFrame topTweets = sqlctx.sql(
+        "SELECT text, retweetCount FROM tweets ORDER BY retweetCount LIMIT 10");
       ArrayList<String> tweetList = new ArrayList<>();
       for (Row r : topTweets.collect()) {
          tweetList.add(r.toString());
@@ -425,18 +426,24 @@ public Boolean call(JobContext jc) throws Exception {
       try {
         jc.streamingctx();
         fail("Access before creation: Should throw IllegalStateException");
-      } catch (IllegalStateException ex) {}
+      } catch (IllegalStateException ex) {
+        // Expected.
+      }
       try {
         jc.stopStreamingCtx();
         fail("Stop before creation: Should throw IllegalStateException");
-      } catch (IllegalStateException ex) {}
+      } catch (IllegalStateException ex) {
+        // Expected.
+      }
       try {
         jc.createStreamingContext(1000L);
         JavaStreamingContext streamingContext = jc.streamingctx();
         jc.stopStreamingCtx();
         jc.streamingctx();
         fail();
-      } catch (IllegalStateException ex) {}
+      } catch (IllegalStateException ex) {
+        // Expected.
+      }
 
       jc.createStreamingContext(1000L);
       JavaStreamingContext streamingContext = jc.streamingctx();

diff --git a/client-local/src/test/java/com/cloudera/livy/client/local/rpc/TestRpc.java b/client-local/src/test/java/com/cloudera/livy/client/local/rpc/TestRpc.java
@@ -33,12 +33,11 @@
 import io.netty.channel.nio.NioEventLoopGroup;
 import io.netty.util.concurrent.Future;
 import org.apache.commons.io.IOUtils;
-import org.slf4j.Logger;
-import org.slf4j.LoggerFactory;
-
 import org.junit.After;
 import org.junit.Before;
 import org.junit.Test;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
 import static org.junit.Assert.*;
 
 import com.cloudera.livy.client.local.LocalConf;

diff --git a/core/src/main/scala/com/cloudera/livy/LineBufferedStream.scala b/core/src/main/scala/com/cloudera/livy/LineBufferedStream.scala
@@ -62,7 +62,7 @@ class LineBufferedStream(inputStream: InputStream) extends Logging {
   def iterator: Iterator[String] = {
     new LinesIterator
   }
-  
+
   def waitUntilClose(): Unit = thread.join()
 
   private class LinesIterator extends Iterator[String] {