From 5fdf71ddc608fd706c6f8981316e258f949f707a Mon Sep 17 00:00:00 2001
From: Gabriel Gonzalez <Gabriel439@gmail.com>
Date: Fri, 11 Sep 2015 18:59:02 -0600
Subject: [PATCH] Add `--verbose` and `--quiet` options to `compile.scalastyle`

This adds new `--verbose` and `--quiet` options to the `compile.scalastyle` goal, which get threaded directly to scalastyle, as requested in issue #1888.

Note: `scalastyle` currently accepts but ignores the `--verbose` option (See: https://github.com/scalastyle/scalastyle/issues/159).  However, I include it anyway for when that issue is eventually fixed.

Testing Done:
$ ./pants test tests/python/pants_test/tasks:scalastyle_integration # Newly added integration test passes
    $ ./pants test tests/python/pants_test:all # Unit tests pass

I'm relying on Travis for the remaining integration tests

Bugs closed: 2172

Reviewed at https://rbcommons.com/s/twitter/r/2799/
---
 .../org/pantsbuild/example/styleissue/BUILD   |  6 ++++++
 .../example/styleissue/StyleIssue.scala       |  8 ++++++++
 .../pantsbuild/example/styleissue/style.xml   |  3 +++
 .../pants/backend/jvm/tasks/scalastyle.py     | 16 +++++++++++++++-
 .../tasks/test_scalastyle_integration.py      | 19 +++++++++++++++++++
 5 files changed, 51 insertions(+), 1 deletion(-)
 create mode 100644 examples/src/scala/org/pantsbuild/example/styleissue/BUILD
 create mode 100644 examples/src/scala/org/pantsbuild/example/styleissue/StyleIssue.scala
 create mode 100644 examples/src/scala/org/pantsbuild/example/styleissue/style.xml

diff --git a/examples/src/scala/org/pantsbuild/example/styleissue/BUILD b/examples/src/scala/org/pantsbuild/example/styleissue/BUILD
new file mode 100644
index 00000000000..31787568836
--- /dev/null
+++ b/examples/src/scala/org/pantsbuild/example/styleissue/BUILD
@@ -0,0 +1,6 @@
+# Copyright 2015 Pants project contributors (see CONTRIBUTORS.md).
+# Licensed under the Apache License, Version 2.0 (see LICENSE).
+
+scala_library(name = 'styleissue',
+  sources = ['StyleIssue.scala'],
+)
diff --git a/examples/src/scala/org/pantsbuild/example/styleissue/StyleIssue.scala b/examples/src/scala/org/pantsbuild/example/styleissue/StyleIssue.scala
new file mode 100644
index 00000000000..2a5f336c75a
--- /dev/null
+++ b/examples/src/scala/org/pantsbuild/example/styleissue/StyleIssue.scala
@@ -0,0 +1,8 @@
+// Copyright 2015 Pants project contributors (see CONTRIBUTORS.md).
+// Licensed under the Apache License, Version 2.0 (see LICENSE).
+
+package org.pantsbuild.example.hello.styleissue;
+
+// A program designed to deliberately fail a scalastyle check
+	class StyleIssue {
+	}
diff --git a/examples/src/scala/org/pantsbuild/example/styleissue/style.xml b/examples/src/scala/org/pantsbuild/example/styleissue/style.xml
new file mode 100644
index 00000000000..707af9eea13
--- /dev/null
+++ b/examples/src/scala/org/pantsbuild/example/styleissue/style.xml
@@ -0,0 +1,3 @@
+<scalastyle>
+ <check level="error" class="org.scalastyle.file.FileTabChecker" enabled="true" />
+</scalastyle>
diff --git a/src/python/pants/backend/jvm/tasks/scalastyle.py b/src/python/pants/backend/jvm/tasks/scalastyle.py
index 3d82788ac05..6e0ccdd20ed 100644
--- a/src/python/pants/backend/jvm/tasks/scalastyle.py
+++ b/src/python/pants/backend/jvm/tasks/scalastyle.py
@@ -71,6 +71,10 @@ def register_options(cls, register):
                   '(relative to the repo root) matches any of these regexes.')
     register('--jvm-options', action='append', metavar='<option>...', advanced=True,
              help='Run scalastyle with these extra jvm options.')
+    register('--verbose', action='store_true', default=False,
+             help='Enable verbose scalastyle output.')
+    register('--quiet', action='store_true', default=False,
+             help='Silence scalastyle error messages.')
     cls.register_jvm_tool(register, 'scalastyle')
 
   @classmethod
@@ -126,6 +130,8 @@ def execute(self):
       invalid_targets = [vt.target for vt in invalidation_check.invalid_vts]
 
       scalastyle_config = self.validate_scalastyle_config()
+      scalastyle_verbose = self.get_options().verbose
+      scalastyle_quiet = self.get_options().quiet
       scalastyle_excluder = self.create_file_excluder()
 
       self.context.log.debug('Non synthetic scala targets to be checked:')
@@ -139,11 +145,19 @@ def execute(self):
 
       if scala_sources:
         def call(srcs):
+          def to_java_boolean(x):
+            return str(x).lower()
+
           cp = self.tool_classpath('scalastyle')
+          scalastyle_args = [
+            '-c', scalastyle_config,
+            '-v', to_java_boolean(scalastyle_verbose),
+            '-q', to_java_boolean(scalastyle_quiet),
+            ]
           return self.runjava(classpath=cp,
                               main=self._MAIN,
                               jvm_options=self.get_options().jvm_options,
-                              args=['-c', scalastyle_config] + srcs)
+                              args=scalastyle_args + srcs)
 
         result = Xargs(call).execute(scala_sources)
         if result != 0:
diff --git a/tests/python/pants_test/tasks/test_scalastyle_integration.py b/tests/python/pants_test/tasks/test_scalastyle_integration.py
index 7bc8832054f..07313e1042e 100644
--- a/tests/python/pants_test/tasks/test_scalastyle_integration.py
+++ b/tests/python/pants_test/tasks/test_scalastyle_integration.py
@@ -35,3 +35,22 @@ def test_scalastyle_cached(self):
         # implying there was as a cache hit
         self.assertNotIn('abc_Scalastyle_compile_scalastyle will write to local artifact cache',
             pants_run.stdout_data)
+
+  def test_scalastyle_without_quiet(self):
+    scalastyle_args = [
+      'compile.scalastyle',
+      '--config=examples/src/scala/org/pantsbuild/example/styleissue/style.xml',
+      'examples/src/scala/org/pantsbuild/example/styleissue',
+      ]
+    pants_run = self.run_pants(scalastyle_args)
+    self.assertIn('Found 2 errors', pants_run.stdout_data)
+
+  def test_scalastyle_with_quiet(self):
+    scalastyle_args = [
+      'compile.scalastyle',
+      '--config=examples/src/scala/org/pantsbuild/example/styleissue/style.xml',
+      '--quiet',
+      'examples/src/scala/org/pantsbuild/example/styleissue',
+      ]
+    pants_run = self.run_pants(scalastyle_args)
+    self.assertNotIn('Found 2 errors', pants_run.stdout_data)