Add provided deps query support to android_library

Summary:
For global code generation, it's beneficial to use provided_deps instead of deps
so that we do not accidentally package items into the app that are used by metagen. This change
allows us to use provided_deps instead, and it also adds better syntax for referencing the declared deps.

Test Plan: new integration test

Reviewed By: dreiss

fbshipit-source-id: a796f60

Author: asp2insp

docs/__common.soy

@@ -1218,6 +1218,20 @@ docsearch({
 {/call}
 {/template}
 
+/***/
+{template .provided_deps_query_arg}
+{call buck.arg}
+  {param name: 'provided_deps_query' /}
+  {param default : 'None' /}
+  {param desc}
+  Status: <strong>experimental/unstable</strong>.
+  The provided deps query functions in the same way as the deps query, but the referenced deps
+  using <code>$declared</code> are the provided deps of the target, and the results of the query
+  are appended to the declared provided deps.
+  {/param}
+{/call}
+{/template}
+
 /***/
 {template .licenses_arg}
 {call buck.arg}

docs/rule/android_library.soy

@@ -151,6 +151,8 @@ compiled class files and resources.
 
 {call buck.deps_query_arg /}
 
+{call buck.provided_deps_query_arg /}
+
 {call buck.tests_arg /}
 
 {/param} // args

src/com/facebook/buck/android/AndroidLibraryDescription.java

@@ -120,6 +120,22 @@ public <A extends Arg> BuildRule createBuildRule(
     }
     final ImmutableSet<BuildRule> queriedDeps = queriedDepsBuilder.build();
 
+    ImmutableSortedSet.Builder<BuildRule> providedDepsBuilder =
+        ImmutableSortedSet.<BuildRule>naturalOrder()
+            .addAll(resolver.getAllRules(args.providedDeps));
+
+    if (args.providedDepsQuery.isPresent()) {
+      providedDepsBuilder.addAll(
+          QueryUtils.resolveDepQuery(
+              params.getBuildTarget(),
+              args.providedDepsQuery.get(),
+              resolver,
+              cellRoots,
+              targetGraph,
+              args.providedDeps)
+              .collect(Collectors.toList()));
+    }
+
     AndroidLibraryGraphEnhancer graphEnhancer = new AndroidLibraryGraphEnhancer(
         params.getBuildTarget(),
         params.copyReplacingExtraDeps(
@@ -157,6 +173,8 @@ public <A extends Arg> BuildRule createBuildRule(
     if (hasDummyRDotJavaFlavor) {
       return dummyRDotJava.get();
     } else {
+      final ImmutableSortedSet<BuildRule> providedDeps = providedDepsBuilder.build();
+
       if (dummyRDotJava.isPresent()) {
         ImmutableSortedSet<BuildRule> newDeclaredDeps = ImmutableSortedSet.<BuildRule>naturalOrder()
             .addAll(params.getDeclaredDeps().get())
@@ -187,7 +205,7 @@ public <A extends Arg> BuildRule createBuildRule(
                   Iterables.concat(
                       declaredDeps,
                       exportedDeps,
-                      resolver.getAllRules(args.providedDeps))))
+                      providedDeps)))
               .addAll(ruleFinder.filterBuildRuleInputs(
                   javacOptions.getAnnotationProcessingParams().getInputs()))
               .addAll(compiler.getExtraDeps(args, resolver))
@@ -197,12 +215,17 @@ public <A extends Arg> BuildRule createBuildRule(
           params.copyReplacingDeclaredAndExtraDeps(
               Suppliers.ofInstance(declaredDeps),
               Suppliers.ofInstance(extraDeps));
+
+      ImmutableSortedSet.Builder<BuildTarget> providedDepsTargetsBuilder =
+          ImmutableSortedSet.naturalOrder();
+      providedDeps.forEach(dep -> providedDepsTargetsBuilder.add(dep.getBuildTarget()));
       return AndroidLibrary.builder(
           androidLibraryParams,
           resolver,
           compiler.compileToJar(args, javacOptions, resolver),
           javacOptions)
           .setConfigAndArgs(javaBuckConfig, args)
+          .setProvidedDeps(providedDepsTargetsBuilder.build())
           .setTrackClassUsage(compiler.trackClassUsage(javacOptions))
           .setTests(args.tests)
           .build();
@@ -239,6 +262,7 @@ public static class Arg extends JavaLibraryDescription.Arg {
     public Optional<String> finalRName;
     public Optional<JvmLanguage> language;
     public Optional<Query> depsQuery;
+    public Optional<Query> providedDepsQuery;
   }
 }
 

src/com/facebook/buck/rules/query/GraphEnhancementQueryEnvironment.java

@@ -98,7 +98,9 @@ public GraphEnhancementQueryEnvironment(
   public ImmutableSet<QueryTarget> getTargetsMatchingPattern(
       String pattern,
       ListeningExecutorService executor) throws QueryException, InterruptedException {
-    if ("$declared_deps".equals(pattern)) {
+    if ("$declared_deps".equals(pattern) ||
+        "$declared".equals(pattern) ||
+        "first_order_deps()".equals(pattern)) {
       return declaredDeps
           .stream()
           .map(QueryBuildTarget::of)

test/com/facebook/buck/android/AndroidLibraryDescriptionIntegrationTest.java

@@ -18,15 +18,23 @@
 package com.facebook.buck.android;
 
 
+import static org.junit.Assert.fail;
+
 import com.facebook.buck.testutil.integration.ProjectWorkspace;
 import com.facebook.buck.testutil.integration.TemporaryPaths;
 import com.facebook.buck.testutil.integration.TestDataHelper;
+import com.fasterxml.jackson.databind.JsonNode;
+import com.fasterxml.jackson.databind.ObjectMapper;
 
+import org.hamcrest.Matchers;
+import org.junit.Assert;
 import org.junit.Before;
 import org.junit.Rule;
 import org.junit.Test;
 
 import java.io.IOException;
+import java.nio.file.Path;
+import java.nio.file.Paths;
 
 /**
  * Tests for AndroidLibraryDescription
@@ -140,4 +148,40 @@ public void testDepQueryWithClasspathDoesNotTraverseProvidedDeps() throws Except
     // Should fail becuase 'C.class' is not added to the classpath because it's a provided dep
     workspace.runBuckCommand("build", "//:no_provided_deps").assertFailure();
   }
+
+  @Test
+  public void testProvidedDepsQuery() throws Exception {
+    AssumeAndroidPlatform.assumeSdkIsAvailable();
+    // Should succeed because required dep (lib_c) will be added as provided
+    workspace.runBuckBuild("//:has_lib_c_from_provided_query").assertSuccess();
+  }
+
+  @Test
+  public void testProvidedDepsQueryDoesNotAffectPackaging() throws Exception {
+    AssumeAndroidPlatform.assumeSdkIsAvailable();
+    workspace.runBuckCommand("build", "//:check_output_of_does_not_package_lib_c")
+        .assertSuccess();
+    String[] outputs = workspace.getFileContents(
+        getOutputFile("//:check_output_of_does_not_package_lib_c"))
+        .split("\\s");
+    // There should be a class entry for UsesC.java
+    Assert.assertThat(outputs, Matchers.hasItemInArray("com/facebook/example/UsesC.class"));
+    // But not one for C.java
+    Assert.assertThat(outputs,
+        Matchers.not(Matchers.hasItemInArray("com/facebook/example/C.class")));
+  }
+
+  private Path getOutputFile(String targetName) {
+    try {
+      ProjectWorkspace.ProcessResult buildResult =
+          workspace.runBuckCommand("targets", targetName, "--show-output", "--json");
+      buildResult.assertSuccess();
+      JsonNode jsonNode = new ObjectMapper().reader().readTree(buildResult.getStdout()).get(0);
+      assert jsonNode.has("buck.outputPath");
+      return Paths.get(jsonNode.get("buck.outputPath").asText());
+    } catch (Exception e) {
+      fail(e.getMessage());
+      return Paths.get("");
+    }
+  }
 }

test/com/facebook/buck/android/testdata/android_library_dynamic_deps/BUCK.fixture

@@ -68,6 +68,17 @@ android_library(
   deps_query = 'kind(android_resource, deps($declared_deps))',
 )
 
+android_library(
+  name = 'has_lib_c_from_provided_query',
+  srcs = [
+    'UsesC.java',
+  ],
+  provided_deps = [
+    ':top_level',
+  ],
+  provided_deps_query = 'kind(java_library, deps($declared))',
+)
+
 android_library(
   name = 'provided_only',
   srcs = [ 'UsesC.java', ],
@@ -79,4 +90,17 @@ android_library(
   srcs = [ 'UsesC.java', ],
   deps = [ ':provided_only', ],
   deps_query = 'classpath($declared_deps)',
+)
+
+java_binary(
+  name = 'does_not_package_lib_c',
+  deps = [
+      ':has_lib_c_from_provided_query',
+  ],
+)
+
+genrule(
+  name = 'check_output_of_does_not_package_lib_c',
+  cmd = 'echo `unzip -l $(location :does_not_package_lib_c)` > $OUT',
+  out = 'out',
 )

test/com/facebook/buck/android/testdata/android_library_dynamic_deps/UsesC.java

@@ -19,4 +19,8 @@
 public class UsesC {
   private C c;
   // method
+
+  public static void main(String[] args) {
+
+  }
 }