Compile with unused dependency checker (bazelbuild#579)

* Compile with unused-deps-checker=error

* no default params in _lib

* Use strict-deps if both strict- and unused-deps are on

* Better comment

* naming

* Readd util_core+util_logging to scrooge_support

* Add exports to unused-deps-ignored

* third_party/ unused dep checker off

* Linter

* disable unused-deps checker for _suite rules

* remove unnecessary unused-deps=off

* Add removed deps as runtime deps

Author: jhnj

WORKSPACE

@@ -97,9 +97,9 @@ filegroup(
     path = "third_party/test/new_local_repo",
 )
 
-load("@io_bazel_rules_scala//scala:toolchains.bzl", "scala_register_toolchains")
+load("@io_bazel_rules_scala//scala:toolchains.bzl", "scala_register_unused_deps_toolchains")
 
-scala_register_toolchains()
+scala_register_unused_deps_toolchains()
 
 load("//scala:scala_maven_import_external.bzl", "scala_maven_import_external", "java_import_external")
 

jmh/jmh.bzl

@@ -122,6 +122,7 @@ def scala_benchmark_jmh(**kw):
       resources = kw.get("resources", []),
       resource_jars = kw.get("resource_jars", []),
       visibility = ["//visibility:public"],
+      unused_dependency_checker_mode = "off",
   )
 
   codegen = name + "_codegen"
@@ -136,6 +137,7 @@ def scala_benchmark_jmh(**kw):
           lib,
       ],
       resource_jars = ["%s_resources.jar" % codegen],
+      unused_dependency_checker_mode = "off",
   )
   scala_binary(
       name = name,
@@ -145,4 +147,5 @@ def scala_benchmark_jmh(**kw):
           compiled_lib,
       ],
       main_class = main_class,
+      unused_dependency_checker_mode = "off",
   )

scala/BUILD

@@ -22,6 +22,19 @@ toolchain(
     visibility = ["//visibility:public"],
 )
 
+scala_toolchain(
+    name = "unused_dependency_checker_error_toolchain_impl",
+    unused_dependency_checker_mode = "error",
+    visibility = ["//visibility:public"],
+)
+
+toolchain(
+    name = "unused_dependency_checker_error_toolchain",
+    toolchain = ":unused_dependency_checker_error_toolchain_impl",
+    toolchain_type = "@io_bazel_rules_scala//scala:toolchain_type",
+    visibility = ["//visibility:public"],
+)
+
 java_import(
     name = "bazel_test_runner_deploy",
     jars = ["@bazel_tools//tools/jdk:TestRunner_deploy.jar"],

scala/private/rule_impls.bzl

@@ -189,11 +189,6 @@ CurrentTarget: {current_target}
         indirect_targets = indirect_targets,
         current_target = current_target)
 
-    if unused_dependency_checker_mode != "off":
-      fail(
-          "Using both --strict_java_deps and unused-dependency-checker at the same time is not allowed"
-      )
-
   elif unused_dependency_checker_mode != "off":
     unused_dependency_plugin = ctx.attr._unused_dependency_checker_plugin
     plugins = depset(transitive = [plugins, unused_dependency_plugin.files])
@@ -380,6 +375,11 @@ def _compile_or_empty(
     java_srcs = [
         f for f in ctx.files.srcs if f.basename.endswith(_java_extension)
     ]
+    # We are not able to verify whether dependencies are used when compiling java sources
+    # Thus we disable unused dependency checking when java sources are found
+    if len(java_srcs) != 0:
+      unused_dependency_checker_mode = "off"
+
     sources = [
         f for f in ctx.files.srcs if f.basename.endswith(_scala_extension)
     ] + java_srcs
@@ -578,7 +578,8 @@ def _collect_jars_from_common_ctx(ctx,
       jars2labels = jars2labels,
       transitive_compile_jars = transitive_compile_jars)
 
-def _lib(ctx, base_classpath, non_macro_lib, unused_dependency_checker_mode):
+def _lib(ctx, base_classpath, non_macro_lib, unused_dependency_checker_mode,
+         unused_dependency_checker_ignored_targets):
   # Build up information from dependency-like attributes
 
   # This will be used to pick up srcjars from non-scala library
@@ -604,7 +605,8 @@ def _lib(ctx, base_classpath, non_macro_lib, unused_dependency_checker_mode):
       jars.jars2labels.jars_to_labels, [],
       unused_dependency_checker_mode = unused_dependency_checker_mode,
       unused_dependency_checker_ignored_targets = [
-          target.label for target in base_classpath
+          target.label for target in base_classpath + ctx.attr.exports +
+          unused_dependency_checker_ignored_targets
       ])
 
   transitive_rjars = depset(outputs.full_jars, transitive = [transitive_rjars])
