"com.android.library" Gradle Module Support (#15)

* ready to review * remove unused import * update README.md with new use case
google · Apr 14, 2021 · 0564ab6 · 0564ab6
1 parent 342afa4
commit 0564ab6
Show file tree

Hide file tree

Showing 4 changed files with 54 additions and 32 deletions.
diff --git a/README.md b/README.md
@@ -32,6 +32,8 @@ plugins {
 }
 ```
 
+This plugin also supports library module type (`com.android.library`). Just install the plugin in your library-level `build.gradle` file and keys will be visible inside that module as well.
+
 ## Example Usage
 
 Example contents of `local.properties` under your root project:

diff --git a/plugin/src/main/java/com/google/secrets_gradle_plugin/Extensions.kt b/plugin/src/main/java/com/google/secrets_gradle_plugin/Extensions.kt
@@ -15,14 +15,18 @@
 package com.google.secrets_gradle_plugin
 
 import com.android.build.gradle.AppExtension
-import com.android.build.gradle.api.ApplicationVariant
+import com.android.build.gradle.LibraryExtension
+import com.android.build.gradle.internal.core.InternalBaseVariant
 import org.gradle.api.Project
 import java.io.FileNotFoundException
 import java.util.Properties
 
 fun Project.androidProject() : AppExtension? =
     extensions.findByType(AppExtension::class.java)
 
+fun Project.libraryProject() : LibraryExtension? =
+    extensions.findByType(LibraryExtension::class.java)
+
 fun Project.loadPropertiesFile(fileName: String) : Properties {
     // Load file
     val propertiesFile = file(fileName)
@@ -40,7 +44,7 @@ fun Project.loadPropertiesFile(fileName: String) : Properties {
 
 private val javaVarRegexp = Regex(pattern = "((?![a-zA-Z_\$0-9]).)")
 
-fun ApplicationVariant.inject(properties: Properties, ignore: List<String>) {
+fun InternalBaseVariant.inject(properties: Properties, ignore: List<String>) {
     val ignoreRegexs = ignore.map { Regex(pattern = it) }
     properties.keys.map { key ->
         key as String

diff --git a/plugin/src/main/java/com/google/secrets_gradle_plugin/SecretsPlugin.kt b/plugin/src/main/java/com/google/secrets_gradle_plugin/SecretsPlugin.kt
@@ -14,6 +14,7 @@
 
 package com.google.secrets_gradle_plugin
 
+import com.android.build.gradle.internal.core.InternalBaseVariant
 import org.gradle.api.Plugin
 import org.gradle.api.Project
 import java.io.FileNotFoundException
@@ -49,38 +50,54 @@ class SecretsPlugin : Plugin<Project> {
                 defaultProperties ?: throw e
             }
 
+            // Target: "com.android.application" module variants
             project.androidProject()?.applicationVariants?.all { variant ->
-                // Inject defaults first
-                defaultProperties?.let {
-                    variant.inject(it, extension.ignoreList)
-                }
+                generateConfigKey(project, extension, defaultProperties, properties, variant)
+            }
 
-                properties?.let {
-                    variant.inject(properties, extension.ignoreList)
-                }
+            // Target: "com.android.library" module variants
+            project.libraryProject()?.libraryVariants?.all { variant ->
+                generateConfigKey(project, extension, defaultProperties, properties, variant)
+            }
+        }
+    }
 
-                // Inject build-type specific properties
-                val buildTypeFileName = "${variant.buildType.name}.properties"
-                val buildTypeProperties = try {
-                    project.rootProject.loadPropertiesFile(buildTypeFileName)
-                } catch (e: FileNotFoundException) {
-                    null
-                }
-                buildTypeProperties?.let {
-                    variant.inject(it, extension.ignoreList)
-                }
+    private fun generateConfigKey(
+        project: Project,
+        extension: SecretsPluginExtension,
+        defaultProperties: Properties?,
+        properties: Properties?,
+        variant: InternalBaseVariant
+    ) {
+        // Inject defaults first
+        defaultProperties?.let {
+            variant.inject(it, extension.ignoreList)
+        }
 
-                // Inject flavor-specific properties
-                val flavorFileName = "${variant.flavorName}.properties"
-                val flavorProperties = try {
-                    project.rootProject.loadPropertiesFile(flavorFileName)
-                } catch (e: FileNotFoundException) {
-                    null
-                }
-                flavorProperties?.let {
-                    variant.inject(it, extension.ignoreList)
-                }
-            }
+        properties?.let {
+            variant.inject(properties, extension.ignoreList)
+        }
+
+        // Inject build-type specific properties
+        val buildTypeFileName = "${variant.buildType.name}.properties"
+        val buildTypeProperties = try {
+            project.rootProject.loadPropertiesFile(buildTypeFileName)
+        } catch (e: FileNotFoundException) {
+            null
+        }
+        buildTypeProperties?.let {
+            variant.inject(it, extension.ignoreList)
+        }
+
+        // Inject flavor-specific properties
+        val flavorFileName = "${variant.flavorName}.properties"
+        val flavorProperties = try {
+            project.rootProject.loadPropertiesFile(flavorFileName)
+        } catch (e: FileNotFoundException) {
+            null
+        }
+        flavorProperties?.let {
+            variant.inject(it, extension.ignoreList)
         }
     }
 }
diff --git a/plugin/src/test/kotlin/com/google/secrets_gradle_plugin/SecretsPluginTest.kt b/plugin/src/test/kotlin/com/google/secrets_gradle_plugin/SecretsPluginTest.kt
@@ -14,7 +14,6 @@
 
 package com.google.secrets_gradle_plugin
 
-import com.android.build.gradle.api.ApplicationVariant
 import com.android.build.gradle.internal.core.InternalBaseVariant
 import com.nhaarman.mockitokotlin2.doReturn
 import com.nhaarman.mockitokotlin2.mock
@@ -38,7 +37,7 @@ class SecretsPluginTest {
     lateinit var placeholders: MutableMap<String, Any>
     lateinit var root: Project
     lateinit var project: Project
-    lateinit var variant: ApplicationVariant
+    lateinit var variant: InternalBaseVariant
 
     @Before
     fun setUp() {