Refines CLI arguments and updates integration tests (#61)

dotanuki-labs · Oct 25, 2023 · 95fd53a · 95fd53a
1 parent 5f5cd35
commit 95fd53a
Show file tree

Hide file tree

Showing 10 changed files with 41 additions and 31 deletions.
diff --git a/e2e/baselines/duckduckgo-5.175.1.toml b/e2e/baselines/duckduckgo-5.175.1.toml
@@ -26,7 +26,7 @@ features = [
     "android.hardware.microphone",
     "android.hardware.screen.portrait"
 ]
-trustedComponents = [  ]
+trustedPackages = [  ]
 activities = [
     "com.duckduckgo.app.SelectedTextSearchActivity",
     "com.duckduckgo.app.WidgetThemeConfiguration",

diff --git a/e2e/baselines/firefoxfocus-118.2.0.toml b/e2e/baselines/firefoxfocus-118.2.0.toml
@@ -29,7 +29,7 @@ permissions = [
     "org.mozilla.focus.permission.RECEIVE_DOWNLOAD_BROADCAST"
 ]
 features = [  ]
-trustedComponents = [  ]
+trustedPackages = [  ]
 activities = [
     "androidx.compose.ui.tooling.PreviewActivity",
     "com.google.android.gms.common.api.GoogleApiActivity",

diff --git a/e2e/baselines/woocommerce-15.7.toml b/e2e/baselines/woocommerce-15.7.toml
@@ -34,7 +34,7 @@ features = [
     "android.hardware.location",
     "android.hardware.wifi"
 ]
-trustedComponents = [
+trustedPackages = [
     "com.woocommerce.*",
     "org.wordpress.*"
 ]

diff --git a/e2e/e2e-tests.sh b/e2e/e2e-tests.sh
@@ -19,7 +19,7 @@ e2e() {
 
   echo -e "• Comparing against $baseline"
 
-  arw compare -t ".tmp/$artifact" -b "$baseline" >/dev/null
+  arw compare -a ".tmp/$artifact" -b "$baseline" >/dev/null
 
   echo -e "✔ No issues found"
 }

diff --git a/scripts/acceptance.sh b/scripts/acceptance.sh
@@ -13,25 +13,25 @@ test_usage() {
 }
 
 test_invalid_inputs() {
-  comparison=$("$arw" overview -t "$fixtures/missing.apk" -b "$toml" || true)
+  comparison=$("$arw" overview -a "$fixtures/missing.apk" -b "$toml" || true)
   echo "$comparison" | grep "missing.apk does not exist" >/dev/null
 }
 
 test_overview() {
 
   echo "✔ Testing artifact overview"
 
-  "$arw" overview --target="$fixtures/app-debug.apk"
+  "$arw" overview --archive="$fixtures/app-debug.apk"
 
-  overview=$("$arw" overview --target="$fixtures/app-debug.apk" --json)
+  overview=$("$arw" overview --archive="$fixtures/app-debug.apk" --json)
   (( $(echo "$overview" | jq '.min_sdk') == 28 ))
   (( $(echo "$overview" | jq '.target_sdk') == 33 ))
 }
 
 test_generate_baseline_complete() {
   echo "✔ Testing baseline generation (complete)"
 
-  "$arw" generate --target="$fixtures/app-debug.apk"
+  "$arw" generate -a "$fixtures/app-debug.apk"
 
   local complete_toml="io.dotanuki.norris.android.debug.toml"
 
@@ -45,7 +45,7 @@ test_generate_baseline_complete() {
 test_generate_baseline_compact() {
   echo "✔ Testing baseline generation (compact)"
 
-  "$arw" generate --target="$fixtures/app-debug.apk" --ignore="io.dotanuki"
+  "$arw" generate --archive="$fixtures/app-debug.apk" --trust="io.dotanuki"
 
   local compact_toml="io.dotanuki.norris.android.debug.toml"
 
@@ -60,10 +60,10 @@ test_compare_baseline_with_artifact() {
   echo
   echo "✔ Testing comparison between baseline and artifacts"
 
-  "$arw" generate --target="$fixtures/app-release.aab" --ignore="io.dotanuki"
+  "$arw" generate --archive="$fixtures/app-release.aab" --trust="io.dotanuki"
 
   local toml="io.dotanuki.norris.android.toml"
-  comparison=$("$arw" compare -t "$fixtures/app-release-changed.apk" -b "$toml" || true)
+  comparison=$("$arw" compare -a "$fixtures/app-release-changed.apk" -b "$toml" || true)
   echo "$comparison"
   echo "$comparison" | grep "Your baseline file does not match the supplied artifact" >/dev/null
 

diff --git a/src/main/kotlin/io/dotanuki/arw/core/toml/WatchdogConfig.kt b/src/main/kotlin/io/dotanuki/arw/core/toml/WatchdogConfig.kt
@@ -15,7 +15,7 @@ data class WatchdogConfig(
     val applicationId: String,
     val permissions: Set<String> = emptySet(),
     val features: Set<String> = emptySet(),
-    val trustedComponents: Set<String> = emptySet(),
+    val trustedPackages: Set<String> = emptySet(),
     val activities: Set<String> = emptySet(),
     val services: Set<String> = emptySet(),
     val receivers: Set<String> = emptySet(),
@@ -27,7 +27,7 @@ data class WatchdogConfig(
             permissions,
             features,
             aggregateComponents().toSet(),
-            trustedComponents
+            trustedPackages
         )
 
     private fun aggregateComponents() =
@@ -37,12 +37,10 @@ data class WatchdogConfig(
             providers.map { AndroidComponent(it, PROVIDER) }
 
     companion object {
-        fun from(analysed: AnalysedArtifact, packages: String? = null) = with(analysed) {
-            val packagesToIgnore = packages?.split(";") ?: emptyList()
-
+        fun from(analysed: AnalysedArtifact, packagesToIgnore: List<String>) = with(analysed) {
             WatchdogConfig(
                 applicationId,
-                trustedComponents = packagesToIgnore.map { "$it.*" }.toSortedSet(),
+                trustedPackages = packagesToIgnore.toSortedSet(),
                 permissions = androidPermissions,
                 features = androidFeatures,
                 activities = androidComponents.declaredNames(ACTIVITY, packagesToIgnore),

diff --git a/src/main/kotlin/io/dotanuki/arw/features/baseline/GenerateCommand.kt b/src/main/kotlin/io/dotanuki/arw/features/baseline/GenerateCommand.kt
@@ -13,12 +13,12 @@ import io.dotanuki.arw.core.toml.WatchdogConfig
 
 context (BaselineContext)
 class GenerateCommand : CliktCommand(
-    help = "arw generate -t/--target <path/to/target>",
+    help = "arw generate -a/--archive <path/to/archive> -t/--trust <packages>",
     name = "generate"
 ) {
 
-    private val target: String by option("-t", "--target").required()
-    private val ignored: String? by option("-i", "--ignore")
+    private val pathToArchive: String by option("-a", "--archive").required()
+    private val trustedPackages: String? by option("-t", "--trust")
     private val debugMode by option("--stacktrace").flag(default = false)
 
     override fun run() {
@@ -28,10 +28,9 @@ class GenerateCommand : CliktCommand(
 
     context (ErrorAware)
     private fun extractBaseline() {
-        val analysed = AndroidArtifactAnalyser.analyse(ValidatedFile(target))
+        val analysed = AndroidArtifactAnalyser.analyse(ValidatedFile(pathToArchive))
+        val baseline = WatchdogConfig.from(analysed, ValidatedPackages(trustedPackages))
         val outputFile = "${analysed.applicationId}.toml"
-
-        val baseline = WatchdogConfig.from(analysed, ignored)
         BaselineWriter.write(baseline, outputFile)
     }
 }
diff --git a/src/main/kotlin/io/dotanuki/arw/features/baseline/ValidatedPackages.kt b/src/main/kotlin/io/dotanuki/arw/features/baseline/ValidatedPackages.kt
@@ -0,0 +1,13 @@
+package io.dotanuki.arw.features.baseline
+
+import io.dotanuki.arw.core.errors.ErrorAware
+
+object ValidatedPackages {
+
+    context (ErrorAware)
+    operator fun invoke(packages: String?): List<String> =
+        packages
+            ?.split(",")
+            ?.map { if (!it.endsWith(".*")) "$it.*" else it }
+            ?: emptyList()
+}
diff --git a/src/main/kotlin/io/dotanuki/arw/features/comparison/CompareCommand.kt b/src/main/kotlin/io/dotanuki/arw/features/comparison/CompareCommand.kt
@@ -13,12 +13,12 @@ import io.dotanuki.arw.core.toml.ValidatedTOML
 
 context (CompareContext)
 class CompareCommand : CliktCommand(
-    help = "arw compare -t/--target <path/to/target> -b/--baseline <path/to/baseline>",
+    help = "arw compare -a/--archive <path/to/archive> -b/--baseline <path/to/baseline>",
     name = "compare"
 ) {
 
-    private val target: String by option("-t", "--target").required()
-    private val baseline: String by option("-b", "--baseline").required()
+    private val pathToArchive: String by option("-a", "--archive").required()
+    private val pathToBaseline: String by option("-b", "--baseline").required()
     private val debugMode by option("--stacktrace").flag(default = false)
 
     override fun run() {
@@ -28,8 +28,8 @@ class CompareCommand : CliktCommand(
 
     context (ErrorAware)
     private fun performComparison() {
-        val current = AndroidArtifactAnalyser.analyse(ValidatedFile(target))
-        val reference = ValidatedTOML(ValidatedFile(baseline))
+        val current = AndroidArtifactAnalyser.analyse(ValidatedFile(pathToArchive))
+        val reference = ValidatedTOML(ValidatedFile(pathToBaseline))
         val comparison = ArtifactsComparator.compare(current, reference.asBaseline())
         ComparisonReporter.reportChanges(comparison)
     }

diff --git a/src/main/kotlin/io/dotanuki/arw/features/overview/OverviewCommand.kt b/src/main/kotlin/io/dotanuki/arw/features/overview/OverviewCommand.kt
@@ -17,14 +17,14 @@ import io.dotanuki.arw.core.filesystem.ValidatedFile
 
 context (OverviewContext)
 class OverviewCommand : CliktCommand(
-    help = "arw overview [--console | --json] ",
+    help = "arw overview -a/--archive <path/to/archive> [--console | --json] ",
     name = "overview"
 ) {
 
     private val switches = listOf("--json" to "json", "--console" to "console").toTypedArray()
 
     private val format: String by option().switch(*switches).default("console")
-    private val target: String by option("-t", "--target").required()
+    private val pathToArchive: String by option("-a", "--archive").required()
     private val debugMode by option("--stacktrace").flag(default = false)
 
     override fun run() {
@@ -34,7 +34,7 @@ class OverviewCommand : CliktCommand(
 
     context (ErrorAware)
     private fun extractOverview() {
-        val analysed = AndroidArtifactAnalyser.analyse(ValidatedFile(target))
+        val analysed = AndroidArtifactAnalyser.analyse(ValidatedFile(pathToArchive))
 
         val overview = with(analysed) {
             ArtifactOverview(