@@ -655,15 +657,17 @@ def scala_library_impl(ctx):
   scalac_provider = ctx.attr._scala_provider[_ScalacProvider]
   unused_dependency_checker_mode = get_unused_dependency_checker_mode(ctx)
   return _lib(ctx, scalac_provider.default_classpath, True,
-              unused_dependency_checker_mode)
+              unused_dependency_checker_mode,
+              ctx.attr.unused_dependency_checker_ignored_targets)
 
 def scala_library_for_plugin_bootstrapping_impl(ctx):
   scalac_provider = ctx.attr._scala_provider[_ScalacProvider]
   return _lib(
       ctx,
       scalac_provider.default_classpath,
       True,
-      unused_dependency_checker_mode = "off")
+      unused_dependency_checker_mode = "off",
+      unused_dependency_checker_ignored_targets = [])
 
 def scala_macro_library_impl(ctx):
   scalac_provider = ctx.attr._scala_provider[_ScalacProvider]
@@ -672,7 +676,8 @@ def scala_macro_library_impl(ctx):
       ctx,
       scalac_provider.default_macro_classpath,
       False,  # don't build the ijar for macros
-      unused_dependency_checker_mode)
+      unused_dependency_checker_mode,
+      ctx.attr.unused_dependency_checker_ignored_targets)
 
 # Common code shared by all scala binary implementations.
 def _scala_binary_common(
@@ -750,7 +755,8 @@ def scala_binary_impl(ctx):
       wrapper,
       unused_dependency_checker_mode = unused_dependency_checker_mode,
       unused_dependency_checker_ignored_targets = [
-          target.label for target in scalac_provider.default_classpath
+          target.label for target in scalac_provider.default_classpath +
+          ctx.attr.unused_dependency_checker_ignored_targets
       ])
   _write_executable(
       ctx = ctx,
@@ -801,7 +807,8 @@ trap finish EXIT
       wrapper,
       unused_dependency_checker_mode = unused_dependency_checker_mode,
       unused_dependency_checker_ignored_targets = [
-          target.label for target in scalac_provider.default_repl_classpath
+          target.label for target in scalac_provider.default_repl_classpath +
+          ctx.attr.unused_dependency_checker_ignored_targets
       ])
   _write_executable(
       ctx = ctx,
@@ -831,7 +838,8 @@ def scala_test_impl(ctx):
 
   unused_dependency_checker_mode = get_unused_dependency_checker_mode(ctx)
   unused_dependency_checker_ignored_targets = [
-      target.label for target in scalac_provider.default_classpath
+      target.label for target in scalac_provider.default_classpath +
+      ctx.attr.unused_dependency_checker_ignored_targets
   ]
   unused_dependency_checker_is_off = unused_dependency_checker_mode == "off"
 
@@ -919,7 +927,11 @@ def scala_junit_test_impl(ctx):
 
   unused_dependency_checker_mode = get_unused_dependency_checker_mode(ctx)
   unused_dependency_checker_ignored_targets = [
-      target.label for target in scalac_provider.default_classpath
+      target.label for target in scalac_provider.default_classpath +
+      ctx.attr.unused_dependency_checker_ignored_targets
+  ] + [
+      ctx.attr._junit.label, ctx.attr._hamcrest.label,
+      ctx.attr.suite_label.label, ctx.attr._bazel_test_runner.label
   ]
   unused_dependency_checker_is_off = unused_dependency_checker_mode == "off"
 

scala/scala.bzl

@@ -143,6 +143,7 @@ _common_attrs.update({
         ),
         allow_files = [".jar"],
         mandatory = False),
+    "unused_dependency_checker_ignored_targets": attr.label_list(default = []),
 })
 
 _library_attrs = {
@@ -440,7 +441,8 @@ def scala_test_suite(name,
         visibility = visibility,
         size = size,
         colors = colors,
-        full_stacktraces = full_stacktraces)
+        full_stacktraces = full_stacktraces,
+        unused_dependency_checker_mode = "off")
     ts.append(n)
   native.test_suite(name = name, tests = ts, visibility = visibility)
 
