[Ruler-CLI] Split configuration into multiple parameters

Author: nathan3d

ruler-cli/src/main/java/com/spotify/ruler/cli/RulerCli.kt

@@ -18,13 +18,16 @@
 package com.spotify.ruler.cli
 
 import com.github.ajalt.clikt.core.CliktCommand
+import com.github.ajalt.clikt.parameters.options.default
+import com.github.ajalt.clikt.parameters.options.flag
 import com.github.ajalt.clikt.parameters.options.multiple
 import com.github.ajalt.clikt.parameters.options.option
 import com.github.ajalt.clikt.parameters.options.required
 import com.github.ajalt.clikt.parameters.types.file
 import com.spotify.ruler.common.BaseRulerTask
 import com.spotify.ruler.common.FEATURE_NAME
 import com.spotify.ruler.common.apk.ApkCreator
+import com.spotify.ruler.common.apk.ApkEntry
 import com.spotify.ruler.common.apk.InjectedToolApkCreator
 import com.spotify.ruler.common.apk.parseSplitApkDirectory
 import com.spotify.ruler.common.apk.unzipFile
@@ -49,7 +52,6 @@ import java.util.logging.Logger
 class RulerCli : CliktCommand(), BaseRulerTask {
     private val logger = Logger.getLogger("Ruler")
     private val dependencyMap by option().file().required()
-    private val rulerConfigJson by option().file().required()
     private val apkFile by option().file()
     private val bundleFile by option().file()
     private val reportDir by option().file(canBeDir = true).required()
@@ -58,6 +60,15 @@ class RulerCli : CliktCommand(), BaseRulerTask {
     private val unstrippedNativeFiles: List<File> by option().file().multiple()
     private val aapt2Tool: File? by option().file()
     private val bloatyTool: File? by option().file()
+    private val defaultOwner by option().default("unknown")
+    private val staticComponentsFile by option().file()
+    private val ownershipFile by option().file()
+    private val omitFileBreakdown by option().flag()
+    private val projectPath by option().required()
+    private val deviceSpecFile by option().file()
+    private val appInfoFile by option().file().required()
+    private val additionalEntriesFile by option().file()
+    private val ignoreFile by option().multiple()
 
     override fun print(content: String) = echo(content)
 
@@ -70,17 +81,26 @@ class RulerCli : CliktCommand(), BaseRulerTask {
     override fun provideBloatyPath() = bloatyTool?.path
 
     private val config: RulerConfig by lazy {
-        val json = Json.decodeFromStream<JsonRulerConfig>(rulerConfigJson.inputStream())
+        val deviceSpec = deviceSpecFile?.let {
+            Json.decodeFromStream<DeviceSpec>(it.inputStream())
+        }
+        val appInfo = Json.decodeFromStream<AppInfo>(appInfoFile.inputStream())
+
+        val additionalEntries =
+            additionalEntriesFile?.let { Json.decodeFromStream<List<ApkEntry.Default>>(it.inputStream()) }
+        logger.log(Level.INFO, "Got ${additionalEntries?.size} additional entries")
         RulerConfig(
-            projectPath = json.projectPath,
-            apkFilesMap = apkFiles(config = json),
+            projectPath = projectPath,
+            apkFilesMap = apkFiles(projectPath, deviceSpec),
             reportDir = reportDir,
-            ownershipFile = json.ownershipFile?.let { File(it) },
-            staticDependenciesFile = json.staticComponentsPath?.let { File(it) },
-            appInfo = json.appInfo,
-            deviceSpec = json.deviceSpec,
-            defaultOwner = json.defaultOwner,
-            omitFileBreakdown = json.omitFileBreakdown
+            ownershipFile = ownershipFile,
+            staticDependenciesFile = staticComponentsFile,
+            appInfo = appInfo,
+            deviceSpec = deviceSpec,
+            defaultOwner = defaultOwner,
+            omitFileBreakdown = omitFileBreakdown,
+            additionalEntries = additionalEntries,
+            ignoredFiles = ignoreFile
         )
     }
 
@@ -110,7 +130,7 @@ class RulerCli : CliktCommand(), BaseRulerTask {
         dependencySanitizer.sanitize(entries)
     }
 
-    private fun apkFiles(config: JsonRulerConfig): Map<String, List<File>> {
+    private fun apkFiles(projectPath: String, deviceSpec: DeviceSpec?): Map<String, List<File>> {
         return if (apkFile != null) {
             if (apkFile!!.extension == "apk") {
                 logger.log(Level.INFO, "Using APK file ${apkFile?.path}")
@@ -122,20 +142,21 @@ class RulerCli : CliktCommand(), BaseRulerTask {
                 parseSplitApkDirectory(directory.toFile())
             }
         } else if (bundleFile != null) {
-            with(if (aapt2Tool != null) {
+            with(
+                if (aapt2Tool != null) {
                     logger.log(
                         Level.INFO,
                         "Creating InjectedToolApkCreator with ${aapt2Tool?.path}"
                     )
                     InjectedToolApkCreator(aapt2Tool!!.toPath())
                 } else {
-                    ApkCreator(File(config.projectPath))
+                    ApkCreator(File(projectPath))
                 }
             ) {
                 createSplitApks(
                     bundleFile!!,
-                    config.deviceSpec!!,
-                    File(config.projectPath).resolve(File("tmp")).apply {
+                    deviceSpec!!,
+                    File(projectPath).resolve(File("tmp")).apply {
                         mkdir()
                     }
                 )
@@ -148,33 +169,25 @@ class RulerCli : CliktCommand(), BaseRulerTask {
     override fun provideDependencies(): Map<String, List<DependencyComponent>> = dependencies
 
     override fun run() {
-        logger.log(Level.INFO,  """
+
+        logger.log(
+            Level.INFO, """
         ~~~~~ Starting Ruler ~~~~~
+       
         Using Dependency Map: ${dependencyMap.path}
-        Using Ruler Config: ${rulerConfigJson.path}
         Using APK File: ${apkFile?.path}
         Using Bundle File: ${bundleFile?.path}
         Using Proguard Mapping File: ${mappingFile?.path}
         Using Resource Mapping File: ${resourceMappingFile?.path}
         Using AAPT2: ${aapt2Tool?.path}
         Using Bloaty: ${bloatyTool?.path}
         Writing reports to: ${reportDir.path}
-        """.trimIndent())
+        """.trimIndent()
+        )
         super.run()
     }
 }
 
-@Serializable
-data class JsonRulerConfig(
-    val projectPath: String,
-    val ownershipFile: String? = null,
-    val staticComponentsPath: String? = null,
-    val appInfo: AppInfo,
-    val deviceSpec: DeviceSpec? = null,
-    val defaultOwner: String,
-    val omitFileBreakdown: Boolean
-)
-
 @Serializable
 data class ModuleMap(
     val assets: List<Asset>,

ruler-common/src/main/java/com/spotify/ruler/common/BaseRulerTask.kt

@@ -91,10 +91,13 @@ interface BaseRulerTask {
         val classNameSanitizer = ClassNameSanitizer(provideMappingFile())
         val resourceNameSanitizer = ResourceNameSanitizer(provideResourceMappingFile())
         val apkSanitizer = ApkSanitizer(classNameSanitizer, resourceNameSanitizer)
-
-        return rulerConfig().apkFilesMap.mapValues { (_, apks) ->
-            val entries = apks.flatMap(apkParser::parse)
-            apkSanitizer.sanitize(entries)
+        val config = rulerConfig()
+        return config.apkFilesMap.mapValues { (name, apks) ->
+            val entries = apks.flatMap(apkParser::parse).toMutableList()
+            if (name == FEATURE_NAME && config.additionalEntries != null) {
+                entries += config.additionalEntries
+            }
+            apkSanitizer.sanitize(entries, config.ignoredFiles)
         }
     }
 

ruler-common/src/main/java/com/spotify/ruler/common/apk/ApkEntry.kt

@@ -16,20 +16,25 @@
 
 package com.spotify.ruler.common.apk
 
+import kotlinx.serialization.Serializable
+
 /** Single entry of an APK. */
+@Serializable
 sealed class ApkEntry {
     abstract val name: String
     abstract val downloadSize: Long
     abstract val installSize: Long
 
     /** Default APK entry. If an entry has no special type, it is considered to be a default entry. */
+    @Serializable
     data class Default(
         override val name: String,
         override val downloadSize: Long,
         override val installSize: Long,
     ) : ApkEntry()
 
     /** DEX file APK entry containing compiled classes. */
+    @Serializable
     data class Dex(
         override val name: String,
         override val downloadSize: Long,
@@ -38,6 +43,7 @@ sealed class ApkEntry {
     ) : ApkEntry()
 
     /** Native Library entry containing files coming from native library. */
+    @Serializable
     data class NativeLibrary(
         override val name: String,
         override val downloadSize: Long,

ruler-common/src/main/java/com/spotify/ruler/common/apk/ApkSanitizer.kt

@@ -16,11 +16,11 @@
 
 package com.spotify.ruler.common.apk
 
+import com.spotify.ruler.common.sanitizer.ClassNameSanitizer
+import com.spotify.ruler.common.sanitizer.ResourceNameSanitizer
 import com.spotify.ruler.models.AppFile
 import com.spotify.ruler.models.FileType
 import com.spotify.ruler.models.ResourceType
-import com.spotify.ruler.common.sanitizer.ClassNameSanitizer
-import com.spotify.ruler.common.sanitizer.ResourceNameSanitizer
 
 /**
  * Responsible for sanitizing APK entries, so they can be attributed easier.
@@ -40,7 +40,7 @@ class ApkSanitizer(
      * @param entries List of raw entries parsed from an APK file
      * @return Sanitized list of entries
      */
-    fun sanitize(entries: List<ApkEntry>): List<AppFile> {
+    fun sanitize(entries: List<ApkEntry>, ignoredFiles: List<String>): List<AppFile> {
         val buckets = listOf(
             NativeLibAssigningBucket(),
             DexFileBucket(),
@@ -52,7 +52,7 @@ class ApkSanitizer(
         )
 
         // Separate entries into their different sanitization bucket
-        entries.forEach { entry ->
+        entries.filterNot { it.name in ignoredFiles }.forEach { entry ->
             val bucket = buckets.first { it.isApplicable(entry) }
             bucket.add(entry)
         }

ruler-common/src/main/java/com/spotify/ruler/common/models/RulerConfig.kt

@@ -16,6 +16,7 @@
 
 package com.spotify.ruler.common.models
 
+import com.spotify.ruler.common.apk.ApkEntry
 import java.io.File
 
 data class RulerConfig(
@@ -27,5 +28,7 @@ data class RulerConfig(
     val appInfo: AppInfo,
     val deviceSpec: DeviceSpec?,
     val defaultOwner: String,
-    val omitFileBreakdown: Boolean
+    val omitFileBreakdown: Boolean,
+    val additionalEntries: List<ApkEntry.Default>?,
+    val ignoredFiles: List<String>
 )

ruler-gradle-plugin/src/main/kotlin/com/spotify/ruler/plugin/RulerTask.kt

@@ -16,15 +16,15 @@
 
 package com.spotify.ruler.plugin
 
-import com.spotify.ruler.common.apk.ApkCreator
-import com.spotify.ruler.plugin.dependency.EntryParser
 import com.spotify.ruler.common.BaseRulerTask
+import com.spotify.ruler.common.apk.ApkCreator
 import com.spotify.ruler.common.dependency.DependencyComponent
 import com.spotify.ruler.common.dependency.DependencySanitizer
 import com.spotify.ruler.common.models.AppInfo
 import com.spotify.ruler.common.models.DeviceSpec
 import com.spotify.ruler.common.models.RulerConfig
 import com.spotify.ruler.common.sanitizer.ClassNameSanitizer
+import com.spotify.ruler.plugin.dependency.EntryParser
 import org.gradle.api.DefaultTask
 import org.gradle.api.file.DirectoryProperty
 import org.gradle.api.file.RegularFile
@@ -97,7 +97,9 @@ abstract class RulerTask : DefaultTask(), BaseRulerTask {
             appInfo = appInfo.get(),
             deviceSpec = deviceSpec.get(),
             defaultOwner = defaultOwner.get(),
-            omitFileBreakdown = omitFileBreakdown.get()
+            omitFileBreakdown = omitFileBreakdown.get(),
+            additionalEntries = emptyList(),
+            ignoredFiles = emptyList()
         )
     }