Merge pull request #87 from i2amsam/restrict-oss-to-compiled-dependencies

zhiqiao · web-flow · commit 5379b72a46b6 · 2019-09-10T15:10:32.000-05:00
Only include packaged dependencies
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1 @@
+.idea/
diff --git a/oss-licenses-plugin/src/main/groovy/com/google/android/gms/oss/licenses/plugin/DependencyTask.groovy b/oss-licenses-plugin/src/main/groovy/com/google/android/gms/oss/licenses/plugin/DependencyTask.groovy
@@ -45,6 +45,11 @@ class DependencyTask extends DefaultTask {
     private static final String ANDROID_TEST_PREFIX = "androidTest"
     private static final Set<String> TEST_COMPILE = ["testCompile",
                                                      "androidTestCompile"]
+
+    private static final Set<String> PACKAGED_DEPENDENCIES_PREFIXES = ["compile",
+                                                            "implementation",
+                                                            "api"]
+
     @Input
     public ConfigurationContainer configurations
 
@@ -149,13 +154,28 @@ class DependencyTask extends DefaultTask {
         return isTestConfiguration
     }
 
+    /**
+     * Checks if the configuration is for a packaged dependency (rather than e.g. a build or test time dependency)
+     * @param configuration
+     * @return true if the configuration is in the set of @link #BINARY_DEPENDENCIES
+     */
+    protected boolean isPackagedDependency(Configuration configuration) {
+        boolean isPackagedDependency = PACKAGED_DEPENDENCIES_PREFIXES.any {
+            configuration.name.startsWith(it)
+        }
+
+        return isPackagedDependency
+    }
+
     protected Set<ResolvedArtifact> getResolvedArtifacts(
             Configuration configuration) {
         /**
-         * skip the configurations that are either cannot be resolved in
-         * newer version of gradle api or are tests.
+         * skip the configurations that, cannot be resolved in
+         * newer version of gradle api, are tests, or are not packaged dependencies.
          */
-        if (!canBeResolved(configuration) || isTest(configuration)) {
+        if (!canBeResolved(configuration)
+                || isTest(configuration)
+                || !isPackagedDependency(configuration)) {
             return null
         }
 
diff --git a/oss-licenses-plugin/src/test/java/com/google/android/gms/oss/licenses/plugin/DependencyTaskTest.java b/oss-licenses-plugin/src/test/java/com/google/android/gms/oss/licenses/plugin/DependencyTaskTest.java
@@ -124,6 +124,63 @@ public void testGetResolvedArtifacts_isTest() {
     assertThat(dependencyTask.getResolvedArtifacts(configuration), is(nullValue()));
   }
 
+  @Test
+  public void testGetResolvedArtifacts_isNotPackaged() {
+    Set<ResolvedArtifact> artifactSet = (Set<ResolvedArtifact>) mock(Set.class);
+    ResolvedConfiguration resolvedConfiguration = mock(ResolvedConfiguration.class);
+    when(resolvedConfiguration.getResolvedArtifacts()).thenReturn(artifactSet);
+
+    Configuration configuration = mock(Configuration.class);
+    when(configuration.getName()).thenReturn("annotationProcessor");
+    when(configuration.isCanBeResolved()).thenReturn(true);
+    when(configuration.getResolvedConfiguration()).thenReturn(resolvedConfiguration);
+
+    assertThat(dependencyTask.getResolvedArtifacts(configuration), is(nullValue()));
+  }
+
+  @Test
+  public void testGetResolvedArtifacts_isPackagedApi() {
+    Set<ResolvedArtifact> artifactSet = (Set<ResolvedArtifact>) mock(Set.class);
+    ResolvedConfiguration resolvedConfiguration = mock(ResolvedConfiguration.class);
+    when(resolvedConfiguration.getResolvedArtifacts()).thenReturn(artifactSet);
+
+    Configuration configuration = mock(Configuration.class);
+    when(configuration.getName()).thenReturn("api");
+    when(configuration.isCanBeResolved()).thenReturn(true);
+    when(configuration.getResolvedConfiguration()).thenReturn(resolvedConfiguration);
+
+    assertThat(dependencyTask.getResolvedArtifacts(configuration), is(artifactSet));
+  }
+
+  @Test
+  public void testGetResolvedArtifacts_isPackagedImplementation() {
+    Set<ResolvedArtifact> artifactSet = (Set<ResolvedArtifact>) mock(Set.class);
+    ResolvedConfiguration resolvedConfiguration = mock(ResolvedConfiguration.class);
+    when(resolvedConfiguration.getResolvedArtifacts()).thenReturn(artifactSet);
+
+    Configuration configuration = mock(Configuration.class);
+    when(configuration.getName()).thenReturn("implementation");
+    when(configuration.isCanBeResolved()).thenReturn(true);
+    when(configuration.getResolvedConfiguration()).thenReturn(resolvedConfiguration);
+
+    assertThat(dependencyTask.getResolvedArtifacts(configuration), is(artifactSet));
+  }
+
+  @Test
+  public void testGetResolvedArtifacts_isPackagedCompile() {
+    Set<ResolvedArtifact> artifactSet = (Set<ResolvedArtifact>) mock(Set.class);
+    ResolvedConfiguration resolvedConfiguration = mock(ResolvedConfiguration.class);
+    when(resolvedConfiguration.getResolvedArtifacts()).thenReturn(artifactSet);
+
+    Configuration configuration = mock(Configuration.class);
+    when(configuration.getName()).thenReturn("compile");
+    when(configuration.isCanBeResolved()).thenReturn(true);
+    when(configuration.getResolvedConfiguration()).thenReturn(resolvedConfiguration);
+
+    assertThat(dependencyTask.getResolvedArtifacts(configuration), is(artifactSet));
+  }
+
+
   @Test
   public void testGetResolvedArtifacts_ResolveException() {
     ResolvedConfiguration resolvedConfiguration = mock(ResolvedConfiguration.class);