@@ -477,7 +479,8 @@ def scala_library_suite(name,
         jvm_flags = jvm_flags,
         print_compile_time = print_compile_time,
         visibility = visibility,
-        exports = exports)
+        exports = exports,
+        unused_dependency_checker_mode = "off")
     ts.append(n)
   scala_library(
       name = name, deps = ts, exports = exports + ts, visibility = visibility)
@@ -519,6 +522,7 @@ def scala_specs2_junit_test(name, **kwargs):
   scala_junit_test(
       name = name,
       deps = _specs2_junit_dependencies() + kwargs.pop("deps", []),
+      unused_dependency_checker_ignored_targets = _specs2_junit_dependencies(),
       suite_label = Label(
           "//src/java/io/bazel/rulesscala/specs2:specs2_test_discovery"),
       suite_class = "io.bazel.rulesscala.specs2.Specs2DiscoveredTestSuite",

scala/toolchains.bzl

@@ -1,2 +1,6 @@
 def scala_register_toolchains():
   native.register_toolchains("@io_bazel_rules_scala//scala:default_toolchain")
+
+def scala_register_unused_deps_toolchains():
+  native.register_toolchains(
+      "@io_bazel_rules_scala//scala:unused_dependency_checker_error_toolchain")

scala_proto/scala_proto.bzl

@@ -496,6 +496,7 @@ def scalapb_proto_library(name,
   scala_library(
       name = name,
       deps = [srcjar] + external_deps,
+      unused_dependency_checker_ignored_targets = [srcjar] + external_deps,
       exports = external_deps,
       visibility = visibility,
   )

src/scala/io/bazel/rules_scala/jmh_support/BUILD

@@ -4,12 +4,13 @@ scala_library(
     name = "benchmark_generator_lib",
     srcs = ["BenchmarkGenerator.scala"],
     visibility = ["//visibility:public"],
+    runtime_deps = [
+        "//external:io_bazel_rules_scala/dependency/jmh/org_ows2_asm_asm",
+    ],
     deps = [
         "//external:io_bazel_rules_scala/dependency/jmh/jmh_core",
         "//external:io_bazel_rules_scala/dependency/jmh/jmh_generator_asm",
         "//external:io_bazel_rules_scala/dependency/jmh/jmh_generator_reflection",
-        "//external:io_bazel_rules_scala/dependency/jmh/org_ows2_asm_asm",
-        "//src/java/io/bazel/rulesscala/io_utils",
         "//src/java/io/bazel/rulesscala/jar",
     ],
 )

src/scala/io/bazel/rules_scala/scrooge_support/BUILD

@@ -3,6 +3,8 @@ load("//scala:scala.bzl", "scala_library")
 scala_library(
     name = "compiler",
     srcs = ["Compiler.scala"],
+    # util_core is still needed as a dep for older versions of scrooge
+    unused_dependency_checker_mode = "off",
     visibility = ["//visibility:public"],
     deps = [
         ":focused_zip_importer",

src/scala/scripts/BUILD

@@ -32,9 +32,11 @@ scala_library(
     name = "scalapb_generator_lib",
     srcs = ["ScalaPBGenerator.scala"],
     visibility = ["//visibility:public"],
+    runtime_deps = [
+        "//external:io_bazel_rules_scala/dependency/com_google_protobuf/protobuf_java",
+    ],
     deps = [
         ":scala_proto_request_extractor",
-        "//external:io_bazel_rules_scala/dependency/com_google_protobuf/protobuf_java",
         "//external:io_bazel_rules_scala/dependency/proto/protoc",
         "//external:io_bazel_rules_scala/dependency/proto/protoc_bridge",
         "//external:io_bazel_rules_scala/dependency/proto/scalapb_plugin",

test/BUILD

@@ -475,6 +475,7 @@ scala_binary(
     name = "ScalaBinary_with_fake",
     srcs = ["ScalaBinary.scala"],
     main_class = "scalarules.test.ScalaBinary",
+    unused_dependency_checker_mode = "off",
     deps = [
         ":HelloLib",
         ":MacroTest",
@@ -504,6 +505,7 @@ scala_binary(
     name = "ScalaBinary_with_service_manifest_srcs",
     srcs = ["A.scala"],
     main_class = "scalarules.test.A",
+    unused_dependency_checker_mode = "off",
     deps = [
         "//test/example_jars:example_jar1",
         "//test/example_jars:example_jar2",

test/src/main/scala/scalarules/test/large_classpath/BUILD

@@ -5,6 +5,7 @@ scala_binary(
     name = "largeClasspath",
     srcs = ["ObjectWithLargeClasspath.scala"],
     main_class = "scalarules.test.large_classpath.ObjectWithLargeClasspath",
+    unused_dependency_checker_mode = "off",
     visibility = ["//visibility:public"],
     deps = get_dependency_labels(
         amount = 250,

test/src/main/scala/scalarules/test/resources/BUILD

@@ -20,6 +20,7 @@ scala_specs2_junit_test(
     size = "small",
     srcs = ["ScalaLibOnlyResourcesTest.scala"],
     suffixes = ["Test"],
+    unused_dependency_checker_mode = "off",
     deps = [":noSrcsWithDirectFileResources"],
 )
 
@@ -28,6 +29,7 @@ scala_specs2_junit_test(
     size = "small",
     srcs = ["ScalaLibOnlyResourcesFilegroupTest.scala"],
     suffixes = ["Test"],
+    unused_dependency_checker_mode = "off",
     deps = [":noSrcsWithFilegroupResources"],
 )
 

test/src/main/scala/scalarules/test/resources/strip/BUILD

@@ -11,5 +11,6 @@ scala_specs2_junit_test(
     size = "small",
     srcs = ["ResourceStripPrefixTest.scala"],
     suffixes = ["Test"],
+    unused_dependency_checker_mode = "off",
     deps = [":noSrcsWithResources"],
 )

test_version/WORKSPACE.template

@@ -31,9 +31,9 @@ load("@io_bazel_rules_scala//specs2:specs2_junit.bzl", "specs2_junit_repositorie
 
 specs2_junit_repositories(scala_version)
 
-load("@io_bazel_rules_scala//scala:toolchains.bzl", "scala_register_toolchains")
+load("@io_bazel_rules_scala//scala:toolchains.bzl", "scala_register_unused_deps_toolchains")
 
-scala_register_toolchains()
+scala_register_unused_deps_toolchains()
 
 http_archive(
     name = "com_google_protobuf",

third_party/dependency_analyzer/src/test/BUILD

@@ -15,6 +15,7 @@ scala_junit_test(
         "-Dapache.commons.jar.location=$(location @org_apache_commons_commons_lang_3_5_without_file//:linkable_org_apache_commons_commons_lang_3_5_without_file)",
     ],
     suffixes = ["Test"],
+    unused_dependency_checker_mode = "off",
     deps = [
         "//external:io_bazel_rules_scala/dependency/scala/scala_compiler",
         "//external:io_bazel_rules_scala/dependency/scala/scala_library",

third_party/unused_dependency_checker/src/test/BUILD

@@ -13,13 +13,13 @@ scala_test(
         "-Dscala.library.location=$(location //external:io_bazel_rules_scala/dependency/scala/scala_library)",
         "-Dapache.commons.jar.location=$(location @org_apache_commons_commons_lang_3_5_without_file//:linkable_org_apache_commons_commons_lang_3_5_without_file)",
     ],
+    unused_dependency_checker_mode = "off",
     deps = [
         "//external:io_bazel_rules_scala/dependency/scala/scala_compiler",
         "//external:io_bazel_rules_scala/dependency/scala/scala_library",
         "//external:io_bazel_rules_scala/dependency/scala/scala_reflect",
         "//third_party/unused_dependency_checker/src/main:unused_dependency_checker",
         "//third_party/utils/src/test:test_util",
-        "@com_google_guava_guava_21_0_with_file//jar",
         "@org_apache_commons_commons_lang_3_5_without_file//:linkable_org_apache_commons_commons_lang_3_5_without_file",
     ],
 )